SmartAPI

This integration hooks into MeridianLink's SmartAPI System which is used for obtaining credit reports and FICO scores

Required Credentials

All calls require the following customer credentials

{
    "username": string,
    "password": string
}

Create a New Credit Request

This call will return a new credit request id, which will be needed for the Get Credit Request call.

Endpoint

Method URI Headers
POST /api/v1/integrations/smart-api/credit-request {"Authorization": "Bearer {access_token}"}

Data Params

{
    //...credentials,
    "data"    : {
        "borrower": {
          "first_name": "string",
          "middle_name": "string",
          "last_name": "string",
          "email": "string",
          "phone": "string",
          "birthday": "YYYY-MM-DD",
          "address": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "ssn": "string",
          "position_type": "string",
          "marital_status_type": "string",
          "residency_type": "string"
        },
        "co-borrower": {
          "first_name": "string",
          "middle_name": "string",
          "last_name": "string",
          "email": "string",
          "phone": "string",
          "birthday": "YYYY-MM-DD",
          "address": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "ssn": "string",
          "position_type": "string",
          "marital_status_type": "string",
          "residency_type": "string"
        }
    }
}

Example Response Content

{
    "data"    : {
        "id": "681706",
        "statusCode": "New",
        "statusDescription": "PENDING",
        "borrower": {...},
        "coBorrower": {...}
    }
}

Get Credit Request

Note, a report may not be finished generating immediately after creating a new request. It can take some time for the reports to be finished so polling is needed until the report has finished before all data is properly returned.

Endpoint

Method URI Headers
GET /api/v1/integrations/smart-api/credit-request/{creditRequestId} {"Authorization": "Bearer {access_token}"}

Data Params

{
    //...credentials,
    "data"    : {
        "borrower": {
          "first_name": "string",
          "middle_name": "string",
          "last_name": "string",
          "email": "string",
          "phone": "string",
          "birthday": "YYYY-MM-DD",
          "address": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "ssn": "string",
          "position_type": "string",
          "marital_status_type": "string",
          "residency_type": "string"
        },
        "co-borrower": {
          "first_name": "string",
          "middle_name": "string",
          "last_name": "string",
          "email": "string",
          "phone": "string",
          "birthday": "YYYY-MM-DD",
          "address": "string",
          "city": "string",
          "state": "string",
          "zip": "string",
          "ssn": "string",
          "position_type": "string",
          "marital_status_type": "string",
          "residency_type": "string"
        }
    }
}

Example Response Content

{
    "data"    : {
      "id": "681706",
      "statusCode": "New",
      "statusDescription": "PENDING",
      "borrower": {...},
      "coBorrower": {...},
      "documents": [
        {
          "name": "CreditOrder",
          "body": "...",
          "encoding": "UTF8",
          "mime": "application/pdf",
          "encodingType": "Base64", //if included, body content will need to be decoded before displayed
          "encodingTypeDescription": "",
          "formPublisherId": "683847"
        }
      ],
      "liabilities": [
        ...
      ],
      "scoreModels": [
        {
          "max": "850",
          "min": "300",
          "name": "ExperianFairIsaac"
        },
        {
          "max": "839",
          "min": "309",
          "name": "FICORiskScoreClassic04"
        },
        {
          "max": "818",
          "min": "334",
          "name": "EquifaxBeacon5.0"
        }
      ],
      "score": 732
    }
}