🪪 KYC Webhooks

🚧
This section applies only to partners using the Whitelabel API integration.

Quick Links:


🪪 KYC Events	🌐 Webhook Response
📄 Sample Response (With `partnerCustomerId`)	🧾 Sample Response (Without `partnerCustomerId`)

KYC Events

The following event IDs are triggered during the KYC lifecycle and sent via webhook:

Event ID	Description
`KYC_SUBMITTED`	Triggered when a user submits their KYC details
`KYC_APPROVED`	Triggered when the user’s KYC verification is approved
`KYC_REJECTED`	Triggered when the user’s KYC verification is rejected

(Optional) Passing `partnerCustomerId` in Quote API

If you provide partnerCustomerId in the Quote API request, it will be returned in the webhook response alongside partnerUserId.

Example

curl --location 'https://api-gateway-stg.transak.com/api/v2/lookup/quotes?apiKey=&fiatCurrency=EUR&cryptoCurrency=USDC&isBuyOrSell=BUY&network=ethereum&paymentMethod=sepa_bank_transfer&fiatAmount=50&partnerCustomerId=12345'

Webhook Response

Mandatory Fields : kycStatus, eventID, partnerUserId

Optional Fields :partnerCustomerId (returned only if provided in the request)

{
  "data": {
    "kycStatus": "string",
    "eventID": "string",
    "partnerUserId": "string",
    "partnerCustomerId": "string"
  }
}

Sample Response (With `partnerCustomerId`)

Webhook Events Code	KYC Status	Description	Response JSON
KYC_SUBMITTED	`SUBMITTED`	Triggered when a user submits their KYC details.	{ data:{ kycstatus:'SUBMITTED', eventID:'KYC_SUBMITTED', partnerUserId:'0870c29f-75a8-4091-a068-775fa4577172’,  PartnerCustomerId: ‘12345’ } }
KYC_APPROVED	`APPROVED`	Triggered when the user’s KYC verification is approved	{ data:{ kycstatus:’APPROVED’, eventID:'KYC_APPROVED', partnerUserId:'0870c29f-75a8-4091-a068-775fa4577172’,  PartnerCustomerId: ‘12345’ } }
KYC_REJECTED	`REJECTED`	Triggered when the user’s KYC verification is rejected	{ data:{ kycstatus:’REJECTED’, eventID:'KYC_REJECTED', partnerUserId:'0870c29f-75a8-4091-a068-775fa4577172’,  PartnerCustomerId: ‘12345’ } }

Sample Response (Without `partnerCustomerId`)

Webhook Events Code	KYC Status	Description	Response JSON
KYC_SUBMITTED	`SUBMITTED`	Triggered when a user submits their KYC details.	{ data:{ kycstatus:'SUBMITTED', eventID:'KYC_SUBMITTED', partnerUserId:'0870c29f-75a8-4091-a068-775fa4577172' } }
KYC_APPROVED	`APPROVED`	Triggered when the user’s KYC verification is approved	{ data:{ kycstatus:’APPROVED’, eventID:'KYC_APPROVED', partnerUserId: '0870c29f-75a8-4091-a068-775fa4577172’, } }
KYC_REJECTED	`REJECTED`	Triggered when the user’s KYC verification is rejected	{ data:{ kycstatus:’REJECTED’, eventID:'KYC_REJECTED', partnerUserId:'0870c29f-75a8-4091-a068-775fa4577172’, } }

Updated about 1 hour ago