Search…
⌃K
Links

Webhooks

In some cases (see examples below), we will send webhooks to the configured link associated to your partner account.
Some of the event that will send a webhook are:
  • Identity updates;
  • Identity KYC updates;
  • Transaction updates;
  • Activated operations;
  • etc.

Activated operations

When an identity reaches a KYC status that is required for an operation to be activated, a webhook will be sent with the following information:
data: {
operations: [{
action: 'create',
code: 'deposit:wire'
}]
},
type: 'operationActivated'

Identity verification created

When a KYC verification is created for a specific identity, a webhook will be sent with the following information:
data: {
identityId: 'ab86bab9-e479-4dcf-8e29-264d355d1d36',
verificationId: '9776d638-dbbe-4546-9d1f-264e7472b84e'
},
type: 'identityVerificationCreated'

Identity verification updated

When a KYC verification is updated for a specific identity, a webhook will be sent with the following information:
data: {
identityId: 'ab86bab9-e479-4dcf-8e29-264d355d1d36',
verificationId: '9776d638-dbbe-4546-9d1f-264e7472b84e'
},
type: 'identityVerificationUpdated'

Identity exception raised

When an exception is raised in the KYC of an identity, a webhook will be sent with the following information:
data: {
exceptions: ['manual_review_required'],
identityId: '9776d638-dbbe-4546-9d1f-264e7472b84e'
},
type: 'identityExceptionRaised'