> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.idenfy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Credit Bureau Reports

> Retrieve credit bureau reports and financial data for companies via the iDenfy KYB API for business verification and due diligence.

<Note>
  **Requirements**

  * **API** key pair
  * Reports functionality **enabled** (done by iDenfy's staff)
</Note>

<Info>
  **Sample reports:** [Download here](/images/preview/ReportSamples.zip)
</Info>

***

The Credit Bureau API lets you search for companies and order detailed credit reports. Use it to assess a company's financial health, creditworthiness, and current status before entering a business relationship.

## Credit Bureau

### Search

<Info>
  **Authorization:** `API key pair`
  **Method:** `GET`
  **Endpoint:** `https://ivs.idenfy.com/api/v2/credit-bureau-documents/search/`
</Info>

**Request structure**

| Parameter (query) | Type   | Required | Sample/available values             |
| ----------------- | ------ | -------- | ----------------------------------- |
| `companyName`     | String | No       | "Mycompany"                         |
| `countries`       | String | Yes      | 2-digit ISO country code, e.g. "DE" |
| `registryNumber`  | String | No       | "12511182"                          |

<Note>
  `registry_number` for US companies could differ depending on the regulations by the secretary of state (SOS) in which the company is operating. In some cases it could be the SOS Charter number, Tax ID, MC number, USDOT number, or other.
</Note>

**Response example**

```json theme={"system"}
{
  "id": "string",
  "country": "string",
  "safeNo": "string",
  "idType": "string",
  "name": "string",
  "type": "string",
  "officeType": "string",
  "status": "string",
  "regNo": "string",
  "vatNo": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "address": {
    "type": "string",
    "simpleValue": "string",
    "street": "string",
    "houseNumber": "string",
    "city": "string",
    "postalCode": "string",
    "province": "string",
    "telephone": "string",
    "directMarketingOptOut": true,
    "directMarketingOptIn": true,
    "country": "string"
  },
  "activity": {
    "code": "string",
    "industrySector": "string",
    "description": "string",
    "classification": "string"
  },
  "legalForm": "string",
  "additionalData": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "dateOfLatestAccounts": "string",
  "dateOfLatestChange": "string"
}
```

***

## Order Credit Bureau Company Report

<Info>
  **Authorization:** `API key pair`
  **Method:** `POST`
  **Endpoint:** `https://ivs.idenfy.com/api/v2/credit-bureau-documents/report/`
</Info>

**Request structure**

| Parameter        | Type   | Required | Sample/available values                           |
| ---------------- | ------ | -------- | ------------------------------------------------- |
| `countries`      | Array  | Yes      | Array of 2-digit ISO country codes, e.g. `["DE"]` |
| `companyName`    | String | Yes      | "Company Name"                                    |
| `registryNumber` | String | Yes      | "12511182"                                        |

<Tabs>
  <Tab title="Request">
    ```json theme={"system"}
    {
      "countries": ["DE"],
      "companyName": "Beispiel GmbH",
      "registryNumber": "HRB 12345"
    }
    ```
  </Tab>

  <Tab title="Response">
    ```json theme={"system"}
    {
      "dataFile": "JSON file URL",
      "reportFile": "PDF file URL",
      "id": "string"
    }
    ```
  </Tab>
</Tabs>

***

## Retrieve Specific Credit Bureau Document

<Info>
  **Authorization:** `API key pair`
  **Method:** `GET`
  **Endpoint:** `https://ivs.idenfy.com/api/v2/credit-bureau-documents/{id}/`
  **{id}:** `Report's unique number`
</Info>

**Response sample**

```json theme={"system"}
{
  "id": "string",
  "externalCompanyId": "string",
  "checkedAt": "2022-06-30T08:55:45.810Z",
  "status": "ACTIVE",
  "dataFile": "JSON",
  "reportFile": "PDF"
}
```

***

## Retrieve All Credit Bureau Documents

<Info>
  **Authorization:** `API key pair`
  **Method:** `GET`
  **Endpoint:** `https://ivs.idenfy.com/api/v2/credit-bureau-documents/`
</Info>

If you do not have an ID of a report or you need to retrieve all available reports, use this endpoint.

Use the `checked_at` query parameter if a date range is needed. The type for the parameter is `array[string]`.

**Response example**

```json theme={"system"}
[
  {
    "id": "string",
    "externalCompanyId": "string",
    "checkedAt": "2022-06-30T10:15:47.692Z",
    "status": "ACTIVE",
    "dataFile": "JSON",
    "reportFile": "PDF"
  }
]
```