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

Headers

​
webhook-id
string
required

A unique identifier for this webhook request

Example:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

​
webhook-signature
string
required

The signature of the webhook request with the webhook version prepended

Example:

"v1,BASE64ENCODEDSIGNATURE"

​
webhook-timestamp
string
required

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

Example:

"1727606400"

Body

application/json
​
id
string
required

A unique ID for every single webhook request

Example:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

​
api_version
string
required

The API version for this webhook

Allowed value: "v1"
Example:

"v1"

​
timestamp
string<date-time>
required

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

Example:

"2025-01-01T00:00:00.000Z"

​
type
string
required

The webhook event type

Allowed value: "verification.succeeded"
Example:

"verification.succeeded"

​
data
object
required

An identity verification session used to confirm a person or entity's identity for payout account eligibility.

​
company_id
string | null

The company ID that this webhook event is associated with

Example:

"biz_xxxxxxxxxxxxxx"

Response

200

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