Create applicant

Creates an applicant.

Table of contents

Overview

Use this method to create a new applicant profile of either of the following types:

  • individual — if the applicant is a physical person.
  • company — if the applicant is a legal entity.

In the constructor above, you can see the parameters that can be provided when creating an individual applicant. Find out the specifics of creating a company applicant in the section below.

When creating a new applicant profile, you do not always have to send us pre-filled applicant data, such as the applicant name, date of birth, address, and so on. You only need to send images and get the recognized document data using this method. It is the best way to increase your conversion because rejects of mismatches in names and typos will be excluded.

Each applicant may have several ID documents (as well as additional photos of different documents) attached, such as, for example, an ID card or a passport.

See Applicant life-cycle to view the way an applicant profile goes through from creation to verification.

👍

Tip

  • If you have requirements to perform data cross-validation and have no possibility to do it on your side, use the fixedInfo object to fill data like names, date of birth, and address.
  • When using the fixedInfo object, mind that a verification level specified for a particular applicant should include the Applicant data step.
  • Make sure to save the applicant ID. You may need it for future requests.

Specifics of creating company applicants

When creating a company applicant, make sure to provide a companyInfo object inside the info object. The companyInfo object attributes are required to properly validate the company data during verification. This information is not mandatory to be added upon creation, but make sure to provide it before requesting a check.

companyInfo attributes

The following table explains the companyInfo object attributes that you can provide when creating a company applicant or obtain when getting the company applicant data.

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.

FieldTypeRequiredDescription
companyNameStringYesThe name of the company.
registrationNumberStringNoA unique number assigned to the company when it was registered as a legal entity.
countryStringYesA three-letter code of the country where the company is legally registered (for example, DEU or GBR).
legalAddressStringNoThe address a legal entity uses to register with a legal authority.
incorporatedOnStringNoThe date of company incorporation (format YYYY-mm-dd, e.g. 2001-09-25).
typeStringNoA type of legal entity. For example, Private Company Limited by Shares, Public Limited Company, Limited Partnership, and so on.
emailStringNoCompany email address.
phoneStringNoCompany phone number.
controlSchemeStringNoDescription of the control scheme of the company or group of entities.
taxIdStringNoTaxpayer registration number/Code of taxpayer registration.
registrationLocationStringNoA city, town, or another location where the company was registered.
websiteStringNoWebsite URL of the company.
postalAddressStringNoCompany postal address.
beneficiariesArray of objectsNoContains applicantId of beneficiaries and additional information, such as the position and type.
addressesArray of objectsNoA list of available company addresses.

beneficiaries element fields

The following table describes the beneficiaries array of objects containing applicantId of beneficiaries and additional information, such as their position and type.

FieldTypeRequiredDescription
applicantIdStringYesApplicant identifier of the beneficiary.
positionsArray of stringsNoPositions in the company ([director, shareholder, other]) that the beneficiary is holding.
typeStringYesType of beneficiary: ubo or shareholder or director or representative.
inRegistryBooleanNoMatching to a Corporate registry.

  • true — found in the registry.
  • false — not found.
  • null — unknown
imageIdsArray of stringsNoImage IDs of the uploaded document. If the imageIds array contains more than one element, the first one would be the front side and the others — back sides.
applicantObjectNoThe structure to create a new beneficiary.

Request examples

curl -X POST \
  'https://api.sumsub.com/resources/applicants?levelName=basic-kyc-level' \
  -H 'Content-Type: application/json' \
  -d '{
          "externalUserId": "someUniqueUserId",
          "email": "[email protected]",
          "phone": "+449112081223",
          "fixedInfo": {
              "country": "GBR",
              "placeOfBirth": "London"
          }
      }'
curl -X POST \
  'https://api.sumsub.com/resources/applicants?levelName=kyb-level' \
  -H 'Content-Type: application/json' \
  -d '{
        "externalUserId": "someClientUserIdCompany",
        "info": {
            "companyInfo": {
                "companyName": "COMPANY NAME LTD",
                "registrationNumber": "09688671",
                "country": "GBR",
                "incorporatedOn": "2015-01-01",
                "type": "Private Company Limited by Shares",
                "email": "[email protected]",
                "phone": "+12366020172",
                "website": "example.com"
            }
        },
        "type": "company"
      }'

Response explained

The response is a JSON file representing the applicant profile that you have created (or Sumsub have created for you, for example, via the WebSDK) with augmented and structured information. The existence of some fields depends on the documents submitted for verification and verification regulations.

Below, you can see the response structure, possible content with descriptions, and examples of response:

Root variables

Root variables are the core applicant profile data items. Some of them may include nested attributes and element fields.

FieldTypeDescription
idStringA 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.
createdAtDateDate and time (GMT) when the applicant profile was created in the Sumsub system. Format: YYYY-MM-DD HH:MI:SS.
clientIdStringA 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.
inspectionIdStringA unique combination of digits and characters to identify all actions with the applicant’s ID documents. Added automatically when the applicant is created.

This is useful, for example, if you want to find out which document photos were a part of the final verification and made the applicant pass or fail the check. To receive the necessary images, use this method.
externalUserIdStringA unique applicant identifier as registered on your side.

When creating an applicant, you can generate and add the externalUserId manually, or it will be automatically generated and added to the applicant profile by Sumsub.
sourceKeyStringA source key that helps you group clients that send applicants.
infoObjectGeneral 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.
fixedInfoObjectGeneral 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.

Note that info and fixedInfo objects have the same attributes.
emailStringApplicant’s email address.

It is mandatory if the email verification is required. If not provided, the applicant cannot receive verification status emails.
phoneStringApplicant’s phone number.

It is mandatory if the phone verification is required.
applicantPlatformStringThe platform from which the applicant registered in the system and/or provided profile data (API, Web, Android, iOS).
ipCountryStringAlpha-3 country code (DEU, GBR, ARE, and so on) of the country that owns the IP address from which the applicant got registered and/or submitted the data.
authCodeStringJWT token to sign in a user.

For more details, refer to WebSDK Settings.
agreementObjectContains information about the applicant consent to submitting and processing the personal data.
requiredIdDocsObjectConfiguration of steps for the applicant to complete verification.

It includes step types (e.g. IDENTITY, SELFIE) and the documents appropriate for each step (e.g. 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.
reviewObjectExplains the details of the current applicant verification status and check result.
langStringTwo-letter code of the language (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 (MSDK), or via API when creating an applicant.
typeEnumDefines the applicant type. 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.
riskLabelsObjectContains information on the applicant risk labels.
questionnairesArray of objectsIncludes the objects describing questionnaires 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.
notesArray of objectsIncludes the objects representing notes added to the applicant profile by you or by Sumsub operators.
tagsArray of stringsContains tags that you have created and then assigned to the applicant.
memberOfArray of objectsIncludes data objects with the applicant companies' IDs the beneficiary of which the applicant is and which are registered in the Sumsub system.

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).

Note that info and fixedInfo objects have the same attributes except for idDocs.

FieldTypeDescription
companyInfoObject⚠ Available for company applicants only.

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.
firstNameStringApplicant first name in the original language.
firstNameEnStringAutomatic transliteration of the applicant first name into Latin characters.
middleNameStringApplicant middle name in the original language.
middleNameEnStringAutomatic transliteration of the applicant middle name into Latin characters.
lastNameStringApplicant last name in the original language.
lastNameEnStringAutomatic transliteration of the applicant last name into Latin characters.
legalNameStringLegal 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.
genderStringApplicant gender (M or F). If the gender was not specified in the applicant profile, this field will not be present.
dobDateApplicant date of birth (format YYYY-mm-dd, e.g. 2001-09-25).
placeOfBirthStringApplicant place of birth. This can be a city, a town or another settlement type.
countryOfBirthStringApplicant country of birth. Presented as an alpha-3 country code (for example, DEU, GBR, ARG, and so on).
stateOfBirthStringThe state, region, district, county or another territorial entity of birth inside a country, if applicable.
countryStringApplicant country of birth. Presented as an alpha-3 country code (for example, DEU, GBR, ARG, and so on).
nationalityStringApplicant country of origin. Presented as an alpha-3 country code (for example, DEU, GBR, ARG, and so on).
addressesArray of objectsIncludes data objects containing the applicant address details extracted from the PoA documents submitted by the applicant.
tinStringTaxpayer identification number that is unique to each taxpayer.
idDocsArray of objectsIncludes 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 that you can provide when creating a company applicant, or obtain when getting the company applicant data.

Mind that the companyInfo object is available for company applicants only.

FieldTypeDescription
companyNameStringThe name of the company.
registrationNumberStringA unique number assigned to the company when it was registered as a legal entity.
countryStringA three-letter code of the country where the company is legally registered (for example, DEU, GBR, and so on).
legalAddressStringThe address a legal entity uses to register with a legal authority.
incorporatedOnStringThe date of company incorporation (format YYYY-mm-dd, e.g. 2001-09-25).
typeStringA type of legal entity. For example, private company limited by shares, public limited company, state-owned enterprise, and so on.
emailStringCompany email address.
phoneStringCompany phone number.
controlSchemeStringDescription of the control scheme of the company or group of entities.
taxIdStringTaxpayer registration number/Code of taxpayer registration.
registrationLocationStringA city, town, or another location where the company was registered.
websiteStringWebsite URL of the company.
postalAddressStringCompany postal address.
beneficiariesArray of objectsContains applicantIds of beneficiaries and additional information such as position and type.
addressesArray of objectsA list of available company addresses.

beneficiaries element fields

The following table describes the beneficiaries array of objects containing applicantIds of beneficiaries and additional information such as their position and type.

Mind that the beneficiaries array is available for company applicants only.

FieldTypeDescription
applicantIdStringApplicant identifier of the beneficiary.
positionsArray of stringsPositions in the company ([director, shareholder, other]) that the beneficiary is holding.
typeStringType of beneficiary: ubo or shareholder or ‘director’ or representative.
inRegistryBooleanMatching to a Corporate registry.
  • true — found in the registry.
  • false — not found.
  • null — unknown
imageIdsArray of stringsImage IDs represent a document uploaded. If imageIds array contains more than one element, the first one would be the front side and the others — back sides.
applicantObjectStructure to create a new beneficiary.

idDocs element fields

The following table explains the data objects representing the details of identity documents provided by the applicant.

FieldTypeDescription
idDocTypeStringThe 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.
countryStringAlpha-3 code (for example, DEU, GBR, ARG, and so on) of the country where the document was issued.
firstNameStringApplicant first name in the original language as it is in the document.
firstNameEnStringAutomatic transliteration of the applicant first name into Latin characters.
middleNameStringApplicant middle name in the original language as it is in the document.
middleNameEnStringAutomatic transliteration of the applicant middle name into Latin characters.
lastNameStringApplicant last name in the original language as it is in the document.
lastNameEnStringAutomatic transliteration of the applicant last name into Latin characters.
issuedDateDateThe date when the identity document was issued (format YYYY-MM-DD).
issueAuthorityCodeStringThe code of the Issuing Authority that is in charge of issuing the uploaded document.
validUntilDateThe date when the document validity expires.
numberStringUnique registration number of the document.
dobDateApplicant date of birth (format YYYY-mm-dd, e.g. 2001-09-25) as it is specified in the document.
addressObjectIncludes the applicant address details.

address attributes and addresses element fields

The following table explains the address attributes and addresses element fields containing the applicant address details extracted from the documents or provided by the applicant.

FieldNameDescription
countryStringAlpha-3 country code (for example, DEU, GBR, ARG, and so on).
postCodeStringAddress postal code.
townStringThe city, town, or another settlement where the applicant lives and/or is registered.
streetStringThe street where the applicant lives and/or is registered.
subStreetStringAdditional information related to the applicant street. This could be a house number or any other details.
stateStringThe state, region, district, county or another territorial entity inside a country.

fixedInfo attributes

The 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 object).

Note that info and fixedInfo objects have the same attributes except for idDocs.

FieldTypeDescription
firstNameStringApplicant first name in the original language.
firstNameEnStringAutomatic transliteration of the applicant first name into Latin characters.
middleNameStringApplicant middle name in the original language.
middleNameEnStringAutomatic transliteration of the applicant middle name into Latin characters.
lastNameStringApplicant last name in the original language.
lastNameEnStringAutomatic transliteration of the applicant last name into Latin characters.
legalNameStringLegal 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.
genderStringApplicant gender that can be male or female (M or F). If the gender is not specified in the applicant profile, this field is absent.
dobDateApplicant date of birth (format YYYY-mm-dd, e.g. 2001-09-25).
placeOfBirthStringApplicant place of birth. This can be a city, a town or another settlement type.
countryOfBirthStringApplicant country of birth. Presented as an alpha-3 country code (for example, DEU, GBR, ARG, and so on).
stateOfBirthStringThe state, region, district, county or another territorial entity of birth inside a country, if applicable.
countryStringApplicant country of birth. Presented as an alpha-3 country code (for example, DEU, GBR, ARG, and so on).
nationalityStringApplicant country of origin. Presented as an alpha-3 country code (for example, DEU, GBR, ARG, and so on).
addressesArray of objectsIncludes data objects containing the applicant address details provided by the applicant.
tinStringTaxpayer identification number that is unique to each taxpayer.

agreement attributes

The following table explains the details of the applicant consent to the submitting and processing of personal data.

FieldTypeDescription
createdAtDateDate and time (GMT) when the applicant confirmed his/her consent to the submitting and processing of personal data.
sourceStringSpecifies the source from which the applicant confirmed the agreement (WebSDK, MSDK).

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.

FieldTypeDescription
videoIdentBooleanSpecifies if the video identification is required (true) or not required (false) to pass verification.
docSetsArray of objectsIncludes the objects representing specific document sets and their attributes.
excludedCountriesArray of stringsLists the countries (in alpha-3 country code, for example, DEU, GBR, ARG, etc.) excluded from the list of supported.

docSets element fields

The following table explains the element fields of the docSets array representing specific document sets and their attributes.

FieldTypeDescription
idDocSetTypeStringA human-readable identifier of the document set type, for example, IDENTITY, SELFIE, PROOF_OF_RESIDENCE, and so on.
fieldsArray of objectsIncludes the objects describing the document data fields that should be filled with personal information to verify the applicant.

Each object contains the following attributes:
  • name (String) — the field name, for example, firstName, lastName, email, and so on.
  • required (Boolean) — true if the field is required for verification, false if not (still, it can be optionally filled in the SDK).
typesArray of stringsIncludes the types of documents that are required for a particular idDocSetType to pass verification.
videoRequiredStringA method of passing the document upload step that can be set up when configuring a verification level.
  • disabled — selfie with a document.
  • enabled — video selfie with a phrase.
  • photoRequired — web camera photo (still face image).
  • passiveLivenessliveness check.
  • docapture — enables the camera for the steps with ID documents.
captureModeStringThis mode is applied in case the docapture method is used (see the table row above).
  • 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.
uploaderModeStringThis mode is applied in case the docapture method is used.
  • 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.
questionnaireDefIdStringIdentifier of the questionnaire that is added to the verification level and is to be or has already been filled by the applicant.

review attributes

The following table explains the review object attributes that represent the details of the current applicant verification status and check result.

FieldTypeDescription
reviewIdStringUnique identifier of the applicant profile review in the Sumsub system.
levelNameStringThe name of the verification level the applicant has to go through.
attemptIdStringUnique 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.
attemptCntIntegerThe counting number of the current verification attempt on the same verification level.
elapsedSincePendingMsIntegerElapsed time since the applicant verification passed to the pending status.
createDateDateDate and time (UTC) when the applicant profile was created in the Sumsub system.
reviewDateDateDate and time (UTC) when the current applicant check was completed.
reviewResultObjectContains extra details of the applicant verification result.
reviewStatusStringIndicates the applicant review status.

reviewResult attributes

The following table explains the reviewResult attributes representing the applicant verification result details.

FieldTypeDescription
reviewAnswerStringExplains the review result.
  • GREEN — the applicant is approved.
  • RED — the applicant is declined.
rejectLabelsArray of stringsIncludes one or more reasons for rejection. The field is available if reviewAnswer returns RED.

For more details, see Temporary rejection and Final rejection clarification.
reviewRejectTypeStringIndicates the type of rejection.
  • FINAL — final rejection 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 rejected with a final rejection status will not be able to resubmit the documents for verification.
  • RETRY — temporary rejection in case of minor violations. For example, a name or address mismatch, incorrect TIN was provided, and so on. A temporary rejected applicant is sent a resubmission request. Thus the applicant has a chance to upload new documents or resubmit correct data.

For more details, see Temporary rejection and Final rejection clarification.
clientCommentStringA human-readable comment that explains the reasons for rejection in detail, and that must not be shown to the applicant.
moderationCommentStringA human-readable comment that explains the reasons for rejection in detail, and that can be shown to the applicant.
buttonIdsArray of stringsA list of button IDs that have been used for applicant rejection.

A specific buttonId is automatically assigned to each rejection. For more details, see Temporary rejection and Final rejection clarification.

questionnaires element fields

The following table includes the data objects explaining the questionnaires 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.

FieldTypeDescription
idStringUnique identifier of the questionnaire. You give this ID to the questionnaire when creating it.
sectionsObjectIncludes the objects each of those is a separate group of questions added to the questionnaire.

A section object has a name representing the section title 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.
itemsObjectIncludes the objects each of those stands for a single question added to the questionnaire.

An item object has a name representing the question. Each item has the value field which contains the applicant answer, and may have its own score assigned.
scoreIntegerA score is a sort of rating that can be assigned to each item, each section, and a questionnaire as a whole. You can see the score element in the corresponding object it belongs to.

When configuring a questionnaire, you have the option to set up risk scoring. It means you can add a value to each possible answer. When the applicant selects this answer, the assigned value is added to the score.

The 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.

notes element fields

The following table explains the data objects representing the notes added to the applicant profile by you or Sumsub operators.

FieldTypeDescription
noteStringContains the text of the note added.
moderatorNameStringIdentifier of the one who created the note in the applicant profile.
createdAtDateDate 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.

FieldTypeDescription
applicantIdStringUnique identifier of the company registered as an applicant in the Sumsub system.
fullNameStringFull name of the company applicant.

Response examples

{
  "id": "5b594ade0a975a36c9349e66",
  "createdAt": "2020-06-24 05:05:14",
  "clientId": "ClientName",
  "inspectionId": "5b594ade0a975a36c9379e67",
  "externalUserId": "SomeExternalUserId",
  "fixedInfo": {
    "firstName": "Chris",
    "lastName": "Smith"
  },
  "info": {
    "firstName": "CHRISTIAN",
    "firstNameEn": "CHRISTIAN",
    "lastName": "SMITH",
    "lastNameEn": "SMITH",
    "dob": "1989-07-16",
    "country": "DEU",
    "idDocs": [
      {
        "idDocType": "ID_CARD",
        "country": "DEU",
        "firstName": "CHRISTIAN",
        "firstNameEn": "CHRISTIAN",
        "lastName": "SMITH",
        "lastNameEn": "SMITH",
        "validUntil": "2028-09-04",
        "number": "LGXX359T8",
        "dob": "1989-07-16",
        "mrzLine1": "IDD<<LGXX359T88<<<<<<<<<<<<<<<",
        "mrzLine2": "8907167<2809045D<<<<<<<<<<<<<8",
        "mrzLine3": "SMITH<<CHRISTIAN<<<<<<<<<<<<<<"
      }
    ]
  },
  "agreement": {  //present when SDK was initialized with Agreement screen enabled
    "createdAt": "2020-06-24 04:18:40",
    "source": "WebSDK",
    "targets": [
      "By clicking Next, I accept [the Terms and Conditions](https://www.sumsub.com/consent-to-personal-data-processing/)",
      "I agree to the processing of my personal data, as described in [the Consent to Personal Data Processing](https://sumsub.com/consent-to-personal-data-processing/)"
    ]
  },
  "email": "[email protected]",
  "applicantPlatform": "Android",
  "requiredIdDocs": {
    "docSets": [
      {
        "idDocSetType": "IDENTITY",
        "types": [
          "PASSPORT",
          "ID_CARD"
        ]
      },
      {
        "idDocSetType": "SELFIE",
        "types": [
          "SELFIE"
        ]
      }
    ]
  },
  "review": {
    "elapsedSincePendingMs": 115879,
    "elapsedSinceQueuedMs": 95785,
    "reprocessing": true,
    "levelName": "basic-kyc",
    "createDate": "2020-06-24 05:11:02+0000",
    "reviewDate": "2020-06-24 05:12:58+0000",
    "reviewResult": {
      "reviewAnswer": "GREEN"
    },
    "reviewStatus": "completed"
  },
  "lang": "de",
  "type": "individual"
}
{
  "id": "5ecfbe9ad5ea48743f8dd1b8",
  "createdAt": "2020-05-28 13:37:30",
  "clientId": "coolclientid",
  "inspectionId": "5ecfbe9ad5ea48743f8dd1b9",
  "externalUserId": "externalCompanyId",
  "info": {
    "companyInfo": {
      "companyName": "SUMSUB LIMITED",
      "registrationNumber": "1555555",
      "country": "GBR",
      "incorporatedOn": "2018-02-28 00:00:00",
      "type": "ltd",
      "website": "www.sumsub.com",
      "beneficiaries": [
        {
          "applicantId": "5ecfbecad5ea48743f8dd438",
          "positions": [
            "director"
          ],
          "type": "ubo",
          "inRegistry": false,
          "imageIds": null,
          "applicant": null
        }
      ]
    }
  },
  "requiredIdDocs": {
    "docSets": [
      {
        "idDocSetType": "COMPANY",
        "types": [
          "COMPANY_DOC"
        ],
        "steps": [
          {
            "name": "company",
            "minDocsCnt": 1,
            "idDocTypes": [
              "COMPANY_DOC"
            ],
            "idDocSubTypes": null
          },
          {
            "name": "ubos",
            "minDocsCnt": null,
            "idDocTypes": null,
            "idDocSubTypes": null
          }
        ]
      }
    ]
  },
  "review": {
    "elapsedSincePendingMs": 308656,
    "elapsedSinceQueuedMs": 26993,
    "reprocessing": true,
    "createDate": "2020-05-29 12:22:11+0000",
    "reviewDate": "2020-05-29 12:27:19+0000",
    "startDate": "2020-05-29 12:26:52+0000",
    "reviewResult": {
      "reviewAnswer": "GREEN"
    },
    "reviewStatus": "completed"
  },
  "lang": "en",
  "type": "company"
}

Applicant life-cycle

The following is a typical applicant life-cycle:

  1. When you create an applicant, they receive an init status.
  2. After uploading all required documents, the status changes to pending.
  3. You must then let us know that the applicant is ready to be reviewed.
  4. After the verification process is complete, the applicant status changes to completed.
Language
Authorization
Header
Click Try It! to start a request and see the response here!