OZozav
Customers

List a customer's supporting documents

Lists a customer's uploaded supporting documents, using the standard cursor pagination. Returns a Page of CustomerDocument. Never returns the raw storage location or a download URL.

get/customers/{customer_id}/documents

Request

  • Base URL
    https://developers.ozav.io/v2
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Query parameters

limitinteger

Page size.

starting_afterstring

Opaque cursor returned as next_cursor on the previous page.

Response

Customer documents.

has_moreboolean required

True when more results exist beyond this page - keep paging with starting_after.

next_cursorstring nullable

Opaque cursor for the next page; pass it as starting_after. Null on the last page.

still_requiredCustomerDocumentType[]

The document categories this customer still owes, computed over all of its documents rather than the page you are reading, so paging does not change the answer. A document counts only once its bytes have arrived: one you declared but never uploaded, and one that failed review, both still appear here.

Read its absence carefully. An empty array and a missing field mean opposite things. An empty array says the customer owes nothing. The field is omitted when OZAV does not model a required set for this customer, which today means only a type that is neither individual nor business. Individuals and businesses of any country are modelled. Omitted never means "nothing is required": it means we will not guess. It is also omitted if the summary could not be computed, so that a failed read can never be read as a clean bill.

The set depends on the customer and the jurisdiction. An individual owes a photo ID and a proof of address (plus a tax return above the high-volume threshold). A business owes its incorporation papers, and its ownership registry where the country and legal form keep them as separate documents. A business registered in Brazil additionally owes the financial pack the local account rail requires. This is guidance, not the gate. The 422 from account opening remains the authoritative checklist, and this list is built to never ask for less than that 422 will.

Example response

{
  "data": [
    {
      "id": "ozav_doc_01J8Z9K2M3N4P5Q6R7S8T9U0V1"
    }
  ],
  "still_required_by_person": [
    {
      "associated_person_id": "ozav_per_01J8Z9K2M3N4P5Q6R7S8T9U0V1",
      "pending": [
        {
          "doc_type": "proof_of_address",
          "state": "rejected",
          "reason": "Issued more than 90 days ago."
        }
      ]
    }
  ],
  "pending": [
    {
      "doc_type": "proof_of_address",
      "state": "rejected",
      "reason": "Issued more than 90 days ago."
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.