QES Onboarding
Create a signing session, register a webhook, and fetch the verification result
What it returns
A hosted signing session link for a document, an optional webhook registration for status pings, and a verification/signature result once the session completes.
Request
POST /onboarding/createSessionLink
| Field | Required | Description |
|---|---|---|
email | yes | User's email |
phoneNumber | yes | E.164 format |
redirectUrl | yes | Redirect target after signing |
docUrl | yes | Public HTTPS URL of the PDF to sign, reachable without auth headers |
signForms | no | AcroForm signature fields (fieldId, actorId) |
fillForm | no | Pre-fillable text fields (fieldId, value) |
POST /onboarding/configureWebhook, { "webhookUrl": "https://your-own-endpoint" }. Use your
own endpoint here, not an IDCanopy-owned host.
GET /onboarding/getVerification/{sessionId}, path parameter only.
Response
createSessionLink returns data.url (the signing wizard link), data.expiresAfter,
data.requestId. configureWebhook returns data.id, data.url, data.createdAt.
getVerification returns data.isVerified, data.status (completed, cancelled, error),
data.identification (KYC result including personData and per-field validationDetail), and
data.signature.content[] (per-document signing metadata).
Decision
The caller decides from data.status and data.isVerified.
Test cases
Pending.