Events

Webhook Structure

FieldData TypeDescription
tenantIdguidtenant id
actionstringdescription of the event that triggered the webhook
idguidunique id of the webhook
resourceIdguidid of the object related to the "resourceType"
resourceTypestringAPI object related to the triggered event
createdAtUtcdate timetime of webhook creation
changesobjectevent specific data

Identity Events

Resource Type: Identity

Create

Action: Create

Changes

  • Empty object

Update

Action: Update

Changes

  • complianceStatus? - (Optional)
  • rejectionReasons? - Array of strings (Optional)

Document Events

Create

Resource Type: Document
Action: Create

Changes

  • Empty object

Payment Events

Create

Resource Type: Payment
Action: Create

Changes

  • paymentStatus
  • paymentType
  • createdAt - ISO 8601 date-time format

Transaction Events

Resource Type: Transaction

Create

Action: Create

Changes

  • transactionStatus
  • transactionType
  • createdAt - ISO 8601 date-time format
  • paymentId - UUID
  • amount - Decimal number as string
  • cryptoAmount - Decimal number as string
  • returnCode? - string (Optional)
  • transactionHash? - string (Optional)
  • price? - Decimal number as string (Optional)

Update

Action: Update

Changes

  • transactionStatus
  • transactionType
  • createdAt - ISO 8601 date-time format
  • paymentId - UUID
  • amount - Decimal number as string
  • cryptoAmount - Decimal number as string
  • updatedAt - ISO 8601 date-time format
  • returnCode? - string (Optional)
  • transactionHash? - string (Optional)
  • price? - Decimal number as string (Optional)