elKYC Web SDK
Search
K

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
1
{
2
"transactionId":"09cc39f7-a12d-4faa-a6da-a883b7d54908",
3
"clientKey":"b6c98bc0-06b4-4cc7-89b1-ebd71b856d20",
4
"appKey":"5c241801-428b-42bd-b7fb-7c9e09ac1101",
5
"status":"failed",
6
"platform":"web",
7
"clientSession":"client session identifier",
8
"services":[
9
"DOCUMENT_CAPTURE",
10
"PASSIVE_LIVENESS",
11
],
12
"type":"verificationCompleted",
13
"failedService":"FACE_MATCH",
14
"error":"[faceMatch] BIOMETRY: Resolution status is DECLINED",
15
"isCloud":true,
16
"createdAt":"2023-05-11T11:46:37.414Z",
17
"updatedAt":"2023-05-11T11:55:48.114Z",
18
"device":{
19
"sdkVersion":"1.0.2",
20
"ip":"::ffff:127.0.0.1 ",
21
"country":null,
22
"region":null,
23
"eu":null,
24
"timezone":null,
25
"city":null,
26
"metro":null,
27
"ll":null,
28
"area":null,
29
"userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/112.0",
30
"browserType":"firefox",
31
"browserVersion":"112.0.0"
32
},
33
"servicesData":[
34
{
35
"service":"DOCUMENT_CAPTURE",
36
"data":[
37
{
38
"stepType":"DOCUMENT_CAPTURE",
39
"elapsedTime":828,
40
"elapsedTimeRFID":0,
41
"overallResult":0,
42
"morePagesAvailable":0,
43
"uploadedPagesCount":2,
44
"createdAt":"2023-05-11T11:49:22.758Z",
45
"types":[
46
{
47
"name":"Latvia - Id Card (2012) #2",
48
"pageIndex":0,
49
"hasMRZ":false,
50
"icao":"LVA",
51
"type":12,
52
"year":"2012",
53
"format":0
54
},
55
{
56
"name":"Latvia - Id Card (2012) #2 Side B",
57
"pageIndex":1,
58
"hasMRZ":true,
59
"icao":"LVA",
60
"type":12,
61
"year":"2012",
62
"format":0
63
}
64
],
65
"graphics":[
66
{
67
"fieldType":201,
68
"data":[
69
{
70
"fieldType":201,
71
"sourceType":17,
72
"pageIndex":0,
73
"image":"https://billing.elkyc.com/api/public/file/verification.doc/17061d90-92e3-4091-9404-596b4cee2afd.jpg"
74
}
75
]
76
},
77
{
78
"fieldType":204,
79
"data":[
80
{
81
"fieldType":204,
82
"sourceType":17,
83
"pageIndex":0,
84
"image":"https://billing.elkyc.com/api/public/file/verification.doc/1aeba861-763f-4b9d-8873-7dd0425c88c5.jpg"
85
}
86
]
87
},
88
{
89
"fieldType":205,
90
"data":[
91
{
92
"fieldType":205,
93
"sourceType":17,
94
"pageIndex":1,
95
"image":"https://billing.elkyc.com/api/public/file/verification.doc/5ec2744e-3348-49cc-a5e8-8d1479516251.jpg"
96
}
97
]
98
},
99
{
100
"fieldType":207,
101
"data":[
102
{
103
"fieldType":207,
104
"sourceType":17,
105
"pageIndex":0,
106
"image":"https://billing.elkyc.com/api/public/file/verification.doc/930a7289-5239-4168-9496-4a8bdb8ef0f6.jpg"
107
},
108
{
109
"fieldType":207,
110
"sourceType":17,
111
"pageIndex":1,
112
"image":"https://billing.elkyc.com/api/public/file/verification.doc/89d42e88-62d5-4485-82de-f476607314f2.jpg"
113
}
114
]
115
},
116
{
117
"fieldType":210,
118
"data":[
119
{
120
"fieldType":210,
121
"sourceType":17,
122
"pageIndex":1,
123
"image":"https://billing.elkyc.com/api/public/file/verification.doc/16aa579e-8a2d-4419-a6f4-78ba375e84ea.jpg"
124
}
125
]
126
}
127
],
128
"fields":[
129
{
130
"fieldType":0,
131
"data":[
132
{
133
"lcid":0,
134
"status":1,
135
"pageIndex":1,
136
"probability":100,
137
"validity":0,
138
"value":"I",
139
"sourceType":3,
140
"comparison":{
141
"sourceLeft":null,
142
"sourceRight":null,
143
"status":null
144
}
145
}
146
]
147
},
148
{
149
"fieldType":1,
150
"data":[
151
{
152
"lcid":0,
153
"status":2,
154
"pageIndex":0,
155
"probability":0,
156
"validity":0,
157
"value":"LVA",
158
"sourceType":17,
159
"comparison":{
160
"sourceLeft":null,
161
"sourceRight":null,
162
"status":null
163
}
164
},
165
{
166
"lcid":0,
167
"status":1,
168
"pageIndex":1,
169
"probability":100,
170
"validity":0,
171
"value":"LVA",
172
"sourceType":3,
173
"comparison":{
174
"sourceLeft":null,
175
"sourceRight":null,
176
"status":null
177
}
178
}
179
]
180
},
181
{
182
"fieldType":2,
183
"data":[
184
{
185
"lcid":0,
186
"status":2,
187
"pageIndex":0,
188
"probability":100,
189
"validity":0,
190
"value":"PA9992592",
191
"sourceType":17,
192
"comparison":{
193
"sourceLeft":null,
194
"sourceRight":null,
195
"status":null
196
}
197
},
198
{
199
"lcid":0,
200
"status":1,
201
"pageIndex":1,
202
"probability":100,
203
"validity":0,
204
"value":"PA9992592",
205
"sourceType":3,
206
"comparison":{
207
"sourceLeft":"MRZ",
208
"sourceRight":"VISUAL",
209
"status":1
210
}
211
}
212
]
213
},
214
{
215
"fieldType":3,
216
"data":[
217
{
218
"lcid":0,
219
"status":0,
220
"pageIndex":0,
221
"probability":97,
222
"validity":0,
223
"value":"04.03.2017",
224
"sourceType":17,
225
"comparison":{
226
"sourceLeft":null,
227
"sourceRight":null,
228
"status":null
229
}
230
}
231
]
232
},
233
{
234
"fieldType":4,
235
"data":[
236
{
237
"lcid":0,
238
"status":2,
239
"pageIndex":1,
240
"probability":100,
241
"validity":0,
242
"value":"05.03.2012",
243
"sourceType":17,
244
"comparison":{
245
"sourceLeft":null,
246
"sourceRight":null,
247
"status":null
248
}
249
}
250
]
251
},
252
{
253
"fieldType":5,
254
"data":[
255
{
256
"lcid":0,
257
"status":2,
258
"pageIndex":0,
259
"probability":100,
260
"validity":0,
261
"value":"12.12.1982",
262
"sourceType":17,
263
"comparison":{
264
"sourceLeft":null,
265
"sourceRight":null,
266
"status":null
267
}
268
},
269
{
270
"lcid":0,
271
"status":1,
272
"pageIndex":1,
273
"probability":100,
274
"validity":0,
275
"value":"12.12.1982",
276
"sourceType":3,
277
"comparison":{
278
"sourceLeft":"MRZ",
279
"sourceRight":"VISUAL",
280
"status":1
281
}
282
}
283
]
284
},
285
{
286
"fieldType":7,
287
"data":[
288
{
289
"lcid":0,
290
"status":2,
291
"pageIndex":0,
292
"probability":99,
293
"validity":0,
294
"value":"12128288882",
295
"sourceType":17,
296
"comparison":{
297
"sourceLeft":null,
298
"sourceRight":null,
299
"status":null
300
}
301
},
302
{
303
"lcid":0,
304
"status":1,
305
"pageIndex":1,
306
"probability":100,
307
"validity":0,
308
"value":"12128288882",
309
"sourceType":3,
310
"comparison":{
311
"sourceLeft":"MRZ",
312
"sourceRight":"VISUAL",
313
"status":1
314
}
315
}
316
]
317
},
318
{
319
"fieldType":8,
320
"data":[
321
{
322
"lcid":1062,
323
"status":2,
324
"pageIndex":0,
325
"probability":98,
326
"validity":0,
327
"value":"PARAUDZIŅŠ",
328
"sourceType":17,
329
"comparison":{
330
"sourceLeft":null,
331
"sourceRight":null,
332
"status":null
333
}
334
},
335
{
336
"lcid":0,
337
"status":2,
338
"pageIndex":0,
339
"probability":98,
340
"validity":0,
341
"value":"PARAUDZINS",
342
"sourceType":17,
343
"comparison":{
344
"sourceLeft":null,
345
"sourceRight":null,
346
"status":null
347
}
348
},
349
{
350
"lcid":0,
351
"status":1,
352
"pageIndex":1,
353
"probability":100,
354
"validity":0,
355
"value":"PARAUDZINS",
356
"sourceType":3,
357
"comparison":{
358
"sourceLeft":"MRZ",
359
"sourceRight":"VISUAL",
360
"status":1
361
}
362
}
363
]
364
},
365
{
366
"fieldType":9,
367
"data":[
368
{
369
"lcid":1062,
370
"status":2,
371
"pageIndex":0,
372
"probability":100,
373
"validity":0,
374
"value":"ANDRIS",
375
"sourceType":17,
376
"comparison":{
377
"sourceLeft":null,
378
"sourceRight":null,
379
"status":null
380
}
381
},
382
{
383
"lcid":0,
384
"status":2,
385
"pageIndex":0,
386
"probability":100,
387
"validity":0,
388
"value":"ANDRIS",
389
"sourceType":17,
390
"comparison":{
391
"sourceLeft":null,
392
"sourceRight":null,
393
"status":null
394
}
395
},
396
{
397
"lcid":0,
398
"status":1,
399
"pageIndex":1,
400
"probability":100,
401
"validity":0,
402
"value":"ANDRIS",
403
"sourceType":3,
404
"comparison":{
405
"sourceLeft":"MRZ",
406
"sourceRight":"VISUAL",
407
"status":1
408
}
409
}
410
]
411
}
412
]
413
}
414
]
415
},
416
{
417
"service":"PASSIVE_LIVENESS",
418
"data":{
419
"liveness":"SUCCESS",
420
"livenessError":null,
421
"createdAt":"2023-05-11T11:55:37.896Z",
422
"images":[
423
"https://billing.elkyc.com/api/public/file/verification.passiveLiveness/liveness-1.jpg",
424
"https://billing.elkyc.com/api/public/file/verification.passiveLivenessVideo/09cc39f7-a12d-4faa-a6da-a883b7d54908_liveness_video.mp4"
425
]
426
}
427
},
428
{
429
"service":"PASSIVE_FACE_MATCH",
430
"data":{
431
"facematchResult":"DECLINED",
432
"similarity":0.0176462904,
433
"images":[
434
"https://billing.elkyc.com/api/public/file/verification.passiveLiveness/liveness-1.jpg",
435
"https://billing.elkyc.com/api/public/file/verification.passiveFacematch/09cc39f7-a12d-4faa-a6da-a883b7d54908document_photo.jpg",
436
"https://billing.elkyc.com/api/public/file/verification.passiveFacematch/09cc39f7-a12d-4faa-a6da-a883b7d54908_document_photo.jpg"
437
],
438
"facematchingError":null
439
}
440
}
441
],
442
"webhookDeliveryState":{
443
"webhookId":2,
444
"status":"success",
445
"eventType":"verificationCompleted",
446
"errorMessage":"",
447
"updatedAt":"2023-05-11T11:46:37.440Z"
448
},
449
"histories":[
450
{
451
"userId":null,
452
"event":"create",
453
"description":"Start new verification",
454
"createdAt":"2023-05-11T11:46:37.414Z"
455
},
456
{
457
"userId":null,
458
"event":"create",
459
"description":"Add document step with type [DOCUMENT_CAPTURE]",
460
"createdAt":"2023-05-11T11:49:23.619Z"
461
},
462
{
463
"userId":null,
464
"event":"create",
465
"description":"Create Passive step with type QUALITY",
466
"createdAt":"2023-05-11T11:55:37.937Z"
467
},
468
{
469
"userId":null,
470
"event":"update",
471
"description":"Change verification status to [failed]",
472
"createdAt":"2023-05-11T11:55:48.154Z"
473
}
474
]
475
}
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:
  • failedService - In verification with status failed this param specify failed service type
  • error - 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
elKYC - Allpass.ai 2023