Reject applicant

post/resources/applicants/{applicantId}/-/reject

Request

Base URL
https://api.sumsub.com
Auth
API key in header X-App-Token
TypeScript
https://skmtc.dev/sumsub/apis/sumsub-api/docs/resources/applicants/:applicantId/-/reject/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

applicantIdstring required

Unique identifier of the applicant in the Sumsub system. This identifier is a random combination of 24 digits and lowercase Latin characters. It is automatically generated when the applicant is created on the Sumsub side, and can be found in the Dashboard. If the applicantId is unknown to you, use the Get applicant data (externalUserId) method to fetch it.

Request body

notestring

Optional note text providing additional context for the applicant profile. Notes can be added and managed either in the Dashboard or via dedicated API methods.

tagsstring[]

Tags that you may want to assign to the applicant profile. Each string represents a standalone tag. ⚠️ Mind that tag names are case sensitive.

Changes

No recorded changes to this operation across all 2 revisions of this API.