Document Scan, Liveness and PEP Sanction Check Workflow
This Workflow combines Liveness and PEP and Sanction check and return a single response. You will also get a PDF report for PEP check in response.
Step 1: Initialize session
POST to
Test enviornment : https://test-gateway.zignsec.com/core/api/sessions/workflow/liveness_with_pep_sanction
Production enviornment : https://gateway.zignsec.com/core/api/sessions/workflow/liveness_with_pep_sanction
Request Example
POST https://test-gateway.zignsec.com/core/api/sessions/workflow/liveness_with_pep_sanction
Content-Type: application/json
Authorization: 12345678-YOUR-ACCESS-TOKEN-5352305c9fb0
Content-Length: 725
{
"locale": "En",
"metadata": {
"options": "FrontAndBack"
},
"redirect_failure": "https://my_failure_url.com",
"redirect_success": "https://my_success_url.com",
"relay_state": "my-unique-customer-id",
"webhook": "https://my_webhook_url.com"
}
1.2: Description of Request Model
| Paramter | Description | Required |
| locale | Preferred Language to Use. example: En | |
| metadata | Yes | |
| redirect_failure | URL to redirect the end-user to on failure | |
| redirect_success | URL to redirect the end-user to on success | |
| relay_state | This optional parameter will be returned to you at the redirect back to your server. Use it to link an unique ID of your choice that you can parse. Example: relaystate=zignsec_eid_1234 | No |
| webhook | A URL where success/error results will automatically be POST:ed. During test you try https://webhook.site/ for free webhook URLs. | No |
1.3: Example of Response Body
{
"data": {
"id": "e9e12407-f9d5-4845-8379-2c1b5a4c981d",
"redirect_url": "https://test-gateway.zignsec.com/core/workflow_instances/e9e12407-f9d5-4845-8379-2c1b5a4c981d"
}
}
1.4: Description of Response Model
| id | A unique session identifier generated for each workflow instance. |
| redirect_url | Redirected URL will open the below form |
Fill all the details in the below mentioned Form and follow the steps to start the session.
Step1 – Choose the Document Type, You can choose if document you want to upload should be one sided or two sided or type of document.
Step2- You can continue the session in browser or scan the QR Code and run it in mobile device.
Step3-Once the document is uploaded it will ask you to confirm personal details .
| Step1 | Step2 | Step3 |
 |  |  |
Step2 : GET results
GET request will tell thestatus of the request, you can get the Full Details in Webhook.
GET to
Test enviornment : https://test-gateway.zignsec.com/core/api/sessions/8dab585c-da9a-426d-9d19-5e7e22289a4b
Production enviornment : https://gateway.zignsec.com/core/api/sessions/8dab585c-da9a-426d-9d19-5e7e22289a4b
Webhook Response
{
"event": "workflow_session_state_updated",
"integration_id": "workflows",
"relay_state": "my-unique-customer-id",
"result": {
"document_analysis": {
"analysis_details": [
{
"analysed_documents": [],
"analysis_id": 517775,
"document_analysis_details": {
"document_type": "Germany - Id Card (2010)",
"found_document_types": [
{
"document_type": "Germany - Id Card (2010)",
"file_name": "img-1.jpg",
"image_url": "https://api.zignsec.com/v3/scan/api/v1/images/34334b34-67a3-4062-9bda-2dcf42e1a50c/3164eaec-5f18-4ba9-8bbd-81331aa8448e"
},
{
"document_type": "Germany - Id Card (2010-2021) Side B",
"file_name": "img-2.jpg",
"image_url": "https://api.zignsec.com/v3/scan/api/v1/images/34334b34-67a3-4062-9bda-2dcf42e1a50c/3ea5357e-115c-4615-b6eb-c8668da293f8"
}
],
"found_image_parts": [
{
"image_url": "https://api.zignsec.com/v3/scan/api/v1/images/34334b34-67a3-4062-9bda-2dcf42e1a50c/d5a3d4d8-80fd-475f-877d-598e7542f4ab",
"name": "Signature",
"type": 204
},
{
"image_url": "https://api.zignsec.com/v3/scan/api/v1/images/34334b34-67a3-4062-9bda-2dcf42e1a50c/05221914-59a8-474f-8a63-e34c5bf48917",
"name": "Portrait",
"type": 201
},
{
"image_url": "https://api.zignsec.com/v3/scan/api/v1/images/34334b34-67a3-4062-9bda-2dcf42e1a50c/0355b461-b64b-40c2-858d-19596124b81e",
"name": null,
"type": 0
}
],
"found_text_fields": [
{
"barcode": null,
"field_name": "Given_Names_local",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "ERIKA"
},
{
"barcode": null,
"field_name": "Surname_local",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 2,
"VisualBarcode": 0
},
"visual": "MUSTERMANN"
},
{
"barcode": null,
"field_name": "Surname_And_Given_Names_local",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 2,
"VisualBarcode": 0
},
"visual": "MUSTERMANN ERIKA"
},
{
"barcode": null,
"field_name": "Given_Names",
"mrz": "ERIKA",
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 3,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "ERIKA"
},
{
"barcode": null,
"field_name": "Surname",
"mrz": "MUSTERMANN",
"verification_scores": {
"Barcode": 0,
"Mrz": 2,
"MrzBarcode": 0,
"MrzVisual": 3,
"Visual": 2,
"VisualBarcode": 0
},
"visual": "MUSTERMANN"
},
{
"barcode": null,
"field_name": "Surname_And_Given_Names",
"mrz": "MUSTERMANN ERIKA",
"verification_scores": {
"Barcode": 0,
"Mrz": 2,
"MrzBarcode": 0,
"MrzVisual": 3,
"Visual": 2,
"VisualBarcode": 0
},
"visual": "MUSTERMANN ERIKA"
},
{
"barcode": null,
"field_name": "Issuing_State_Name",
"mrz": "Germany",
"verification_scores": {
"Barcode": 0,
"Mrz": 1,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": null
},
{
"barcode": null,
"field_name": "Issuing_State_Code",
"mrz": "D",
"verification_scores": {
"Barcode": 0,
"Mrz": 1,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": null
},
{
"barcode": null,
"field_name": "Age",
"mrz": "58",
"verification_scores": {
"Barcode": 0,
"Mrz": 1,
"MrzBarcode": 0,
"MrzVisual": 3,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "58"
},
{
"barcode": null,
"field_name": "Document_Number",
"mrz": "T015Z7NGF",
"verification_scores": {
"Barcode": 0,
"Mrz": 1,
"MrzBarcode": 0,
"MrzVisual": 3,
"Visual": 2,
"VisualBarcode": 0
},
"visual": "T015Z7NGF"
},
{
"barcode": null,
"field_name": "Authority",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "STADT KOEL"
},
{
"barcode": null,
"field_name": "RemainderTerm",
"mrz": "53",
"verification_scores": {
"Barcode": 0,
"Mrz": 1,
"MrzBarcode": 0,
"MrzVisual": 3,
"Visual": 1,
"VisualBarcode": 0
},
"visual": "53"
},
{
"barcode": null,
"field_name": " (522)",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "52"
},
{
"barcode": null,
"field_name": " (523)",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "5"
},
{
"barcode": null,
"field_name": "Address_City_local",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "KÖLN"
},
{
"barcode": null,
"field_name": "Address_local",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "51147 KÖLN^HEIDESTRASSE 17"
},
{
"barcode": null,
"field_name": "Address_Postal_Code_local",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "51147"
},
{
"barcode": null,
"field_name": "Address_Street_local",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "HEIDESTRASSE 17"
},
{
"barcode": null,
"field_name": "Authority_local",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "STADT KÖL"
},
{
"barcode": null,
"field_name": "Card_Access_Number",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "217145"
},
{
"barcode": null,
"field_name": "Date_of_Birth",
"mrz": "1964-08-12",
"verification_scores": {
"Barcode": 0,
"Mrz": 1,
"MrzBarcode": 0,
"MrzVisual": 3,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "1964-08-12"
},
{
"barcode": null,
"field_name": "Date_of_Birth_CheckDigit",
"mrz": "5",
"verification_scores": {
"Barcode": 0,
"Mrz": 1,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": null
},
{
"barcode": null,
"field_name": "Date_of_Expiry",
"mrz": "2027-04-05",
"verification_scores": {
"Barcode": 0,
"Mrz": 1,
"MrzBarcode": 0,
"MrzVisual": 3,
"Visual": 1,
"VisualBarcode": 0
},
"visual": "2027-04-05"
},
{
"barcode": null,
"field_name": "Date_of_Expiry_CheckDigit",
"mrz": "8",
"verification_scores": {
"Barcode": 0,
"Mrz": 1,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": null
},
{
"barcode": null,
"field_name": "Date_of_Issue",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "2017-04-06"
},
{
"barcode": null,
"field_name": "Document_Class_Code",
"mrz": "ID",
"verification_scores": {
"Barcode": 0,
"Mrz": 1,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": null
},
{
"barcode": null,
"field_name": "Document_Number_CheckDigit",
"mrz": "5",
"verification_scores": {
"Barcode": 0,
"Mrz": 1,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": null
},
{
"barcode": null,
"field_name": "Eyes_Color_local",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "GRUN"
},
{
"barcode": null,
"field_name": "FinalCheckDigit",
"mrz": "4",
"verification_scores": {
"Barcode": 0,
"Mrz": 1,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": null
},
{
"barcode": null,
"field_name": "Height",
"mrz": null,
"verification_scores": {
"Barcode": 0,
"Mrz": 0,
"MrzBarcode": 0,
"MrzVisual": 0,
"Visual": 0,
"VisualBarcode": 0
},
"visual": "160 cm"
},
{
"barcode": null,
"field_name": "MRZ_Strings",
"mrz": "IDD<",
"result_image_url": "https://api.zignsec.com/v3/scan/api/v1/images/34334b34-67a3-4062-9bda-2dcf42e1a50c/ca2c713e-4b65-4595-a0e8-f08a0380ccb9",
"source_file_name": "vid-3.mov",
"source_image_url": "https://api.zignsec.com/v3/scan/api/v1/images/34334b34-67a3-4062-9bda-2dcf42e1a50c/0b107b49-1063-49c6-a4e2-a4d6320ea9a7"
},
{
"result_file_name": "",
"result_image_url": "https://api.zignsec.com/v3/scan/api/v1/images/34334b34-67a3-4062-9bda-2dcf42e1a50c/6fc4db1f-962e-4e5f-b9e1-ee8665732a40",
"source_file_name": "img-1.jpg",
"source_image_url": "https://api.zignsec.com/v3/scan/api/v1/images/34334b34-67a3-4062-9bda-2dcf42e1a50c/2a658c7d-a10d-4da9-ad27-e762cdfa5c1e"
}
],
"max_confidence": 0.0,
"min_confidence": 0.0,
"process_state": "Finished",
"resolution": "ACCEPTED",
"resolution_message": "Percent of similarity 98.00%",
"resolution_status": "ACCEPTED"
},
"selfie_analysis_process_state": "Finished",
"selfie_analysis_result": "ACCEPTED",
"selfie_max_confidence": 0.0,
"selfie_min_confidence": 0.0,
"session_status": "ACCEPTED",
"started_at": "2022-10-25T08:45:12.2788558Z",
"total_process_state": "Finished"
}
],
"analysis_summary": {
"analysis_duration_sec": 80.5,
"expert_summary": {
"error": null,
"result": "NOT_REQUESTED",
"result_title": "Not Requested"
},
"fraud_summary": {
"all_errors": [],
"error": null,
"result": "NOT_REQUESTED",
"result_reason": null,
"result_title": "Not Requested",
"risk_score": "Undefined"
},
"id_document_summary": {
"age": 58,
"document_type_name": "Germany - Id Card (2010)",
"error": null,
"expiration_date": "2027-04-05T00:00:00+00:00",
"fields": {
"MRZ_Strings_MRZ": "IDD< You can GET results in the Portal and in the webhook response.
workflow_session_id | checks the status of the session by doing GET request . Ex : e9e12407-f9d5-4845-8379-2c1b5a4c981d |
id | Gives the detailed response for Scanning session.Detailed description can be seen by GET request or in Portal. ex: b5c71921-be1d-4f33-a28f-0271cd982bc9 |
relay_state | identifier for session |
total_result | ACCEPTED , DECLINED etc |
pep_sanction_report_download_url | PDF report of Pep & Sanction analysis |
pep_sanction_result | matches and numberOfMatches |
