BRbreeze
Headless KYC

Get a KYC request by ID

Changed on

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/{id}

Request

Path parameters

idstring required

Headless KYC request ID (hkr_xxx)

Response

Success

status'SUCCEEDED' required

Changes

  • 4af083d182a6Revision 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