Update app
Legacy boarding is deprecated and will be sunset in Q2 2027. Update the record that holds the data instead, such as the business or a person. Use Update an application only for the application’s own fields.
Updates a boarding application by ID. This endpoint requires an application API token.
If you send ownership, it replaces the application’s owners. Include every owner, and set primaryOwner again on the primary owner, or the application loses its primary owner. If you leave ownership out, the owners don’t change.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Long-lived API token sent in the requestToken header. See API token authentication.
Path parameters
Request
Array of fileContent objects with attached documents. Max upload size is
30 MB.
Business country in ISO-3166-1 alpha 2 format. See ISO 3166-1 for more information.
Numeric percent of volume processed in person. To pass validation,
binperson, binweb, and binphone must total 100 together.
Numeric percent of volume processed by phone. To pass validation,
binperson, binweb, and binphone must total 100 together.
Numeric percent of volume processed on web. To pass validation,
binperson, binweb, and binphone must total 100 together.
Business Merchant Category Code (MCC). This resource lists MCC codes.
List of Owners with at least a 25% ownership.
The total number of bills the business pays each month. For example, if your business pays an electric bill of $500, an internet bill of $150, and various suppliers $5,000 every month then your monthly bill volume would be $5,650.
The average amount of each bill you pay through our service. For example, if your business paid 3 bills for a total of $1,500 then your average bill size is $500.
The maximum amount of credit that our lending partner has authorized to the business for on-demand payouts. It’s the upper boundary on how much you can spend or owe on a credit account at any given time.
The largest amount for a bill you will pay through our service. For example, if your business paid for 3 bills each month for $500, $1000, and $5000 respectively, then your highest ticket is $5000.
When true, Payabli will send the applicant a boarding link. Set this
value to false if you are sending pre-filled applications via the API
and don’t want Payabli to send the applicant an email to complete the
boarding application.
When true, the applicant can save an incomplete application and
resume it later. When false, the applicant won’t have an option to
save their progress, and must complete the application in one session.
Business start date. Accepted formats:
- YYYY-MM-DD
- MM/DD/YYYY
The average transaction size that the business expects to process. For example, if you process $10,000 a month across 10 transactions, that’s an average ticket of $1000.
The business website address. Include only the domain and TLD, do not
enter the protocol (http/https). For example: www.example.com is
acceptable.
Actions to take when the application is created. The only currently
supported option is submitApplication. Use this when you have collected
eSignature elsewhere or are adding additional locations for an applicant,
or when you want to submit an application via API with one call without
using the hosted boarding UI or embedded boarding components. Pass the
value as an array, for example ["submitApplication"].
Response
Response text for operation: ‘Success’ or ‘Declined’.
Code for the response. Learn more in API Response Codes.
Describes the room ID. Only in use on Boarding endpoints, returns 0 when not applicable.
Boolean indicating whether the operation was successful. A true value
indicates success. A false value indicates failure.