API Reference

Submit KYC for a customer (via image URL)

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 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.

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

KYC submission details

string
required
length ≤ 255
const
enum
required
Allowed:
string
required
length ≤ 255
string
required
length ≤ 100
string
required
length ≤ 100
string
length ≤ 100
string
required
string
required
string
required
length ≤ 20
address
object
required
string
required
length between 4 and 50
document
required
consent
object
required
Responses

Updated about 1 month ago

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 about 1 month ago