Requirements
- API key pair
- Reports functionality enabled (done by iDenfy’s staff)
Registry Reports
Available Registry Report documents
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 |
registrationNumber | String | Yes | ”12511182” |
Response example
{
"products": [
{
"id": "EBROFF_MzA0NjE3NjIxO0xUVV9CUzs0OzQ7RlMwMTI5_TFRVX0JT_QmFsYW5jZSBzaGVldA==_MzA0NjE3NjIx",
"priceTag": "LTU_BS",
"price": "0",
"vatCharge": "0",
"currency": "\u20ac",
"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": "\u20ac",
"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
}
]
}
Order Registry Report document
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 |
registrationNumber | String | Yes | ”12511182” |
companyName | String | Yes | ”Company Name” |
productKey | String | Yes | id of the document from the available Registry Reports response |
{
"countryCode": "LT",
"registrationNumber": "304617621",
"companyName": "IDENFY",
"productKey": "EBRON_RUJSX0NvbXBhbnlQcm9maWxlXzE=_MzA0NjE3NjIx__"
}
Successful request / 200 OK with empty body.
List ordered Registry Report documents
Authorization: API key pair
Method: GET
Endpoint: https://ivs.idenfy.com/api/v2/gov-ordered-documents/
Response example
[
{
"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/..."
},
{
"id": "f0733089-c27e-47cb-b49d-e9950097aed2",
"title": "Beneficial Ownership Report",
"documentFormat": "PDF",
"productKey": "ROWOFF_Q1pfVUJP_QmVuZWZpY2lhbCBPd25lcnNoaXAgUmVwb3J0_...",
"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/..."
}
]
Retrieve specific Registry Report document
Authorization: API key pair
Method: GET
Endpoint: https://ivs.idenfy.com/api/v2/gov-ordered-documents/{id}/
: Report's unique number
Response 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/..."
}