Get or send boarding link
Retrieves a link and the verification code used to log into an existing boarding application. You can also use this endpoint to send a link and referenceId for an existing boarding application to an email address. The recipient can use the referenceId and email address to access and edit the application.
Authentication
requestTokenstring
API Key authentication via header
Path parameters
appId
Boarding application ID.
mail2
Email address used to access the application. If sendEmail parameter is true, a link to the application is sent to this email address.
Query parameters
sendEmail
If true, sends an email that includes the link to the application to the mail2 address. Defaults to false.
Response
Success
responseText
Response text for operation: ‘Success’ or ‘Declined’.
isSuccess
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
pageIdentifier
Auxiliary validation used internally by payment pages and components.
responseCode
Code for the response. Learn more in API Response Codes.
responseData
The object containing the response data.
