Get started with API

The following scenario provides a verification flow example to help you understand the overall process and how you can handle common verification procedures:

  1. Generate an app token to start working with the Sumsub API.
  2. Create an applicant.
    1. Set up the steps that your applicants must go through to complete verification by creating a verification level. For more information about the supported types of documents, see this article.
    2. Provide as much information about your applicants as you have, e.g. email, phone, etc. — it helps us with our anti-fraud checks.
  3. Upload documents.
    1. Make sure to upload all the documents that you require. If a document is double-sided, submit two images and set the idDocSubType properly (FRONT_SIDE and BACK_SIDE). Make sure to send BACK_SIDE if FRONT_SIDE was already sent; otherwise, the verification step will not be completed, and you will not be able to initiate the check.
    2. If you have changed the list of restricted countries, we suggest rewriting it for applicants created before the change with this method.
  4. Request a check. Once all required documents are uploaded, you must let us know that the applicant is ready to be reviewed by moving them to the Pending status. if you do not submit documents correctly, the applicant will be rejected (or will not be checked at all). Make sure to check all the cases on your side to avoid having incomplete applicants.
  5. Set up webhooks and get verification results. The results are delivered by the applicantReviewed webhook that contains the reviewResult object that includes the reviewAnswer field indicating the verification status:
    1. If you receive a GREEN response, all is fine; the applicant has been verified. If needed, you can also fetch the applicant data in a separate API call.
    2. If you receive a RED response and rejectType is FINAL, block the applicant and let them resolve the issue via support. There are only 1-2% of such cases, and it can happen when, for example, there is a fake account or forged documents were used.
    3. If you receive a RED response and rejectType is RETRY, the applicant has some issues with their documents that can potentially be solved. Refer to Resubmit problematic documents to learn how to fix them.