π¬π§UK Business Credit Report
UK Business Credit Report
POST
{{baseurl}}/v2/api/identity/credit-report/gb/business
This endpoint allows you to validate the credit history of a UK Business.
Headers
Name
Type
Description
token*
String
API secret token
Request Body
Name
Type
Description
companyName*
String
The valid company registration number
isSubjectConsent*
Boolean
Indicate subject has given consent. Must be true
metadata
Object
Metadata
{
"companyNumber": "T12345678",
"isSubjectConsent": true
}
{
"success": true,
"statusCode": 200,
"message": "success",
"data": {
"id": "680b5eade11a96c33f7428c5",
"parentId": null,
"status": "not_found",
"reason": "Not Found",
"businessData": [],
"companyShareholderList": [],
"facilityPerformanceSummary": [],
"companyFinancialList": [],
"creditRatingInformation": {
"rating": null,
"ratingScore": null,
"ratingDate": null,
"previousRating": null,
"previousRatingScore": null,
"previousRatingDate": null,
"creditLimit": null,
"creditLimitDate": null,
"previousCreditLimit": null,
"previousCreditLimitDate": null,
"contractLimit": null,
"keyPositiveFactors": [],
"otherFactors": [],
"topShareholders": []
},
"isConsent": true,
"idNumber": "T01234560",
"businessId": "628b38f03ae28a14f52d4bf7",
"type": "gbBusinessCreditReport",
"requestedAt": "2025-04-25T10:06:38.963Z",
"requestedById": "628b38f03ae28a5a122d4bf3",
"country": "GB",
"createdAt": "2025-04-25T10:06:39.133Z",
"lastModifiedAt": "2025-04-25T10:06:39.133Z",
"metadata": {},
"requestedBy": {
"firstName": "API",
"lastName": "User",
"middleName": "",
"id": "628b38f03ae28a5a122d4bf3"
}
},
"links": []
}
HTTP/1.1 402 Payment Required
{
"success": false,
"statusCode": 402,
"message": "Insufficient fund",
"name": "PaymentRequiredError",
"data": {}
}
HTTP/1.1 500 Service Unavailable
{
"success": false,
"statusCode": 500,
"message": "Third-party provider not reachable",
"name": "Error",
"data": {}
}
HTTP/1.1 403 Forbidden
{
"success": false,
"statusCode": 403,
"message": "Permission denied",
"name": "UnauthorizedError",
"data": {}
}
HTTP/1.1 404 NotFound
{
"success": false,
"statusCode": 404,
"message": "You have attempted to get a resource that does not exist.",
"name": "ResourceNotFoundError",
"data": {}
}
Last updated
Was this helpful?