API referencePay Ops endpointsBoardingBoarding apps

Retrieve application by link ID

Retrieves details for a boarding link, by ID.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

boardingLinkIdintegerRequired

The boarding link ID. Can be found at the end of the boarding link reference name. The boarding link reference name. For example https://boarding.payabli.com/boarding/app/myorgaccountname-00091. The ID is 91.

Response

Success
acceptOauthbooleanOptional
acceptRegisterbooleanOptional
builderDataobjectOptional
entryAttributesstringOptional
idlongOptional
orgIdlongOptional
Organization ID. Unique identifier assigned to an org by Payabli.
pageIdentifier:stringOptional
Auxiliary validation used internally by payment pages and components.
recipientEmailNotificationbooleanOptional

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.

referenceNamestringOptional
referenceTemplateIdlongOptional
resumablebooleanOptional

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.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error