/
KYC document archived

KYC document archived
Webhook

Request

Security
SecretApiKey or JWT
Bodyapplication/json

Payload of KYC document-related webhook event.

customerIdstring, <= 50 characters(CustomerId)

ID of the customer resource.

Example:"cus_0YV7DDSDD1C8DA64KHH2W33CPF"
kycDocumentIdstring, <= 50 characters

ID of the KYC document.

Example:"kyc_doc_0YV7JHY705C6DA487BFTAA33V8"
fileIdstring, <= 50 characters

ID of the file.

Example:"file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N"
eventTypestring

Type of event that triggered the webhook.

Enum:"kyc-document-accepted""kyc-document-created""kyc-document-modified""kyc-document-rejected""kyc-document-reviewed""kyc-document-archived"
_embeddedobject

Embedded objects related to the KYC document event.

Payload
{
  "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
  "kycDocumentId": "kyc_doc_0YV7JHY705C6DA487BFTAA33V8",
  "fileId": "file_0YV7HZ7KDCC5WBV9Q7WRKG1H6N",
  "eventType": "kyc-document-accepted",
  "_embedded": {
    "customer": { … },
    "kycDocument": { … }
  },
  "_links": [
    { … }
  ]
}

Responses

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