Company record
Records act as representations of documents used to extract companies. This resource encompasses metadata associated with the document itself, alongside the extracted entities.
The recordId can be obtained from the kybBusinessIdentity section. For more information, refer to the section documentation.
Records act as representations of documents used to extract companies. This route accepts the parameters listed below.
Permission required: Services query
Your access token. See more in the 'Authentication' topic of this section.
The name of the requested service, for Company Record need be "kybCompanyRecord"
kybCompanyRecord
Example: kybCompanyRecord
All fields passed to the metadata will be returned in the response, this field is useful to bring an internal identifier of the request for example
Success
Invalid provided body
Invalid token
The token does not have permission to access this resource
Internal server error
POST /v1/services HTTP/1.1
Host: api.public.caf.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 77
{
"service": "kybCompanyRecord",
"parameters": {
"recordId": "text"
},
"metadata": {}
}
{
"requestId": "text",
"message": "text",
"data": {
"service": "kybCompanyRecord",
"serviceData": {
"id": "7b3f91a4c28e6d7f2a4e682b15638d2a%2F603039824%2F1610341200000",
"label": "Company Record from UK",
"publicationDate": "2021-01-11",
"acquisitionDate": "2021-01-11",
"sourceUrl": "https://country.gov/",
"sourceId": "7b3f91a4c28e6d7f2a4e682b15638d2a",
"documentUrls": [
"text"
],
"entities": {
"count": 7,
"data": [
{
"type": "text",
"entity": {
"id": "text",
"label": "text",
"type": "text",
"degree": 1,
"pep": true,
"psaId": "text",
"psaCount": 1,
"sanctioned": true,
"closed": true,
"registrationDate": "text",
"identifiers": [
{
"value": "text",
"type": "text",
"label": "text"
}
],
"addresses": [
"text"
],
"countries": [
"text"
],
"risk": [
{
"name": "text",
"value": 1,
"countries": [
"text"
],
"level": "text"
}
],
"counts": {
"relatedEntities": 1,
"relationships": {
"hasRegisteredAgent": 1
},
"attributes": {
"name": 1,
"identifier": 1,
"country": 1,
"status": 1,
"address": 1
},
"sources": [
{
"label": "text",
"count": 1
}
]
}
}
}
]
}
},
"metadata": {}
}
}
Last updated