API Reference

Submit KYC for a customer (via image upload)

post
https://api.breeze.cash/v1/headless_kyc?

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 multipart/form-data content type. For the application/json content type, please refer to the Submit KYC for a customer (via image URL) 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

These document types require both front and back image files.

data
object
required

Must be serialized as a JSON string.

file
required

Front document image file. Supported formats: JPEG, PNG, HEIC.

file
required

Back document image file. Supported formats: JPEG, PNG, HEIC.

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?