Skip to main content
POST
/
onboarding
/
createSessionLink
Create QES Session Link
curl --request POST \
  --url https://sandbox-umbrella-api.azurewebsites.net/api/services/onboarding/createSessionLink \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "support@idcanopy.com",
  "phoneNumber": "+436508021530",
  "redirectUrl": "https://example.com/onboarding/success",
  "docUrl": "https://cdn.idcanopy.com/pdf/onb-t3.pdf",
  "signForms": [
    {
      "fieldId": "Signature1",
      "actorId": "userToIdentify"
    },
    {
      "fieldId": "Signature2",
      "actorId": "userToIdentify"
    }
  ],
  "fillForm": [
    {
      "fieldId": "name",
      "value": "${identification.firstName}"
    },
    {
      "fieldId": "surname",
      "value": "${identification.lastName}"
    }
  ]
}
'
{
  "status": true,
  "data": {
    "requestId": "123e4567-e89b-12d3-a456-426614174000",
    "url": "https://example.com/api/v2/actorTrip/urlback?t=EXAMPLE_TOKEN",
    "expiresAfter": "2025-07-30T08:55:52.520909994Z"
  }
}
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 authentication header of the form Bearer <token>, where <token> is your auth token.

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).

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.

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