Retrieve application by link ID

GET

/Boarding/linkbyId/:boardingLinkId

Retrieves details for a boarding link, by ID.

Authentication

requestTokenstring

API Key authentication via header

Path parameters

boardingLinkIdintegerRequired

The boarding link ID. You can find this at the end of the boarding link reference name. For example https://boarding.payabli.com/boarding/app/myorgaccountname-00091. The ID is 91.

Response

Success

acceptOauthboolean

acceptRegisterboolean

builderDataobject

entryAttributesstring

idlong

logoobject

Object containing logo file.

orgIdlong

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

pageIdentifier:string

Auxiliary validation used internally by payment pages and components.

recipientEmailNotificationboolean

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

referenceTemplateIdlong

resumableboolean

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

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	}

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	}

$	curl https://api-sandbox.payabli.com/api/Boarding/linkbyId/91 \
>	-H "requestToken: <apiKey>"