Skip to main content
Requirements
  • API key pair
  • Reports functionality enabled (done by iDenfy’s staff)
Sample reports: Download here
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

Authorization: API key pair Method: GET Endpoint: https://ivs.idenfy.com/api/v2/credit-bureau-documents/search/
Request structure
Parameter (query)TypeRequiredSample/available values
companyNameStringNo”Mycompany”
countriesStringYes2-digit ISO country code, e.g. “DE”
registryNumberStringNo”12511182”
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.
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

Authorization: API key pair Method: POST Endpoint: https://ivs.idenfy.com/api/v2/credit-bureau-documents/report/
Request structure
ParameterTypeRequiredSample/available values
countriesArrayYesArray of 2-digit ISO country codes, e.g. ["DE"]
companyNameStringYes”Company Name”
registryNumberStringYes”12511182”
{
  "countries": ["DE"],
  "companyName": "Beispiel GmbH",
  "registryNumber": "HRB 12345"
}

​
Retrieve Specific Credit Bureau Document

Authorization: API key pair Method: GET Endpoint: https://ivs.idenfy.com/api/v2/credit-bureau-documents/{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

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 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 
[
  {
    "id": "string",
    "externalCompanyId": "string",
    "checkedAt": "2022-06-30T10:15:47.692Z",
    "status": "ACTIVE",
    "dataFile": "JSON",
    "reportFile": "PDF"
  }
]