Overview

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

• individual if it is a physical person.
• company if it is a legal entity.

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.

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

👍

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.

📘

Note

Make sure to save an applicant ID upon creating an applicant — you may need this for future requests.

Specifics of creating company applicants

When creating a company applicant, the info object should include a companyInfo object. The companyInfo object attributes are required to properly validate 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.

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.

Company creation request example

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" : "sumsub.com"
          }
        },
        "type": "company"
      }'

Company creation response example

{
  "id": "5e9412223cc1813b4db0b0e3",
  "createdAt": "2020-10-10 00:05:20",
  "clientId": "rda_t_key",
  "inspectionId": "5e9412223cc1813b4db0b0e4",
  "externalUserId": "someClientUserIdCompany",
  "info": {
    "companyInfo": {
      "companyName": "COMPANY NAME LTD",
      "registrationNumber": "09688671",
      "country": "GBR",
      "incorporatedOn": "2015-01-01 00:00:00",
      "type": "Private Company Limited by Shares",
      "email": "[email protected]",
      "phone": "+12366020172",
      "website": "sumsub.com"
    }
  },
  "requiredIdDocs": {
    "docSets": [
      {
        "idDocSetType": "COMPANY",
        "types": [
          "COMPANY_DOC"
        ],
        "steps": [
          {
            "name": "company",
            "minDocsCnt": 1,
            "idDocTypes": [
              "COMPANY_DOC"
            ],
            "idDocSubTypes": null,
            "fields": null,
            "customFields": null
          },
          {
            "name": "ubos",
            "minDocsCnt": null,
            "idDocTypes": null,
            "idDocSubTypes": null,
            "fields": null,
            "customFields": null
          }
        ]
      }
    ]
  },
  "review": {
    "reprocessing": false,
    "createDate": "2020-10-10 00:05:20+0000",
    "reviewStatus": "init"
  },
  "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.