Company reports API

To retrieve credit bureau or gov register reports on companies, the functionality has to be enabled for the environment that you use.

Our sales@idenfy.com team will help you include new functionalities in your contract and the technical support team will help with enabling these new features and assist throughout the implementation. Please contact our technical support team via Dashboard using your account.

To make the API calls, all of the requests will require basic auth, where API key is username, and API secret is password.

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.

Sample response

Response code: 200

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

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

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

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

Credit Bureau All Reports

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

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

Response sample:

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

GOV Registry

Search

GOV Registry Lite

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

note

If company_name is not provided, all countries country_code are available, except: BD, BR, FI, ID, MA, NI, OM, PH, TT & US-IL, US-NY, US-SC .

Parameter(query)	Type	Required	Sample/available values
`company_name`	String	Yes	"Mycompany", check note above
`country_code`	String	Yes	2-digit ISO country code, check note above
`registry_number`	String	Yes	"12511182"
`region`	String	for US & Canada	2-digit ISO state code

Sample response

Response code:

{
  "addressesField": [
    {
      "countryField": "string",
      "typeField": "string",
      "typeCodeField": "string",
      "addressInOneLineField": "string",
      "addressLine1Field": "string",
      "addressLine2Field": "string",
      "addressLine3Field": "string",
      "addressLine4Field": "string",
      "addressLine5Field": "string",
      "postcodeField": "string",
      "cityTownField": "string",
      "regionStateField": "string",
      "websiteUrlField": "string",
      "emailField": "string",
      "faxNumberField": "string",
      "telephoneNumberField": "string",
      "PropertyChanged": "string"
    }
  ],
  "aliasesField": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "codeField": "string",
  "companyIDField": "string",
  "dateField": "string",
  "legalFormField": "string",
  "legalStatusField": "string",
  "nameField": "string",
  "officialField": true,
  "registrationAuthorityField": "string",
  "registrationAuthorityCodeField": "string",
  "sourceField": "string",
  "virtualIDField": "string",
  "moreKeyField": "string",
  "functionField": "string",
  "PropertyChanged": "string"
}

Order GOV registers company report

GOV registers Report

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

Request
Response

{
  "countryCode": "AF",
  "companyName": "string",
  "registryNumber": "string"
}

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

note

If the request is made for USA and Canada's countries, an additional parameter region should be added with a state in alpha-2 format. i.e. "region":"CA"

Retrieve specific GOV Registry document

GOV Registry Specific Document

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

Response sample:

{
  "id": "string",
  "externalCompanyId": "string",
  "checkedAt": "2022-06-30T10:08:00.701Z",
  "dataFile": "JSON",
  "reportFile": "PDF",
  "companyName": "string",
  "postcode": "string",
  "city": "string",
  "activityCode": "string",
  "activity": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "addresses": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "aliases": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "email": "string",
  "faxNumber": "string",
  "telephoneNumber": "string",
  "fiscalCode": "string",
  "websiteUrl": "string",
  "foundationDate": "string",
  "legalForm": "string",
  "legalStatus": "string",
  "registrationAuthority": "string",
  "registrationAuthorityCode": "string",
  "registrationDate": "string",
  "registrationNumber": "string",
  "vatNumber": "string",
  "stateOfIncorporation": "string",
  "associatedPersons": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

Retrieve all GOV Register documents

GOV register's All Reports

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

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

Response sample:

[
  {
    "id": "string",
    "externalCompanyId": "string",
    "checkedAt": "2022-06-30T10:23:49.511Z",
    "dataFile": "json",
    "reportFile": "pdf",
    "companyName": "string",
    "postcode": "string",
    "city": "string",
    "activityCode": "string",
    "activity": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "addresses": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "aliases": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "email": "string",
    "faxNumber": "string",
    "telephoneNumber": "string",
    "fiscalCode": "string",
    "websiteUrl": "string",
    "foundationDate": "string",
    "legalForm": "string",
    "legalStatus": "string",
    "registrationAuthority": "string",
    "registrationAuthorityCode": "string",
    "registrationDate": "string",
    "registrationNumber": "string",
    "vatNumber": "string",
    "stateOfIncorporation": "string",
    "associatedPersons": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  }
]

Registry Reports

Available Registry Report documents

Available Registry Reports

Authorization: API key pair
Method: GET
Endpoint: https://ivs.idenfy.com/api/v2/gov-ordered-documents/available-documents/

Parameter(query)	Type	Required	Sample/available values
`countryCode`	String	Yes	2-digit ISO country code, check note above
`registrationNumber`	String	Yes	"12511182"

Example response:

{
  "products": [
    {
      "id": "EBROFF_MzA0NjE3NjIxO0xUVV9CUzs0OzQ7RlMwMTI5_TFRVX0JT_QmFsYW5jZSBzaGVldA==_MzA0NjE3NjIx",
      "priceTag": "LTU_BS",
      "price": "0",
      "vatCharge": "0",
      "currency": "€",
      "productCode": "304617621;LTU_BS;4;4;FS0129",
      "companyCode": "304617621",
      "productDetails": [
        {
          "keyField": "EFFECTIVE_DATE",
          "valueField": "2020-12-31",
          "documentCountField": 0
        }
      ],
      "productFormat": "HTML",
      "productTitle": "Balance sheet",
      "displayDate": "2020-12-31",
      "type": "BALANCE_SHEET",
      "deliveryTimeMinutes": 5,
      "tierCode": "A",
      "tierValue": "1.00",
      "status": "NOT_ORDERED",
      "canOrder": true
  },
  {
      "id": "304617621;LTU_BS;4;7;FS0229",
      "productCode": "304617621;LTU_BS;4;7;FS0229",
      "price": 1,
      "productFormat": null,
      "productTitle": "Balance sheet",
      "deliveryTimeMinutes": 5,
      "type": "BALANCE_SHEET",
      "displayDate": "2023-12-31",
      "priceTag": "LTU_BS",
      "vatCharge": "0",
      "currency": "€",
      "productCode": "304617621;LTU_PL;4;4;FS0129",
      "companyCode": "304617621",
      "productDetails": [
        {
          "keyField": "EFFECTIVE_DATE",
          "valueField": "2020-12-31",
          "documentCountField": 0
        }
      ],
      "productFormat": "HTML",
      "productTitle": "Profit and loss account",
      "displayDate": "2020-12-31",
      "type": "PROFIT_AND_LOSS_ACCOUNT",
      "deliveryTimeMinutes": 5,
      "tierCode": "A",
      "tierValue": "1.00",
      "status": "NOT_ORDERED",
      "canOrder": true
    },
    {
      "id": "EBROFF_MzA0NjE3NjIxO0xUVV9CUzs0OzM7RlMwMTI5_TFRVX0JT_QmFsYW5jZSBzaGVldA==_MzA0NjE3NjIx",
      "priceTag": "LTU_BS",
      "price": "0",
      "vatCharge": "0",
      "currency": "€",
      "productCode": "304617621;LTU_BS;4;3;FS0129",
      "companyCode": "304617621",
      "productDetails": [
        {
          "keyField": "EFFECTIVE_DATE",
          "valueField": "2019-12-31",
          "documentCountField": 0
        }
      ],
      "productFormat": "HTML",
      "productTitle": "Balance sheet",
      "displayDate": "2019-12-31",
      "type": "BALANCE_SHEET",
      "deliveryTimeMinutes": 5,
      "tierCode": "A",
      "tierValue": "1.00",
      "status": "NOT_ORDERED",
      "canOrder": true
    }
  ]
}

Order Registry Report document

Order Registery Report

Authorization: API key pair
Method: POST
Endpoint: https://ivs.idenfy.com/api/v2/gov-ordered-documents/document-order/

Parameter	Type	Required	Sample/available values
`countryCode`	String	Yes	2-digit ISO country code, check note above
`registrationNumber`	String	Yes	"12511182"
`companyName`	String	Yes	"Company Name"
`productKey`	String	Yes	`id` of the document from the available Registry Reports reponse of the previous request

Request
Response

{
  "countryCode": "LT",
  "registrationNumber": "304617621",
  "companyName": "IDENFY",
  "productKey": "EBRON_RUJSX0NvbXBhbnlQcm9maWxlXzE=_MzA0NjE3NjIx__"
}

List ordered Registry Report documents

List Registry's Reports

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

Example response:

[
  {
    "id": "39e40532-8838-402b-a72e-ab39d1c43b16",
    "title": "Company Officials",
    "documentFormat": "PDF",
    "productKey": "EBRON_RUJSX0NvbXBhbnlPZmZpY2lhbHNfMQ==_MzA0NjE3NjIx__",
    "expectedDeliveryTime": "2024-01-02T09:51:53.643567Z",
    "price": 1.0,
    "deliveredAt": "2024-01-02T09:52:55.543725Z",
    "status": "FINISHED",
    "file": "https://s3.eu-west-1.amazonaws.com/production.users.storage/kyb_storage/partners/2253/ordered_documents/40326ba2-84b5-41b4-810b-3b765a335d24.pdf?AWSAccessKeyId=AKIAJEE33B4FZLU73WMA&Signature=n5fjCoNfcoWKssaypTASA3L%2BJw%3D&Expires=1704192777"
  },
  {
    "id": "f0733089-c27e-47cb-b49d-e9950097aed2",
    "title": "Beneficial Ownership Report",
    "documentFormat": "PDF",
    "productKey": "ROWOFF_Q1pfVUJP_QmVuZWZpY2lhbCBPd25lcnNoaXAgUmVwb3J0_MjYxODU2MTA=___MS8xLzAwMDEgMTI6MDA6MDAgQU0=__S1lDT04=",
    "expectedDeliveryTime": "2023-12-14T08:24:18.959072Z",
    "price": 5.0,
    "deliveredAt": "2023-12-14T09:21:58.768875Z",
    "status": "FINISHED",
    "file": "https://s3.eu-west-1.amazonaws.com/production.users.storage/kyb_storage/partners/2253/ordered_documents/9f97ec5a-df0e-4dd6-834f-9c26982a9b6c.pdf?AWSAccessKeyId=AKIAJEE33B4FZLU73WMA&Signature=np2%2B8JyWK2n0SWIjbnEbUGVm9H%3D&Expires=1704192777"
  }
]

Retrieve specific Registry Report document

GOV registers Report

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

Example:

{
  "id": "39e40532-8838-402b-a72e-ab39d1c43b16",
  "title": "Company Officials",
  "documentFormat": "PDF",
  "productKey": "EBRON_RUJSX0NvbXBhbnlPZmZpY2lhbHNfMQ==_MzA0NjE3NjIx__",
  "expectedDeliveryTime": "2023-12-14T08:36:26.033428Z",
  "price": 1.0,
  "deliveredAt": "2024-01-02T09:52:55.543725Z",
  "status": "FINISHED",
  "file": "https://s3.eu-west-1.amazonaws.com/production.users.storage/kyb_storage/partners/2253/ordered_documents/9f93f3de-15c5-45ae-99e3-9e4b72e52925.pdf?AWSAccessKeyId=AKIAJEE33B4FZLU73WMA&Signature=q5WXtPdUJknQmtW5U8wn0At5X4%3D&Expires=1704204453"
}

Sample reports

Download sample reports here

Company reports API

Credit Bureau​

Search​

Sample response​

Order Credit Bureau company report​

Retrieve specific Credit Bureau document​

Retrieve all Credit Bureau documents​

GOV Registry​

Search​

Sample response​

Order GOV registers company report​

Retrieve specific GOV Registry document​

Retrieve all GOV Register documents​

Registry Reports​

Available Registry Report documents​

Order Registry Report document​

List ordered Registry Report documents​

Retrieve specific Registry Report document​

Sample reports​

Credit Bureau

Search

Sample response

Order Credit Bureau company report

Retrieve specific Credit Bureau document

Retrieve all Credit Bureau documents

GOV Registry

Search

Sample response

Order GOV registers company report

Retrieve specific GOV Registry document

Retrieve all GOV Register documents

Registry Reports

Available Registry Report documents

Order Registry Report document

List ordered Registry Report documents

Retrieve specific Registry Report document

Sample reports