KYB Credit Bureau

Requirements

• API key pair
• Reports functionality enabled (done by iDenfy's staff)

---

sample reports

Download here

---

Credit Bureau

Search

Credit Bureau Lite

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

Request structure

Parameter(query)	Type	Required	Sample/available values
companyName	String	Yes	"Mycompany"
countries	String	Yes	2-digit ISO country code, e.g. "DE"
registryNumber	String	Yes	"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 SOS Charter number, Tax ID, MC number, USDOT number or other.

Response example

{
  "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

Credit Bureau Report

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

Request structure

Parameter	Type	Required	Sample/available values
countryCode	String	Yes	2-digit ISO country code, e.g. "DE"
companyName	String	Yes	"Company Name"
registryNumber	String	Yes	"12511182"

Request

{
  "countries": ["AF"],
  "companyName": "string",
  "registryNumber": "string"
}

Response

{
  "dataFile": "JSON file URL",
  "reportFile": "PDF file URL",
  "id": "string"
}

---

Retrieve specific Credit Bureau document

Credit Bureau Specific Document

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

Response sample

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

---

Retrieve all Credit Bureau documents

Credit Bureau All Reports

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

If you do not have an ID of a report or you need to retrieve all of the available reports.

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

Response example

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