Verification Completed
This Webhook event is executed when verification completed. Verification can be completed with success or failed statuses. These events have the same fields (if there are successfully completed flow steps), but failed verification also has an additional fields with a description of the error as well. Types description you can find in dictionary VerificationCompleteEntity. Example:
Example
{
"transactionId":"09cc39f7-a12d-4faa-a6da-a883b7d54908",
"clientKey":"b6c98bc0-06b4-4cc7-89b1-ebd71b856d20",
"appKey":"5c241801-428b-42bd-b7fb-7c9e09ac1101",
"status":"failed",
"platform":"web",
"clientSession":"client session identifier",
"services":[
"DOCUMENT_CAPTURE",
"PASSIVE_LIVENESS",
],
"type":"verificationCompleted",
"failedService":"FACE_MATCH",
"error":"[faceMatch] BIOMETRY: Resolution status is DECLINED",
"isCloud":true,
"createdAt":"2023-05-11T11:46:37.414Z",
"updatedAt":"2023-05-11T11:55:48.114Z",
"device":{
"sdkVersion":"1.0.2",
"ip":"::ffff:127.0.0.1 ",
"country":null,
"region":null,
"eu":null,
"timezone":null,
"city":null,
"metro":null,
"ll":null,
"area":null,
"userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/112.0",
"browserType":"firefox",
"browserVersion":"112.0.0"
},
"servicesData":[
{
"service":"DOCUMENT_CAPTURE",
"data":[
{
"stepType":"DOCUMENT_CAPTURE",
"elapsedTime":828,
"elapsedTimeRFID":0,
"overallResult":0,
"morePagesAvailable":0,
"uploadedPagesCount":2,
"createdAt":"2023-05-11T11:49:22.758Z",
"types":[
{
"name":"Latvia - Id Card (2012) #2",
"pageIndex":0,
"hasMRZ":false,
"icao":"LVA",
"type":12,
"year":"2012",
"format":0
},
{
"name":"Latvia - Id Card (2012) #2 Side B",
"pageIndex":1,
"hasMRZ":true,
"icao":"LVA",
"type":12,
"year":"2012",
"format":0
}
],
"graphics":[
{
"fieldType":201,
"data":[
{
"fieldType":201,
"sourceType":17,
"pageIndex":0,
"image":"https://billing.elkyc.com/api/public/file/verification.doc/17061d90-92e3-4091-9404-596b4cee2afd.jpg"
}
]
},
{
"fieldType":204,
"data":[
{
"fieldType":204,
"sourceType":17,
"pageIndex":0,
"image":"https://billing.elkyc.com/api/public/file/verification.doc/1aeba861-763f-4b9d-8873-7dd0425c88c5.jpg"
}
]
},
{
"fieldType":205,
"data":[
{
"fieldType":205,
"sourceType":17,
"pageIndex":1,
"image":"https://billing.elkyc.com/api/public/file/verification.doc/5ec2744e-3348-49cc-a5e8-8d1479516251.jpg"
}
]
},
{
"fieldType":207,
"data":[
{
"fieldType":207,
"sourceType":17,
"pageIndex":0,
"image":"https://billing.elkyc.com/api/public/file/verification.doc/930a7289-5239-4168-9496-4a8bdb8ef0f6.jpg"
},
{
"fieldType":207,
"sourceType":17,
"pageIndex":1,
"image":"https://billing.elkyc.com/api/public/file/verification.doc/89d42e88-62d5-4485-82de-f476607314f2.jpg"
}
]
},
{
"fieldType":210,
"data":[
{
"fieldType":210,
"sourceType":17,
"pageIndex":1,
"image":"https://billing.elkyc.com/api/public/file/verification.doc/16aa579e-8a2d-4419-a6f4-78ba375e84ea.jpg"
}
]
}
],
"fields":[
{
"fieldType":0,
"data":[
{
"lcid":0,
"status":1,
"pageIndex":1,
"probability":100,
"validity":0,
"value":"I",
"sourceType":3,
"comparison":{
"sourceLeft":null,
"sourceRight":null,
"status":null
}
}
]
},
{
"fieldType":1,
"data":[
{
"lcid":0,
"status":2,
"pageIndex":0,
"probability":0,
"validity":0,
"value":"LVA",
"sourceType":17,
"comparison":{
"sourceLeft":null,
"sourceRight":null,
"status":null
}
},
{
"lcid":0,
"status":1,
"pageIndex":1,
"probability":100,
"validity":0,
"value":"LVA",
"sourceType":3,
"comparison":{
"sourceLeft":null,
"sourceRight":null,
"status":null
}
}
]
},
{
"fieldType":2,
"data":[
{
"lcid":0,
"status":2,
"pageIndex":0,
"probability":100,
"validity":0,
"value":"PA9992592",
"sourceType":17,
"comparison":{
"sourceLeft":null,
"sourceRight":null,
"status":null
}
},
{
"lcid":0,
"status":1,
"pageIndex":1,
"probability":100,
"validity":0,
"value":"PA9992592",
"sourceType":3,
"comparison":{
"sourceLeft":"MRZ",
"sourceRight":"VISUAL",
"status":1
}
}
]
},
{
"fieldType":3,
"data":[
{
"lcid":0,
"status":0,
"pageIndex":0,
"probability":97,
"validity":0,
"value":"04.03.2017",
"sourceType":17,
"comparison":{
"sourceLeft":null,
"sourceRight":null,
"status":null
}
}
]
},
{
"fieldType":4,
"data":[
{
"lcid":0,
"status":2,
"pageIndex":1,
"probability":100,
"validity":0,
"value":"05.03.2012",
"sourceType":17,
"comparison":{
"sourceLeft":null,
"sourceRight":null,
"status":null
}
}
]
},
{
"fieldType":5,
"data":[
{
"lcid":0,
"status":2,
"pageIndex":0,
"probability":100,
"validity":0,
"value":"12.12.1982",
"sourceType":17,
"comparison":{
"sourceLeft":null,
"sourceRight":null,
"status":null
}
},
{
"lcid":0,
"status":1,
"pageIndex":1,
"probability":100,
"validity":0,
"value":"12.12.1982",
"sourceType":3,
"comparison":{
"sourceLeft":"MRZ",
"sourceRight":"VISUAL",
"status":1
}
}
]
},
{
"fieldType":7,
"data":[
{
"lcid":0,
"status":2,
"pageIndex":0,
"probability":99,
"validity":0,
"value":"12128288882",
"sourceType":17,
"comparison":{
"sourceLeft":null,
"sourceRight":null,
"status":null
}
},
{
"lcid":0,
"status":1,
"pageIndex":1,
"probability":100,
"validity":0,
"value":"12128288882",
"sourceType":3,
"comparison":{
"sourceLeft":"MRZ",
"sourceRight":"VISUAL",
"status":1
}
}
]
},
{
"fieldType":8,
"data":[
{
"lcid":1062,
"status":2,
"pageIndex":0,
"probability":98,
"validity":0,
"value":"PARAUDZIŅŠ",
"sourceType":17,
"comparison":{
"sourceLeft":null,
"sourceRight":null,
"status":null
}
},
{
"lcid":0,
"status":2,
"pageIndex":0,
"probability":98,
"validity":0,
"value":"PARAUDZINS",
"sourceType":17,
"comparison":{
"sourceLeft":null,
"sourceRight":null,
"status":null
}
},
{
"lcid":0,
"status":1,
"pageIndex":1,
"probability":100,
"validity":0,
"value":"PARAUDZINS",
"sourceType":3,
"comparison":{
"sourceLeft":"MRZ",
"sourceRight":"VISUAL",
"status":1
}
}
]
},
{
"fieldType":9,
"data":[
{
"lcid":1062,
"status":2,
"pageIndex":0,
"probability":100,
"validity":0,
"value":"ANDRIS",
"sourceType":17,
"comparison":{
"sourceLeft":null,
"sourceRight":null,
"status":null
}
},
{
"lcid":0,
"status":2,
"pageIndex":0,
"probability":100,
"validity":0,
"value":"ANDRIS",
"sourceType":17,
"comparison":{
"sourceLeft":null,
"sourceRight":null,
"status":null
}
},
{
"lcid":0,
"status":1,
"pageIndex":1,
"probability":100,
"validity":0,
"value":"ANDRIS",
"sourceType":3,
"comparison":{
"sourceLeft":"MRZ",
"sourceRight":"VISUAL",
"status":1
}
}
]
}
]
}
]
},
{
"service":"PASSIVE_LIVENESS",
"data":{
"liveness":"SUCCESS",
"livenessError":null,
"createdAt":"2023-05-11T11:55:37.896Z",
"images":[
"https://billing.elkyc.com/api/public/file/verification.passiveLiveness/liveness-1.jpg",
"https://billing.elkyc.com/api/public/file/verification.passiveLivenessVideo/09cc39f7-a12d-4faa-a6da-a883b7d54908_liveness_video.mp4"
]
}
},
{
"service":"PASSIVE_FACE_MATCH",
"data":{
"facematchResult":"DECLINED",
"similarity":0.0176462904,
"images":[
"https://billing.elkyc.com/api/public/file/verification.passiveLiveness/liveness-1.jpg",
"https://billing.elkyc.com/api/public/file/verification.passiveFacematch/09cc39f7-a12d-4faa-a6da-a883b7d54908document_photo.jpg",
"https://billing.elkyc.com/api/public/file/verification.passiveFacematch/09cc39f7-a12d-4faa-a6da-a883b7d54908_document_photo.jpg"
],
"facematchingError":null
}
}
],
"webhookDeliveryState":{
"webhookId":2,
"status":"success",
"eventType":"verificationCompleted",
"errorMessage":"",
"updatedAt":"2023-05-11T11:46:37.440Z"
},
"histories":[
{
"userId":null,
"event":"create",
"description":"Start new verification",
"createdAt":"2023-05-11T11:46:37.414Z"
},
{
"userId":null,
"event":"create",
"description":"Add document step with type [DOCUMENT_CAPTURE]",
"createdAt":"2023-05-11T11:49:23.619Z"
},
{
"userId":null,
"event":"create",
"description":"Create Passive step with type QUALITY",
"createdAt":"2023-05-11T11:55:37.937Z"
},
{
"userId":null,
"event":"update",
"description":"Change verification status to [failed]",
"createdAt":"2023-05-11T11:55:48.154Z"
}
]
}Where:
transactionId - Allpass transactionId (UUIDv4)
clientSession - Session identifier in your system
clientKey - Your own Allpass client key
appKey - Your own Allpass application key (API key)
device - User device information, ip, geo-position
type - Webhook event type
status - Verification status
platform - User platform
sdkVersion - SDK version
services - List of successful verification service types. It can include next entities:
LivenessInfoEntity - 3D liveness on mobile devices
FacematchInfoEntity - Facematch on mobile devices
OtpEntity - One-Time-Password authentication (email/phone)
InnEntity - scan Ukrainian tax number on mobile
ImageEntity - make a custom photo
PassiveLivenessInfoEntity - 3D liveness on web platform
PassiveFacematchInfoEntity - facematch on web platform
failedService - In verification with status
failedthis param specify failed service typeerror - Verification error message
isCloud - Verification cloud flag (for web always
true)servicesData - List of verification services data
histories - List of verification history events
webhookDeliveryState - Verification webhook delivery state
createdAt - Verification created time
updatedAt - Verification confirmation time
Last updated