Skip to navigation

List application document requirements

Beta
View as MarkdownOpen in Claude

Lists the documents an application asks for, from its template and from Payabli business rules. For example, a business with an annual revenue of $1,000,000 or more needs bank statements. Each requirement gives the fieldPath and subject to send when you upload, the formats it accepts, how many documents it takes, and how many are uploaded so far.

A person requirement appears once for each owner of the business, with that owner’s personReference. The list is empty when the application asks for no documents.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

requestsReferencestringRequired
The application reference.

Response

The application's document requirements.
successboolean
Whether the request succeeded.
messagestring or null

A human-readable result message.

traceIdstring or null
The trace identifier for the request, useful for support.
datalist of objects
The application's document requirements. Empty when the application asks for no documents.

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error