Detailed verification report

The Detailed Verification Report API retrieves the verification results for a transaction. The following data is included in the report:

• Personal information
• Document information
• An SFT URL to the picture of the ID document
• The score and the threshold that are associated with the verification

For more information about downloading the pictures of the ID document, see Download image binary data.

Syntax

GET /api/transactions/id/detailed-verification-report

Available parameters

Request parameters

Name	Type	Description
id	String	Required. This is the unique identifier of the verification of a single person.

Examples

Example request

1. curl --location --request GET 'http(s)://$host:$port/api/transactions/$TX_ID/detailed-verification-report' \
2. --header 'Authorization: Bearer $TENANT_ACCESS_TOKEN'

Example responses

The Detailed Verification Report response contains information about the various stages of a transaction. The actual content of the response depends on the IDV status of the transaction.

CreateVerification stage response

In this stage, the response covers all data that was submitted prior to the start of the verification process.

1. {
2.   "id": "fe74D66E-6B51-8992-A169-E14C3c281E5f",
3.   "result": "Undefined",
4.   "status": "InProgress",
5.   "stages": [
6.     {
7.       "stageId": 1,
8.       "stageType": {
9.         "title": "CreateVerification"
10.       },
11.       "attemptNumber": 1,
12.       "result": "Passed",
13.       "created": "2021-09-29T18:25:43.511Z",
14.       "details": {
15.         "personalInformation": {
16.           "nameInformation": {
17.             "forename": "John",
18.             "surname": "Doe",
19.             "birthSurname": "B"
20.           },
21.           "dateOfBirth": "1999-01-01",
22.           "addressInformation": {
23.             "flatOrApartmentNumber": 123,
24.             "houseName": "MyHouse",
25.             "houseNumber": 456,
26.             "postCode": "MyPostCode",
27.             "country": "MyCountry",
28.             "countyOrProvince": "MyProvince",
29.             "poBox": 1234,
30.             "street": "MyStreet",
31.             "town": "MyTown",
32.             "city": "MyCity"
33.           },
34.           "mobilePhoneNumber": "+12345678900"
35.         }
36.       }
37.     }
38.   ]
39. }

AddProviderData stage response

In this stage, the response covers all data that was extracted from the provided IDs.

1. {
2.   "stageId": 1,
3.   "stageType": {
4.     "service": "DocumentId",
5.     "provider": "xyz",
6.     "title": "AddProviderData"
7.   },
8.   "comment": "Identity Verification Data is successfully extracted from provider.",
9.   "attemptNumber": 1,
10.   "result": "Passed",
11.   "created": "2023-03-22T12:37:35.065Z",
12.   "details": {
13.     "personalInformation": {
14.       "documentsInformation": [
15.         {
16.           "documentElement": {
17.             "type": "Passport",
18.             "pages": [
19.               {
20.                 "type": "PassportDataPage",
21.                 "url": "sfs://MyURL/default/Test_Tenant_ID/transactions/bf0d536d-3cb9-41b5-b158-8a5936169XXX/document/a5658e14-d174-47f6-8ab2-14da8257cXXX/jpeg"
22.               }
23.             ]
24.           },
25.           "extractedDocumentSegments": [
26.             {
27.               "zone": "MergedZones",
28.               "personalInformation": {
29.                 "nameInformation": {
30.                   "forename": "JOHN",
31.                   "surname": "DOE"
32.                 },
33.                 "dateOfBirth": "1980-01-01",
34.                 "gender": "Male",
35.                 "nationality": "GBR",
36.                 "addressInformation": {},
37.                 "documentElement": {
38.                   "type": "Passport",
39.                   "number": "123456789",
40.                   "issuingCountry": "GB",
41.                   "issuingAuthority": "HMPO",
42.                   "issueDate": "2018-08-09",
43.                   "expiryDate": "2029-05-09"
44.                 }
45.               },
46.               "providerSpecificData": {
47.                 "Document Class Name": "Passport",
48.                 "Issuing State Name": "United Kingdom (Citizen)",
49.                 "Issuing State Code": "GBR",
50.                 "Issue Date": "/Date(1533772800000)/",
51.                 "Document Class Code": "P",
52.                 "Biographic.ExpirationDate": "/Date(1872979200000)/",
53.                 "Nationality Name": "United Kingdom (Citizen)"
54.               }
55.             },
56.             {
57.               "zone": "Viz",
58.               "personalInformation": {
59.                 "nameInformation": {
60.                   "forename": "JOHN",
61.                   "surname": "DOE"
62.                 },
63.                 "dateOfBirth": "1980-01-01",
64.                 "gender": "Male",
65.                 "addressInformation": {},
66.                 "documentElement": {
67.                   "number": "123456789",
68.                   "issuingAuthority": "HMPO",
69.                   "issueDate": "2018-08-09",
70.                   "expiryDate": "2029-05-09"
71.                 }
72.               },
73.               "providerSpecificData": {
74.                 "VIZ Nationality Name": "BRITISH CITIZEN",
75.                 "VIZ Issue Date": "/Date(1533772800000)/",
76.                 "VIZ Expiration Date": "/Date(1872979200000)/"
77.               }
78.             },
79.             {
80.               "zone": "Mrz",
81.               "personalInformation": {
82.                 "nameInformation": {
83.                   "forename": "JOHN",
84.                   "surname": "DOE"
85.                 },
86.                 "dateOfBirth": "1980-01-01",
87.                 "gender": "Male",
88.                 "nationality": "GBR",
89.                 "addressInformation": {},
90.                 "documentElement": {
91.                   "number": "123456789",
92.                   "issuingCountry": "GB",
93.                   "expiryDate": "2029-05-09"
94.                 }
95.               },
96.               "providerSpecificData": {
97.                 "VI Issuing State Code": "GBR",
98.                 "VI Document Class Code": "P",
99.                 "VI Issuing State Name": "United Kingdom (Citizen)",
100.                 "VI Nationality Name": "United Kingdom (Citizen)",
101.                 "VI Expiration Date": "/Date(1872979200000)/"
102.               }
103.             },
104.             {
105.               "zone": "MergedZones",
106.               "segmentCategory": "Type",
107.               "personalInformation": {
108.                 "documentElement": {
109.                   "type": "Passport",
110.                   "issuingCountry": "GB"
111.                 }
112.               },
113.               "providerSpecificData": {
114.                 "Type.IssuerName": "United Kingdom (Citizen)",
115.                 "Type.IssueType": "ePassport",
116.                 "Type.CountryCode": "GBR",
117.                 "Type.IssuerCode": "GBR",
118.                 "Type.ClassName": "Passport",
119.                 "Type.ClassCode": "P"
120.               }
121.             },
122.             {
123.               "zone": "MergedZones",
124.               "segmentCategory": "Front",
125.               "personalInformation": {
126.                 "documentElement": {
127.                   "type": "Passport",
128.                   "issuingCountry": "GB"
129.                 }
130.               },
131.               "providerSpecificData": {
132.                 "Front.ClassCode": "P",
133.                 "Front.IssuerName": "United Kingdom (Citizen)",
134.                 "Front.ClassName": "Passport",
135.                 "Front.IssuerCode": "GBR",
136.                 "Front.IssueType": "ePassport",
137.                 "Front.CountryCode": "GBR"
138.               }
139.             }
140.           ]
141.         }
142.       ]
143.     }
144.   }
145. }

AttemptVerification Stage response

In this stage, the response covers the verification result for a given field.

1. {
2.   "stageId": 3,
3.   "stageType": {
4.     "service": "DocumentId",
5.     "provider": "xyz",
6.     "title": "AttemptVerification"
7.   },
8.   "attemptNumber": 1,
9.   "result": "Passed",
10.   "created": "2023-05-23T10:59:16.088Z",
11.   "details": {
12.     "matchers": [
13.       {
14.         "name": "document_number",
15.         "result": "Match",
16.         "behaviors": [
17.           "AffectsVerificationAttemptResult"
18.         ],
19.         "checks": [
20.           {
21.             "name": "document_number",
22.             "description": "Compares document number submitted and extracted.",
23.             "evaluated": "[1234567M123PB5, KB1234567]",
24.             "operator": "Equivalent",
25.             "evaluatedAgainst": "1234567M123PB5",
26.             "result": "Passed",
27.             "personalInformation": {
28.               "documentsInformation": [
29.                 {
30.                   "documentElement": {
31.                     "number": "1234567M123PB5",
32.                     "pages": [
33.                       {
34.                         "type": "PassportDataPage",
35.                         "url": "sfs://MyURL/default/ONESPAN_IDV_LIVE/transactions/439dfba9-817a-433d-83c3-8c384a43f5de/document/d11196a9-31af-4b94-a154-2695c7d46a00/jpeg"
36.                       }
37.                     ]
38.                   },
39.                   "extractedDocumentSegments": [
40.                     {
41.                       "zone": "MergedZones",
42.                       "personalInformation": {
43.                         "documentElement": {
44.                           "number": "KB1234567",
45.                           "identificationNumber": "1234567M123PB5"
46.                         }
47.                       }
48.                     }
49.                   ]
50.                 }
51.               ]
52.             }
53.           }
54.         ]
55.       },
56.       {
57.         "name": "date_of_birth",
58.         "result": "Match",
59.         "behaviors": [
60.           "AffectsVerificationAttemptResult"
61.         ],
62.         "checks": [
63.           {
64.             "name": "date_of_birth",
65.             "description": "Compares date of birth submitted and extracted.",
66.             "evaluated": "1986-10-16",
67.             "operator": "EqualsTo",
68.             "evaluatedAgainst": "1986-10-16",
69.             "result": "Passed",
70.             "personalInformation": {
71.               "dateOfBirth": "1986-10-16",
72.               "documentsInformation": [
73.                 {
74.                   "documentElement": {
75.                     "type": "Passport",
76.                     "pages": [
77.                       {
78.                         "type": "PassportDataPage",
79.                         "url": "sfs://MyURL/default/ONESPAN_IDV_LIVE/transactions/439dfba9-817a-433d-83c3-8c384a43f5de/document/d11196a9-31af-4b94-a154-2695c7d46a00/jpeg"
80.                       }
81.                     ]
82.                   },
83.                   "extractedDocumentSegments": [
84.                     {
85.                       "zone": "MergedZones",
86.                       "personalInformation": {
87.                         "dateOfBirth": "1986-10-16"
88.                       }
89.                     }
90.                   ]
91.                 }
92.               ]
93.             }
94.           }
95.         ]
96.       },
97.       {
98.         "name": "date_of_expiry",
99.         "result": "Match",
100.         "behaviors": [
101.           "AffectsVerificationAttemptResult"
102.         ],
103.         "checks": [
104.           {
105.             "name": "date_of_expiry",
106.             "description": "Checks that document expire date is today or later.",
107.             "evaluated": "2023-12-15",
108.             "operator": "GreaterOrEqualsTo",
109.             "evaluatedAgainst": "2023-05-23",
110.             "result": "Passed",
111.             "personalInformation": {
112.               "documentsInformation": [
113.                 {
114.                   "documentElement": {
115.                     "type": "Passport",
116.                     "pages": [
117.                       {
118.                         "type": "PassportDataPage",
119.                         "url": "sfs://MyURL/default/ONESPAN_IDV_LIVE/transactions/439dfba9-817a-433d-83c3-8c384a43f5de/document/d11196a9-31af-4b94-a154-2695c7d46a00/jpeg"
120.                       }
121.                     ]
122.                   },
123.                   "extractedDocumentSegments": [
124.                     {
125.                       "zone": "MergedZones",
126.                       "personalInformation": {
127.                         "documentElement": {
128.                           "expiryDate": "2023-12-15"
129.                         }
130.                       }
131.                     }
132.                   ]
133.                 }
134.               ]
135.             }
136.           }
137.         ]
138.       },
139.       {
140.         "name": "document_supported",
141.         "result": "Match",
142.         "behaviors": [
143.           "AffectsVerificationAttemptResult"
144.         ],
145.         "checks": [
146.           {
147.             "name": "document_supported",
148.             "description": "Compares a match of countries and supported document types.",
149.             "evaluated": "{\"type\":\"P\",\"country\":\"GB\"}",
150.             "operator": "Equivalent",
151.             "evaluatedAgainst": "{\"type\":\"P\",\"country\":\"GB\"}",
152.             "result": "Passed",
153.             "personalInformation": {
154.               "documentsInformation": [
155.                 {
156.                   "documentElement": {
157.                     "type": "Passport",
158.                     "issuingCountry": "GB",
159.                     "pages": [
160.                       {
161.                         "type": "PassportDataPage",
162.                         "url": "sfs://MyURL/default/ONESPAN_IDV_LIVE/transactions/439dfba9-817a-433d-83c3-8c384a43f5de/document/d11196a9-31af-4b94-a154-2695c7d46a00/jpeg"
163.                       }
164.                     ]
165.                   },
166.                   "extractedDocumentSegments": [
167.                     {
168.                       "zone": "MergedZones",
169.                       "personalInformation": {
170.                         "documentElement": {
171.                           "type": "Passport",
172.                           "issuingCountry": "GB"
173.                         }
174.                       },
175.                       "providerSpecificData": {
176.                         "documentType": "XX_Passport_YYYY",
177.                         "DD_ExpeditionPlace_Out": "GBR",
178.                         "DD_IssuingCountry_Out": "GBR"
179.                       }
180.                     }
181.                  ]
182.                 }
183.               ]
184.             }
185.           }
186.         ]
187.       },
188.       {
189.         "name": "address_match",
190.         "comment": "Some data was not supplied, the comparison cannot be executed.",
191.         "result": "Error",
192.         "behaviors": [
193.           "ExecuteOnly"
194.         ],
195.         "checks": [
196.           {
197.             "name": "address_match",
198.             "description": "Compares address submitted and extracted.",
199.             "operator": "Equivalent",
200.             "evaluatedAgainst": "{\"houseNumber\":\"11\",\"postCode\":\"ABC123\",\"poBox\":\"1234\"}",
201.             "result": "AnalysedDataInsufficient",
202.             "personalInformation": {
203.               "addressInformation": {
204.                 "houseNumber": "11",
205.                 "postCode": "ABC123",
206.                 "poBox": "1234"
207.               },
208.               "documentsInformation": [
209.                 {
210.                   "documentElement": {
211.                     "type": "Passport",
212.                     "pages": [
213.                       {
214.                         "type": "PassportDataPage",
215.                         "url": "sfs://MyURL/default/ONESPAN_IDV_LIVE/transactions/439dfba9-817a-433d-83c3-8c384a43f5de/document/d11196a9-31af-4b94-a154-2695c7d46a00/jpeg"
216.                       }
217.                     ]
218.                   }
219.                 }
220.               ]
221.             }
222.           }
223.         ]
224.       },
225.       {
226.         "name": "name",
227.         "result": "Match",
228.         "behaviors": [
229.           "AffectsVerificationAttemptResult"
230.         ],
231.         "checks": [
232.           {
233.             "name": "name",
234.             "description": "Full name match: compares different name part submitted and extracted in order to determine how closely the submitted and extracted data is. Matching the calculated proximity is between 0.0 and 1.0 which is to be understood as a percentage of similarity.",
235.             "evaluated": "1.0",
236.             "operator": "GreaterOrEqualsTo",
237.             "evaluatedAgainst": "1.0",
238.             "result": "Passed",
239.             "personalInformation": {
240.               "nameInformation": {
241.                 "forename": "John",
242.                 "surname": "Doe"
243.               },
244.               "documentsInformation": [
245.                 {
246.                   "documentElement": {
247.                     "type": "Passport",
248.                     "pages": [
249.                       {
250.                         "type": "PassportDataPage",
251.                         "url": "sfs://MyURL/default/ONESPAN_IDV_LIVE/transactions/439dfba9-817a-433d-83c3-8c384a43f5de/document/d11196a9-31af-4b94-a154-2695c7d46a00/jpeg"
252.                       }
253.                     ]
254.                   },
255.                   "extractedDocumentSegments": [
256.                     {
257.                       "zone": "MergedZones",
258.                       "personalInformation": {
259.                         "nameInformation": {
260.                           "forename": "JOHN",
261.                           "surname": "DOE"
262.                         }
263.                       }
264.                     }
265.                   ]
266.                 }
267.               ]
268.             }
269.           }
270.         ]
271.       },
272.       {
273.         "name": "face_similarity",
274.         "result": "Match",
275.         "behaviors": [
276.           "AffectsVerificationAttemptResult"
277.         ],
278.         "checks": [
279.           {
280.             "name": "face_similarity",
281.             "description": "Determine how closely selfie(s) is(are) similar to picture of the person on the document.",
282.             "evaluated": "0.9999998366743112",
283.             "operator": "GreaterOrEqualsTo",
284.             "evaluatedAgainst": "0.7",
285.             "result": "Passed",
286.             "personalInformation": {
287.               "documentsInformation": [
288.                 {
289.                   "documentElement": {
290.                     "type": "Passport",
291.                     "pages": [
292.                       {
293.                         "type": "PassportDataPage",
294.                         "url": "sfs://MyURL/default/DTE_AGREEMENT_AUTOMATION_TEST/transactions/yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy/document/a0564f56-be41-4d94-ad3f-8069c132bec0/jpeg"
295.                       }
296.                     ]
297.                   },
298.                   "analyzedData": [
299.                     {
300.                       "result": "0.9999998366743112",
301.                       "biometricInformation": {
302.                         "type": "Picture",
303.                         "detail": "Selfie",
304.                         "url": "sfs://MyURL/default/DTE_AGREEMENT_AUTOMATION_TEST/transactions/yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy/biometrics/23268a24-1d1f-420e-b33c-878bb313eef6/jpeg"
305.                       }
306.                     }
307.                   ]
308.                 }
309.               ]
310.             }
311.           }
312.         ]
313.       },
314.       {
315.         "name": "liveness_check",
316.         "result": "Match",
317.         "behaviors": [
318.           "AffectsVerificationAttemptResult"
319.         ],
320.         "checks": [
321.           {
322.             "name": "liveness_check",
323.             "description": "Checks the liveness of the selfie(s).",
324.             "evaluated": "1.0",
325.             "operator": "GreaterOrEqualsTo",
326.             "evaluatedAgainst": "0.95",
327.             "result": "Passed",
328.             "personalInformation": {
329.               "documentsInformation": [
330.                 {
331.                   "documentElement": {
332.                     "type": "Passport",
333.                     "pages": [
334.                       {
335.                         "type": "PassportDataPage",
336.                         "url": "sfs://MyURL/default/DTE_AGREEMENT_AUTOMATION_TEST/transactions/yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy/document/a0564f56-be41-4d94-ad3f-8069c132bec0/jpeg"
337.                       }
338.                     ]
339.                   },
340.                   "analyzedData": [
341.                     {
342.                       "result": "1.0",
343.                       "biometricInformation": {
344.                         "type": "Picture",
345.                         "detail": "Selfie",
346.                         "url": "sfs://MyURL/default/DTE_AGREEMENT_AUTOMATION_TEST/transactions/yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy/biometrics/23268a24-1d1f-420e-b33c-878bb313eef6/jpeg"
347.                       }
348.                     }
349.                   ]
350.                 }
351.               ]
352.             }
353.           }
354.         ]
355.       }
356.     ]
357.   }
358. }
359. ]
360. }

Status codes

Status codes

Status code	Name	Description
200	OK	Verification report is successfully retrieved.
400	Bad Request	The client has provided invalid input.
401	Unauthorized	The client has not provided a valid access token, or has provided an access token which misses a number of claims. In this specific case, for reasons of security, no details are provided in the response.
404	Not Found	The requested resource was not found.
500	Internal Server Error	The server encountered an unexpected condition which prevented it from completing the request.