PApayabli
Applications

List application document requirements

Changed on

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.

get/v2/requests/{requestsReference}/documents/requirements

Request

  • Base URL
    https://api-sandbox.payabli.com/api
  • URL
    https://api-sandbox.payabli.com/api/v2/requests/{requestsReference}/documents/requirements
  • Auth
    HTTP bearer

Path parameters

requestsReferencestring required

The application reference.

Response

The application's document requirements.

successboolean required

Whether the request succeeded.

messagestring nullable required

A human-readable result message.

traceIdstring nullable required

The trace identifier for the request, useful for support.

Changes