Sign in
Verifications

Verification Succeeded

Sent when a verification is succeeded

Required permissions:

  • payout:account:read
  • webhook_receive:verifications
postWebhookverification.succeeded

Headers

webhook-idstring required

A unique identifier for this webhook request

Example:msg_xxxxxxxxxxxxxxxxxxxxxxxx
webhook-signaturestring required

The signature of the webhook request with the webhook version prepended

Example:v1,BASE64ENCODEDSIGNATURE
webhook-timestampstring required

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

Example:1727606400

Payload

api_version'v1' required

The API version for this webhook

company_idstring nullable

The company ID that this webhook event is associated with

idstring required

A unique ID for every single webhook request

timestampstring date-time required

The timestamp in ISO 8601 format that the webhook was sent at on the server

type'verification.succeeded' required

The webhook event type

Example payload

{
  "api_version": "v1",
  "company_id": "biz_xxxxxxxxxxxxxx",
  "data": {
    "id": "verf_xxxxxxxxxxxxx",
    "last_error_reason": "Document image was too blurry to read."
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "verification.succeeded"
}

Response

Return a 200 status to indicate that the data was received successfully

Changes