Skip to main content
POST
Create QES Session Link
For a usage description of the QES Onboarding Create Session Link Service, please refer to the QES Onboarding page.

Endpoint

POST /onboarding/createSessionLink

Swagger

Authorizations

Authorization
string
header
required

Bearer token obtained from POST /auth. Valid for 60 minutes.

Body

application/json
email
string<email>
required

User's email address.

Example:

"user@example.com"

phoneNumber
string
required

User's phone number (E.164 format).

Pattern: ^\+?[1-9]\d{1,14}$
Example:

"+436769556026"

redirectUrl
string<uri>
required

URL to redirect user to after signing.

Example:

"https://example.com/onboarding/success"

docUrl
string<uri>
required

Public HTTPS URL of the PDF to sign. Must be accessible without auth headers.

Pattern: ^https://
Example:

"https://cdn.idcanopy.com/pdf/onb-t3.pdf"

signForms
object[]

Signature fields in the PDF (AcroForm field IDs).

fillForm
object[]

Pre-fillable text fields in the PDF.

Response

Session link successfully created

status
boolean
required

Whether the request was successful.

data
object
required