# UK Business Credit Report

## UK Business Credit Report

<mark style="color:green;">`POST`</mark> `{{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<mark style="color:red;">\*</mark> | String | API secret token |

#### Request Body

| Name                                               | Type    | Description                                                                        |
| -------------------------------------------------- | ------- | ---------------------------------------------------------------------------------- |
| companyName<mark style="color:red;">\*</mark>      | String  | The valid company registration number                                              |
| isSubjectConsent<mark style="color:red;">\*</mark> | Boolean | Indicate subject has given consent. <mark style="color:red;">`Must be true`</mark> |
| metadata                                           | Object  | Metadata                                                                           |

{% tabs %}
{% tab title="UK Business Credit Report Sample Request" %}

```json
{
    "companyNumber": "T12345678",
    "isSubjectConsent": true
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="UK Business Credit ReportSample Response" %}

```json
{
    "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": []
}
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="Error Responses" %}

```json
 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": {}
}

```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.youverify.co/credit-report/uk-business-credit-report.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.