POST
/
creditreports
Create a new Credit Report
curl --request POST \
  --url https://commerce.driv.ly/api/creditreports \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "crp_5dk3j9dk2l3k",
  "time": "2023-04-12T15:30:00Z",
  "hasNS": false,
  "creditBand": {
    "id": "crb_39fjkd93nmd0",
    "name": "Excellent",
    "minimumCreditScore": 700,
    "maximumCreditScore": 800
  },
  "creditScore": 720,
  "preApproval": {
    "id": "pre_59dk394fjdl3",
    "consumer": "Consumer ID",
    "creditBand": "crb_39fjkd93nmd0",
    "validUntilTime": "2024-04-12T00:00:00Z"
  },
  "hasUnknownScore": false
}'
{
  "data": {
    "id": "crp_5dk3j9dk2l3k",
    "time": "2023-04-12T15:30:00Z",
    "hasNS": false,
    "creditBand": {
      "id": "crb_39fjkd93nmd0",
      "name": "Excellent",
      "minimumCreditScore": 700,
      "maximumCreditScore": 800
    },
    "creditScore": 720,
    "preApproval": {
      "id": "pre_59dk394fjdl3",
      "consumer": "Consumer ID",
      "creditBand": "crb_39fjkd93nmd0",
      "validUntilTime": "2024-04-12T00:00:00Z"
    },
    "hasUnknownScore": false
  },
  "success": true
}

Query Parameters

​
depth
integer

The number of levels of related objects to include in the response

Body

application/json
​
time
string<date-time>
required

Credit Report was pulled at Time

​
creditBand
required

Credit Report falls in Credit Band

​
preApproval
required

Pre-Approval has Credit Report

​
id
string

Credit Report is uniquely identified by id

​
creditScore
number

Credit Report has Credit Score

​
hasUnknownScore
boolean

Credit Report has unknown score

​
hasNS
boolean

Credit Report has NS

Response

Credit Report Created

​
data
object
Examples:
{
  "id": "crp_5dk3j9dk2l3k",
  "time": "2023-04-12T15:30:00Z",
  "hasNS": false,
  "creditBand": {
    "id": "crb_39fjkd93nmd0",
    "name": "Excellent",
    "minimumCreditScore": 700,
    "maximumCreditScore": 800
  },
  "creditScore": 720,
  "preApproval": {
    "id": "pre_59dk394fjdl3",
    "consumer": "Consumer ID",
    "creditBand": "crb_39fjkd93nmd0",
    "validUntilTime": "2024-04-12T00:00:00Z"
  },
  "hasUnknownScore": false
}
​
success
boolean