get https://api.sumsub.com/resources/applicants//one
Returns applicant information.
Overview
Use this method to get information about the created applicant.
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
andcountry
was approved using this method.
Tip
If the applicant ID is unknown to you, use the Get applicant data (externalUserId) method.
Response explained
Name | Type | Description |
---|---|---|
id | String | A unique applicant identification number. |
inspectionId | String | Inspection ID. |
externalUserId | String | An applicant ID on your side. |
sourceKey | String | A source key that helps you group clients that send applicants. |
email | String | An applicant email address. |
phone | String | An applicant phone number. |
ipCountry | String | The country IP address. |
lang | String | The language, in which the verification results should be displayed to applicants. |
metadata | Array of objects | Additional information not displayed to the end-user. For example: [{"key": "keyFromClient", "value": "valueFromClient"}] . |
fixedInfo | Object | Contains information submitted by the applicant via Web or Mobile SDK or by you via this API method. Used to compare the data that you provide to us with that we extract from the applicant documents. |
createdAt | Date | Time and date when the applicant was created. |
requiredIdDocs | Object | An object that describes a set of required documents and data for the applicant to upload and pass verification. |
review | Object | An object that describes the current applicant status. |
riskLabels | Object | An object that describes risk labels. |
questionnaires | Array of objects | Contains data about the questionnaire. |
tags | Array of objects | Contains data about the tags assigned to an applicant :[ "Low risk", "comply" ] , etc. |
fixedInfo
and info
attributes
fixedInfo
and info
attributesName | Type | Description |
---|---|---|
firstName | String | First applicant name. |
lastName | String | Last applicant name. |
middleName | String | Middle applicant name. |
firstNameEn | String | Automatic transliteration of the first applicant name. |
lastNameEn | String | Automatic transliteration of the last applicant name. |
middleNameEn | String | Automatic transliteration of the middle applicant name. |
legalName | String | Legal name. |
gender | String | Applicant gender (M or F ). |
dob | String | Date of birth (format YYYY-mm-dd , e.g. 2001-09-25). |
placeOfBirth | String | Place of birth. |
country | String | Alpha-3 country code (e.g. DEU or GBR ). |
nationality | String | Alpha-3 country code. |
addresses | Array of objects | List of applicant addresses. |
idDocs | Array of objects | Contains information extracted from the applicant documents. |
address
element fields
address
element fieldsName | Type | Description |
---|---|---|
country | String | Alpha-3 country code. |
postCode | String | Postal code. |
town | String | Town or city name. |
street | String | Street name. |
subStreet | String | Additional street information. |
state | String | State name if applicable. |