Liveness is used to protect against biometric attacks. It’s a proof of a real person working on Id analysis, Face biometry verification and Liveness verification.
Swagger link:
Test: Swagger UI (zignsec.com)
Prod : Swagger UI (zignsec.com)
Flow
- Initialize Scanning session
- Browser Steps
- Get analysis result
Step 1: Initialize scanning session
Note: Liveness is video based only and no audio is available.
Step 1.1: Create a new Browser flow (web flow) scanning session
POST to
Test environment: https://test-gateway.zignsec.com/core/api/sessions/identity_verification/zignsec
Prod environment : https://gateway.zignsec.com/core/api/sessions/identity_verification/zignsec
Request example
If you want only document to be verified you have mention it in two_steps as 1 in request body and if you want document scanning and liveness both you have to mention two_steps as 3 in request body. Please refer description of request model for more information.
POST https://test-gateway.zignsec.com/core/api/sessions/identity_verification/zignsec
Content-Type: application/json
Authorization: 12345678-YOUR-ACCESS-TOKEN-5352305c9fb0
Content-Length: 725
{
"locale": "En",
"metadata": {
"action": "move_left_right",
"hide_toc": true,
"origin": "string",
"privacy_url": "",
"terms_url": "",
"two_steps": 3
},
"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"
}
Step 1.2: Description of request model
Headers
In order to send a message you need to authenticate yourself using the credentials given by ZignSec.
Authorization | This header parameter is the access token or apiKey, you received from ZignSec during the registration process. Example: Authorization: 00000000-e2a2-4968-b651-5352305c9fb0 | Required |
Content-Type | Specifies the media type of the request body data. Set to application/x-www-form-urlencoded. for post data and application/json if JSON object. Example: Content-Type: application/x-www-form-urlencoded | Required |
Request Parameters
locale | Preferred Language to Use | |
metadata | describes the data in the folder, metadata and location | Required |
action | [ move_left_right, nod_up_down ] | |
hide_toc | Hide the Terms&Conditions and Privacy Policy step. Useful if the Client’s T&C and Privacy Policy are stored elsewhere, outside the widget’s workflow | |
privacy_url | URL to Privacy Policy page. Prohibited if hide_toc is true. Required if hide_toc is false | |
terms_url | URL to T&C page. Prohibited if hide_toc is true. Required if hide_toc is false | |
two_steps | integer . example : 1 1 – document only, 2 – video only, 3 – both | |
redirect_success | URL to redirect the end-user to on failure | Not required |
redirect_failure | URL to redirect the end-user to on success | Not required |
relay_state | Optional Custom Parameter to be included in webhook calls | |
webhook | Webhook URL where your backend will receive session events. During test you try https://webhook.site/ for free webhook URLs. | Not required |
Step 1.3: Example of response for initializing scanning session
{
"data": {
"id": "2ff212c4-bc45-43f5-88d6-14951ce2c348",
"result": {
"redirectUrl": "https://test-gateway.zignsec.com/ui/kyc-widget/api/2ff212c4-bc45-43f5-88d6-14951ce2c348"
}
}
}
Step 1.4: Description of response model
id | The session identifier, a GUID (globally unique identifier) unique for the started workflow, used both in the redirect_url and the get analysis results |
redirect_url | The URL that the user need to be redirected to complete the data via the web interface. |
statusCode | The HTTP status code generated by origin server for this occurrence of the problem. |
message | A human-readable explanation specific to this occurrence of the problem. |
Step 2: Browser steps
There are two approaches to complete files upload to scanning:
- Browser
- Mobile
Step 2.1: Example of Browser
Browser flow: Upload all images from current browser.
| 1. Choose language and Start session | 2.Accepting Terms and Conditions to proceed further | 3. Choose Document type | 4- Follow instructions to upload documents | 5- Waiting for Analyzing and Getting result (See details in the portal) |
 |  |  |  |  |
Steps and Actions Description for Scanning session from Browser
1. Choose langauge and start session : You can change language we support multiple languages like Italian, Spanish, French, Deutsch and many more.
2. Accepting Terms and Conditions to proceed further : Accept the terms and conditions to proceed further to scanning session
3. Choose Document type : Choose the document type and once you choose the document type. It will give you option to upload from your Web Camera or will allow you to upload Files. You will be given guidelines for image quality before uploading documents.
4. Follow instructions to upload documents : Follow instructions to upload front and back side of the document to proceed further . Once document is uploaded you need to follow the instructions for liveness session actions.
5. Waiting for Analyzing and Getting result : Once the liveness session is completed you will be notified and then it will redirect to redirect_successURL.
Step 3: Get analysis result
To get status of the request send the GET request to
GET to https://test-gateway.zignsec.com/core/api/sessions/2ff212c4-bc45-43f5-88d6-14951ce2c348
Test Swagger Link : Swagger UI (zignsec.com)
Prod Swagger Link : Swagger UI (zignsec.com)
You can also GET the results in Webhook.
We have 3 types of checks for liveness :
1. Liveness (QUALITY analysis) – Confirmation that the video includes a face of a real living person
– to verify that a living person is present in a video and not his/her image
-The Best Shot algorithm checks for the best shot from a video (a best-quality frame where the face is seen the most properly).
After checking, the analysis shows the chance of a spoofing attack in percents.
· 100% – an attack is detected, the person in the video is not a real living person
· 0% – a person in the video is a real living person
*Spoofing in biometry is a kind of scam when a person disguises as another person using both program and non-program tools like deepfake, masks, ready-made photos, and videos.
2. Biometry (BIOMETRY analysis) – Biometric identification using a photo/video footage
-perform biometric identification of a person by his/her photos and videos
-The algorithm allows to compare several media and check if the people on them resemble each other. As sources, you can use images, videos, and scans of documents (with photo). To perform the analysis, the algorithm requires at least two media.
After comparison, the algorithm provides a number that represents the similarity level. The number varies from 100 to 0%, where
· 100% – faces are similar
· 0% – faces are not similar and belong to different people
Note this feature is currently under going construction3. Text (DOCUMENTS analysis) – Verification of the genuineness of digital documents
-The documents analysis aims to recognize the document and check if its fields are correct according to its type.
-As an output, you’ll get a list of document fields with recognition results for each field and a result of checking that can be:
- The documents passed the check successfully
- The documents failed to pass the check
Webhook Response for type: Document
{
"data": {
"analyse_id": "63583865-cf37-4b97-b879-bb73703ba031",
"confs": {
"authenticity": 0,
"capabilities": null
},
"error_code": null,
"error_message": null,
"folder_id": "1367e9f9-d597-40bc-94a6-625f474222a6",
"meta_data": null,
"resolution": "SUCCESS",
"resolution_operator": null,
"resolution_status": "SUCCESS",
"results_data": {
"text_fields": [
{
"barcode": null,
"field_name": "Document_Class_Code",
"field_type": 0,
"mrz": "ID",
"verification": {
"barcode": 0,
"mrz": 1,
"mrz-barcode": 0,
"mrz-visual": 0,
"visual": 0,
"visual-barcode": 0
},
"visual": null
},
{
"barcode": null,
"field_name": "Issuing_State_Code",
"field_type": 1,
"mrz": "D",
"verification": {
"barcode": 0,
"mrz": 1,
"mrz-barcode": 0,
"mrz-visual": 0,
"visual": 0,
"visual-barcode": 0
},
"visual": null
},
{
"barcode": null,
"field_name": "Document_Number",
"field_type": 2,
"mrz": "T015Z7NGF",
"verification": {
"barcode": 0,
"mrz": 1,
"mrz-barcode": 0,
"mrz-visual": 3,
"visual": 2,
"visual-barcode": 0
},
"visual": "T015Z7NGF"
},
{
"barcode": null,
"field_name": "Date_of_Expiry",
"field_type": 3,
"mrz": "2027-04-05",
"verification": {
"barcode": 0,
"mrz": 1,
"mrz-barcode": 0,
"mrz-visual": 3,
"visual": 1,
"visual-barcode": 0
},
"visual": "2027-04-05"
},
{
"barcode": null,
"field_name": "Date_of_Issue",
"field_type": 4,
"mrz": null,
"verification": {
"barcode": 0,
"mrz": 0,
"mrz-barcode": 0,
"mrz-visual": 0,
"visual": 0,
"visual-barcode": 0
},
"visual": "2017-04-06"
},
{
"barcode": null,
"field_name": "Date_of_Birth",
"field_type": 5,
"mrz": "1964-08-12",
"verification": {
"barcode": 0,
"mrz": 1,
"mrz-barcode": 0,
"mrz-visual": 3,
"visual": 0,
"visual-barcode": 0
},
"visual": "1964-08-12"
},
{
"barcode": null,
"field_name": "Place_of_Birth (67567622)",
"field_type": 6,
"mrz": null,
"verification": {
"barcode": 0,
"mrz": 0,
"mrz-barcode": 0,
"mrz-visual": 0,
"visual": 0,
"visual-barcode": 0
},
"visual": "BERLIN"
},
{
"barcode": null,
"field_name": "Place_of_Birth",
"field_type": 6,
"mrz": null,
"verification": {
"barcode": 0,
"mrz": 0,
"mrz-barcode": 0,
"mrz-visual": 0,
"visual": 0,
"visual-barcode": 0
},
"visual": "BERLIN"
},
{
"barcode": null,
"field_name": "Surname (67567624)",
"field_type": 8,
"mrz": null,
"verification": {
"barcode": 0,
"mrz": 0,
"mrz-barcode": 0,
"mrz-visual": 0,
"visual": 2,
"visual-barcode": 0
},
"visual": "MUSTERMANN"
},
{
"barcode": null,
"field_name": "Surname",
"field_type": 8,
"mrz": "MUSTERMANN",
"verification": {
"barcode": 0,
"mrz": 2,
"mrz-barcode": 0,
"mrz-visual": 3,
"visual": 2,
"visual-barcode": 0
},
"visual": "MUSTERMANN"
},
{
"barcode": null,
"field_name": "Given_Names (67567625)",
"field_type": 9,
"mrz": null,
"verification": {
"barcode": 0,
"mrz": 0,
"mrz-barcode": 0,
"mrz-visual": 0,
"visual": 0,
"visual-barcode": 0
},
"visual": "ERIKA"
},
{
"barcode": null,
"field_name": "Given_Names",
"field_type": 9,
"mrz": "ERIKA",
"verification": {
"barcode": 0,
"mrz": 0,
"mrz-barcode": 0,
"mrz-visual": 3,
"visual": 0,
"visual-barcode": 0
},
"visual": "ERIKA"
},
{
"barcode": null,
"field_name": "Nationality",
"field_type": 11,
"mrz": null,
"verification": {
"barcode": 0,
"mrz": 0,
"mrz-barcode": 0,
"mrz-visual": 0,
"visual": 0,
"visual-barcode": 0
},
"visual": "DEUTSCH"
},
{
"barcode": null,
"field_name": "Height",
"field_type": 13,
"mrz": null,
"verification": {
"barcode": 0,
"mrz": 0,
"mrz-barcode": 0,
"mrz-visual": 0,
"visual": 2,
"visual-barcode": 0
},
"visual": "16000 cm"
},
{
"barcode": null,
"field_name": "Eyes_Color (67567631)",
"field_type": 15,
"mrz": null,
"verification": {
"barcode": 0,
"mrz": 0,
"mrz-barcode": 0,
"mrz-visual": 0,
"visual": 0,
"visual-barcode": 0
},
"visual": "ORUN"
},
{
"barcode": null,
"field_name": "Address (67567633)",
"field_type": 17,
"mrz": null,
"verification": {
"barcode": 0,
"mrz": 0,
"mrz-barcode": 0,
"mrz-visual": 0,
"visual": 0,
"visual-barcode": 0
},
"visual": "51147 KÖLN^HEIDESTRASSE 17"
},
{
"barcode": null,
"field_name": "Authority (67567640)",
"field_type": 24,
"mrz": null,
"verification": {
"barcode": 0,
"mrz": 0,
"mrz-barcode": 0,
"mrz-visual": 0,
"visual": 0,
"visual-barcode": 0
},
"visual": "STADT KÖLN"
},
{
"barcode": null,
"field_name": "Surname_And_Given_Names (67567641)",
"field_type": 25,
"mrz": null,
"verification": {
"barcode": 0,
"mrz": 0,
"mrz-barcode": 0,
"mrz-visual": 0,
"visual": 2,
"visual-barcode": 0
},
"visual": "MUSTERMANN ERIKA"
},
{
"barcode": null,
"field_name": "Surname_And_Given_Names",
"field_type": 25,
"mrz": "MUSTERMANN ERIKA",
"verification": {
"barcode": 0,
"mrz": 2,
"mrz-barcode": 0,
"mrz-visual": 3,
"visual": 2,
"visual-barcode": 0
},
"visual": "MUSTERMANN ERIKA"
},
{
"barcode": null,
"field_name": "Nationality_Code",
"field_type": 26,
"mrz": "D",
"verification": {
"barcode": 0,
"mrz": 1,
"mrz-barcode": 0,
"mrz-visual": 0,
"visual": 0,
"visual-barcode": 0
},
"visual": null
},
{
"barcode": null,
"field_name": "MRZ_Type",
"field_type": 35,
"mrz": "ID-1",
"verification": {
"barcode": 0,
"mrz": 0,
"mrz-barcode": 0,
"mrz-visual": 0,
"visual": 0,
"visual-barcode": 0
},
"visual": null
},
{
"barcode": null,
"field_name": "Issuing_State_Name",
"field_type": 38,
"mrz": "Germany",
"verification": {
"barcode": 0,
"mrz": 1,
"mrz-barcode": 0,
"mrz-visual": 0,
"visual": 0,
"visual-barcode": 0
},
"visual": null
},
{
"barcode": null,
"field_name": "MRZ_Strings",
"field_type": 51,
"mrz": "IDD<",
"original_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/c90e2c77-442e-4b22-a57e-eba4cc79aa09.jpeg",
"tags": [],
"thumb_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/c90e2c77-442e-4b22-a57e-eba4cc79aa09_thumb.jpeg",
"time_created": 1659523073,
"time_updated": 1659523073
},
{
"image_id": "72e40eef-f793-422a-a810-f10c1a19a30d",
"info": {
"original": {
"height": 476,
"md5": "ff9b8efea5c881f6782293cd8ad67114",
"mime-type": "image/jpeg",
"size": 12391,
"width": 377
},
"thumb": {
"height": 300,
"md5": "18f2b05e4cf4b445146c2c2d47866a4b",
"mime-type": "image/jpeg",
"size": 9543,
"width": 238
}
},
"media_association_id": 721248,
"media_id": "72e40eef-f793-422a-a810-f10c1a19a30d",
"media_type": "IMAGE_RESULT_ANALYSE_SINGLE",
"meta_data": {
"field_name": "Portrait",
"field_type": 201
},
"original_name": "",
"original_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/72e40eef-f793-422a-a810-f10c1a19a30d.jpeg",
"tags": [],
"thumb_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/72e40eef-f793-422a-a810-f10c1a19a30d_thumb.jpeg",
"time_created": 1659523073,
"time_updated": 1659523073
},
{
"image_id": "634b8452-c939-48d3-8e94-5d0df910a0ef",
"info": {
"original": {
"height": 637,
"md5": "bb7d7271b0dd3883cfa73d7623187027",
"mime-type": "image/jpeg",
"size": 47224,
"width": 1015
},
"thumb": {
"height": 188,
"md5": "a1de223852a805041ada5f350989e0cc",
"mime-type": "image/jpeg",
"size": 11483,
"width": 300
}
},
"media_association_id": 721248,
"media_id": "634b8452-c939-48d3-8e94-5d0df910a0ef",
"media_type": "IMAGE_RESULT_ANALYSE_SINGLE",
"meta_data": {
"type": "document"
},
"original_name": "",
"original_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/634b8452-c939-48d3-8e94-5d0df910a0ef.jpeg",
"tags": [],
"thumb_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/634b8452-c939-48d3-8e94-5d0df910a0ef_thumb.jpeg",
"time_created": 1659523073,
"time_updated": 1659523073
}
],
"results_data": {
"document_id": 1829644991,
"document_name": "Germany - Id Card (2010)"
},
"source_image_id": "35100fd2-80f7-4417-9c85-db20cbac5558"
},
{
"analyse_id": "63583865-cf37-4b97-b879-bb73703ba031",
"collection_persons": [],
"media_association_id": 721247,
"media_association_type": "IMAGE",
"output_images": [
{
"image_id": "62a0439d-82b7-4d2e-b94f-dea81d388bc8",
"info": {
"original": {
"height": 80,
"md5": "a0eaf18dbd110e3db31a8185acc17ac8",
"mime-type": "image/jpeg",
"size": 932,
"width": 70
},
"thumb": {
"height": 80,
"md5": "81d30bb0f770a61cb909de8ac4c70f0b",
"mime-type": "image/jpeg",
"size": 1028,
"width": 70
}
},
"media_association_id": 721247,
"media_id": "62a0439d-82b7-4d2e-b94f-dea81d388bc8",
"media_type": "IMAGE_RESULT_ANALYSE_SINGLE",
"meta_data": {
"field_name": "Ghost portrait",
"field_type": 210
},
"original_name": "",
"original_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/62a0439d-82b7-4d2e-b94f-dea81d388bc8.jpeg",
"tags": [],
"thumb_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/62a0439d-82b7-4d2e-b94f-dea81d388bc8_thumb.jpeg",
"time_created": 1659523072,
"time_updated": 1659523072
},
{
"image_id": "75b8ca95-6c02-4dfa-b987-7a66aa4a28f5",
"info": {
"original": {
"height": 649,
"md5": "387fb899aff9764d4f03e76606c075be",
"mime-type": "image/jpeg",
"size": 45020,
"width": 1015
},
"thumb": {
"height": 191,
"md5": "a8fcecea0097c7993f028a682ae1d5d6",
"mime-type": "image/jpeg",
"size": 11822,
"width": 300
}
},
"media_association_id": 721247,
"media_id": "75b8ca95-6c02-4dfa-b987-7a66aa4a28f5",
"media_type": "IMAGE_RESULT_ANALYSE_SINGLE",
"meta_data": {
"type": "document"
},
"original_name": "",
"original_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/75b8ca95-6c02-4dfa-b987-7a66aa4a28f5.jpeg",
"tags": [],
"thumb_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/75b8ca95-6c02-4dfa-b987-7a66aa4a28f5_thumb.jpeg",
"time_created": 1659523072,
"time_updated": 1659523072
}
],
"results_data": {
"document_id": 1974639081,
"document_name": "Germany - Id Card (2010-2021) Side B"
},
"source_image_id": "a35be618-3a6c-4708-85ba-7dacb1c810a6"
}
],
"source_media": [
{
"image_id": "35100fd2-80f7-4417-9c85-db20cbac5558",
"info": {
"original": {
"height": 720,
"md5": "39b7899f38bbf9aabdc64f15180e116c",
"mime-type": "image/png",
"size": 1104168,
"width": 1280
},
"thumb": {
"height": 168,
"md5": "ac89008898abe69be2abf17c8d9560e1",
"mime-type": "image/png",
"size": 85228,
"width": 300
}
},
"media_id": "35100fd2-80f7-4417-9c85-db20cbac5558",
"media_type": "IMAGE_FOLDER",
"meta_data": [],
"original_name": "G7cMoTU9pqPwFu8KIgqfqa3ZgGV8N1jAO4k3WgY5.png",
"original_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/35100fd2-80f7-4417-9c85-db20cbac5558.png",
"tags": [],
"thumb_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/35100fd2-80f7-4417-9c85-db20cbac5558_thumb.png",
"time_created": 1659523064,
"time_updated": 1659523064
},
{
"image_id": "a35be618-3a6c-4708-85ba-7dacb1c810a6",
"info": {
"original": {
"height": 720,
"md5": "4407f3d761d1f063904f5c50bb0f43e1",
"mime-type": "image/png",
"size": 1058325,
"width": 1280
},
"thumb": {
"height": 168,
"md5": "f6a5c9cd0f31797b10d6d152b4f09f7e",
"mime-type": "image/png",
"size": 84982,
"width": 300
}
},
"media_id": "a35be618-3a6c-4708-85ba-7dacb1c810a6",
"media_type": "IMAGE_FOLDER",
"meta_data": [],
"original_name": "AYqLktBYLrhMsgomGTVvcNkpUbrsnMcMq7GFrmVU.png",
"original_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/a35be618-3a6c-4708-85ba-7dacb1c810a6.png",
"tags": [],
"thumb_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/a35be618-3a6c-4708-85ba-7dacb1c810a6_thumb.png",
"time_created": 1659523064,
"time_updated": 1659523064
}
],
"state": "FINISHED",
"time_created": 1659523066,
"time_task_finished": 1659523073,
"time_task_received": 1659523066,
"time_task_send_to_broker": 1659523066,
"time_updated": 1659523073,
"type": "DOCUMENTS"
},
"event": "session_updated",
"id": "7692074d-38c4-41e5-be1d-9c08a37245cb",
"integration_id": "identity_verification.kyc_widget",
"relay_state": "my-unique-customer-id",
"status": "analysis_finished"
}
Webhook Response for type: Quality
{
"data": {
"analyse_id": "79fdf3a8-7ab0-42a2-a5cd-a1db6bad5ff1",
"confs": {
"extract_best_shot": false,
"threshold_liveness": 0.5,
"threshold_replay": 0.5,
"threshold_spoofing": 0.5
},
"error_code": null,
"error_message": null,
"folder_id": "1367e9f9-d597-40bc-94a6-625f474222a6",
"meta_data": null,
"resolution": "SUCCESS",
"resolution_operator": null,
"resolution_status": "SUCCESS",
"results_data": null,
"results_group": [],
"results_media": [
{
"analyse_id": "79fdf3a8-7ab0-42a2-a5cd-a1db6bad5ff1",
"collection_persons": [],
"media_association_id": 721244,
"media_association_type": "VIDEO",
"output_images": [],
"results_data": {
"confidence_liveness": null,
"confidence_replay": 0.00337633491,
"confidence_spoofing": 0.00337633491
},
"source_video_id": "2ef7358c-074c-4541-9389-89b822775bf7"
},
{
"analyse_id": "79fdf3a8-7ab0-42a2-a5cd-a1db6bad5ff1",
"collection_persons": [],
"media_association_id": 721243,
"media_association_type": "VIDEO",
"output_images": [],
"results_data": {
"confidence_liveness": null,
"confidence_replay": 0.00185641646,
"confidence_spoofing": 0.00185641646
},
"source_video_id": "185748e4-a240-4207-86f3-f100b550819c"
}
],
"source_media": [
{
"info": {
"preview": {
"FPS": 10,
"duration": 3,
"height": 720,
"md5": "89a07efce25492cfd5f7fdb44978b4b8",
"mime-type": "video/mp4",
"size": 595430,
"width": 1280
},
"thumb": {
"height": 168,
"md5": "12d379ecfe7b19c0b7df45714b2c1447",
"mime-type": "image/jpeg",
"size": 10179,
"width": 300
},
"video": {
"FPS": 10,
"duration": 3,
"height": 720,
"md5": "e54afe9bccda754a7178739925131b96",
"mime-type": "video/quicktime",
"size": 765963,
"width": 1280
}
},
"media_id": "2ef7358c-074c-4541-9389-89b822775bf7",
"media_type": "VIDEO_FOLDER",
"meta_data": [],
"original_name": "vid-1.mov",
"preview_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/2ef7358c-074c-4541-9389-89b822775bf7_preview.mp4",
"tags": [
"video_selfie",
"orientation_portrait",
"video_selfie_left"
],
"thumb_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/2ef7358c-074c-4541-9389-89b822775bf7_thumb.jpg",
"time_created": 1659523054,
"time_updated": 1659523065,
"video_id": "2ef7358c-074c-4541-9389-89b822775bf7",
"video_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/2ef7358c-074c-4541-9389-89b822775bf7.quicktime"
},
{
"info": {
"preview": {
"FPS": 10,
"duration": 3,
"height": 720,
"md5": "9cf2e6cb72ef044560b5a5ebc0d77eef",
"mime-type": "video/mp4",
"size": 579747,
"width": 1280
},
"thumb": {
"height": 168,
"md5": "fc20c989511ba3f6dc0b6093fee93079",
"mime-type": "image/jpeg",
"size": 10471,
"width": 300
},
"video": {
"FPS": 10,
"duration": 3,
"height": 720,
"md5": "c78338831632ecc0bf93681b61ffe7e6",
"mime-type": "video/quicktime",
"size": 747349,
"width": 1280
}
},
"media_id": "185748e4-a240-4207-86f3-f100b550819c",
"media_type": "VIDEO_FOLDER",
"meta_data": [],
"original_name": "vid-2.mov",
"preview_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/185748e4-a240-4207-86f3-f100b550819c_preview.mp4",
"tags": [
"video_selfie",
"orientation_portrait",
"video_selfie_right"
],
"thumb_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/185748e4-a240-4207-86f3-f100b550819c_thumb.jpg",
"time_created": 1659523054,
"time_updated": 1659523065,
"video_id": "185748e4-a240-4207-86f3-f100b550819c",
"video_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/185748e4-a240-4207-86f3-f100b550819c.quicktime"
}
],
"state": "FINISHED",
"time_created": 1659523055,
"time_task_finished": 1659523068,
"time_task_received": 1659523055,
"time_task_send_to_broker": 1659523055,
"time_updated": 1659523068,
"type": "QUALITY"
},
"event": "session_updated",
"id": "7692074d-38c4-41e5-be1d-9c08a37245cb",
"integration_id": "identity_verification.kyc_widget",
"relay_state": "my-unique-customer-id",
"status": "analysis_finished"
}
Webhook Response for type: Biometry
{
"data": {
"analyse_id": "e2d39897-8779-4af1-8a92-92d37c55380a",
"confs": {
"threshold_max": 0.7789,
"threshold_min": 0.7588
},
"error_code": 202,
"error_message": "Biometry. Analyse requires at least 2 media objects to process",
"folder_id": "1367e9f9-d597-40bc-94a6-625f474222a6",
"meta_data": null,
"resolution": "SUCCESS",
"resolution_operator": null,
"resolution_status": "SUCCESS",
"results_data": null,
"results_group": [],
"results_media": [
{
"analyse_id": "e2d39897-8779-4af1-8a92-92d37c55380a",
"collection_persons": [],
"media_association_id": 721246,
"media_association_type": "VIDEO",
"output_images": [],
"results_data": null,
"source_video_id": "2ef7358c-074c-4541-9389-89b822775bf7"
},
{
"analyse_id": "e2d39897-8779-4af1-8a92-92d37c55380a",
"collection_persons": [],
"media_association_id": 721245,
"media_association_type": "VIDEO",
"output_images": [],
"results_data": null,
"source_video_id": "185748e4-a240-4207-86f3-f100b550819c"
}
],
"source_media": [
{
"info": {
"preview": {
"FPS": 10,
"duration": 3,
"height": 720,
"md5": "89a07efce25492cfd5f7fdb44978b4b8",
"mime-type": "video/mp4",
"size": 595430,
"width": 1280
},
"thumb": {
"height": 168,
"md5": "12d379ecfe7b19c0b7df45714b2c1447",
"mime-type": "image/jpeg",
"size": 10179,
"width": 300
},
"video": {
"FPS": 10,
"duration": 3,
"height": 720,
"md5": "e54afe9bccda754a7178739925131b96",
"mime-type": "video/quicktime",
"size": 765963,
"width": 1280
}
},
"media_id": "2ef7358c-074c-4541-9389-89b822775bf7",
"media_type": "VIDEO_FOLDER",
"meta_data": [],
"original_name": "vid-1.mov",
"preview_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/2ef7358c-074c-4541-9389-89b822775bf7_preview.mp4",
"tags": [
"video_selfie",
"orientation_portrait",
"video_selfie_left"
],
"thumb_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/2ef7358c-074c-4541-9389-89b822775bf7_thumb.jpg",
"time_created": 1659523054,
"time_updated": 1659523065,
"video_id": "2ef7358c-074c-4541-9389-89b822775bf7",
"video_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/2ef7358c-074c-4541-9389-89b822775bf7.quicktime"
},
{
"info": {
"preview": {
"FPS": 10,
"duration": 3,
"height": 720,
"md5": "9cf2e6cb72ef044560b5a5ebc0d77eef",
"mime-type": "video/mp4",
"size": 579747,
"width": 1280
},
"thumb": {
"height": 168,
"md5": "fc20c989511ba3f6dc0b6093fee93079",
"mime-type": "image/jpeg",
"size": 10471,
"width": 300
},
"video": {
"FPS": 10,
"duration": 3,
"height": 720,
"md5": "c78338831632ecc0bf93681b61ffe7e6",
"mime-type": "video/quicktime",
"size": 747349,
"width": 1280
}
},
"media_id": "185748e4-a240-4207-86f3-f100b550819c",
"media_type": "VIDEO_FOLDER",
"meta_data": [],
"original_name": "vid-2.mov",
"preview_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/185748e4-a240-4207-86f3-f100b550819c_preview.mp4",
"tags": [
"video_selfie",
"orientation_portrait",
"video_selfie_right"
],
"thumb_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/185748e4-a240-4207-86f3-f100b550819c_thumb.jpg",
"time_created": 1659523054,
"time_updated": 1659523065,
"video_id": "185748e4-a240-4207-86f3-f100b550819c",
"video_url": "https://oz-api.zignsec.com/static/1367e9f9-d597-40bc-94a6-625f474222a6/185748e4-a240-4207-86f3-f100b550819c.quicktime"
}
],
"state": "FINISHED",
"time_created": 1659523055,
"time_task_finished": 1659523055,
"time_task_received": 1659523055,
"time_task_send_to_broker": 1659523055,
"time_updated": 1659523055,
"type": "BIOMETRY"
},
"event": "session_updated",
"id": "7692074d-38c4-41e5-be1d-9c08a37245cb",
"integration_id": "identity_verification.kyc_widget",
"relay_state": "my-unique-customer-id",
"status": "analysis_finished"
}
Description of Webhook Response Parameters
| type | “DOCUMENTS”, “BIOMETRY” ,“QUALITY” |
| resolution_status | “FINISHED” “DECLINED” “SUCCESS” |
| results_media | array of extracted photos and metrics |
| source_media | array of used source media |
