Applicant Public Api

Create, read, move, deactivate and delete applicants, and issue verification tokens for them.

📄️Create an applicant

Creates an applicant in the verification flow selected by `flowName` and returns the applicant profile. The request is rejected if an applicant with the same `externalUserId` already exists, or if the email or the phone belongs to another applicant. To let the applicant pass the verification, create a token with `POST /api/public/applicant/{applicantId}/token`.

📄️Get an applicant

Returns the applicant profile with the review status and the results of the passed services. `applicantId` is either the internal ID of the applicant or the `externalUserId` you passed on creation.

📄️Get the status of an applicant

Returns only the current review status of the applicant. Use it to poll the status without loading the whole profile.

📄️Move an applicant to another flow

Changes the verification flow of the applicant to the flow with the given `flowId` and returns the status of the applicant.

📄️Schedule applicant deletion

Marks the applicant for deletion. The date when the applicant data is removed is returned in `scheduledDeletionDate`. The deletion can be cancelled with `POST /api/public/applicant/{applicantId}/restore`.

📄️Restore an applicant

Cancels the scheduled deletion of the applicant.

📄️Create a verification token for an applicant

Starts a verification for an existing applicant and returns an access token and a short link. Open the link, or pass `accessToken` to the verification SDK, to let the applicant pass the verification. If `flowName` is omitted, the current flow of the applicant is used. The client balance is checked for the first service of the flow before the token is issued.

📄️Deactivate applicant services now

Deactivates the results of the listed services immediately: the newest active result of each service is rejected with the given `comment`, its data is removed from the applicant, and the review status of the applicant is set to `INCOMPLETE` so the applicant has to pass the services again. Services the applicant has not passed are skipped. The response lists the services that were actually deactivated.

📄️Set the automatic deactivation date of applicant services

Sets the date when the results of the listed services (or of all services with `all`) are deactivated automatically. The services are not changed now: on that day they are deactivated the same way as with `POST /api/public/applicant/{applicantId}/services/deactivate`. The response lists the services the date was set for.