Skip to main content
Use this endpoint when your client uses their own KYC provider instead of the platform’s built-in provider. Calling this endpoint creates a compliance tracking record on our side and returns a unique reference. Your client must pass this reference to their KYC provider as the external user identifier (e.g. externalUserId, correlationId, or equivalent) when starting the verification session. When the customer completes verification, the provider sends a webhook to the platform. We use the reference echoed back in that webhook to match the result to the correct customer record and close the outstanding KYC rule.

​
Request Body

​
Response

The response data object contains a reference string. If you passed a correlationId, the reference echoes it back. If you did not, it is a platform-generated UUID. Either way, pass this value to your KYC provider as the external user identifier so the platform can match the webhook result to the correct customer.
Option B clients (own KYC provider): Pass your internal profile ID or user ID as correlationId. Your KYC provider must send it back as the external user identifier in the webhook payload. The platform uses this to link the verification result to the customer record.