Verification Request State Change

This webhook will be issued when a verification request in an order changes state. A completed state indicates that new data is now available on the order. A canceled state indicates that a verification was not able to be completed, but may have applicant-provided information and/or documents.

Payload

The payload of this webhook request is an object.

versionstringOptional

The version of the webhook payload

hookobjectOptional

dataobjectOptional

Response

200

any

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

The payload of this webhook request is an object.

The version of the webhook payload

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

1	{
2	"version": "2023-10-30",
3	"hook": {
4	"id": 123,
5	"event": "verification_request.state.change",
6	"target": "https://example.com/your-webhook-endpoint",
7	"triggered_at": "2025-01-01T12:00:00Z"
8	},
9	"data": {
10	"order_id": "order_123",
11	"state": "completed",
12	"verification_request_id": "verification_request_456",
13	"credentials_session_token": "credentials_session_token_789",
14	"metadata": {
15	"test_key": "test_value"
16	}
17	}
18	}

1	{
2	"version": "2023-10-30",
3	"hook": {
4	"id": 123,
5	"event": "verification_request.state.change",
6	"target": "https://example.com/your-webhook-endpoint",
7	"triggered_at": "2025-01-01T12:00:00Z"
8	},
9	"data": {
10	"order_id": "order_123",
11	"state": "completed",
12	"verification_request_id": "verification_request_456",
13	"credentials_session_token": "credentials_session_token_789",
14	"metadata": {
15	"test_key": "test_value"
16	}
17	}
18	}