Answers a request for supporting documents with 1 to 5 uploaded files and an optional message. The request then waits for our review (status: submitted); we accept the documents (approved) or ask for more (requested again, with a reason and the next round).

A request that does not wait for you (submitted or approved) answers 409 documents_not_requested.

Parameters

NameInTypeRequiredDescription
companyId path string (uuid) yes

Your company that Payca enabled for Virtual IBAN.

requestId path string (uuid) yes

The requestId of a documents object whose status is requested.

Request body

application/json · object · required

FieldTypeRequiredDescription
fileIds array of string (uuid) yes

Files uploaded with POST …/documents/files and not submitted yet.

message string no

Responses

StatusBodyDescription
200 VirtualIbanDocuments

The request with what was submitted.

400 VirtualIbanError

The request was refused; code says why (see errors).

401 —

Missing or invalid x-client-id / x-client-secret (no body).

403 VirtualIbanError

The request was refused; code says why (see errors).

404 VirtualIbanError

The request was refused; code says why (see errors).

409 VirtualIbanError

The request was refused; code says why (see errors).

Specification

This page is generated from the OpenAPI specification, which remains the authoritative machine-readable source.