KYB GOV Registry
- API key pair
- Reports functionality
enabled
(done by iDenfy's staff)
GOV Registry
Authorization: API key pair
Method: GET
Endpoint: https://ivs.idenfy.com/api/v2/gov-registers-documents/search/
Search
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 |
Response example
{
"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
Authorization: API key pair
Method: POST
Endpoint: https://ivs.idenfy.com/api/v2/gov-registers-documents/report/
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"
- Request
- Response
{
"countryCode": "AF",
"companyName": "string",
"registryNumber": "string"
}
{
"dataFile": "JSON file URL",
"reportFile": "PDF file URL",
"id": "string"
}
Retrieve specific GOV Registry 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
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"
}
}
]