HomeWeb SiteTerms of ServicesPrivacy Policy

Applicant Webhooks

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.

applicantStepPassed

This event occurs when an applicant successfully passes a step in the verification flow.

applicantDuplicateDocument

It indicates that the system has detected duplicate document submissions for multiple applicant profiles, requiring further investigation.

expiredDocument

This event is triggered when a submitted document has expired

additionalDocumentStepError

Indicates an error at the stage of additional document validation

applicantDuplicateEmail

It is triggered when the system detects duplicate email addresses associated with multiple applicant profiles, suggesting possible fraud or system errors.

applicantDuplicatePhone

It is triggered when the system identifies duplicate phone numbers linked to different applicants, indicating potential fraud or data duplication.

amlPositiveCases

This event indicates that the applicant's information matches a record in an anti-money laundering (AML) database, requiring further review and investigation.

amlCannotStarted

It denotes that the AML screening process could not be initiated due to missing or incomplete data.

amlResultUpdated

This event occurs when the results of the AML screening process are updated, reflecting changes such as clearing a match or confirming a positive case.

applicantCreated

{
    "type":"applicantCreated",
    "id":"e007bf91-f78d-459d-a48d-408982f886f1",
    "externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
    "appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
    "timestamp": 1737977546178
}
Name
Type
Description

id*

UUID

A unique applicant identifier

type*

String

externalUserId*

String

A unique applicant identifier on your side.

appKey*

UUID

A unique application identifier.

timestamp*

Number

event time in milliseconds

applicantInProgress

{
    "type":"applicantInProgress",
    "id":"e007bf91-f78d-459d-a48d-408982f886f1",
    "externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
    "appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
    "fullName": "John Back",
    "previousStatus": "INCOMPLETE",
    "newStatus": "IN_PROGRESS",
    "timestamp": 1737977546178
}
Name
Type
Description

id*

UUID

A unique applicant identifier

type*

String

externalUserId*

String

A unique applicant identifier on your side.

appKey*

UUID

A unique application identifier.

fullName

String

An Applicant Full Name

previousStatus*

String

newStatus*

String

timestamp*

Number

event time in milliseconds

applicantIncomplete

{
    "type":"applicantIncomplete",
    "id":"e007bf91-f78d-459d-a48d-408982f886f1",
    "externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
    "appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
    "fullName": "John Back",
    "previousStatus": "INIT",
    "newStatus": "INCOMPLETE",
    "timestamp": 1737977546178
}
Name
Type
Description

id*

UUID

A unique applicant identifier

type*

String

externalUserId*

String

A unique applicant identifier on your side.

appKey*

UUID

A unique application identifier.

fullName

String

An Applicant Full Name

previousStatus*

String

newStatus*

String

timestamp*

Number

event time in milliseconds

applicantInReview

{
    "type":"applicantInReview",
    "id":"e007bf91-f78d-459d-a48d-408982f886f1",
    "externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
    "appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
    "fullName": "John Back",
    "timestamp": 1737977546178
}
Name
Type
Description

id*

UUID

A unique applicant identifier

type*

String

externalUserId*

String

A unique applicant identifier on your side.

appKey*

UUID

A unique application identifier.

fullName

String

An Applicant Full Name

timestamp*

Number

event time in milliseconds

applicantRejected

{
    "type":"applicantRejected",
    "id":"e007bf91-f78d-459d-a48d-408982f886f1",
    "externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
    "appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
    "fullName": "John Back",
    "previousStatus": "COMPLETED",
    "newStatus": "REJECTED",
    "timestamp": 1737977546178
}
Name
Type
Description

id*

UUID

A unique applicant identifier

type*

String

externalUserId*

String

A unique applicant identifier on your side.

appKey*

UUID

A unique application identifier.

fullName

String

An Applicant Full Name

previousStatus*

String

newStatus*

String

timestamp*

Number

event time in milliseconds

applicantApproved

{
    "type":"applicantApproved",
    "id":"e007bf91-f78d-459d-a48d-408982f886f1",
    "externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
    "appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
    "fullName": "John Back",
    "previousStatus": "COMPLETED",
    "newStatus": "APPROVED",
    "timestamp": 1737977546178
}
Name
Type
Description

id*

UUID

A unique applicant identifier

type*

String

externalUserId*

String

A unique applicant identifier on your side.

appKey*

UUID

A unique application identifier.

fullName

String

An Applicant Full Name

previousStatus*

String

newStatus*

String

timestamp*

Number

event time in milliseconds

applicantCompleted

{
    "type":"applicantCompleted",
    "id":"e007bf91-f78d-459d-a48d-408982f886f1",
    "externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
    "appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
    "fullName": "John Back",
    "previousStatus": "INCOMPLETE",
    "newStatus": "COMPLETED",
    "timestamp": 1737977546178
}
Name
Type
Description

id*

UUID

A unique applicant identifier

type*

String

externalUserId*

String

A unique applicant identifier on your side.

appKey*

UUID

A unique application identifier.

fullName

String

An Applicant Full Name

previousStatus*

String

newStatus*

String

timestamp*

Number

event time in milliseconds

applicantStepPassed

{
    "type":"applicantStepPassed",
    "id":"e007bf91-f78d-459d-a48d-408982f886f1",
    "externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
    "appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
    "stepName": "liveness",
    "timestamp": 1737977546178
}
Name
Type
Description

id*

UUID

A unique applicant identifier

type*

String

externalUserId*

String

A unique applicant identifier on your side.

appKey*

UUID

A unique application identifier.

stepName*

String

timestamp*

Number

event time in milliseconds

applicantDuplicateDocument

{
    "type":"applicantDuplicateDocument",
    "id":"e007bf91-f78d-459d-a48d-408982f886f1",
    "externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
    "appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
    "warning": "APPLICANT_DUPLICATE_DOCUMENT",
    "timestamp": 1737977546178
}
Name
Type
Description

id*

UUID

A unique applicant identifier

type*

String

externalUserId*

String

A unique applicant identifier on your side.

appKey*

UUID

A unique application identifier.

fullName

String

An Applicant Full Name

warning*

String

timestamp*

Number

event time in milliseconds

expiredDocument

{
    "type":"expiredDocument",
    "id":"e007bf91-f78d-459d-a48d-408982f886f1",
    "externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
    "appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
    "warning": "EXPIRED_DOCUMENT",
    "timestamp": 1737977546178
}
Name
Type
Description

id*

UUID

A unique applicant identifier

type*

String

externalUserId*

String

A unique applicant identifier on your side.

appKey*

UUID

A unique application identifier.

fullName

String

An Applicant Full Name

warning*

String

timestamp*

Number

event time in milliseconds

additionalDocumentStepError

{
    "type":"additionalDocumentStepError",
    "id":"e007bf91-f78d-459d-a48d-408982f886f1",
    "externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
    "appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
    "warning": "ADDITIONAL_DOCUMENT_STEP_ERROR",
    "timestamp": 1737977546178
}
Name
Type
Description

id*

UUID

A unique applicant identifier

type*

String

externalUserId*

String

A unique applicant identifier on your side.

appKey*

UUID

A unique application identifier.

fullName

String

An Applicant Full Name

warning*

String

timestamp*

Number

event time in milliseconds

applicantDuplicateEmail

{
    "type":"applicantDuplicateEmail",
    "id":"e007bf91-f78d-459d-a48d-408982f886f1",
    "externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
    "appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
    "warning": "APPLICANT_DUPLICATE_EMAIL",
    "timestamp": 1737977546178
}
Name
Type
Description

id*

UUID

A unique applicant identifier

type*

String

externalUserId*

String

A unique applicant identifier on your side.

appKey*

UUID

A unique application identifier.

fullName

String

An Applicant Full Name

warning*

String

timestamp*

Number

event time in milliseconds

applicantDuplicatePhone

{
    "type":"applicantDuplicatePhone",
    "id":"e007bf91-f78d-459d-a48d-408982f886f1",
    "externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
    "appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
    "warning": "APPLICANT_DUPLICATE_PHONE",
    "timestamp": 1737977546178
}
Name
Type
Description

id*

UUID

A unique applicant identifier

type*

String

externalUserId*

String

A unique applicant identifier on your side.

appKey*

UUID

A unique application identifier.

fullName

String

An Applicant Full Name

warning*

String

timestamp*

Number

event time in milliseconds

amlPositiveCases

{
    "type":"amlPositiveCases",
    "id":"e007bf91-f78d-459d-a48d-408982f886f1",
    "externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
    "appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
    "warning": "AML_POSITIVE_CASES",
    "timestamp": 1737977546178
}
Name
Type
Description

id*

UUID

A unique applicant identifier

type*

String

externalUserId*

String

A unique applicant identifier on your side.

appKey*

UUID

A unique application identifier.

fullName

String

An Applicant Full Name

warning*

String

timestamp*

Number

event time in milliseconds

amlCannotStarted

{
    "type":"amlCannotStarted",
    "id":"e007bf91-f78d-459d-a48d-408982f886f1",
    "externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
    "appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
    "warning": "AML_CANNOT_STARTED",
    "timestamp": 1737977546178
}
Name
Type
Description

id*

UUID

A unique applicant identifier

type*

String

externalUserId*

String

A unique applicant identifier on your side.

appKey*

UUID

A unique application identifier.

fullName

String

An Applicant Full Name

warning*

String

timestamp*

Number

event time in milliseconds

amlResultUpdated

{
    "type":"amlResultUpdated",
    "id":"e007bf91-f78d-459d-a48d-408982f886f1",
    "externalUserId":"9bd44413-3309-4029-929e-f73b34d4",
    "appKey":"42d5860c-2b3f-4a70-a094-69965fbf5db0",
    "warning": "AML_RESULT_UPDATED",
    "timestamp": 1737977546178
}
Name
Type
Description

id*

UUID

A unique applicant identifier

type*

String

externalUserId*

String

A unique applicant identifier on your side.

appKey*

UUID

A unique application identifier.

fullName

String

An Applicant Full Name

warning*

String

timestamp*

Number

event time in milliseconds

PreviousWebhooksNextOpen API

Last updated