--- updatedAt: 2026-09-29T07:46:24.000Z agentTools: projectIndex: https://docs.sumsub.com/llms.txt --- # Get applicant data # Overview Use this method to get information about the [created applicant](https://docs.sumsub.com/sumsub/reference/create-applicants) — both `individual` and `company`. ## Required permissions To use this method, your [app token](https://docs.sumsub.com/sumsub/docs/app-tokens) must have the **View applicants** [permission](https://docs.sumsub.com/sumsub/docs/user-roles#permissions). ## Request example ```curl curl -X GET \ 'https://api.sumsub.com/resources/applicants/5b594ade0a975a89ju78yt77/one' \ -H 'accept: application/json' \ -H 'X-App-Token: ' \ -H 'X-App-Access-Sig: ' \ -H 'X-App-Access-Ts: ' ``` ### Note - Some data is shown only if it was recognized from the documents or provided by the applicant. - To make sure you have fetched the data from a relevant document, you can get what `idDocType` and `country` was approved using [this method](https://docs.sumsub.com/sumsub/reference/get-applicant-verification-steps-status). ### Tip If the applicant ID is unknown to you, use the [Get applicant data (externalUserId)](https://docs.sumsub.com/sumsub/reference/get-applicant-data-via-externaluserid) method. # Response explained The response is a JSON object representing the applicant profile that you created (or that Sumsub created for you, for example via the [WebSDK](/docs/web-sdk)), enriched with structured data. The presence of certain fields depends on the documents and data submitted for verification, applicable verification rules, and the permissions assigned to the [app token](https://docs.sumsub.com/sumsub/docs/app-tokens) at creation time. Below, you can see the response structure, possible content with descriptions, and examples of response: * [Root variables](#root-variables) * [info](#info-attributes) * [companyInfo](#companyinfo-attributes) * [beneficiaries](#beneficiaries-element-fields) * [beneficiaryinfo ](#beneficiaryinfo-attributes) * [idDocs](#iddocs-element-fields) * [nfcInfo](#nfcinfo-attributes) * [address](#address-attributes-and-addresses-element-fields), [addresses](#address-attributes-and-addresses-element-fields) * [fixedInfo](#fixedinfo-attributes) * [agreement](#agreement-attributes) * [requiredIdDocs](#requirediddocs-attributes) * [docSets](#docsets-element-fields) * [fields](#fields-element-fields) * [customFields](#customfields-element-fields) * [companyBeneficiaryDefinitions](#companybeneficiarydefinitions-element-fields) * [individual](#individual-and-company-attributes), [company](#individual-and-company-attributes) * [companyDocsGroupDefinitions](#companydocsgroupdefinitions-element-fields) * [review](#review-attributes) * [reviewResult](#reviewresult-attributes) * [assessment](#assessment-attributes) * [scores](#scores-element-fields) * [rules](#rules-element-fields) * [questionnaires](#questionnaires-element-fields) * [sections](#sections-element-fields) * [items](#items-element-fields) * [notes](#notes-element-fields) * [memberOf](#memberof-element-fields) * [Response examples](#response-examples) ## Root variables Root variables are the core applicant profile data items. Some of them may include nested attributes and element fields.
Field Type Description
`id` String Unique applicant identifier in the Sumsub system (`applicantId`). 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.
`createdAt` Date Date and time (GMT) when the applicant profile was created in the Sumsub system, in the format: `YYYY-MM-DD HH:MI:SS`.
`clientId` String Unique identifier of you as our client in the Sumsub system. This identifier is assigned to you when you are registered in and get access to the Sumsub system. It usually resembles your name or your company name. `clientId` is automatically added to the applicant profile when it is created.
`inspectionId` String Unique combination of digits and characters to identify all actions with the applicant’s ID documents. Added automatically when the applicant is created.
`externalUserId` String Unique applicant identifier as registered on your side. When [creating an applicant](https://docs.sumsub.com/sumsub/reference/create-applicants), you can generate and add the `externalUserId` manually, or it will be automatically generated and added to the applicant profile by Sumsub. This field supports up to 512 characters.
`sourceKey` String [Source key](/docs/source-keys) that helps you group clients that send applicants.
`structuredMetadata` Object Includes the `readOnlySettings` array, which may contain the `dashboard` value indicating that the applicant is read-only in the Dashboard but remains editable via the API and SDK. If `readOnlySettings` is `null`, the `structuredMetadata` field is not returned.
`info` [Object](#info-attributes) General applicant information recognized from the documents that Sumsub cross-validates with the applicant data provided (`fixedInfo`). Note that `info` and `fixedInfo` objects have the same attributes.
`fixedInfo` [Object](#fixedinfo-attributes) General applicant information that is submitted by the applicant via the [Web](/docs/web-sdk) or [Mobile](/docs/mobile-sdk) SDK or by you via [this API method](/reference/create-applicants). Sumsub should not change this information but use it to cross-validate with the data recognized from the applicant documents. Note that `info` and `fixedInfo` objects have the same attributes.
`email` String Applicant email address. It is mandatory if the email verification is required. If not provided, the applicant cannot receive [verification status emails](/docs/review-results-in-applicant-profile#send-verification-status-email). This field must contain a valid email address in an [RFC 5321/5322](https://en.wikipedia.org/wiki/Email_address) format with TLD verification.
`phone` String Applicant phone number. It is mandatory if the phone verification is required. This field must contain a valid phone number in [ITU-T E.164](https://en.wikipedia.org/wiki/E.164) format.
`applicantPlatform` String The platform from which the applicant registered in the system and/or provided profile data (`API`, `Web`, `Android`, `iOS`).
`ipCountry` String Alpha-3 country code (for example, `DEU`, `GBR`, `ARE`) of the country that owns the IP address from which the applicant got registered and/or submitted the data.
`authCode` String JWT token to sign in a user. For more details, refer to [WebSDK Settings](/docs/websdk-settings).
`agreement` [Object](#agreement-attributes) Contains information about the applicant consent to submitting and processing the personal data.
`requiredIdDocs` [Object](#requirediddocs-attributes) Configuration of steps for the applicant to complete verification. It includes step types (for example, `IDENTITY`, `SELFIE`) and the documents appropriate for each step (for example, `PASSPORT`, `ID_CARD`, `RESIDENCE_PERMIT`), or necessary data fields to be filled in. For example, the `APPLICANT_DATA` step type includes a list of fields the applicant must fill in, so we could proceed with verification.
`deleted` Boolean Indicates whether the [applicant profile has ever been deactivated](https://docs.sumsub.com/sumsub/reference/deactivate-applicant-profile).
  • true — applicant profile is currently deactivated.
  • false — applicant profile was previously deactivated but has since been reactivated.
`review` [Object](#review-attributes) Explains the details of the current applicant verification status and check result.
`lang` String Two-letter code of the language ([ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format, for example, `en`, `fr`, `de`) for the SDK and emails sent to the applicant. The verification results should be displayed to the applicant in this language as well. As a rule, it is detected by the applicant IP address. You can set the language when [initializing the SDK](/docs/set-up-frontend-integration) (MSDK), or via API when [creating an applicant](/reference/create-applicants).
`metadata` Array of objects The metadata field contains additional information in the form of key-value pairs (keys must not be null). This data is not displayed to the end-user. For example: `[{"key": "keyFromClient", "value": "valueFromClient"}]`.
`type` Enum Defines the [applicant type](/docs/applicants). Added automatically when the applicant is created. The following entity types are available:
  • individual — for applicants registered and checked as individuals.
  • company — for applicants registered and checked as legal entities.
`registrationDate` Date Date and time when the applicant was initially registered in your system. Format: `YYYY-MM-DD hh:mm:ss` (for example, `2025-01-15 10:20:35`).
`riskLabels` Object Contains information on the [applicant risk labels](https://docs.sumsub.com/sumsub/docs/applicant-risk-labels).
`assessment` [Object](#assessment-attributes) Includes applicant assessment data, such as the total score, scores based on specific factors, scoring tags, score weights, whether scores are included in the total score, related transactions with dates, and other assessment details.
`questionnaires` [Array of objects](#questionnaires-element-fields) Includes the objects describing [questionnaires](/docs/questionnaire) that the applicant is given to complete during (or after) verification. If the applicant has already filled a questionnaire, you can see the submitted answers in the `value` fields.
`notes` [Array of objects](#notes-element-fields) Includes the objects representing [notes](/docs/review-results-in-applicant-profile#manage-notes) added to the applicant profile by you or by Sumsub operators.
`tags` Array of strings Contains [tags](/docs/review-results-in-applicant-profile#assign-tags) that you have created and then assigned to the applicant.
`memberOf` [Array of objects](#memberof-element-fields) Includes data objects with the applicant companies' IDs the beneficiary of which the applicant is and which are registered in the Sumsub system.
`creationTrackingData` [Object](#creationtrackingdata-attributes) Tracking data captured at applicant creation. Present only when it was submitted in the request or resolved from a behavioral access token.
## `info` attributes The following table explains the `info` object attributes — general applicant information recognized from the documents that Sumsub cross-validates with the applicant data provided ([fixedInfo](#fixedinfo-attributes)). ### Note In some documents, the applicant name may be presented as a single line without a clear separation into first and last name components. In such cases, the system returns the extracted name value in the `firstName` field only. | Field | Type | Description | | :--------------- | :------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `companyInfo` | [Object](#companyinfo-attributes) | The object contains general information about the company, such as the company name, location and country of registration, legal entity type, contacts and other details. | | `firstName` | String | Applicant first name in the original language. There is no length limit for this field. | | `firstNameEn` | String | Automatic transliteration of the applicant first name into Latin characters. There is no length limit for this field. | | `middleName` | String | Applicant middle name in the original language. There is no length limit for this field. | | `middleNameEn` | String | Automatic transliteration of the applicant middle name into Latin characters. There is no length limit for this field. | | `lastName` | String | Applicant last name in the original language. There is no length limit for this field. | | `lastNameEn` | String | Automatic transliteration of the applicant last name into Latin characters. There is no length limit for this field. | | `aliasName` | String | Alternative first/last name. | | `legalName` | String | Legal name of the company the applicant is related to (UBO or shareholder). You can keep this information and use it for your personal navigation.
Note that the `legalName` field is not checked and you might need it just in case.
There is no length limit for this field. | | `gender` | String | Gender of the applicant (`M`, `F`, or `X`). This field is omitted if gender is not specified in the applicant profile. | | `dob` | Date | Applicant date of birth ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format `yyyy-MM-dd`, for example, `2001-09-25`). | | `estimatedAge` | Float | Applicant age estimated by Sumsub from their most recent usable selfie, using facial/liveness analysis. This is a Sumsub-computed value — it cannot be set or changed through the API. Present once the applicant has submitted at least one usable selfie; absent otherwise. | | `placeOfBirth` | String | Applicant place of birth. This can be a city, a town or another settlement type. There is no length limit for this field. | | `placeOfBirthEn` | String | Automatic transliteration of the applicant place of birth. There is no length limit for this field. | | `countryOfBirth` | String | Applicant country of birth. Presented as an [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code (for example, `DEU`, `GBR`, `ARG`). | | `stateOfBirth` | String | State, region, district, county or another territorial entity of birth inside a country, if applicable. | | `country` | String | Country that issued the applicant's document. Presented as an [ISO 3166-1 alpha-](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)3 country code (for example, `DEU`, `GBR`, `ARG`). | | `nationality` | String | Applicant country of origin. Presented as an [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code (for example, `DEU`, `GBR`, `ARG`). | | `addresses` | [Array of objects](#address-attributes-and-addresses-element-fields) | Includes data objects containing the applicant address details extracted from the PoA documents submitted by the applicant. | | `tin` | String | Taxpayer identification number that is unique to each taxpayer.
⚠️This field has a country-specific format. | | `idDocs` | [Array of objects](#iddocs-element-fields) | Includes data objects containing information extracted from the applicant documents, which can be useful in cases where a verification has been completed. | ## `companyInfo` attributes The following table explains the `companyInfo` object attributes representing the company applicant data. ⚠️ This object is only available for company applicants. | Field | Type | Description | | :--------------------- | :--------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `companyName` | String | The name of the company. There is no length limit for this field. | | `registrationNumber` | String | Unique number that is assigned to the company when it was registered as a legal entity. | | `country` | String | [ISO 3166-1 alpha-3 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) of the country where the company is legally registered (for example, `DEU`, `GBR`). | | `alternativeNames` | Array of strings | List of alternative names of the company: a brand name, business trademark, name in a local language, and so on. For example, "Megacorp" instead of "The Megacorp ABC Inc." These names also undergo AML screening. | | `legalAddress` | String | Address a legal entity uses to register with a legal authority. | | `incorporatedOn` | Date | Date of company incorporation ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format `yyyy-MM-dd`, for example, `2001-09-25`). | | `applicantPosition` | String | Applicant position in regards to the company. | | `type` | String | Type of legal entity. For example, private company limited by shares, public limited company, state-owned enterprise, and so on. | | `email` | String | Company email address ([RFC 5321/5322](https://en.wikipedia.org/wiki/Email_address) format). | | `phone` | String | Company phone number ([ITU-T E.164](https://en.wikipedia.org/wiki/E.164) format). | | `taxId` | String | Taxpayer registration number/Code of taxpayer registration.
⚠️This field has a country-specific format. | | `leiCode` | String | Legal Entity Identifier (LEI) code. Refers to the public identifier from the financial entities registry. | | `registrationLocation` | String | City, town, or another location where the company was registered. | | `website` | String | Website URL of the company. | | `postalAddress` | String | Company postal address. | | `address` | [Object](#address-attributes-and-addresses-element-fields) | Represents the company address. | | `companyAddresses` | [Array of objects](#companyaddresses-element-fields) | List of the company structured addresses. | | `controlScheme` | String | Description of the control scheme of the company ownership or group of entities. | | `skippedTypes` | Array of strings | Includes the required values to verify a company applicant without the corresponding entities specified in the company profile.

Available values: `shareholder`, `ubo`, `representative`, `director`, `companyOfficer`, `investor`, `secretary`, `founder`, `legalAdvisor`, `authorizedSignatory`, `trustee`, `trustBeneficiary`, `trustSettlor`, `trustProtector`, `managingPartner`, `equityPartner`, `fundInvestor`, `fundManager`, `investmentManager`, `investmentAdviser`, `fundAdministrator`, `depositary`, `custodian`, `primeBroker`, `accountUser`.

⚠️ Applicable to the `fixedInfo` object only. | | `noDocs` | Boolean | Indicates whether company documents must be uploaded to proceed verification.
  • true — uploading company documents is optional.
  • false (default) — at least one document must be uploaded.
| | `beneficiaries` | [Array of objects](#beneficiaries-element-fields) | Contains `applicantId`s of beneficiaries and additional information such as position and type. | ## `companyAddresses[]` element fields
Field Type Description
`id` String Address identifier. Generated by the service when the address is created.
`addressTypes` Array of strings Address types assigned to this address. Possible values: - `trade` — trade point address. - `legal` — legal registration address. - `postal` — postal or office address.
`main` Boolean Indicates whether this address is the main one within its address type.
`imageId` Integer Identifier of an uploaded proof-of-address image, if one was attached.
`address` [Object](#companyaddresses-address-attributes) Structured company address. See `address` attributes below.
## `companyAddresses[].address` attributes | Field | Type | Description | | :----------------- | :----- | :------------------------------------------------------------------------------------------------------------------------------------- | | `street` | String | Street and building. | | `town` | String | Town or city. | | `postCode` | String | Postal code. | | `stateCode` | String | State code based on the address, in the [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format (for example, `TR-34`, `AD-07`). | | `country` | String | 3-letter ISO 3166-1 alpha-3 country code (for example, `FIN`). | | `formattedAddress` | String | Full address as a single string. | ## `beneficiaries` element fields The following table describes the `beneficiaries` array of objects containing `applicantId`s of beneficiaries and additional information such as their position and type within the company. ⚠️ The `beneficiaries` array is only available for company applicants. | Field | Type | Description | | :---------------- | :------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | String | Beneficiary identifier that is autogenerated for all KYB beneficiaries when they are added to the company structure.
⚠️ Beneficiary identifier is not the equivalent of `applicantId`. | | `applicant` | Object | [Applicant profile data](#root-variables). | | `applicantId` | String | Applicant identifier of the beneficiary in the Sumsub system. | | `beneficiaryInfo` | [Object](#beneficiaryinfo-attributes) | Structure that contains the beneficiary contact data. | | `types` | Array of strings | Beneficiary roles for the new data structure, where a single entity can have multiple roles.

See [Available values for types array](#available-values-for-types-array). | | `shareSize` | Double | Percentage of ownership if the beneficiary is a shareholder of the company. | ## `beneficiaryInfo` attributes The following table explains the `beneficiaryInfo` attributes representing the beneficiary contact data. ⚠️ Available for company applicants only. | Field | Type | Description | | :-------------------- | :----- | :--------------------------------------------------------------------------------------------------------- | | `firstName` | String | First name of the beneficiary. There is no length limit for this field. | | `lastName` | String | Last name of the beneficiary. There is no length limit for this field. | | `dob` | Date | Beneficiary date of birth. | | `email` | String | Beneficiary email address ([RFC 5321/5322](https://en.wikipedia.org/wiki/Email_address)format). | | `taxResidenceCountry` | String | Country where the beneficiary pays taxes. Presented as an alpha-3 code (for example, `DEU`, `GBR`, `ARG`). | | `shareSize` | Double | Percentage of ownership if the beneficiary is a shareholder of the company. | ## Available values for `types` array The following table describes the available types array values, which represent beneficiary roles in the new data structure, where a single entity can have multiple roles. | Value | Role description | | :-------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ubo` | Ultimate beneficial owner of the company. | | `shareholder` | Owns shares in the company stock. | | `representative` | Authorized to act or speak for or in support of the company. | | `director` | Appointed to manage the company business and affairs. | | `companyOfficer` | Holds an executive position within the company (e.g., CEO, CFO, COO).

⚠️ Not verifiable by Sumsub, for your internal use only. | | `investor` | Provides capital to the company without necessarily holding controlling shares.

⚠️ Not verifiable by Sumsub, for your internal use only. | | `secretary` | Responsible for administrative tasks and regulatory compliance of the company. | | `founder` | Established the company or contributed to its initial creation. | | `legalAdvisor` | Professionally provides legal counsel or representation for the company. | | `authorizedSignatory` | Officially authorized to sign documents and contracts on behalf of the company. | | `trustee` | Holds assets in a trust for the benefit of beneficiaries. Should be used exclusively for Trust flows. | | `trustBeneficiary` | Entitled to benefit from assets held in a trust. Should be used exclusively for Trust flows. | | `trustSettlor` | Creates a trust and transfers assets into it. Should be used exclusively for Trust flows. | | `trustProtector` | Appointed to oversee the administration of a trust to safeguard the interests of beneficiaries. Should be used exclusively for Trust flows. | | `managingPartner` | Exercises management or decision-making authority over the partnership (for example, General Partner or Designated Partner). | | `equityPartner` | Holds an interest in the partnership, including rights to its profits, assets, or capital (for example, Limited Partner, Member, or Partner). | | `fundInvestor` | Holds an ownership, investment, economic, or equivalent interest in the fund. | | `fundManager` | Exercises management or decision-making authority over the fund. | | `investmentManager` | Manages the fund's investments or portfolio in accordance with the fund's investment strategy and applicable mandate, with authority to make investment decisions. | | `investmentAdviser` | Provides investment advice or recommendations concerning the fund's investments or portfolio, and may have authority to make investment decisions on the fund's behalf. | | `fundAdministrator` | Performs administrative and operational functions for the fund, including maintaining fund records and supporting accounting, reporting, and investor servicing. | | `depositary` | Oversees the safekeeping and custody of the fund's assets and performs the oversight functions required under the applicable regulatory framework. Company only. | | `custodian` | Provides custody and safekeeping services for the fund's assets. Company only. | | `primeBroker` | Provides brokerage, financing, custody, and related services to the fund, typically in connection with its investment activities. Company only. | | `accountUser` | Is granted access to the account to be opened. | ## `idDocs` element fields The following table explains the data objects representing the details of identity documents provided by the applicant.
Field Type Description
`idDocType` String Type of document that is specified in the level to be provided for verification. For example, `PASSPORT`, `UTILITY_BILL`, `VEHICLE_REGISTRATION_CERTIFICATE`, and so on. See the lists of [supported document types](https://docs.sumsub.com/sumsub/reference/add-verification-documents#supported-document-types) and [supported company document types](https://docs.sumsub.com/sumsub/reference/add-verification-documents#supported-company-document-types) for details.
`ocrDocType` String

Specifies the document subtype as a full type identifier (for example, cyp.rp.type1, nga.nins.type2, and so on). The identifier typically follows this structure:

  1. Alpha-3 country code (deu, gbr, arg, and so on).
  2. Document type, (for example, ID card id, driving license drvlic, residence permit rp, and so on).
  3. Subtype category (for example, type1, type2, type3) – often used to determine different varieties of the document type.

Additional variations may be the following:

  • State-level identifiers for supported countries (for example, usa.drvlic.al.type2, can.drvlic.on.type1).
  • Unique document identifiers when supported (for example, sgp.work.type1, gbr.drvlic.provisional.type1, ind.aadhaar.type1).

If the subtype cannot be determined, the field is returned empty.

⚠️ Note: This field is intended for analytical purposes only. Do not rely on its value for critical business logic, as it may not always be determinable with full accuracy.
`country` String [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) code (for example, `DEU`, `GBR`, `ARG`) of the country where the document was issued.
`firstName` String Applicant first name in the original language as it is in the document. There is no length limit for this field.
`firstNameEn` String Automatic transliteration of the applicant first name into Latin characters. There is no length limit for this field.
`middleName` String Applicant middle name in the original language as it is in the document. There is no length limit for this field.
`middleNameEn` String Automatic transliteration of the applicant middle name into Latin characters. There is no length limit for this field.
`lastName` String Applicant last name in the original language as it is in the document. There is no length limit for this field.
`lastNameEn` String Automatic transliteration of the applicant last name into Latin characters. There is no length limit for this field.
`aliasName` String Alternative first/last name.
`title` String A word or abbreviation placed before a person's name to indicate their profession, social rank, academic degree, or form of address (`Dr`, `Mr`, `Ms`, `Prof`, and so on).
`issuedDate` Date Date when the identity document was issued (format `YYYY-MM-DD`).
`issueAuthority` String Official name of the authority that issued the document.
`issueAuthorityCode` String Code of the Issuing Authority that is in charge of issuing the uploaded document.
`termless` Boolean Indicates whether the document is marked as valid indefinitely (`true`) or not (`false`); see the `validUntil` field for the expiration date. ⚠️ For now, `"validUntil": "2099-01-01"` will be returned for documents marked as indefinite (`"termless": true`). This is a temporary behavior and will be discontinued in the coming months.
`validUntil` Date Date when the document validity expires.
`extendedValidUntil` Date Additional date when the document validity expires, in case the document validity has been extended (format: `YYYY-MM-DD`, for example, `2029-05-20`). ⚠️ Returned only if custom rules are applied to extend `validUntil`, or if country-specific document prolongation rules are in effect.
`dlCategoryBIssuedDate` Date Date when driving-licence category B was issued (format `YYYY-MM-DD`); `null` when not present.
`dlCategoryBValidUntil` Date Date when driving-licence category B expires (format `YYYY-MM-DD`); `null` when not present.
`dlCategoryAmIssuedDate` Date Date when driving-licence category AM was issued (format `YYYY-MM-DD`); `null` when not present.
`entitlementDate` Date Date of entitlement extracted for German driving licences (subtypes `deu.drvlic.type1` and `deu.drvlic.type2`) from the handwritten sticker (field `10`), in `YYYY-MM-DD` format.
`number` String Unique registration number of the document.
`additionalNumber` String Usually, it is a sort of personal number. For example, DNI in Spain, CRP in Brazil, or ARC in Cyprus.
`serialNumber` String ID document serial number (up to 64 characters). For example, the INE identifier on Mexican ID cards.
`visaType` String Visa category, returned only for VISA documents. Auto-extracted where supported and editable by moderators.

One of the following: - `A` — airport transit visa. - `C` — short-stay visa. - `D` — long-stay visa.
`dob` Date Applicant date of birth ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), in the format `yyyy-MM-dd` (for example, `2001-09-25`) as it is specified in the document.
`address` [Object](#address-attributes-and-addresses-element-fields) Includes the applicant address details.
`ethnicity` String Indicates the applicant's ethnic background. Presented as a custom value.
`mrzLine1` String A line of MRZ (machine-readable zone) from the document. Additional lines, such as `mrzLine2` and `mrzLine3`, may also be present if available. The number indicates the line position in sequential order.
`nfcInfo` [Object](#nfcinfo-attributes) Includes the data extracted from the NFC chip of an identity document.
`withNfc` Boolean Indicates whether the document contains NFC data (`true`), or not (`false`).
## `address` attributes and `addresses` element fields The following table explains the `address` attributes and `addresses` element fields containing the applicant address details. [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-0": "`buildingName`", "0-1": "String", "0-2": "Building name.", "1-0": "`flatNumber`", "1-1": "String", "1-2": "Flat or apartment number.", "2-0": "`subStreet`", "2-1": "String", "2-2": "Additional information related to the street. This could be a house number or any other details.", "3-0": "`subStreetEn`", "3-1": "String", "3-2": "Automatic transliteration of the additional information related to the street into Latin characters.", "4-0": "`street`", "4-1": "String", "4-2": "Street name.", "5-0": "`streetEn`", "5-1": "String", "5-2": "Automatic transliteration of the street name into Latin characters.", "6-0": "`state`", "6-1": "String", "6-2": "State, region, district, county or another territorial entity inside a country.", "7-0": "`stateEn`", "7-1": "String", "7-2": "Automatic transliteration of the territorial entity into Latin characters.", "8-0": "`stateCode`", "8-1": "String", "8-2": "Applicant state code based on the address. A list of state codes is based on the [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format (for example, `TR-34`, `AD-07`).", "9-0": "`buildingNumber`", "9-1": "String", "9-2": "Building number.", "10-0": "`town`", "10-1": "String", "10-2": "City, town, or another settlement.", "11-0": "`townEn`", "11-1": "String", "11-2": "Automatic transliteration of the settlement into Latin characters.", "12-0": "`postCode`", "12-1": "String", "12-2": "Address postal code.", "13-0": "`country`", "13-1": "String", "13-2": "[ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code (for example, `DEU`, `GBR`, `ARG`).", "14-0": "`formattedAddress`", "14-1": "String", "14-2": "Address in a human-readable format. For example, `Design Offices, Philipsbornstraße 2, 30165 Hannover, Germany`.", "15-0": "`locationPosition`", "15-1": "[Object](#locationposition-attributes)", "15-2": "Contains the`formattedAddress` field and the `locationCoords` object with the geographical coordinates of the specified address.", "16-0": "`providedLocationPosition`", "16-1": "Object", "16-2": "Contains the `locationCoords` [object](#locationcoords-attributes) with the geographical coordinates of the specified address. \nFor example: \n`\"providedLocationPosition\": { \"locationCoords\": { \"lat\": 30.436224, \"lon\": -97.742058 } }`.", "17-0": "`source`", "17-1": "String", "17-2": "

Indicates the source of the address data.

  • manual — The user manually entered the address (for example, in the applicant data form).
  • gps — The address was derived from GPS coordinates (Geolocation as PoA).
  • externalDb — The address was retrieved from an external database (Non-Doc Verification).
  • proofOfAddress — The address was extracted from a proof of address document (for example, a utility bill or bank statement).
  • proofOfIdentity — The address was extracted from an identity document (for example, a passport, ID card, residence permit, or driver's license).

  • autoComplete — The address was filled using autocomplete.

    ⚠️ This is a rare case, as autoComplete is not currently assigned automatically by the system.

" }, "cols": 3, "rows": 18, "align": [ "left", "left", "left" ] } [/block] ## `locationPosition` attributes | Field | Type | Description | | :----------------- | :----------------------------------- | :--------------------------------------------------------------------------------------------------------------- | | `formattedAddress` | String | Address in a human-readable format. For example, `Design Offices, Philipsbornstraße 2, 30165 Hannover, Germany`. | | `locationCoords` | [Object](#locationcoords-attributes) | Contains the geographical coordinates of the specified address. | ## `locationCoords` attributes | Field | Type | Description | | :---- | :----- | :-------------------------------------------- | | `lat` | Double | Latitude of the position in decimal degrees. | | `lon` | Double | Longitude of the position in decimal degrees. | ## `nfcInfo` attributes The following table explains the `nfcInfo` attributes representing the data extracted from the NFC chip of an identity document. | Field | Type | Description | | :-------- | :------ | :----------------------------------------------------------------------- | | `fullMrz` | String | Contains the full Machine-Readable Zone (MRZ) data from the ID document. | | `imageId` | Integer | Unique identifier of the image that represents the uploaded document. | ## `fixedInfo` attributes The following table explains the `fixedInfo` object attributes — general applicant information that is submitted by the applicant via the [Web](/docs/web-sdk) or [Mobile](/docs/mobile-sdk) SDK or by you via [this API method](/reference/create-applicants). Sumsub should not change this information but use it to cross-validate with the data recognized from the applicant documents ([`info`](https://docs.sumsub.com/sumsub/reference/get-applicant-data#info-attributes)).
Field Type Description
`companyInfo` [Object](#companyinfo-attributes) The object contains general information about the company, such as the company name, location and country of registration, legal entity type, contacts and other details.
`firstName` String Applicant first name in the original language. There is no length limit for this field.
`firstNameEn` String Automatic transliteration of the applicant first name into Latin characters. There is no length limit for this field.
`middleName` String Applicant middle name in the original language. There is no length limit for this field.
`middleNameEn` String Automatic transliteration of the applicant middle name into Latin characters. There is no length limit for this field.
`lastName` String Applicant last name in the original language. There is no length limit for this field.
`lastNameEn` String Automatic transliteration of the applicant last name into Latin characters. There is no length limit for this field.
`aliasName` String Alternative first/last name.
`parentName1` String Applicant's parent name in the original language. There is no length limit for this field.
`parentName2` String Applicant's parent name in the original language. There is no length limit for this field.
`legalName` String Legal name of the company the applicant is related to (UBO or shareholder). You can keep this information and use it for your personal navigation. Note that the `legalName` field is not checked and you might need it just in case. There is no length limit for this field.
`gender` String Gender of the applicant (`M`, `F`, or `X`). This field is omitted if gender is not specified in the applicant profile.
`dob` Date Applicant date of birth ([ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format `yyyy-MM-dd`, for example, `2001-09-25`).
`placeOfBirth` String Applicant place of birth. This can be a city, a town or another settlement type. There is no length limit for this field.
`placeOfBirthEn` String Automatic transliteration of the applicant place of birth. There is no length limit for this field.
`countryOfBirth` String Applicant country of birth. Presented as an [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code (for example, `DEU`, `GBR`, `ARG`).
`stateOfBirth` String State, region, district, county or another territorial entity of birth inside a country, if applicable.
`country` String Applicant country as provided by you or by the applicant. Presented as an [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code (for example, `DEU`, `GBR`, `ARG`). It may differ from the country of birth.
`nationality` String Applicant country of origin. Presented as an [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code (for example, `DEU`, `GBR`, `ARG`).
`addresses` [Array of objects](#address-attributes-and-addresses-element-fields) Includes data objects containing the applicant address details provided by the applicant.
`tin` String Taxpayer identification number that is unique to each taxpayer. Required if the company tax check is enabled for the applicant's country.
`taxResidenceCountry` String Country where the applicant pays taxes. Presented as an [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) code (for example, `DEU`, `GBR`, `ARG`).
`tins` [Array of objects](#tins-element-fields) List of the applicant taxpayer identification numbers, present when the applicant has more than one TIN. Each entry carries its own country (see sub-table). The single `tin` / `taxResidenceCountry` pair mirrors the first entry (`tins[0]`).

⚠️ This option is currently available only upon request to our support team or your CSM.
# `tins` element fields List of the applicant's taxpayer identification numbers, present when the applicant has more than one TIN. ⚠️ This option is currently available only upon request to our support team or your CSM. | Field | Type | Description | | :-------- | :----- | :---------------------------------------------------------------------------------------------------------------------------------------------------- | | `tin` | string | Taxpayer identification number. | | `country` | string | Country where this TIN applies, as an [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) code (for example, `DEU`, `GBR`, `ARG`). | ## `agreement` attributes > 🚧 Attention > > A new data format for the `agreement` object has been introduced (see the [following response examples](https://docs.sumsub.com/sumsub/reference/add-applicant-consent#response-examples) for details). The old format will be deprecated and no longer be supported starting June 10, 2025. > > Update your integration accordingly to ensure continued compatibility. The following table explains the details of the applicant consent to the submitting and processing of personal data. Mind that the new `agreement` object includes an `items` array, where each object represents an individual consent event and may contain multiple agreements. Objects in the `items` array are sorted chronologically, from oldest to newest. Since an applicant can accept the same agreement multiple times, such instances are grouped within the same item. **Grouping logic:** * If you send different sets of agreements in separate requests, each set will be returned as a separate item in the response. * If you send the same set of agreements more than once, a new item will not be created. Instead, the response will include the original item with the earliest `acceptedAt` timestamp. | Field | Type | Description | | :----------- | :--------------- | :----------------------------------------------------------------------------------------------------------------- | | `id` | String | Consent identifier. | | `createdAt` | Date | Date and time (GMT) when consent for the submission and processing of personal data was given to the applicant. | | `acceptedAt` | Date | Date and time (GMT) when the applicant confirmed their consent for the submission and processing of personal data. | | `source` | String | Specifies the source from which the applicant confirmed the agreement (`WebSDK`, `MSDK`, `API`). | | `type` | String | Indicates the way the agreement was obtained (for example, during onboarding, via reusable KYC, and so on). | | `recordIds` | Array of strings | Each `recordId` corresponds to an individual accepted agreement text. | ## `requiredIdDocs` attributes The `requiredIdDocs` object represents the configuration of steps for the applicant to complete verification. It includes a set of required documents and data to provide. [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-0": "`videoIdent`", "0-1": "Boolean", "0-2": "Specifies if the video identification is required (`true`) or not required (`false`) to pass verification.", "1-0": "`videoIdentSettings`", "1-1": "Object", "1-2": "

Contains the resetAllStepsOnEachAttempt boolean field that indicates whether each new video identification resubmission must start from the beginning with all required steps defined for the verification level, regardless of which steps were previously completed successfully.

  • If enabled (true) — the applicant must repeat all verification steps on every new attempt from the beginning.
  • If disabled (false) — only incomplete or failed steps must be repeated.

⚠️ This field is available only if the setting is configured for the level.

", "2-0": "`videoIdentUploadTypes`", "2-1": "Array of strings", "2-2": "Lists the document types that can be uploaded during a video interview, if such documents are specified in the level settings. \n \nThe field is available if the video identification is required on the level.", "3-0": "`stepsOutsideVideoId`", "3-1": "Array of strings", "3-2": "Lists the verification steps that can be passed outside the video identification. \n \nThe field is available if the video identification is required on the level.", "4-0": "`includedCountries`", "4-1": "Array of strings", "4-2": "Countries (in ISO 3166-1 alpha-3 country code, for example, `DEU`, `GBR`, `ARG`) that are included in the list of supported.", "5-0": "`excludedCountries`", "5-1": "Array of strings", "5-2": "Countries (in ISO 3166-1 alpha-3 country code, for example, `DEU`, `GBR`, `ARG`) that are excluded from the list of supported.", "6-0": "`docSets`", "6-1": "[Array of objects](#docsets-element-fields)", "6-2": "Includes the objects representing specific document sets and their attributes.", "7-0": "`kybSettings`", "7-1": "[Object](#kybsettings-attributes)", "7-2": "

Available for company applicants.

Includes the settings that are used to identify the types of company beneficiaries, to enable/disable company search in selected registry databases and automatic verification of the company's ownership and control structure.

" }, "cols": 3, "rows": 8, "align": [ "left", "left", "left" ] } [/block] ## `docSets` element fields The following table explains the element fields of the `docSets` array representing specific document sets and their attributes. [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-0": "`idDocSetType`", "0-1": "String", "0-2": "A human-readable [identifier of the document set type](https://docs.sumsub.com/sumsub/reference/iddocsettypes) (for example, `IDENTITY`, `SELFIE`, `PROOF_OF_RESIDENCE`).", "1-0": "`types`", "1-1": "Array of strings", "1-2": "Includes the [types of documents](https://docs.sumsub.com/sumsub/reference/add-verification-documents#supported-document-types) that are required for a particular `idDocSetType` to pass verification.", "2-0": "`subTypes`", "2-1": "Array of strings", "2-2": "List of [document subtypes](https://docs.sumsub.com/sumsub/reference/add-verification-documents#supported-iddocsubtypes-for-company_doc) required for verification (applicable only to company documents).", "3-0": "`videoRequired`", "3-1": "String", "3-2": "Method of passing the document upload step that can be set up when [configuring a verification level](/docs/get-started-with-verification-level#configure-required-steps).
  • disabled — selfie with a document.
  • enabled — video selfie with a phrase.
  • photoRequired — web camera photo (still face image).
  • passiveLiveness — liveness check.
  • docapture — enables the camera for the steps with ID documents, so applicants can take pictures of their documents in real time.
", "4-0": "`captureMode`", "4-1": "String", "4-2": "

Applicable only when videoRequired=docapture.

  • manualAndAuto — allows both to automatically capture the photo of a document when the camera is initialized, and for the applicant to hit a button to take a photo.
  • manualOnly — allows only manually hitting a button to take a photo.
  • seamless — Seamless ID Capture mode for QES.
", "5-0": "`uploaderMode`", "5-1": "String", "5-2": "

Applicable only when videoRequired=docapture.

  • always — always allows uploading a ready-made photo instead of using a camera.
  • never — does not allow uploading a ready-made photo.
  • fallback — allows uploading a ready-made photo only if a camera is not available.
", "6-0": "`fields`", "6-1": "[Array of objects](#fields-element-fields)", "6-2": "Contains objects that define the document data fields to be populated with personal information for verifying the applicant during the **Applicant data** verification step.", "7-0": "`customFields`", "7-1": "[Array of objects](#customfields-element-fields)", "7-2": "Contains objects that describe custom fields if they are created for the **Applicant data** verification step.", "8-0": "`questionnaireDefId`", "8-1": "String", "8-2": "Identifier of the questionnaire that is added to the verification level and is to be or has already been filled by the applicant.", "9-0": "`questionnaireProcessingSettings`", "9-1": "Object", "9-2": "Contains configuration parameters for the `QUESTIONNAIRE` step that modify how previously submitted questionnaire answers are handled.", "10-0": "`skipIfFilled`", "10-1": "Boolean", "10-2": "Defines whether the `QUESTIONNAIRE` step should be automatically accepted (`true`) or not (`false`) if the applicant has previously completed the same questionnaire.", "11-0": "`poaStepSettingsId`", "11-1": "String", "11-2": "Identifier of the selected [Proof of Address preset](https://docs.sumsub.com/sumsub/docs/customize-supported-address-documents#create-poa-preset).", "12-0": "`companyBeneficiaryDefinitions`", "12-1": "[Array of objects](#companybeneficiarydefinitions-element-fields)", "12-2": "Specification of level steps to be fulfilled. Stands for **Associated parties**. \n \nAvailable for company applicants.", "13-0": "`companyDocsGroupDefinitions`", "13-1": "[Array of objects](#companydocsgroupdefinitions-element-fields)", "13-2": "Definitions of the required document groups for verification. \n \nAvailable for company applicants.", "14-0": "`captureParams`", "14-1": "Object", "14-2": "

Describes the capture method and related settings for this step.

Contains the inputType enum attribute, which defines how data is captured. Possible values:

  • fileUpload — upload a file.
  • cameraStream — capture a web camera photo or a short video fragment.
  • liveness — perform an advanced liveness check.
  • docapture — perform live document capture.

If inputType=cameraStream, the cameraStream.contentType field is returned:

  • image — for web camera photo
  • video — for short video fragment.

If inputType=docapture, the docapture.captureMode and docapture.uploaderMode fields are returned.

", "15-0": "`ekycAllowed`", "15-1": "Boolean", "15-2": "Indicates if [Non-Doc Verification](https://docs.sumsub.com/sumsub/docs/no-document-verification) for the step is allowed (`true`) or not (`false`).", "16-0": "`checkSourceSettings`", "16-1": "Object", "16-2": "Describes the configuration of the [Database Validation](https://docs.sumsub.com/sumsub/docs/database-validation) setting for the verification level.", "17-0": "`esignSettings`", "17-1": "Object", "17-2": "Contains configuration for the [E-sign verification step](https://docs.sumsub.com/sumsub/docs/qualified-electronic-signature-qes-verification), including objects that define the document to be signed (ID and name) and signature settings.", "18-0": "`restrictCountries`", "18-1": "Boolean", "18-2": "Returns `true` if the verification step [restricts applicants from specific countries](https://docs.sumsub.com/sumsub/docs/configure-verification-levels#location-settings). Otherwise the field is not returned.", "19-0": "`skipAllowed`", "19-1": "Boolean", "19-2": "Indicates whether this verification step can be skipped (`true`) or not (`false`). \n \nAvailable only for steps that support the skip option.", "20-0": "`nfcVerificationSettings`", "20-1": "Object", "20-2": "

Contains the mode parameter that defines NFC-based ID verification behavior. Possible values:\n

  • disabled — NFC chip reading is not requested from applicants.
  • optional — if the document contains an NFC chip, the system requests a chip reading. Applicants may complete or skip this step. If skipped or if scanning fails, verification continues using the standard document-based flow.
  • required — if the document contains an NFC chip, the system requires a successful chip reading. Skipping or fallback to document-based verification is not allowed.
", "21-0": "`phoneVerificationSettings`", "21-1": "Object", "21-2": "

Contains the immutablePhoneIfPresent boolean field, which controls whether applicants can edit their pre-filled phone number.

  • true — editing is disabled.
  • false — editing is allowed.
  • not returned — editing is allowed, or the setting is not supported for the verification step.
", "22-0": "`emailVerificationSettings`", "22-1": "Object", "22-2": "

Contains the immutableEmailIfPresent boolean field, which controls whether applicants can edit their pre-filled email address.

  • true — editing is disabled.
  • false — editing is allowed.
  • not returned — editing is allowed, or the setting is not supported for the verification step.
", "23-0": "`selfieProcessingSettings`", "23-1": "Object", "23-2": "

Contains the skipLivenessCheck boolean field, which indicates whether the Skip liveness check setting is enabled.

  • true — enabled.
  • false — disabled.
  • not returned — disabled, or the setting is not supported for the verification step.
", "24-0": "`applicantDataSettings`", "24-1": "Object", "24-2": "

Contains the prefill boolean field, which indicates whether the applicant data form is prefilled in the SDK step.

  • true — pre-fill is enabled.
  • false — pre-fill is disabled.
  • not returned — pre-fill is disabled, or the setting is not supported for the verification step.
" }, "cols": 3, "rows": 25, "align": [ "left", "left", "left" ] } [/block] ## `fields` element fields The following table explains the `fields` element fields. | Field | Type | Description | | :------------------- | :------ | :---------------------------------------------------------------------------------------------------------------- | | `name` | String | Field name (for example, `firstName`, `lastName`, `email`). | | `required` | Boolean | `true` if the field is required for verification, `false` if not (still, it can be optionally filled in the SDK). | | `prefill` | Boolean | `true` if the field is pre-populated in the SDK, `false` if not. | | `immutableIfPresent` | Boolean | `true` if the field is locked and cannot be edited by the applicant; `false` otherwise. | ## `customFields` element fields The following table explains the `customFields` element fields. | Field | Type | Description | | :------------ | :------ | :------------------------------------------------------------------------------------------------------------------------ | | `name` | String | System name of the custom field. | | `displayName` | String | Name of the field as it is shown to the applicant. | | `required` | Boolean | Returns `true` if the field is required for verification, `false` if not (still, it can be optionally filled in the SDK). | ## `companyBeneficiaryDefinitions` element fields The following table explains the `companyBeneficiaryDefinitions` element fields. | Field | Type | Description | | :----------- | :------------------------------------------- | :----------------------------------------------------------------------- | | `category` | String | Beneficiary role name (`ubos`, `shareholders`, `directors`). | | `canSkip` | Boolean | Indicates if it is skippable via SDK: `true` — yes, `false` — no. | | `individual` | [Object](#individual-and-company-attributes) | Contains information on the associated party as an individual applicant. | | `company` | [Object](#individual-and-company-attributes) | Contains information on the associated party as a company applicant. | ## `individual` and `company` attributes the following table explains the `individual` and `company` attributes. | Field | Type | Description | | :------------- | :----------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------ | | `enabled` | Boolean | Nested KYC (for individuals) or KYB (for companies) verification enabled for this role: `true` — yes, `false` — no. | | `levelName` | String | Name of the verification level. There is no length limit for this field. | | `fields` | [Array of objects](#fields-element-fields) | Includes the objects describing the data fields that should be filled with personal information to verify the applicant. | | `customFields` | [Array of objects](#customfields-element-fields) | Includes the objects each of those represents an additional custom field (`applicantIdDocSetCustomField`) that should be filled for verification. | ## `companyDocsGroupDefinitions` element fields The following table explains the `companyDocsGroupDefinitions` element fields. | Field | Type | Description | | :--------- | :--------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `label` | String | Label of the document group. Available labels: `legalPresence`, `companyDetails`, `ownershipStructure`, `controlStructure`, `representativesAuthorization`, `other1`, `other2`, `other3`. | | `subTypes` | Array of strings | List of [document types](https://docs.sumsub.com/sumsub/reference/add-verification-documents#supported-iddocsubtypes-for-company_doc) included into the verification group. | | `required` | Boolean | Indicates if this is required (`true`) or optional (`false`). | ## `kybSettings` attributes The following table explains the `kybSettings` attributes. [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-0": "`shareholderThreshold`", "0-1": "Integer", "0-2": "Ownership percentage threshold used to classify an individual beneficiary as a shareholder. \n \nIf `shareholderThreshold` is less and `uboThreshold` is greater than the ownership percentage, then the individual is a shareholder. \n \nCompanies are always classified as shareholders.", "1-0": "`uboThreshold`", "1-1": "Integer", "1-2": "Ownership percentage threshold used to classify an individual beneficiary as a UBO (Ultimate Beneficial Owner). \n \nIf the ownership percentage is greater than or equal to `uboThreshold`, then the individual is a UBO. \n \nCompanies are always classified as shareholders.", "2-0": "`disableCompanySearchAndPrefill`", "2-1": "Boolean", "2-2": "Indicates whether company search in selected corporate registry databases for pre-filling company and associated parties’ data is disabled (`true`) or enabled (`false`).", "3-0": "`enableBeneficiariesAutoCheck`", "3-1": "Boolean", "3-2": "

Indicates whether automatic verification of the company’s ownership and control structure against selected corporate registries is enabled.

  • When enabled (true), the system compares the applicant-provided ownership and management information (for example, shareholders and directors) with official registry data and flags discrepancies.
  • When disabled (false), this verification is not performed.
" }, "cols": 3, "rows": 4, "align": [ "left", "left", "left" ] } [/block] ## `review` attributes The following table explains the `review` object attributes that represent the details of the current applicant verification status and check result. [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-0": "`reviewId`", "0-1": "String", "0-2": "Unique identifier of the applicant profile review in the Sumsub system.", "1-0": "`levelName`", "1-1": "String", "1-2": "Name of the [verification level](/docs/verification-levels) the applicant has to go through. There is no length limit for this field.", "2-0": "`attemptId`", "2-1": "String", "2-2": "Unique identifier of the current verification attempt. \n \nApplicants may initiate several attempts to get verified if, for example, they failed once or changed/added the documents, or you could change the verification level to start another check.", "3-0": "`attemptCnt`", "3-1": "Integer", "3-2": "Counting number of the current verification attempt on the same verification level.", "4-0": "`elapsedSincePendingMs`", "4-1": "Long", "4-2": "Elapsed time since the applicant verification passed to the `pending` status.", "5-0": "`createDate`", "5-1": "Date", "5-2": "Date and time (UTC) when the applicant profile was created in the Sumsub system.", "6-0": "`reviewDate`", "6-1": "Date", "6-2": "Date and time (UTC) when the current applicant check was completed.", "7-0": "`reviewResult`", "7-1": "[Object](#reviewresult-attributes)", "7-2": "Contains extra details of the applicant verification result.", "8-0": "`reviewStatus`", "8-1": "String", "8-2": "Indicates the applicant [review status](/reference/get-applicant-review-status#possible-review-statuses)." }, "cols": 3, "rows": 9, "align": [ "left", "left", "left" ] } [/block] ## `reviewResult` attributes The following table explains the `reviewResult` attributes representing the applicant verification result details. [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-0": "`reviewAnswer`", "0-1": "String", "0-2": "Explains the review result.
  • GREEN — the applicant is approved.
  • RED — the applicant is declined.
", "1-0": "`rejectLabels`", "1-1": "Array of strings", "1-2": "Includes one or more reasons for rejection. The field is available if `reviewAnswer` returns `RED`. \n \nFor more information, see [Resubmission requested](https://docs.sumsub.com/sumsub/reference/resubmission-requested) and [Rejected](https://docs.sumsub.com/sumsub/reference/rejected) .", "2-0": "`reviewRejectType`", "2-1": "String", "2-2": "Indicates the type of rejection.
  • FINAL — Rejected status in case of major violations. For example, an attempt of fraud was detected during identification, the applicant is found in the list of persons under sanctions, and so on. The applicant in this status will not be able to resubmit the documents for verification.
  • RETRY — Resubmission requested status in case of minor violations. For example, a name or address mismatch, incorrect TIN was provided, and so on. The applicant is sent a resubmission request. Thus the applicant has a chance to upload new documents or resubmit correct data.
\nFor more information, see [Resubmission requested](https://docs.sumsub.com/sumsub/reference/resubmission-requested) and [Rejected](https://docs.sumsub.com/sumsub/reference/rejected) .", "3-0": "`clientComment`", "3-1": "String", "3-2": "Human-readable comment that explains the reasons for rejection in detail, and that must not be shown to the applicant.", "4-0": "`moderationComment`", "4-1": "String", "4-2": "Human-readable comment that explains the reasons for rejection in detail, and that can be shown to the applicant.", "5-0": "`buttonIds`", "5-1": "Array of strings", "5-2": "Button identifiers that have been used for applicant rejection. \n \nA specific `buttonId` is automatically assigned to each rejection type. For more information, see [Resubmission requested](https://docs.sumsub.com/sumsub/reference/resubmission-requested) and [Rejected](https://docs.sumsub.com/sumsub/reference/rejected) ." }, "cols": 3, "rows": 6, "align": [ "left", "left", "left" ] } [/block] ## `assessment` attributes The following table explains the `assessment` attributes. | Field | Type | Description | | ------------ | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | | `totalScore` | Float | Final aggregated assessment score calculated from all scores included in the total score. | | `scores` | [Array of objects](#scores-element-fields) | Each object represents an individual assessment score based on a specific factor contributing to the overall evaluation. | ## `scores` element fields The following table explains the `scores` element fields. | Field | Type | Description | | --------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | | `id` | String | Unique identifier of the score entry. | | `tag` | String | Tag associated with the score, indicating the factor it relates to. | | `createdAt` | Date | Date and time when the score was generated, in the format `YYYY-MM-DD hh:mm:ss+0000` (for example, `2025-12-12 13:04:59+0000`). | | `score` | Float | Raw score value produced by the evaluation logic. | | `scoreWeight` | Float | Weight applied to the score when calculating the total score. | | `includeInTotalScore` | Boolean | Indicates whether this score is included in the `totalScore` calculation (`true`), or not (`false`). | | `txnId` | String | Unique identifier of the transaction in the Sumsub system related to this score, if applicable. | | `rules` | [Array of objects](#rules-element-fields) | List of rules that contributed to this score. | ## `rules` element fields The following table explains the `rules` element fields. | Field | Type | Description | | ---------- | ---------------- | --------------------------------------------------------------- | | `id` | String | Unique identifier of the rule. | | `name` | String | System name of the rule. | | `title` | String | Human-readable title of the rule. | | `revision` | Integer | Revision number of the rule definition. | | `tags` | Array of strings | Tags associated with the rule for categorization and filtering. | ## `questionnaires` element fields The following table includes the data objects explaining the [questionnaires](/docs/questionnaire) that the applicant is given to complete during (or after) verification. If the applicant has already filled in a questionnaire, in the `value` fields, you can see the answers provided and the score assigned to them. [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "0-0": "`id`", "0-1": "String", "0-2": "Unique identifier of the questionnaire. You give this ID to the questionnaire when [creating it](/docs/questionnaire-get-started#create-questionnaire).", "1-0": "`sections`", "1-1": "[Object](#sections-element-fields)", "1-2": "Includes the objects each of those is a separate [group of questions](/docs/questionnaire-get-started#add-questionnaire-section) added to the questionnaire. \n \nA section object has an ID representing the section given when the questionnaire was created. Each section consists of items (single questions), and has its own score based on the score of the items included.", "2-0": "`score`", "2-1": "Double", "2-2": "When setting up a questionnaire, you have the [option to set up the risk scoring](/docs/questionnaire-get-started#options). It means that you can add a value to each possible answer. When the applicant selects this answer, the assigned value is added to the score. You can set up the score for the following question types: `dropdown`, `checkboxes`, `multiple choice`, `country (countrySelect or countryMultiSelect)`. \n \nThe section score depends on the score values given to the items it contains. Upon completion of the questionnaire, the system sums up the section score values which results in the entire questionnaire score." }, "cols": 3, "rows": 3, "align": [ "left", "left", "left" ] } [/block] > 📘 Note > > Each questionnaire `ID` attribute should be unique. If you intend to change the questionnaire structure, IDs should not be reused. ## `sections` element fields The following table describes the `sections` attributes. | Name | Type | Description | | ----------- | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | String | Unique section identifier. | | `condition` | String | Condition that makes a section visible, depending on the `value` of the specified `sectionId.itemId={options.value}`. | | `score` | Double | Score that is an estimation of the sum of all scores in one section. | | `items` | [Object](#items-element-fields) | Includes the objects each of those stands for a [single question](https://docs.sumsub.com/sumsub/docs/questionnaire-get-started#add-question) added to the questionnaire, and has an ID—item identifier—representing this question. | ## `items` element fields The `items` object contains internal objects each of those stands for a single question added to the questionnaire, and has the attributes described in the table below. [block:parameters] { "data": { "h-0": "Field", "h-1": "Type", "h-2": "Description", "h-3": "Supported values", "0-0": "`id`", "0-1": "String", "0-2": "Unique item identification number.", "0-3": "Any unique item identifier.", "1-0": "`condition`", "1-1": "String", "1-2": "Condition that makes the item show up.", "1-3": "`sectionId.itemId={options.value}` ( Example: `1-Section.1-2=someValue` )", "2-0": "`value`", "2-1": "String", "2-2": "Contains the value that represents an answer to a question.", "2-3": "Any string value.", "3-0": "`values`", "3-1": "Array of strings", "3-2": "Contains the values that represent multiple answers to a question (for example, for checkboxes).", "3-3": "Any string values.", "4-0": "`score`", "4-1": "Double", "4-2": "Score that is an estimation of the sum of all answers in one question.", "4-3": "`Double` value.", "5-0": "`dataScores`", "5-1": "Array of objects", "5-2": "Compartmentalized information about risk scoring for each answer (for example, a question may have multiple answers to choose from in the checkboxes).", "5-3": "Each object includes the following:
  • value — represents the given answer.
  • score — represents the estimation of the answer.
" }, "cols": 4, "rows": 6, "align": [ "left", "left", "left", "left" ] } [/block] ## `notes` element fields The following table explains the data objects representing the [notes](/docs/review-results-in-applicant-profile#manage-notes) added to the applicant profile by you or Sumsub operators. | Field | Type | Description | | :-------------- | :----- | :------------------------------------------------------------------- | | `note` | String | Contains the text of the note added. | | `moderatorName` | String | Identifier of the one who created the note in the applicant profile. | | `createdAt` | Date | Date and time (GMT) when the note was created. | ## `memberOf` element fields The following table explains the element fields in the `memberOf` array which contains the objects representing the companies the beneficiary of which is this applicant, and which are registered in the Sumsub system. | Field | Type | Description | | :------------ | :----- | :-------------------------------------------------------------------------------- | | `applicantId` | String | Unique identifier of the company registered as an applicant in the Sumsub system. | | `fullName` | String | Full name of the company applicant. | ## `creationTrackingData` attributes Tracking data captured at applicant creation. Present only when it was submitted in the request or resolved from a behavioral access token. | Field | Type | Description | | --------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ip` | String | Applicant's IP address. Used for Advanced IP Check. | | `byokDeviceRequestId` | String | The `requestId` of a device fingerprint event that you have already collected via your own Fingerprint Pro integration, outside of Sumsub's WebSDK/MobileSDK. When provided, Sumsub retrieves this event from your Fingerprint Pro account and links it to the applicant instead of waiting for an SDK-based device check. Requires a BYOK Fingerprint Pro integration configured for your account. | ## Response examples If the request is successfully sent and processed, you will get a response like one of those below. ```json For individual applicants { "id": "5b594ade0a975a36c9349e66", "createdAt": "2020-06-24 05:05:14", "clientId": "your_cool_id", "inspectionId": "5b594ade0a975a36c9379e67", "externalUserId": "SomeExternalUserId", "info": { "firstName": "DANIEL", "firstNameEn": "DANIEL", "lastName": "BROOKS", "lastNameEn": "BROOKS", "aliasName": "DAN BROOKS", "dob": "1989-07-16", "country": "DEU", "idDocs": [ { "idDocType": "ID_CARD", "country": "DEU", "firstName": "DANIEL", "firstNameEn": "DANIEL", "lastName": "BROOKS", "lastNameEn": "BROOKS", "aliasName": "DAN BROOKS", "validUntil": "2028-09-04", "number": "LGXX359T8", "dob": "1989-07-16", "mrzLine1": "IDD<IHJ/lihfr/xfmQ2ZjFkYmQ1NjE3MWY4YTk2NiJ9._eRh4qLCRxJA6lk6hKJrt-H67X9fmggdFEMpxaAmn_Y", "agreement": { "createdAt": "2025-01-27 10:41:29", "acceptedAt": "2025-01-27 10:41:29", "source": "WebSDK" }, "requiredIdDocs": { "docSets": [ { "idDocSetType": "COMPANY_DATA", "fields": [ { "name": "companyName", "required": true }, { "name": "country", "required": true }, { "name": "registrationNumber", "required": false }, { "name": "incorporatedOn", "required": false }, { "name": "website", "required": false }, { "name": "legalAddress", "required": false }, { "name": "state", "required": false } ] }, { "idDocSetType": "COMPANY_BENEFICIARIES", "companyBeneficiaryDefinitions": [ { "category": "ubos", "canSkip": true, "individual": { "enabled": true, "levelName": "basic-kyc-level", "fields": [ { "name": "firstName", "required": true }, { "name": "lastName", "required": true }, { "name": "middleName", "required": false }, { "name": "dob", "required": false }, { "name": "taxResidenceCountry", "required": true }, { "name": "shareSize", "required": true } ], "customFields": null } }, { "category": "shareholders", "canSkip": true, "individual": { "enabled": true, "levelName": "basic-kyc-level", "fields": [ { "name": "firstName", "required": true }, { "name": "lastName", "required": true }, { "name": "middleName", "required": false }, { "name": "dob", "required": false }, { "name": "taxResidenceCountry", "required": false }, { "name": "shareSize", "required": true } ], "customFields": null }, "company": { "enabled": true, "levelName": "Auto KYB demo", "fields": [ { "name": "companyName", "required": true }, { "name": "country", "required": true }, { "name": "registrationNumber", "required": false } ], "customFields": null } }, { "category": "directors", "individual": { "enabled": true, "levelName": "basic-kyc-level", "fields": [ { "name": "firstName", "required": true }, { "name": "lastName", "required": true }, { "name": "middleName", "required": false }, { "name": "dob", "required": false }, { "name": "email", "required": true }, { "name": "phone", "required": false } ], "customFields": null }, "company": { "enabled": false, "levelName": "Auto KYB demo", "fields": [ { "name": "companyName", "required": true }, { "name": "country", "required": true }, { "name": "registrationNumber", "required": true } ], "customFields": null } } ] }, { "idDocSetType": "COMPANY_DOCUMENTS", "companyDocsGroupDefinitions": [ { "label": "legalPresence", "subTypes": [ "INCORPORATION_CERT", "INCORPORATION_ARTICLES", "STATE_REGISTRY" ], "required": true }, { "label": "companyDetails", "subTypes": [ "INFORMATION_STATEMENT", "PROOF_OF_ADDRESS", "STATE_REGISTRY", "INCORPORATION_ARTICLES", "INCORPORATION_CERT", "INCUMBENCY_CERT", "GOOD_STANDING_CERT" ], "required": true } ] } ], "kybSettings": { "shareholderThreshold": 5, "uboThreshold": 25 } }, "review": { "reviewId": "bUKIB", "attemptId": "OKxAF", "attemptCnt": 1, "elapsedSincePendingMs": 219, "levelName": "Auto KYB demo", "createDate": "2025-01-27 10:44:39+0000", "reviewDate": "2025-01-27 10:44:39+0000", "reviewResult": { "reviewAnswer": "GREEN" }, "reviewStatus": "completed" }, "lang": "en", "type": "company", "riskLabels": { "attemptId": "SLfbz", "createdAt": "2025-01-27 10:44:39", "device": [ "vpnUsage" ], "crossCheck": [ "manyAccountDuplicates" ] } } ``` If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example: ```json { "code": 400, "correlationId": "345fd9bcc7d3a7670c5a6b25fcd7d0dd", "description": "Invalid parameters provided" } ``` # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "sumsub-api", "version": "1.0" }, "servers": [ { "url": "https://api.sumsub.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "name": "X-App-Token", "in": "header", "x-default": "" } } }, "security": [ { "sec0": [] } ], "paths": { "/resources/applicants/{applicantId}/one": { "get": { "summary": "Get applicant data", "description": "", "operationId": "get-applicant-data", "parameters": [ { "name": "applicantId", "in": "path", "description": "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 is created on the Sumsub side, and can be found in the [Dashboard](https://cockpit.sumsub.com/checkus/#/applicants/individual?limit=10&page=0).

If the `applicantId` is unknown to you, use the [Get applicant data (externalUserId)](https://docs.sumsub.com/sumsub/reference/get-applicant-data-via-externaluserid) method to fetch it.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Individual applicants": { "value": "{\n \"id\": \"5b594ade0a975a36c9349e66\",\n \"createdAt\": \"2020-06-24 05:05:14\",\n \"clientId\": \"ClientName\",\n \"inspectionId\": \"5b594ade0a975a36c9379e67\",\n \"externalUserId\": \"SomeExternalUserId\",\n \"fixedInfo\": {\n \"firstName\": \"Chris\",\n \"lastName\": \"Smith\"\n },\n \"info\": {\n \"firstName\": \"CHRISTIAN\",\n \"firstNameEn\": \"CHRISTIAN\",\n \"lastName\": \"SMITH\",\n \"lastNameEn\": \"SMITH\",\n \"dob\": \"1989-07-16\",\n \"country\": \"DEU\",\n \"idDocs\": [\n {\n \"idDocType\": \"ID_CARD\",\n \"country\": \"DEU\",\n \"firstName\": \"CHRISTIAN\",\n \"firstNameEn\": \"CHRISTIAN\",\n \"lastName\": \"SMITH\",\n \"lastNameEn\": \"SMITH\",\n \"validUntil\": \"2028-09-04\",\n \"number\": \"LGXX359T8\",\n \"dob\": \"1989-07-16\",\n \"mrzLine1\": \"IDD<IHJ/lihfr/xfmQ2ZjFkYmQ1NjE3MWY4YTk2NiJ9._eRh4qLCRxJA6lk6hKJrt-H67X9fmggdFEMpxaAmn_Y\",\n \"agreement\" : {\n \"createdAt\" : \"2025-01-27 10:41:29\",\n \"acceptedAt\" : \"2025-01-27 10:41:29\",\n \"source\" : \"WebSDK\"\n },\n \"requiredIdDocs\" : {\n \"docSets\" : [ {\n \"idDocSetType\" : \"COMPANY_DATA\",\n \"fields\" : [ {\n \"name\" : \"companyName\",\n \"required\" : true\n }, {\n \"name\" : \"country\",\n \"required\" : true\n }, {\n \"name\" : \"registrationNumber\",\n \"required\" : false\n }, {\n \"name\" : \"incorporatedOn\",\n \"required\" : false\n }, {\n \"name\" : \"website\",\n \"required\" : false\n }, {\n \"name\" : \"legalAddress\",\n \"required\" : false\n }, {\n \"name\" : \"state\",\n \"required\" : false\n } ]\n }, {\n \"idDocSetType\" : \"COMPANY_BENEFICIARIES\",\n \"companyBeneficiaryDefinitions\" : [ {\n \"category\" : \"ubos\",\n \"canSkip\" : true,\n \"individual\" : {\n \"enabled\" : true,\n \"levelName\" : \"basic-kyc-level\",\n \"fields\" : [ {\n \"name\" : \"firstName\",\n \"required\" : true\n }, {\n \"name\" : \"lastName\",\n \"required\" : true\n }, {\n \"name\" : \"middleName\",\n \"required\" : false\n }, {\n \"name\" : \"dob\",\n \"required\" : false\n }, {\n \"name\" : \"taxResidenceCountry\",\n \"required\" : true\n }, {\n \"name\" : \"shareSize\",\n \"required\" : true\n } ],\n \"customFields\" : null\n }\n }, {\n \"category\" : \"shareholders\",\n \"canSkip\" : true,\n \"individual\" : {\n \"enabled\" : true,\n \"levelName\" : \"basic-kyc-level\",\n \"fields\" : [ {\n \"name\" : \"firstName\",\n \"required\" : true\n }, {\n \"name\" : \"lastName\",\n \"required\" : true\n }, {\n \"name\" : \"middleName\",\n \"required\" : false\n }, {\n \"name\" : \"dob\",\n \"required\" : false\n }, {\n \"name\" : \"taxResidenceCountry\",\n \"required\" : false\n }, {\n \"name\" : \"shareSize\",\n \"required\" : true\n } ],\n \"customFields\" : null\n },\n \"company\" : {\n \"enabled\" : true,\n \"levelName\" : \"Auto KYB demo\",\n \"fields\" : [ {\n \"name\" : \"companyName\",\n \"required\" : true\n }, {\n \"name\" : \"country\",\n \"required\" : true\n }, {\n \"name\" : \"registrationNumber\",\n \"required\" : false\n } ],\n \"customFields\" : null\n }\n }, {\n \"category\" : \"directors\",\n \"individual\" : {\n \"enabled\" : true,\n \"levelName\" : \"basic-kyc-level\",\n \"fields\" : [ {\n \"name\" : \"firstName\",\n \"required\" : true\n }, {\n \"name\" : \"lastName\",\n \"required\" : true\n }, {\n \"name\" : \"middleName\",\n \"required\" : false\n }, {\n \"name\" : \"dob\",\n \"required\" : false\n }, {\n \"name\" : \"email\",\n \"required\" : true\n }, {\n \"name\" : \"phone\",\n \"required\" : false\n } ],\n \"customFields\" : null\n },\n \"company\" : {\n \"enabled\" : false,\n \"levelName\" : \"Auto KYB demo\",\n \"fields\" : [ {\n \"name\" : \"companyName\",\n \"required\" : true\n }, {\n \"name\" : \"country\",\n \"required\" : true\n }, {\n \"name\" : \"registrationNumber\",\n \"required\" : true\n } ],\n \"customFields\" : null\n }\n } ]\n }, {\n \"idDocSetType\" : \"COMPANY_DOCUMENTS\",\n \"companyDocsGroupDefinitions\" : [ {\n \"label\" : \"legalPresence\",\n \"subTypes\" : [ \"INCORPORATION_CERT\", \"INCORPORATION_ARTICLES\", \"STATE_REGISTRY\" ],\n \"required\" : true\n }, {\n \"label\" : \"companyDetails\",\n \"subTypes\" : [ \"INFORMATION_STATEMENT\", \"PROOF_OF_ADDRESS\", \"STATE_REGISTRY\", \"INCORPORATION_ARTICLES\", \"INCORPORATION_CERT\", \"INCUMBENCY_CERT\", \"GOOD_STANDING_CERT\" ],\n \"required\" : true\n } ]\n } ],\n \"kybSettings\" : {\n \"shareholderThreshold\" : 5.0,\n \"uboThreshold\" : 25.0\n }\n },\n \"review\" : {\n \"reviewId\" : \"bUKIB\",\n \"attemptId\" : \"OKxAF\",\n \"attemptCnt\" : 1,\n \"elapsedSincePendingMs\" : 219,\n \"levelName\" : \"Auto KYB demo\",\n \"createDate\" : \"2025-01-27 10:44:39+0000\",\n \"reviewDate\" : \"2025-01-27 10:44:39+0000\",\n \"reviewResult\" : {\n \"reviewAnswer\" : \"GREEN\"\n },\n \"reviewStatus\" : \"completed\"\n },\n \"lang\" : \"en\",\n \"type\" : \"company\",\n \"riskLabels\" : {\n \"attemptId\" : \"SLfbz\",\n \"createdAt\" : \"2025-01-27 10:44:39\",\n \"device\" : [ \"vpnUsage\" ],\n \"crossCheck\" : [ \"manyAccountDuplicates\" ]\n }\n}" } }, "schema": { "oneOf": [ { "title": "Company applicants (KYB 1.0)", "type": "object", "properties": { "id": { "type": "string", "example": "5ecfbe9ad5ea48743f8dd1b8" }, "createdAt": { "type": "string", "example": "2020-05-28 13:37:30" }, "clientId": { "type": "string", "example": "coolclientid" }, "inspectionId": { "type": "string", "example": "5ecfbe9ad5ea48743f8dd1b9" }, "externalUserId": { "type": "string", "example": "externalCompanyId" }, "info": { "type": "object", "properties": { "companyInfo": { "type": "object", "properties": { "companyName": { "type": "string", "example": "Cool_company_name" }, "registrationNumber": { "type": "string", "example": "5555555" }, "country": { "type": "string", "example": "GBR" }, "legalAddress": { "type": "string", "example": "Street 123, London, England" }, "incorporatedOn": { "type": "string", "example": "2018-02-28 00:00:00" }, "applicantPosition": { "type": "string", "example": "Secretary" }, "type": { "type": "string", "example": "ltd" }, "email": { "type": "string", "example": "email@email.com" }, "phone": { "type": "string", "example": "(020) 0000 3333" }, "taxId": { "type": "string", "example": "55555276F" }, "registrationLocation": { "type": "string", "example": "UK Company Registration" }, "website": { "type": "string", "example": "www.website_name.com" }, "postalAddress": { "type": "string", "example": "10 St John Axe, London DT7R 00F" }, "noUBOs": { "type": "boolean", "example": true, "default": true }, "noShareholders": { "type": "boolean", "example": true, "default": true }, "beneficiaries": { "type": "array", "items": { "type": "object", "properties": { "applicantId": { "type": "string", "example": "5ecfbecad5ea48743f8dd438" }, "positions": { "type": "array", "items": { "type": "string", "example": "director" } }, "type": { "type": "string", "example": "ubo" }, "inRegistry": { "type": "boolean", "example": false, "default": true }, "imageIds": {}, "applicant": {} } } } } } } }, "requiredIdDocs": { "type": "object", "properties": { "docSets": { "type": "array", "items": { "type": "object", "properties": { "idDocSetType": { "type": "string", "example": "COMPANY" }, "types": { "type": "array", "items": { "type": "string", "example": "COMPANY_DOC" } }, "steps": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "company" }, "minDocsCnt": { "type": "integer", "example": 1, "default": 0 }, "idDocTypes": { "type": "array", "items": { "type": "string", "example": "COMPANY_DOC" } }, "idDocSubTypes": {} } } } } } } } }, "review": { "type": "object", "properties": { "elapsedSincePendingMs": { "type": "integer", "example": 308656, "default": 0 }, "elapsedSinceQueuedMs": { "type": "integer", "example": 26993, "default": 0 }, "reprocessing": { "type": "boolean", "example": true, "default": true }, "createDate": { "type": "string", "example": "2020-05-29 12:22:11+0000" }, "reviewDate": { "type": "string", "example": "2020-05-29 12:27:19+0000" }, "startDate": { "type": "string", "example": "2020-05-29 12:26:52+0000" }, "reviewResult": { "type": "object", "properties": { "reviewAnswer": { "type": "string", "example": "GREEN" } } }, "reviewStatus": { "type": "string", "example": "completed" } } }, "lang": { "type": "string", "example": "en" }, "type": { "type": "string", "example": "company" } } }, { "title": "Company applicants (KYB 2.0)", "type": "object", "properties": { "id": { "type": "string", "example": "679762d6f1dbd5610000000f" }, "createdAt": { "type": "string", "example": "2025-01-27 10:41:26" }, "clientId": { "type": "string", "example": "cool_client_id" }, "inspectionId": { "type": "string", "example": "679762d6f1dbd56171000000" }, "externalUserId": { "type": "string", "example": "level-a543e802-b156-4375-8b68-000000000000" }, "info": { "type": "object", "properties": { "idDocs": { "type": "array", "items": { "type": "object", "properties": { "idDocType": { "type": "string", "example": "COMPANY_DOC" }, "country": { "type": "string", "example": "DEU" } } } }, "companyInfo": { "type": "object", "properties": { "companyName": { "type": "string", "example": "COMPANY LTD" }, "registrationNumber": { "type": "string", "example": "00000000" }, "country": { "type": "string", "example": "GBR" }, "legalAddress": { "type": "string", "example": "30 Street, London, England, 7DR" }, "incorporatedOn": { "type": "string", "example": "2015-07-16 00:00:00" }, "applicantPosition": { "type": "string", "example": "Secretary" }, "type": { "type": "string", "example": "limitedLiabilityCompany" }, "email": { "type": "string", "example": "hello@email.com" }, "phone": { "type": "string", "example": "(020) 0000 0000" }, "taxId": { "type": "string", "example": "00000000F" }, "registrationLocation": { "type": "string", "example": "UK Company Registration" }, "website": { "type": "string", "example": "https://website.com/" }, "postalAddress": { "type": "string", "example": "30 Street, London 7DR" }, "noShareholders": { "type": "boolean", "example": true, "default": true }, "beneficiaries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "ba1ec4a0-6c39-47e0-b9a5-000000000000" }, "applicantId": { "type": "string", "example": "6797633958c30f00000000gf" }, "shareSize": { "type": "integer", "example": 100, "default": 0 }, "types": { "type": "array", "items": { "type": "string", "example": "ubo" } }, "beneficiaryInfo": { "type": "object", "properties": { "email": { "type": "string", "example": "name@email.com" }, "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "Doe" }, "taxResidenceCountry": { "type": "string", "example": "PRT" }, "shareSize": { "type": "integer", "example": 100, "default": 0 } } } } } } } } } }, "fixedInfo": { "type": "object", "properties": { "companyInfo": { "type": "object", "properties": { "companyName": { "type": "string", "example": "COMPANY LTD" }, "registrationNumber": { "type": "string", "example": "00000000" }, "country": { "type": "string", "example": "GBR" }, "legalAddress": { "type": "string", "example": "30 Street, London, England" }, "incorporatedOn": { "type": "string", "example": "2015-07-16 00:00:00" }, "applicantPosition": { "type": "string", "example": "-" }, "type": { "type": "string", "example": "limitedLiabilityCompany" }, "email": { "type": "string", "example": "hello@email.com" }, "phone": { "type": "string", "example": "020-0000-0000" }, "taxId": { "type": "string", "example": "00000000F" }, "registrationLocation": { "type": "string", "example": "-" }, "website": { "type": "string", "example": "https://website.com/" }, "postalAddress": { "type": "string", "example": "30 Street, London 7DR" }, "noUBOs": { "type": "boolean", "example": false, "default": true }, "noShareholders": { "type": "boolean", "example": true, "default": true }, "beneficiaries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "ba1ec4a0-6c39-47e0-b9a5-000000000000" }, "applicantId": { "type": "string", "example": "6797633958c30f00000000gf" }, "shareSize": { "type": "integer", "example": 100, "default": 0 }, "types": { "type": "array", "items": { "type": "string", "example": "ubo" } }, "beneficiaryInfo": { "type": "object", "properties": { "email": { "type": "string", "example": "name@email.com" }, "firstName": { "type": "string", "example": "John" }, "lastName": { "type": "string", "example": "Doe" }, "taxResidenceCountry": { "type": "string", "example": "PRT" }, "shareSize": { "type": "integer", "example": 100, "default": 0 } } } } } } } } } }, "applicantPlatform": { "type": "string", "example": "Web" }, "ipCountry": { "type": "string", "example": "DEU" }, "authCode": { "type": "string", "example": "dglkbnzd;fkjnLULHLugluhlUGlyuhgvlUH;ihj;IH;ughkuhg;0MTQzNiwic3ViIjoibGV2ZWwtYTU0M2U4MDItYjE1Ni00Mzc1LThiNjgtNWJhNzhkMzBiOGU1IiwiYXVkIjoic3KDjnfzvkdfnH:H>IHJ/lihfr/xfmQ2ZjFkYmQ1NjE3MWY4YTk2NiJ9._eRh4qLCRxJA6lk6hKJrt-H67X9fmggdFEMpxaAmn_Y" }, "agreement": { "type": "object", "properties": { "createdAt": { "type": "string", "example": "2025-01-27 10:41:29" }, "acceptedAt": { "type": "string", "example": "2025-01-27 10:41:29" }, "source": { "type": "string", "example": "WebSDK" } } }, "requiredIdDocs": { "type": "object", "properties": { "docSets": { "type": "array", "items": { "type": "object", "properties": { "idDocSetType": { "type": "string", "example": "COMPANY_DATA" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "example": "companyName" }, "required": { "type": "boolean", "example": true, "default": true } } } } } } }, "kybSettings": { "type": "object", "properties": { "shareholderThreshold": { "type": "integer", "example": 5, "default": 0 }, "uboThreshold": { "type": "integer", "example": 25, "default": 0 } } } } }, "review": { "type": "object", "properties": { "reviewId": { "type": "string", "example": "bUKIB" }, "attemptId": { "type": "string", "example": "OKxAF" }, "attemptCnt": { "type": "integer", "example": 1, "default": 0 }, "elapsedSincePendingMs": { "type": "integer", "example": 219, "default": 0 }, "levelName": { "type": "string", "example": "Auto KYB demo" }, "createDate": { "type": "string", "example": "2025-01-27 10:44:39+0000" }, "reviewDate": { "type": "string", "example": "2025-01-27 10:44:39+0000" }, "reviewResult": { "type": "object", "properties": { "reviewAnswer": { "type": "string", "example": "GREEN" } } }, "reviewStatus": { "type": "string", "example": "completed" } } }, "lang": { "type": "string", "example": "en" }, "type": { "type": "string", "example": "company" }, "riskLabels": { "type": "object", "properties": { "attemptId": { "type": "string", "example": "SLfbz" }, "createdAt": { "type": "string", "example": "2025-01-27 10:44:39" }, "device": { "type": "array", "items": { "type": "string", "example": "vpnUsage" } }, "crossCheck": { "type": "array", "items": { "type": "string", "example": "manyAccountDuplicates" } } } } } } ] } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```