curl --request GET \
--url https://sandbox-umbrella-api.azurewebsites.net/api/services/onboarding/getVerification/{sessionId} \
--header 'Authorization: Bearer <token>'{
"status": true,
"data": {
"isVerified": true,
"status": "completed",
"message": "Verification completed",
"requestId": "64d35e63-fdf4-43f6-8459-1216787fb34e",
"signature": {
"content": [
{
"id": "e919520e-bb24-41c3-8a7b-88b3c8b0008b",
"method": "RemoteSignatureLongLivedDisposableCertificate",
"status": "COMPLETED",
"pageMode": "headless",
"signedAt": "2025-06-11T11:53:04.107687Z",
"plainResource": {
"id": "5a28c0e7-a57e-4bb5-88f3-6b6bb47c2cf7",
"name": "Document To Sign",
"type": "CONTRACT_DOCUMENT",
"family": "DOCUMENT_TO_SIGN",
"status": "AVAILABLE",
"subType": "DOCUMENT_FLATTENED",
"filename": "Onboarding_TEST.pdf",
"metadata": {
"sourceTemplateUrl": "https://files.example.com/Onboarding_TEST.pdf"
},
"mimeType": "application/pdf",
"sizeBytes": 138763,
"resourceUri": "nor://example/resource/5a28c0e7",
"resourceUrl": "https://example.com/storage/data/Onboarding_TEST.pdf",
"urlValidBefore": "2025-06-16T11:53:34.028Z"
},
"signedResource": {
"id": "60ab66ba-3b03-477c-8936-be55b15e890f",
"type": "CONTRACT_DOCUMENT",
"family": "SIGNED_DOCUMENT",
"status": "AVAILABLE",
"filename": "Onboarding_TEST.pdf",
"metadata": {
"fileId": "8168e8d7-ab7b-4c6f-b19e-2fe1418da0d1",
"workstep": "EXAMPLE_WORKSTEP_ID"
},
"mimeType": "application/pdf",
"sizeBytes": 207066,
"resourceUri": "nor://example/resource/60ab66ba",
"resourceUrl": "https://example.com/storage/data/Onboarding_TEST_signed.pdf",
"urlValidBefore": "2025-06-16T11:53:34.028Z"
}
}
]
},
"identification": {
"id": "2b307448-4880-4d3d-b9ab-0a438298c77a",
"actor": "userToIdentify",
"idSelf": {
"artifacts": {
"biometry": [],
"document": []
},
"biometryCheck": {
"keysWithError": [],
"controlsSummary": 0
},
"documentCheck": {
"documentType": "PASSPORT",
"documentTypeFamily": "IDENTITY_DOCUMENT",
"keysWithError": [],
"controlsSummary": 0
}
},
"source": "ID-SELF",
"status": "COMPLETED",
"personData": {
"email": "max.mustermann@example.com",
"gender": "M",
"firstName": "Max",
"lastName": "Mustermann",
"birthDate": "1971-01-01",
"birthPlace": "Musterstadt",
"nationality": "DE",
"phoneNumber": "+491234567890",
"documentDetails": {
"type": "Passport",
"number": "X1234567",
"issuedOn": "2016-01-01",
"expiryDate": "2026-01-01",
"issuanceCountry": "DE",
"issuanceAuthority": "Example Authority"
}
},
"finalizedAt": "2025-06-11T11:52:29.961249669Z",
"organizationId": "example-org-id",
"validationDetail": {
"email": {
"otpValidated": "SKIPPED",
"byRequestInput": "OK",
"requestMatched": "SKIPPED",
"byIdentificationSource": "SKIPPED"
}
}
}
}
}QES Onboarding Get Verification Service API Documentation
curl --request GET \
--url https://sandbox-umbrella-api.azurewebsites.net/api/services/onboarding/getVerification/{sessionId} \
--header 'Authorization: Bearer <token>'{
"status": true,
"data": {
"isVerified": true,
"status": "completed",
"message": "Verification completed",
"requestId": "64d35e63-fdf4-43f6-8459-1216787fb34e",
"signature": {
"content": [
{
"id": "e919520e-bb24-41c3-8a7b-88b3c8b0008b",
"method": "RemoteSignatureLongLivedDisposableCertificate",
"status": "COMPLETED",
"pageMode": "headless",
"signedAt": "2025-06-11T11:53:04.107687Z",
"plainResource": {
"id": "5a28c0e7-a57e-4bb5-88f3-6b6bb47c2cf7",
"name": "Document To Sign",
"type": "CONTRACT_DOCUMENT",
"family": "DOCUMENT_TO_SIGN",
"status": "AVAILABLE",
"subType": "DOCUMENT_FLATTENED",
"filename": "Onboarding_TEST.pdf",
"metadata": {
"sourceTemplateUrl": "https://files.example.com/Onboarding_TEST.pdf"
},
"mimeType": "application/pdf",
"sizeBytes": 138763,
"resourceUri": "nor://example/resource/5a28c0e7",
"resourceUrl": "https://example.com/storage/data/Onboarding_TEST.pdf",
"urlValidBefore": "2025-06-16T11:53:34.028Z"
},
"signedResource": {
"id": "60ab66ba-3b03-477c-8936-be55b15e890f",
"type": "CONTRACT_DOCUMENT",
"family": "SIGNED_DOCUMENT",
"status": "AVAILABLE",
"filename": "Onboarding_TEST.pdf",
"metadata": {
"fileId": "8168e8d7-ab7b-4c6f-b19e-2fe1418da0d1",
"workstep": "EXAMPLE_WORKSTEP_ID"
},
"mimeType": "application/pdf",
"sizeBytes": 207066,
"resourceUri": "nor://example/resource/60ab66ba",
"resourceUrl": "https://example.com/storage/data/Onboarding_TEST_signed.pdf",
"urlValidBefore": "2025-06-16T11:53:34.028Z"
}
}
]
},
"identification": {
"id": "2b307448-4880-4d3d-b9ab-0a438298c77a",
"actor": "userToIdentify",
"idSelf": {
"artifacts": {
"biometry": [],
"document": []
},
"biometryCheck": {
"keysWithError": [],
"controlsSummary": 0
},
"documentCheck": {
"documentType": "PASSPORT",
"documentTypeFamily": "IDENTITY_DOCUMENT",
"keysWithError": [],
"controlsSummary": 0
}
},
"source": "ID-SELF",
"status": "COMPLETED",
"personData": {
"email": "max.mustermann@example.com",
"gender": "M",
"firstName": "Max",
"lastName": "Mustermann",
"birthDate": "1971-01-01",
"birthPlace": "Musterstadt",
"nationality": "DE",
"phoneNumber": "+491234567890",
"documentDetails": {
"type": "Passport",
"number": "X1234567",
"issuedOn": "2016-01-01",
"expiryDate": "2026-01-01",
"issuanceCountry": "DE",
"issuanceAuthority": "Example Authority"
}
},
"finalizedAt": "2025-06-11T11:52:29.961249669Z",
"organizationId": "example-org-id",
"validationDetail": {
"email": {
"otpValidated": "SKIPPED",
"byRequestInput": "OK",
"requestMatched": "SKIPPED",
"byIdentificationSource": "SKIPPED"
}
}
}
}
}/onboarding/getVerification/{sessionId}
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
ID from the onboarding session.
Verification result retrieved successfully
Indicates whether the request succeeded.
Verification payload.
Show child attributes
Whether the verification was successful.
High-level status of the verification.
completed, cancelled, error Status message.
Unique ID for the verification request.
Signature metadata and resources.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
KYC / identification results.
Show child attributes
Role of the actor in session (e.g., userToIdentify).
Show child attributes
Show child attributes
Show child attributes
Per-field validation indicators.
Show child attributes