Events

When configuring a webhook, you can choose which events you want to receive payloads for. Subscribing only to the specific events you plan to handle is useful in order to reduce the number of HTTP requests your server is going to process. You can change the list of subscribed events through the app manager at any time.

Events

List of available events

Event

Description

Scope failed

When user's scope state change to failed

Scope verified

When user's scope state change to verified

Scope expired

When user's scope state change to expired

Revoke access

When a user revoke your app

Certificate ready

When a certificate is ready for download

AML Monitoring

When AML checks are updated for a given user

We add a secret query parameters when we call your webhook URL. Secret can be found in your webhook details. It adds an extra layer of security to prove that this is Synaps that is calling this endpoint.

Scope Failed

API Request

Field

Type

Description

uuid

string

Unique User Identifier (UUID) involved

scope

string

Scope involved identity, residency, corporate, phone, email

document

string

ONLY identity / residency scope

Identity

national_id

passport

driver_license

resident_permit

Residency

utility_bill bank_statement

government_document

corporate_id

int

ONLY corporate scope

Corporate Unique Identifier

state

string

FAILED

Scope Expired

Field

Type

Description

uuid

string

Unique User Identifier (UUID) involved

scope

string

Scope involved identity, residency, corporate, phone, email

document

string

ONLY identity / residency scope

Identity

national_id

passport

driver_license

resident_permit

Residency

utility_bill bank_statement

government_document

corporate_id

int

ONLY corporate scope

Corporate Unique Identifier

state

string

EXPIRED

Scope Verified

Field

Type

Description

uuid

string

Unique User Identifier (UUID) involved

scope

string

Scope involved identity, residency, corporate ,phone, email

document

string

ONLY identity and residency scope

Identity

national_id

passport

driver_license

resident_permit

Residency

utility_bill bank_statement

government_document

corporate_id

int

ONLY corporate scope

Corporate Unique Identifier

state

string

VERIFIED

App Revoked

API Request

Field

Type

Description

uuid

string

Unique User Identifier (UUID) involved

AML Monitoring

API Request

Field

Type

Description

uuid

string

Unique User Identity (UUID) involved

Certificate ready

API Request

Field

Type

Description

cuid

string

Certificate Unique Identifier (CUID) involved