Overview
Use this method to get information about the created applicant — both individual and company.
Request example
curl -X GET \
'https://api.sumsub.com/resources/applicants/5b594ade0a975a36c9349e66/one'
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
idDocTypeandcountrywas approved using this method.
TipIf the applicant ID is unknown to you, use the Get applicant data (externalUserId) method.
info attributes
info attributesThe following table explains the info object attributes — general applicant information recognized from the documents that Sumsub cross-validates with the applicant data provided (fixedInfo).
| Field | Type | Description |
|---|---|---|
companyInfo | Object | 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 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 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 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-3 country code (for example, DEU, GBR, ARG). |
nationality | String | Applicant country of origin. Presented as an ISO 3166-1 alpha-3 country code (for example, DEU, GBR, ARG). |
addresses | Array of objects | 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 | Includes data objects containing information extracted from the applicant documents, which can be useful in cases where a verification has been completed. |
companyInfo attributes
companyInfo attributesThe 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 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." |
legalAddress | String | Address a legal entity uses to register with a legal authority. |
incorporatedOn | Date | Date of company incorporation (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 format). |
phone | String | Company phone number (ITU-T 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 | Represents the company address. |
controlScheme | String | Description of the control scheme of the company ownership or group of entities. |
skippedTypes | Array of strings | Includes the required values ( ⚠️ Applicable to the |
noDocs | Boolean | Indicates whether company documents must be uploaded to proceed verification.
|
beneficiaries | Array of objects | Contains applicantIds of beneficiaries and additional information such as position and type. |
beneficiaries element fields
beneficiaries element fieldsThe following table describes the beneficiaries array of objects containing applicantIds 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 2.0 beneficiaries when they are added to the company structure. ⚠️ Beneficiary identifier is not the equivalent of |
applicant | Object | Applicant profile data. |
applicantId | String | Applicant identifier of the beneficiary in the Sumsub system. |
beneficiaryInfo | Object | Structure that contains the beneficiary contact data. |
types | Array of strings | Beneficiary roles for the new data structure, when one entity may have multiple roles. Possible values:
|
shareSize | Double | Percentage of ownership if the beneficiary is a shareholder of the company. |
beneficiaryInfo attributes
beneficiaryInfo attributesThe 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/5322format). |
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. |
address attributes and addresses element fields
address attributes and addresses element fieldsThe following table explains the address attributes and addresses element fields containing the applicant address details.
| Field | Type | Description |
|---|---|---|
buildingName | String | Building name. |
flatNumber | String | Flat or apartment number. |
subStreet | String | Additional information related to the street. This could be a house number or any other details. |
subStreetEn | String | Automatic transliteration of the additional information related to the street into Latin characters. |
street | String | Street name. |
streetEn | String | Automatic transliteration of the street name into Latin characters. |
state | String | State, region, district, county or another territorial entity inside a country. |
stateEn | String | Automatic transliteration of the territorial entity into Latin characters. |
stateCode | String | Applicant state code based on the address. A list of state codes is based on the ISO 3166-2 format (for example, TR-34, AD-07). |
buildingNumber | String | Building number. |
town | String | City, town, or another settlement. |
townEn | String | Automatic transliteration of the settlement into Latin characters. |
postCode | String | Address postal code. |
country | String | ISO 3166-1 alpha-3 country code (for example, DEU, GBR, ARG). |
formattedAddress | String | Address in a human readable format. For example, Design Offices, Philipsbornstraße 2, 30165 Hannover, Germany. |
source | String | Address data source. This information can be obtained from Applicant data, Proof of Address, and Geo as PoA. |
fixedInfo attributes
fixedInfo attributesThe following table explains the fixedInfo object attributes — general applicant information that is submitted by the applicant via the Web or Mobile SDK or by you via this API method. Sumsub should not change this information but use it to cross-validate with the data recognized from the applicant documents (info).
| Field | Type | Description |
|---|---|---|
companyInfo | Object | 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. |
parentName1 | 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 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 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 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 of birth. Presented as an ISO 3166-1 alpha-3 country code (for example, DEU, GBR, ARG). |
nationality | String | Applicant country of origin. Presented as an ISO 3166-1 alpha-3 country code (for example, DEU, GBR, ARG). |
addresses | Array of objects | 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 code (for example, DEU, GBR, ARG). |
agreement attributes
agreement attributes
AttentionA new data format for the
agreementobject has been introduced (see the following 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
acceptedAttimestamp.
| 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. |
companyBeneficiaryDefinitions element fields
companyBeneficiaryDefinitions element fieldsThe 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 | Contains information on the associated party as an individual applicant. |
company | Object | Contains information on the associated party as a company applicant. |
companyDocsGroupDefinitions element fields
companyDocsGroupDefinitions element fieldsThe 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 included into the verification group. |
required | Boolean | Indicates if this is required (true) or optional (false). |
review attributes
review attributesThe following table explains the review object attributes that represent the details of the current applicant verification status and check result.
| Field | Type | Description |
|---|---|---|
reviewId | String | Unique identifier of the applicant profile review in the Sumsub system. |
levelName | String | Name of the verification level the applicant has to go through. There is no length limit for this field. |
attemptId | String | Unique identifier of the current verification attempt. Applicants 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. |
attemptCnt | Integer | Counting number of the current verification attempt on the same verification level. |
elapsedSincePendingMs | Long | Elapsed time since the applicant verification passed to the pending status. |
createDate | Date | Date and time (UTC) when the applicant profile was created in the Sumsub system. |
reviewDate | Date | Date and time (UTC) when the current applicant check was completed. |
reviewResult | Object | Contains extra details of the applicant verification result. |
reviewStatus | String | Indicates the applicant review status. |
reviewResult attributes
reviewResult attributesThe following table explains the reviewResult attributes representing the applicant verification result details.
| Field | Type | Description |
|---|---|---|
reviewAnswer | String | Explains the review result.
|
rejectLabels | Array of strings | Includes one or more reasons for rejection. The field is available if For more information, see Resubmission requested and Rejected . |
reviewRejectType | String | Indicates the type of rejection.
For more information, see Resubmission requested and Rejected . |
clientComment | String | Human-readable comment that explains the reasons for rejection in detail, and that must not be shown to the applicant. |
moderationComment | String | Human-readable comment that explains the reasons for rejection in detail, and that can be shown to the applicant. |
buttonIds | Array of strings | Button identifiers that have been used for applicant rejection. A specific |
assessment attributes
assessment attributesThe 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 | Each object represents an individual assessment score based on a specific factor contributing to the overall evaluation. |
scores element fields
scores element fieldsThe 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 | List of rules that contributed to this score. |
rules element fields
rules element fieldsThe 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. |
notes element fields
notes element fieldsThe following table explains the data objects representing the 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. |
If the request fails, you will receive an HTTP response containing an error code along with a message explaining the error. For example:
{
"code": 400,
"correlationId": "345fd9bcc7d3a7670c5a6b25fcd7d0dd",
"description": "Invalid parameters provided"
}