Get OCR fields from company documents

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 typeExpected fields
Certificate of incorporation/registrationCountry, (state), registration authority, registration date, company name, registration number, legal form type.
Memorandum of incorporation/association/registrationCountry, (state), company name, incorporation date.
Recent excerpt from a state company registryCountry, (state), registration authority, registration date, name, reg number, status, address, date of export, legal form type.
Statement of informationCountry, (state), name, registration number, date of document issue, issuing authority, legal form type.
Proof of addressCompany name, registration number, address, date of issue, type of the PoA, issuing authority.
Certificate of incumbencyCountry, (state), name, registration number, status, address, date of issue, list of shareholders, list of directors.
Certificate of good standingCountry, (state), issuing authority, registration date, name, reg number, status, address, date of issue.
Shareholder registryCompany name, registration number, list of shareholders, date of issue.
Director registryCompany name, registration number, list of directors, date of issue.
Trust agreementCountry, (state), registration date, trust name, date of issue, beneficiary(s), trustee, settlor.
Power of attorneyCountry, (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.

FieldTypeDescription
applicantIdStringUnique 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.
docsArray of ObjectsRepresents a list of documents uploaded by the applicant.

docs element fields

The following table explains the element fields of the docs array that represents a list of documents uploaded to the applicant profile.

FieldTypeDescription
idStringUnique document identifier.
allDocsPresetNameStringPreset 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.
imageIdsArray of stringsIncludes a list of identifiers for all uploaded documents.
questionnaireIdStringUnique identifier of the questionnaire.
questionnaireSectionIdStringIdentifier of the questionnaire section that represents a separate group of questions added to the questionnaire..
questionnaireItemIdStringIdentifier of the questionnaire section item that stands for a single question added to the questionnaire.
fieldsArray of objectsList of parameters and corresponding values that define the allDocsPresetName configuration.

fields element fields

The following table explains the elements of the fields array.

FieldTypeDescription
nameStringField name corresponding to a parameter extracted from the document.
valuesArray of stringsValue or values of the field with the corresponding name.

name available values

The following table lists possible values of the name field.

ValueDescription
countryAlpha-3 code of the country where the company is legally registered (for example, DEU, GBR, and so on).
stateState, region, district, county or another territorial entity inside a country where the company is registered.
companyNameName of the company.
issueDateDate when the company document was issued.
registrationNumberUnique number that is assigned to the company when it was registered as a legal entity.
registrationDateDate when the company was registered as a legal entity.
registrationAuthorityLegal authority that is in charge of registering the company.
addressCompany address.
statusCompany status.
directorsList of the company directors.
poaTypeProof of address type.
trusteeTrustee of the company.
settlorSettlor of the company.
incorporationDateDate of company incorporation.
legalFormLegal form type.
shareholdersList of the company shareholders and/or beneficiaries.
expirationDateDate when the document validity expires.
representativesList of the company representatives.
exportDateDate of export in the ISO-8601 format.
licenseNumberNumber of a license assigned for a time-bound term for a company specific activity type, like banking or gambling.
tradeNameCompany trade name.
industryCodesBusiness 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"
                    ]
                }
            ]
        }
    ]
}