BRbreeze
Headless KYC

Submit KYC for a customer (via image URL)

Changed on

Submits KYC data for a customer on behalf of the merchant. Only TIER_2 is supported. Idempotent on customerReferenceId.

This API spec details the request body for the application/json content type. For the multipart/form-data content type, please refer to the Submit KYC for a customer (via image upload) endpoint.

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

Request

Request body

customerReferenceIdstring required
tier'TIER_2' required
emailstring email required
firstNamestring required
lastNamestring required
middleNamestring
dateOfBirthstring required
countrystring required
phoneNumberstring required
taxIdstring

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