Headless KYC

Initiate Tier 3 verification for a KYC request

Changed on

Starts the user-facing part of a Tier 3 KYC request and returns the request with its actionLink: a hosted verification link the end user must open to complete the Tier 3 identity checks.

Tier 3 requests are raised by Breeze, not submitted by the merchant. A new Tier 3 request is created in the pending_user_info status and announced through the HEADLESS_KYC_STATUS_UPDATED webhook; call this endpoint with its id when you are ready to send the user through verification. Only requests with tier set to TIER_3 are accepted — any other request ID is answered with RESOURCE_NOT_FOUND.

The call is idempotent and safe to repeat: while the request is pending_user_info, every call returns a usable actionLink. A verification link expires after some time; when that happens the next call issues a replacement, so always hand the user the actionLink from the most recent response rather than one stored earlier. Once the request has left pending_user_info (the user completed verification, or Tier 3 was approved by other means) the request is returned as-is and no link is issued.

Status changes after the user completes the link are delivered through the HEADLESS_KYC_STATUS_UPDATED webhook, exactly as for Tier 2 requests.

Note: This endpoint is only available to merchants configured by the Breeze team. Please reach out to the Breeze team to find out more.

post/v1/headless_kyc/{id}/initiate_tier_3_kyc

Request

Path parameters

idstring required

Headless KYC request ID (hkr_xxx) of a Tier 3 request

Response

Success

status'SUCCEEDED' required

Changes