Boarding application statuses
Intelligent boarding is in beta. To opt in, reach out to your Payabli contact.
A boarding application moves through a series of statuses, from the moment it’s created until its requested services are live. Application responses return the status as a lowercase name in applicationStatus and as a number in applicationStatusCode. Responses from lifecycle actions, such as submitting or withdrawing an application, return the new applicationStatus.
For how applications relate to businesses, people, templates, and paypoints, see the Intelligent boarding overview.
Application statuses
The Status column contains the value of applicationStatus, and the Code column contains the value of applicationStatusCode.
How an application moves between statuses
Three kinds of actors move an application from one status to the next:
- You: your integration calls a lifecycle endpoint.
- Payabli or Enterprise Partner: Payabli’s underwriting team, or an Enterprise Partner’s, acts on the application.
- Automatic: Payabli’s systems move the application without anyone acting on it.
An application in denied, withdrawn, or activated doesn’t change status again.
Check which actions are allowed
Application responses and lifecycle action responses include an allowedActions array that lists the actions available in the application’s current status. The array can include actions that Payabli or its systems perform, which you can’t call through the API. These are actions, not statuses. For example, provideDocuments is how you respond when an application is in pendingdocuments. Check for one of these values before you call the matching endpoint:
Track status changes
To see how an application reached its current status, use Get application status history. The response lists every transition, oldest first, with the fromStatus, toStatus, what triggered the change, and any reason recorded with it. The transition that creates the application has a fromStatus of none.
Related resources
See these related resources to help you get the most out of Payabli.