GET
/
creditreports
/
{id}
Retrieve a Credit Report
curl --request GET \
  --url https://commerce.driv.ly/api/creditreports/{id}
{
  "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
}

Path Parameters

id
string
required

Credit Report is uniquely identified by id

Query Parameters

depth
integer

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

Response

200
application/json

Credit Report Found

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