Get boarding link by reference
Retrieves the details for a boarding link, by reference name. This endpoint requires an application API token.
Path parameters
boardingLinkReference
The boarding link reference name. You can find this at the end of the boarding link URL. For example https://boarding.payabli.com/boarding/app/myorgaccountname-00091
Response
Success
acceptOauth
acceptRegister
builderData
entryAttributes
id
logo
Object containing logo file.
orgId
Organization ID. Unique identifier assigned to an org by Payabli.
pageIdentifier:
Auxiliary validation used internally by payment pages and components.
recipientEmailNotification
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.
referenceName
referenceTemplateId
resumable
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