BRbreeze
Headless KYC

Submit a proof of address for a customer (via document upload)

Changed on

Submits a proof-of-address document for a customer who has already been submitted for KYC.

The document is the only data to supply: the name and address sent for verification are read back from the customer's earlier KYC submission. Supplementary documentation does not change the customer's KYC status, and it does not create or advance a KYC request, so the response carries no identifier of its own — track the submission by the customerReferenceId you submitted under.

One document per submission. If the proof spans several pages or images, combine them into a single file (for example a multi-page PDF) before submitting. Submitting again does not add a page to the previous document — it sends a separate document for review.

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

To reference a document you host instead, use the Submit a proof of address for a customer (via document URL) endpoint.

post/v1/headless_kyc/proof_of_address/upload

Request

Headers

Content-Typestring
Example:multipart/form-data

The content type of the request

Acceptstring
Example:application/json

The content type of the response

Request body multipart/form-data

documentstring binary required

Proof-of-address document file. Supported formats: JPEG, PNG, HEIC, PDF. Exactly one file per submission — combine multi-page proof into a single file.

Response

Success

status'SUCCEEDED' required

Changes