post https://api.sumsub.com/resources/applicants//ekyc/submit
Sends applicant data for no-document verification.
Overview
Use this method to initiate a Non-Doc verification based on the provided applicant data.
Response explained
The following is a response example.
Name | Type | Optional | Description |
---|---|---|---|
status | String | No | The status of the verification flow. Possible statuses: completed — submission completed, skipped — object representing transaction review result, confirmationRequired — submission needs approval. See confirmationType, rejected — submission was rejected. |
confirmationType | String | Yes | Confirmation type. Possible values: otp — Submission should be confirmed via OTP code, oAuth — Applicant should be directed to external service to proceed submission. |
confirmationId | String | Yes | Confirmation ID. |
confirmationStatus | String | Yes | Status of the confirmation flow. |
otpConfirmation | Object | Yes | Details for OTP confirmation if confirmationType is otp . |
Note
Access to applicant data from some providers need to be confirmed by the applicant. In that case,
status
will be set toconfirmationRequired
andconfirmationStatus
tocreated
. The confirmation type will be provided in theconfirmationType
field. For details on how to confirm submission, see Confirm applicant data.For example, for an Indian AADHAAR, the applicant receives an SMS with the OTP code on the phone number that is linked to that particular AADHAAR. The applicant should then provide the code to confirm access.
otpConfirmation
attributes
otpConfirmation
attributesName | Type | Description |
---|---|---|
codeLength | Number | OTP code length. |
oAuthConfirmation
attributes
oAuthConfirmation
attributesName | Type | Description |
---|---|---|
url | String | External auth URL where applicant should be directed to pass authentication. |
redirectUrl | String | Final URL address where auth page will be redirected after applicant finish the journey. |
Mind the following:
- Applicants should be redirected to the
url
where they can authenticate the external source. At the end of the auth journey, applicants will be redirected to thecompleteUrl
consisting ofredirectUrl
enriched withqueryParams
with the auth result.- If
url
was opened in the child window,postMessage: {type: "ekycOauth", completeUrl: "<completeUrl>"}
will be sent.- Several redirects can be performed during the auth flow. To detect the completion of the journey, redirect to the
redirectUrl
or subscribe topostMessages
.- To complete the Non-Doc oAuth flow, pass the final full url as
completeUrl
to Confirm applicant data.