Applicant
The "Applicant" serves as a centralized repository consolidating all data pertinent to an individual user within the platform collected with the help of webhooks.
Applicant Webhooks
Name | Description |
---|---|
applicantCreated | It signifies the creation of an applicant profile within the system. No specific action is required from the client or end-user at this stage, and the verification process may not have commenced. |
applicantInProgress | It denotes that the user has completed all required actions on their end, and the system has commenced background checks. |
applicantIncomplete | It indicates that the user has initiated the verification process but has not yet provided all the necessary details. As a result, the process remains unfinished. |
applicantInReview | It is assigned when a compliance officer has initiated a manual review of the verification process. |
applicantRejected | It signifies that the compliance officer has declined the verification after review. |
applicantApproved | It denotes that the compliance officer has completed their review and approved the verification. |
applicantCompleted | It indicates that the user has fulfilled all required actions and provided the necessary data, and all system-side processes related to verification are also finalized. |
applicantOnHold | It is assigned when the system identifies a potentially suspicious verification case that cannot be automatically marked as completed. Examples include duplicate applicant entries or suspicious document submissions, requiring manual intervention. |
applicantStepPassed | event occurs when an applicant passes a step in the flow |
Payload Attributes
Name | Type | Description |
---|---|---|
id* | UUID | A unique applicant identifier |
externalUserId* | String | A unique applicant identifier on your side. |
appKey* | UUID | A unique application identifier. |
warnings | Array of strings | |
stepName | String |
Last updated