Headless KYC

Get a KYC request by customer reference ID

Changed on Nov 3, 2026

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

get/v1/headless_kyc

Request

Base URL
https://api.breeze.cash
Auth
HTTP basic
TypeScript
https://skmtc.dev/breeze/apis/breeze-api/docs/v1/headless_kyc/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

customerReferenceIdstring required

Response

Success

status'SUCCEEDED' required

Changes

Nov 3, 20264af083d182a6 Revision changes
- warning
  added the new pending_user_info enum value to the / response property for the response status
- info
  added the optional property / to the response with the status
- info
  removed the pending enum value from the / response property for the response status

Operation history