Application

Application

post

Submit credit application for a loan approval.

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 application submitted.

application/json

400

Bad request.

404

Not found.

409

Conflict.

500

Unknown error occured.

post

/v1/credit/application

HTTPcURLJavaScriptPython

POST /v1/credit/application 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: 2148

{
  "applicant": {
    "curr_address_less_2y": false,
    "previous_address": {
      "address": "1 Main St",
      "address_2": "401",
      "city": "Boston",
      "state": "MA",
      "zip": "02215"
    },
    "ssn": "111-11-1111",
    "dob": "11/05/1970",
    "housing": {
      "status": "Mortgage",
      "mortgage_rent": 3199,
      "time_at_address": {
        "years": 5,
        "months": 7
      }
    },
    "income": {
      "type": "Permanent",
      "interval": "Monthly",
      "income": 8799
    },
    "other_income": {
      "type": "Part-Time",
      "interval": "Monthly",
      "income": 8799,
      "source": "Consulting"
    },
    "employment": {
      "status": "Full-Time",
      "employer": "Bank of America",
      "job_title": "Manager",
      "work_phone": "8004445555",
      "time_at_job": {
        "years": 5,
        "months": 7
      }
    },
    "previous_employment": {
      "status": "Full-Time",
      "employer": "Bank of America",
      "job_title": "Manager",
      "work_phone": "8004445555",
      "time_at_job": {
        "years": 5,
        "months": 7
      }
    },
    "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",
    "vid": "123e4567-e89b-12d3-a456-426614174000"
  },
  "has_co_applicant": false,
  "co_applicant": {
    "curr_address_less_2y": false,
    "previous_address": {
      "address": "1 Main St",
      "address_2": "401",
      "city": "Boston",
      "state": "MA",
      "zip": "02215"
    },
    "ssn": "111-11-1111",
    "dob": "11/05/1970",
    "housing": {
      "status": "Mortgage",
      "mortgage_rent": 3199,
      "time_at_address": {
        "years": 5,
        "months": 7
      }
    },
    "income": {
      "type": "Permanent",
      "interval": "Monthly",
      "income": 8799
    },
    "other_income": {
      "type": "Part-Time",
      "interval": "Monthly",
      "income": 8799,
      "source": "Consulting"
    },
    "employment": {
      "status": "Full-Time",
      "employer": "Bank of America",
      "job_title": "Manager",
      "work_phone": "8004445555",
      "time_at_job": {
        "years": 5,
        "months": 7
      }
    },
    "previous_employment": {
      "status": "Full-Time",
      "employer": "Bank of America",
      "job_title": "Manager",
      "work_phone": "8004445555",
      "time_at_job": {
        "years": 5,
        "months": 7
      }
    },
    "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",
    "vid": "123e4567-e89b-12d3-a456-426614174000"
  },
  "deal_id": "456735se-e89b-12d3-a456-426614174000"
}

{
  "application_id": "456735se-e89b-12d3-a456-426614174000",
  "request_id": "12345678-e89b-12d3-a456-426614174000"
}

Last Application

get

Retrieve the credit application results for the ID provided.

Authorizations

access_token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

application_idstring · alphanumericRequired

The unique application ID.

Example: 456735se-e89b-12d3-a456-426614174000

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

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

Credit application results for the ID provided.

application/json

400

Bad request.

404

Not found.

409

Conflict.

500

Unknown error occured.

get

/v1/credit/application/{application_id}

HTTPcURLJavaScriptPython

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

{
  "application_id": "456735se-e89b-12d3-a456-426614174000",
  "status": "pending",
  "message": "Please contact the dealer.",
  "deal_id": "456735se-e89b-12d3-a456-426614174000"
}