Check

Soft Credit

post

Submit a soft credit check and get the latest credit score for a customer.

Authorizations

access_token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

x-dm-access-keystringRequired

The unique identifier of your dealer. Refer to Console > Dealers to get or setup your dealer access key.

x-api-keystringRequired

Your app's client ID.

Example: 47de026c-e52f-afc1-9214-063740bbce4d

Body

application/json

Responses

200

The request ID of the check submitted.

application/json

Responseall of

400

Bad request.

404

Not found.

409

Conflict.

500

Unknown error occured.

post

/v1/credit/check

HTTPcURLJavaScriptPython

POST /v1/credit/check HTTP/1.1
Host: api.dealermesh.com
Authorization: Bearer YOUR_SECRET_TOKEN
x-dm-access-key: text
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 383

{
  "ssn_last4": "1111",
  "dob": "11/05/1970",
  "tos": true,
  "vid": "123e4567-e89b-12d3-a456-426614174000",
  "sid": "sese4567-e89b-12d3-a456-426614174000",
  "first_name": "John",
  "middle_name": "Parker",
  "last_name": "Smith",
  "suffix": "Jr",
  "email": "[email protected]",
  "home_phone": "2221110000",
  "mobile_phone": "2221110000",
  "address_1": "1 Main St",
  "address_2": "401",
  "city": "Boston",
  "state": "MA",
  "zip": "02215"
}

{
  "status": "completed",
  "message": "Record not found.",
  "application_id": "52345678-e89b-12d3-a456-426614174000",
  "tier": 1,
  "low": 750,
  "high": 900
}