For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
API GuideAPI ReferenceChangelog
API GuideAPI ReferenceChangelog
  • API Reference
  • Webhook Reference
      • POSTThird Party Customer Status Updated Event
LogoLogo
Webhook ReferenceThird Party Customers

Third Party Customer Status Updated Event

Payload
1{
2 "event_id": "550e8400-e29b-41d4-a716-446655440000",
3 "event_type": "THIRD PARTY CUSTOMER STATUS",
4 "version": "v1.0.0",
5 "event_timestamp": "2025-07-17T10:30:00Z",
6 "data": {
7 "customer_id": "12345678901",
8 "client_customer_ref": "BUYER_ABC123",
9 "status": "REJECTED"
10 }
11}
Sent when a third party customer's compliance status changes to `APPROVED` or `REJECTED`. Subscribe to the `THIRD PARTY CUSTOMER STATUS` event type to receive these updates. The `data` object contains `customer_id`, `client_customer_ref`, and `status`. When the status is `REJECTED`, a `reasons` array is included with machine-readable codes and human-readable descriptions. **Example payloads:** <Accordion title="REJECTED"> ```json { "event_id": "1", "event_type": "THIRD PARTY CUSTOMER STATUS", "version": "v1.0.0", "event_timestamp": "2025-01-01T00:00:00Z", "data": { "customer_id": "0201001008132685", "client_customer_ref": "CUST_001", "status": "REJECTED", "reasons": [ { "reason": "Compliance check failed due to validation or regulatory issues", "code": "COMPLIANCE_CHECK_FAILED" } ] } } ``` </Accordion> <Accordion title="APPROVED"> ```json { "event_id": "3", "event_type": "THIRD PARTY CUSTOMER STATUS", "version": "v1.0.0", "event_timestamp": "2025-01-01T00:00:00Z", "data": { "customer_id": "0201001008132685", "client_customer_ref": "CUST_001", "status": "APPROVED" } } ``` </Accordion>
Was this page helpful?
Previous

Changelog

Next
Built with

Sent when a third party customer’s compliance status changes to APPROVED or REJECTED. Subscribe to the THIRD PARTY CUSTOMER STATUS event type to receive these updates.

The data object contains customer_id, client_customer_ref, and status. When the status is REJECTED, a reasons array is included with machine-readable codes and human-readable descriptions.

Example payloads:

REJECTED
1{
2 "event_id": "1",
3 "event_type": "THIRD PARTY CUSTOMER STATUS",
4 "version": "v1.0.0",
5 "event_timestamp": "2025-01-01T00:00:00Z",
6 "data": {
7 "customer_id": "0201001008132685",
8 "client_customer_ref": "CUST_001",
9 "status": "REJECTED",
10 "reasons": [
11 {
12 "reason": "Compliance check failed due to validation or regulatory issues",
13 "code": "COMPLIANCE_CHECK_FAILED"
14 }
15 ]
16 }
17}
APPROVED
1{
2 "event_id": "3",
3 "event_type": "THIRD PARTY CUSTOMER STATUS",
4 "version": "v1.0.0",
5 "event_timestamp": "2025-01-01T00:00:00Z",
6 "data": {
7 "customer_id": "0201001008132685",
8 "client_customer_ref": "CUST_001",
9 "status": "APPROVED"
10 }
11}

Payload

The payload of this webhook request is an object.
event_idstringRequired
Unique identifier for the event
event_typeenumRequired
Type of webhook event. Always "THIRD PARTY CUSTOMER STATUS" for third party customer status events.
Allowed values:
versionstringRequired
Payload version. Currently "v1.0.0". This enables controlled evolution of the webhook contract.
event_timestampdatetimeRequired

Timestamp of the event in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).

dataobjectRequired

Business data for the third party customer status event. Contains customer and status information. The reasons field is only present when the status is REJECTED.

Response

200
Webhook received successfully
400
Invalid payload