Initiate Cl@ve
Initiates the Cl@ve identity verification process for a tenant.
Asynchronous Operation
This endpoint initiates an Asynchronous process. The API response confirms that the Cl@ve flow has been started, While document downloads are completed in the background.
How this flow works:
- Provide a
redirect_urlwhere the tenant should be redirected after completing verification. - The API will respond with a verification link.
- Redirect the tenant to the provided link.
- The tenant completes identity verification by entering their details on the Cl@ve page.
- After successful verification, identity documents are automatically downloaded.
- Once the process is complete, call Get Tenant Documents to retrieve the downloaded documents.
Important:
- The
redirect_urlmust be a valid, publicly accessible URL. - Document availability depends on successful completion of the Cl@ve flow.
- This endpoint only initiates the process; it does not return documents immediately.
Clave completion webhook:
When Clave flow is completed successfully, a webhook event
CLAVE_SUCCESS is sent.
The webhook payload contains:
event: Event name (CLAVE_SUCCESS)data: null (This webhook event is used only to indicate that the Clave flow has completed successfully and documents are downloaded)
The configured webhook endpoint must accept POST requests.
Authorizations
HTTP Bearer Authentication. Pass the token generated via
/keys/generate-token as Authorization: Bearer <token>.
Path Parameters
Body
URL to redirect the tenant after completing Cl@ve verification
"https://yourapp.com/kyc/callback"