LogoLogo
Status PageContact sales
DevelopersIntegration guidesEmbedded componentsSDKs & toolsAPI reference
  • Using the API
    • API overview
    • API responses
  • API
Status PageContact sales
APIPay Ops endpointsBoardingBoarding apps

GET
/Boarding/linkbyTemplate/:templateId
GET
/api/Boarding/linkbyTemplate/:templateId
1curl https://api-sandbox.payabli.com/api/Boarding/linkbyTemplate/80 \
2     -H "requestToken: <apiKey>"
Try it
1{
2  "acceptOauth": false,
3  "acceptRegister": false,
4  "builderData": {
5    "attributes": {
6      "minimumDocuments": 1,
7      "multipleContacts": true,
8      "multipleOwners": true
9    }
10  },
11  "entryAttributes": "entryAttributes",
12  "id": 1000000,
13  "logo": {
14    "fContent": "TXkgdGVzdCBmaWxlHJ==...",
15    "filename": "my-doc.pdf",
16    "ftype": "pdf",
17    "furl": "https://mysite.com/my-doc.pdf"
18  },
19  "orgId": 123,
20  "pageIdentifier:": "null",
21  "recipientEmailNotification": true,
22  "referenceName": "payabli-00710",
23  "referenceTemplateId": 1830,
24  "resumable": false
25}
Get details for a boarding link using the boarding template ID. This endpoint requires an application API token.
Was this page helpful?
Previous

Get or send boarding link

Next
Built with
Get or send boarding link
Get details for a boarding link using the boarding template ID. This endpoint requires an application API token.

Path parameters

templateIddoubleRequired
The boarding template ID. You can find this at the end of the boarding template URL in PartnerHub. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.

Headers

requestTokenstringRequired

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.

Errors

Get boarding link by template ID

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.

The boarding template ID. You can find this at the end of the boarding template URL in PartnerHub. Example: https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80. Here, the template ID is 80.