/
KYC request failed

KYC request failed
Webhook

Request

Security
SecretApiKey or JWT
Bodyapplication/json

Payload of KYC request-related webhook event.

customerIdstring, <= 50 characters(CustomerId)

ID of the customer resource.

Example:"cus_0YV7DDSDD1C8DA64KHH2W33CPF"
kycRequestIdstring, <= 50 characters

ID of the KYC request.

Example:"kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5"
eventTypestring

Type of event that triggered the webhook.

Enum:"kyc-request-attempted""kyc-request-failed""kyc-request-fulfilled""kyc-request-partially-fulfilled"
_embeddedobject

Embedded objects related to the KYC request event.

Payload
{
  "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
  "kycRequestId": "kyc_req_0YV7JMJ3DBCGRBR7K9D4HVGPP5",
  "eventType": "kyc-request-attempted",
  "_embedded": {
    "customer": { … },
    "kycRequest": { … }
  },
  "_links": [
    { … }
  ]
}

Responses

Returns any 2xx status to indicate that data is received.