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

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 upload the document directly instead, use the Submit a proof of address for a customer (via document upload) endpoint.

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

Proof of address submission details

string
required
length ≤ 255
uri
required
length ≤ 2048
Responses

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