In Automated Company Documents Reading (ACDR), the AllDocs model is applied.
To retrieve the list of documents along with the data fields extracted from them by ACDR, use the Get AllDocs results by applicant ID method.
Supported documents and extracted fields
The table below provides the list of documents supported by ACDR together with the expected fields that can be extracted per document type.
Document type | Expected fields |
---|---|
Certificate of incorporation/registration | Country, (state), registration authority, registration date, company name, registration number, legal form type. |
Memorandum of incorporation/association/registration | Country, (state), company name, incorporation date. |
Recent excerpt from a state company registry | Country, (state), registration authority, registration date, name, reg number, status, address, date of export, legal form type. |
Statement of information | Country, (state), name, registration number, date of document issue, issuing authority, legal form type. |
Proof of address | Company name, registration number, address, date of issue, type of the PoA, issuing authority. |
Certificate of incumbency | Country, (state), name, registration number, status, address, date of issue, list of shareholders, list of directors. |
Certificate of good standing | Country, (state), issuing authority, registration date, name, reg number, status, address, date of issue. |
Shareholder registry | Company name, registration number, list of shareholders, date of issue. |
Director registry | Company name, registration number, list of directors, date of issue. |
Trust agreement | Country, (state), registration date, trust name, date of issue, beneficiary(s), trustee, settlor. |
Power of attorney | Country, (state), company name, date of issue, date of expiration, names of director(s), name of representative(s). |
Request example
The request example of getting the ACDR results looks as follows:
curl -X GET \
'https://api.sumsub.com/resources/applicants/673f34507b66912100000d87/allDocs/docs'
Response explained
The response is a JSON file that includes structured data from the documents uploaded to the profile of a company applicant and extracted via ACDR.
Field | Type | Description |
---|---|---|
applicantId | String | Unique applicant identifier in the Sumsub system. This identifier is a random combination of 24 digits and lowercase Latin characters. It is automatically generated when the applicant profile is created on the Sumsub side. |
docs | Array of Objects | Represents a list of documents uploaded by the applicant. |
docs
element fields
docs
element fieldsThe following table explains the element fields of the docs
array that represents a list of documents uploaded to the applicant profile.
Field | Type | Description |
---|---|---|
id | String | Unique document identifier. |
allDocsPresetName | String | Preset that was used for AllDocs verification. Mind that presets are created and edited for you by Sumsub experts. You can view them in read-only mode. |
imageIds | Array of strings | Includes a list of identifiers for all uploaded documents. |
questionnaireId | String | Unique identifier of the questionnaire. |
questionnaireSectionId | String | Identifier of the questionnaire section that represents a separate group of questions added to the questionnaire.. |
questionnaireItemId | String | Identifier of the questionnaire section item that stands for a single question added to the questionnaire. |
fields | Array of objects | List of parameters and corresponding values that define the allDocsPresetName configuration. |
fields
element fields
fields
element fieldsThe following table explains the elements of the fields
array.
Field | Type | Description |
---|---|---|
name | String | Field name corresponding to a parameter extracted from the document. |
values | Array of strings | Value or values of the field with the corresponding name . |
name
available values
name
available valuesThe following table lists possible values of the name
field.
Value | Description |
---|---|
country | Alpha-3 code of the country where the company is legally registered (for example, DEU , GBR , and so on). |
state | State, region, district, county or another territorial entity inside a country where the company is registered. |
companyName | Name of the company. |
issueDate | Date when the company document was issued. |
registrationNumber | Unique number that is assigned to the company when it was registered as a legal entity. |
registrationDate | Date when the company was registered as a legal entity. |
registrationAuthority | Legal authority that is in charge of registering the company. |
address | Company address. |
status | Company status. |
directors | List of the company directors. |
poaType | Proof of address type. |
trustee | Trustee of the company. |
settlor | Settlor of the company. |
incorporationDate | Date of company incorporation. |
legalForm | Legal form type. |
shareholders | List of the company shareholders and/or beneficiaries. |
expirationDate | Date when the document validity expires. |
representatives | List of the company representatives. |
exportDate | Date of export in the ISO-8601 format. |
licenseNumber | Number of a license assigned for a time-bound term for a company specific activity type, like banking or gambling. |
tradeName | Company trade name. |
industryCodes | Business activity types with their codes. |
Response example
Below is the response example for the Get ACDR Results request:
{
"applicantId": "68ac73772939332d00000000",
"docs": [
{
"id": "68ac7403293933000000d000",
"allDocsPresetName": "systemKyb_INCORPORATION_CERT",
"imageIds": [
"21038000"
],
"fields": [
{
"name": "country",
"values": [
"CYP"
]
},
{
"name": "state"
},
{
"name": "companyName",
"values": [
"COMPANY NAME LTD"
]
},
{
"name": "registrationAuthority",
"values": [
"Ministry of Finance and Corporate Relations, Registrar of Companies"
]
},
{
"name": "registrationDate"
},
{
"name": "registrationNumber",
"values": [
"HE000000"
]
},
{
"name": "legalForm",
"values": [
"LTD"
]
}
]
}
]
}