Get boarding link by reference

from payabli import payabli
client = payabli(
    api_key="YOUR_API_KEY_HERE",
)
client.boarding.get_link_application(
    boarding_link_reference="myorgaccountname-00091",
)

{
  "acceptOauth": false,
  "acceptRegister": false,
  "builderData": {
    "attributes": {
      "minimumDocuments": 1,
      "multipleContacts": true,
      "multipleOwners": true
    }
  },
  "entryAttributes": "entryAttributes",
  "id": 1000000,
  "logo": {
    "fContent": "TXkgdGVzdCBmaWxlHJ==...",
    "filename": "my-doc.pdf",
    "ftype": "pdf",
    "furl": "https://mysite.com/my-doc.pdf"
  },
  "orgId": 123,
  "pageIdentifier:": "null",
  "recipientEmailNotification": true,
  "referenceName": "payabli-00710",
  "referenceTemplateId": 1830,
  "resumable": false
}

Retrieves the details for a boarding link, by reference name. This endpoint requires an application API token.

Authentication

requestTokenstring

API Key authentication via header

Path parameters

boardingLinkReferencestringRequired

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

acceptOauthboolean or null

acceptRegisterboolean or null

builderDataobject or null

entryAttributesstring or null

idlong or null

logoobject or null

Object containing logo file.

orgIdlong or null

Organization ID. Unique identifier assigned to an org by Payabli.

pageIdentifier:string or null

Auxiliary validation used internally by payment pages and components.

recipientEmailNotificationboolean or null

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.

referenceNamestring or null

referenceTemplateIdlong or null

resumableboolean or null

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.

Authentication

Path parameters

Response

Errors