Checkio API
post/{tenantId}/v1/credit-reports

Generate credit report

Requires Authentication
Credit Reports

Initiates a new credit report request

Path Parameters

NameTypeDescription
tenantId
required
string (uuid)Tenant UUID

Request Body

required
sessionId
string
required
bureaus
array
"equifax" | "experian" | "transunion"[]
required
ipAddress
string
required
searchType
string
required
title
string
firstName
string
required
middleName
string
lastName
string
required
dateOfBirth
string (date)
required
gender
string
mobileNumber
string
email
string (email)
externalReference
string
addresses
array
Address[]
required
Address
test
boolean
challengeOptions
ChallengeOptions
status
string
enum: "allow" | "block" | "challenge"
url
string
- Optional callback URL for verification. In production, specify your website URL.

Responses

Credit report generation initiated

Response Bodyapplication/json
meta
ResponseMeta
request
object
wallet
object
data
object
status
string
challengeType
string
creditReportId
string
creditReport
unknown
challenge
object

Code Examples

curl -X POST 'https://api-next.checkio.co.uk/{tenantId}/v1/credit-reports' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
  "sessionId": "string",
  "bureaus": [
    "equifax"
  ],
  "ipAddress": "string",
  "searchType": "string",
  "title": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "dateOfBirth": "2024-01-15",
  "gender": "string",
  "mobileNumber": "string",
  "email": "user@example.com",
  "externalReference": "string",
  "addresses": [
    {
      "type": "string",
      "ukAddress": {
        "subBuildingName": "string",
        "buildingName": "string",
        "buildingNumber": "string",
        "thoroughfare": "string",
        "townOrCity": "string",
        "district": "string",
        "county": "string",
        "country": "string",
        "postcode": "string"
      }
    }
  ],
  "test": true,
  "challengeOptions": {
    "status": "allow"
  },
  "url": "string"
}'