For archived content, access the previous documentation here or the previous API reference here.

Account holder KYC status notification webhook

Prev Next
Post
/your_account_holder_kyc_webhook_url

These events will be sent when there is an update on a sub-account's KYC status

Security
HTTP
Type basic
Body parameters
Account Holder KYC Callback
{
  "event": "account_holder.kyc.status",
  "created": "2021-01-01T10:00:00Z",
  "business_id": "5fe2b0137b7d62542fe6d7de",
  "data": {
    "id": "57fb4e076fa3fa296b7f5a97",
    "created": "2021-01-01T10:00:00Z",
    "updated": "2021-01-01T10:00:00Z",
    "kyc": {
      "status": "PASSED",
      "verified_at": "2021-01-01T10:00:00Z",
      "requested_at": "2021-01-01T10:00:00Z",
      "kyc_passed_at": "2021-01-01T10:00:00Z"
    }
  }
}
Expand All
object
event
string

Event that occurred for this webhook

Valid values[ "account_holder.kyc.status" ]
Exampleaccount_holder.kyc.status
business_id
string

ID of your Account, use this in the for-user-id header to create transactions on behalf of your Account

created
string

Timestamp of when the webhook was sent

updated
string

Timestamp of when the webhook was updated

data
object
id
string

The unique ID of an Account Holder object

created
string

Timestamp of when the webhook was sent

updated
string

Timestamp of when the webhook was updated

kyc
object (xenPlatform_account_holder_kyc_response)
status
string
Valid values[ "PASSED", "FAILED", "RESUBMISSION_REQUIRED" ]
requested_at
string

Timestamp of when the object was updated

kyc_passed_at
string

Timestamp of when the object was updated

verified_at
string

Timestamp of when the object was updated

capabilities
Array of object (xenPlatform_account_holder_capability_response)
object

An object containing the details of the Account Holder capabilities activation process

type
string
channel_code
string
status
string
Valid values[ "LIVE", "VERIFICATION_IN_PROGRESS", "RESUBMISSION_REQUIRED", "DECLINED" ]
activated_at
string

Timestamp of when the object was updated

verified_at
string

Timestamp of when the object was updated

requested_at
string

Timestamp of when the object was updated

Responses
200

OK