Status

Check Status

get

By passing specific parameters, retrieve the latest status of the soft credit check.

Authorizations

access_token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

vidstring · alphanumericRequired

The unique external indentifier for the user's session.

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

sidstring · alphanumericOptional

The unique external indentifier for the user's current session.

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

application_idstring · alphanumericOptional

The unique application ID of the soft credit check.

Example: 52345678-e89b-12d3-a456-426614174000

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

Responses

200

Status of the credit check.

application/json

400

Bad request.

404

Not found.

409

Conflict.

500

Unknown error occured.

get

/v1/credit/check/status

HTTPcURLJavaScriptPython

GET /v1/credit/check/status?vid=text HTTP/1.1
Host: api.dealermesh.com
Authorization: Bearer YOUR_SECRET_TOKEN
x-dm-access-key: text
x-api-key: text
Accept: */*

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