Skip to content
Staircase

MeridianLink

A credit and identity vendor whose integration covers consumer credit, first in the committed employment ordering.

The vendor's consumer credit product is asynchronous. The integration polls it and presents a synchronous call to the caller, because the vendor's stated typical report time is short enough that a polling loop on the caller's side buys nothing.

Soft pulls are the case that matters here. A soft pull leaves no borrower-visible inquiry, which is what makes credit usable early in an application without exposing the borrower to competing outreach.

Catalogue entries

Modelled as an entry in the product catalogue, named after this vendor. The operations below are what it declares.

Meridian
filed under Integration

How the integration works

Credentials are per lender. The setup surface takes the lender's own vendor domain, interface identifier and account, so a lender's credit pulls run under its own contract with the vendor rather than under a shared one.

The integration is reached through Credit, and the vendor also holds positions in the employment and income orderings.

Operations

Setup

POST /meridian-setup/credentials

Set Meridian Credentials

setMeridianCredentials

By using Set Meridian Credentials API we allow our customers to configure Meridian in customer environment.

If you want to use your own Meridian contract for verification, please check Request body Schema example for required values from Meridian side and run Set Meridian Credentials API.

Request
application/json 
{
  "mlm_username": "--------",
  "mlm_password": "--------",
  "credentials_type": "test"
}
Response
application/json

Setup API Triggered Successfully

{
  "message": "Credentials are saved and verified"
}
Parameters
1
ParameterTypeExampleDescription
x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Staircase Environment API Key
Request bodyapplication/json
3 fields
FieldTypeDescription
mlm_usernamerequiredstringMeridianLink Mortgage username
mlm_passwordrequiredstringMeridianLink Mortgage password
credentials_typerequiredstringType of credentials, can be either test or production
Response 200application/json
1 fields

Setup API Triggered Successfully

FieldTypeDescription
messagestringMessage
Response 400application/json
1 fields

Request data failed validation

FieldTypeDescription
messagestringMessage
Response 403application/json
2 fields

Invalid key for service

FieldTypeDescription
messagestring—
urlstring—
Response 422application/json
1 fields

Request data failed validation

FieldTypeDescription
messagestringMessage
Response 500application/json
1 fields

The product has encountered an internal server error

FieldTypeDescription
messagestringError Message
Other responses

404

POST /meridian-setup/custom-fields

Set Meridian Custom Fields Identifiers schema

setMeridianCustomFieldsIdentifiers

Set Meridian Custom Fields Identifiers

By using Set Meridian Custom Fields API we allow our customers to configure Meridian Custom Fields in customer environment.

To be able to use MeridianLink Mortgage - Dytrix integration then you need to provide custom fields identifier to the request. As mentioned integration requires custom fields to be created as a part of MeridianLink Mortgage application, custom field IDs need to be provided for integration to work. More details regarding the custom fields can be found at the Identity MeridianLink-Dytrix Integration Configuration Guide.

Custom field IDs required are:

  • Closing Agent Requested
  • Closing Agent Requested ID
  • Closing Agent Status
  • Request ID
  • Request Status
  • Report Expiration Date
  • Account and ABA numbers
Request
application/json 
{
  "closing_agent_requested": "custLoan100",
  "closing_agent_requested_id": "custLoan101",
  "closing_agent_status": "custLoan102",
  "request_id": "custLoan103",
  "request_status": "custLoan104",
  "report_expiration_date": "custLoan105",
  "account_aba_numbers": "custLoan106"
}
Response
application/json

Setup API Triggered Successfully

{
  "message": "Custom fields configuration is saved"
}
Parameters
1
ParameterTypeExampleDescription
x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Staircase Environment API Key
Request bodyapplication/json
7 fields
FieldTypeDescription
closing_agent_requestedrequiredstringMeridianLink Mortgage custom field identifier for Closing Agent Requested.
closing_agent_requested_idrequiredstringMeridianLink Mortgage custom field identifier for Closing Agent Requested ID.
closing_agent_statusrequiredstringMeridianLink Mortgage custom field identifier for Closing Agent Status.
request_idrequiredstringMeridianLink Mortgage custom field identifier for Request ID.
request_statusrequiredstringMeridianLink Mortgage custom field identifier for Request Status.
report_expiration_daterequiredstringMeridianLink Mortgage custom field identifier for Report Expiration Date.
account_aba_numbersrequiredstringMeridianLink Mortgage custom field identifier for Account and ABA numbers.
Response 200application/json
1 fields

Setup API Triggered Successfully

FieldTypeDescription
messagestringMessage
Response 400application/json
1 fields

Request data failed validation

FieldTypeDescription
messagestringMessage
Response 403application/json
2 fields

Invalid key for service

FieldTypeDescription
messagestring—
urlstring—
Response 422application/json
1 fields

Request data failed validation

FieldTypeDescription
messagestringMessage
Response 500application/json
1 fields

The product has encountered an internal server error

FieldTypeDescription
messagestringError Message
Other responses

404

GET /meridian-setup/credentials

Retrieve Meridian Credentials Schema

getMeridianCredentials

Get Credentials Schema

Get credentials schema for Meridian. You can use retrieved schema for setting the Meridian credentials.

Response
application/json

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}
Parameters
1
ParameterTypeExampleDescription
x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Staircase Environment API Key
Response 200application/json
1 fields

Create Adapter API Triggered Successfully

FieldTypeDescription
messagestringMessage
Response 400application/json
1 fields

Request data failed validation

FieldTypeDescription
messagestringMessage
Response 403application/json
2 fields

Invalid key for service

FieldTypeDescription
messagestring—
urlstring—
Response 422application/json
1 fields

Request data failed validation

FieldTypeDescription
messagestringMessage
Response 500application/json
1 fields

The product has encountered an internal server error

FieldTypeDescription
messagestringError Message
Other responses

404

GET /meridian-setup/custom-fields

Retrieve Meridian Custom Fields Identifiers schema

getMeridianCustomFieldsIdentifiers

Get Custom Fields Identifiers Schema

Get custom fields identifiers schema for Meridian. You can use retrieved schema for setting the Meridian custom fields identifier.

Response
application/json

Request data failed validation

{
  "message": "{'data': ['Missing data for required field.']}"
}
Parameters
1
ParameterTypeExampleDescription
x-api-key required string header xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Staircase Environment API Key
Response 200application/json
1 fields

Create Adapter API Triggered Successfully

FieldTypeDescription
messagestringMessage
Response 400application/json
1 fields

Request data failed validation

FieldTypeDescription
messagestringMessage
Response 403application/json
2 fields

Invalid key for service

FieldTypeDescription
messagestring—
urlstring—
Response 422application/json
1 fields

Request data failed validation

FieldTypeDescription
messagestringMessage
Response 500application/json
1 fields

The product has encountered an internal server error

FieldTypeDescription
messagestringError Message
Other responses

404

Errors

400403404422500

Products it serves

Position in the ordering

  • Employment MeridianArgyleAtomicWageFinicityExperianPinwheelCitadelEquifaxTrueworkInstantTruework
  • Income ArgyleAtomicEquifaxExperianFinicityMeridianPinwheelPlaidTrueworkTruework-Instant
  • Credit configured per lender

How this integration is built

connection configuration
The wire protocol. One repository per vendor API call, not per vendor.
language configuration
The field mapping between the vendor's vocabulary and the canonical model.
flow file
The four-way translation: canonical request, vendor request, vendor response, canonical response.
waterfall priority
One line naming where this vendor sits in the vertical's ordering.
status call
Activating the vendor for a lender, optionally with the lender's own credentials.

Evidence

This vendor is on the roster because each of the following resolves to a committed artifact.

  • StaircaseAPI/employment-product-product-data product/data/waterfall.json waterfall
  • StaircaseAPI/income-pp-data product/data/waterfall/waterfall.json waterfall
  • credit-meridian-integration-service
  • credit-pp-data product/data/flows/meridian.json
  • credit-pp-data product/data/flows/meridianlink.json
  • employment-pp-data product/data/flows/Meridian.json
  • identity-meridian-integration
  • income-pp-data product/data/flows/meridian.json
  • los-meridian-service
  • meridian-data
  • meridian-setup-service
  • mortgage-verification-credit-meridian_link
  • mortgage-verification-credit-verification-meridian-configuration
  • partner-meridian-credit-language-configuration
  • partner-meridian-verification-connection-configuration

Type to search.