Credit Check

Credit Check

post

This endpoint enables registered partners to perform credit checks.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

extUserIdstring | nullableOptional

titlestringOptional

firstNamestringOptional

lastNamestringOptional

dobstringOptional

buildingNumberstringOptional

streetAddressstringOptional

citystringOptional

regionstringOptional

postCodestringOptional

Responses

200

Success

application/json

Responsestring

Raw credit check result

403

The specified partner ID does not have sufficient permissions

application/json

500

An unexpected error occurred on the server side. Please try again later. If the issue persists, contact support for assistance.

application/json

post

/api/v2/partner/creditcheck

HTTPcURLJavaScriptPython

POST /api/v2/partner/creditcheck HTTP/1.1
Host: qa-api.steadypay.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "extUserId": "text",
  "title": "text",
  "firstName": "text",
  "lastName": "text",
  "dob": "text",
  "buildingNumber": "text",
  "streetAddress": "text",
  "city": "text",
  "region": "text",
  "postCode": "text"
}

text