Flow Details
Flow details lets you access all resources for each steps that is part of your verification flow.
getVerification flow details
get
https://workflow-api.synaps.io/v2/workflow/details
Get all information about all your steps in your verification flow
Request
Response
Request
Headers
Api-Key
required
string
Synaps application Api-Key
Session-Id
required
string
Session-Id that you want retrieve info
Response
200: OK
​
All steps follows the same format structure as their standalone version. For instance, the API Response structure of identity is available in the identity section > details​
Example Response
Field |
| Description |
session_id |
| Verification flow session_id |
residency_step |
| Residency Details structure available here​ |
identity_step |
| Identity Details structure available here​ |
phone_step |
| Phone Details structure available here​ |
liveness_step |
| Liveness Details structure available here |
{"session_id":"b973ebd6-b295-4f9d-12d6-8976847d","residency_step":[{"file": "<SYNAPS_SIGNED_LINK>","session_id":"1b222e8f-d71d-2266-8ba2-7343bfe1","state":"VALIDATED","valid":true,"firstname": "John","lastname": "Doe","address":"75 Emerson Street","country":"USA","city":"Los Angeles","document_type":"UTILITY_BILL","issuing_date":"2020-07-29","history": [{"state": "VALIDATED","notice_date": "2020-07-16T15:35:40.271306Z"}],}],"identity_step":[{"state":"VALIDATED","verification":{"info":{"firstname": {"value":"JOHN","crosscheck_score":1,"cross_checkable":true},"lastname":{"value":"DOE","crosscheck_score":1,"cross_checkable":true},"birth_date":{"value":"1998-06-08","crosscheck_score":1,"cross_checkable":true},"document_number":{"value":"273842JRJNE","crosscheck_score":1,"cross_checkable":true},"document_country":{"value":"USA","crosscheck_score":0,"cross_checkable":false},"document_type":{"value":"PASSPORT","crosscheck_score":0,"cross_checkable":false},"document_expiration":{"value":"2024-12-31","crosscheck_score":1,"cross_checkable":true},"nationality":{"value":"USA","crosscheck_score":1,"cross_checkable": true}},"valid": true,"document_country":"USA","document_type":"PASSPORT","authenticity_score":1,"features":{"security":[{"name":"USA Watermark","confidence_score":1,"included":true},{"name":"USA Header","confidence_score":1,"included":true},{"name":"Face","confidence_score":1,"included":true},{"name":"Signature","confidence_score":1,"included":true}],"data":[{"name":"Firstname","confidence_score":1,"included":true},{"name":"Lastname","confidence_score":1,"included":true},{"name":"Birth Date","confidence_score":1,"included":true},{"name":"Document Number","confidence_score":1,"included":true},{"name":"Document Expiration","confidence_score":1,"included":true},{"name":"Issuing Organization","confidence_score":1,"included":true},{"name":"Address","confidence_score":1,"included":true},{"name":"Initials","confidence_score":1,"included":true},{"name":"Nationality","confidence_score":1,"included":true},{"name":"Height","confidence_score":1,"included":true},{"name":"Gender","confidence_score":1,"included":true},{"name":"Issuing Date","confidence_score":1,"included":true},{"name":"Birth Place","confidence_score":1,"included":true}],"mrz":{"name":"MRZ","confidence_score":1,"included":true,"verified":true,"mode": "TEXT","algorithm": "FRA_ID_1994"}},"notices": null},"session_id":"8e61743f-1303-06ad-11c6-88fc3aa2","facematch":{"valid": true,"state":"VERIFIED"}},{"state":"VALIDATED","verification":{"info":{"firstname":{"value":"JOHN","crosscheck_score":1,"cross_checkable":true},"lastname":{"value":"DOE","crosscheck_score":1,"cross_checkable":true},"birth_date":{"value":"1993-09-04","crosscheck_score":1,"cross_checkable":true},"document_number":{"value":"RKJENZ23","crosscheck_score":1,"cross_checkable":true},"document_country":{"value":"FRA","crosscheck_score":0,"cross_checkable":false},"document_type":{"value":"PASSPORT","crosscheck_score":0,"cross_checkable":false},"document_expiration":{"value":"2028-05-13","crosscheck_score":1,"cross_checkable":true},"nationality":{"value":"FRA","crosscheck_score":1,"cross_checkable":true}},"valid":true,"document_country":"FRA","document_type":"PASSPORT","authenticity_score":0.8083333,"features":{"security":[{"name":"Face","confidence_score": 0.2,"included":true},{"name":"Document Number Punch","confidence_score": 1,"included":true},{"name":"French Republic Watermark","confidence_score": 0.2,"included":true},{"name":"French Republic","confidence_score": 0.2,"included":true}],"data":[{"name":"Firstname","confidence_score": 1,"included":true},{"name":"Lastname","confidence_score": 1,"included":true},{"name":"Birth Date","confidence_score": 1,"included":true},{"name":"Nationality","confidence_score": 1,"included":true},{"name":"Document Number","confidence_score": 1,"included":true},{"name":"Document Expiration","confidence_score": 1,"included": true},{"name":"Issuing Date","confidence_score": 1,"included": true},{"name":"Birth Place","confidence_score":1,"included": true},{"name":"Eyes Color","confidence_score":1,"included": true},{"name": "Authority","confidence_score": 1,"included": true},{"name":"Address","confidence_score": 0.5,"included": true},{"name": "Height","confidence_score": 0.5,"included": true},{"name": "Document Country","confidence_score": 0.5,"included": true},{"name":"Gender","confidence_score": 0.5,"included": true},{"name":"Document Type","confidence_score": 0.5,"included": true}],"mrz":{"name":"MRZ","confidence_score": 1,"included": true,"verified": true,"mode": "TEXT","algorithm": "DEFAULT_PP"}},"front_file": "<SYNAPS_SIGNED_LINK>","back_file": "<SYNAPS_SIGNED_LINK>","history": [{"state": "VALIDATED","notice_date": "2020-07-16T15:35:40.271306Z"}],},"aml":{"state":"VERIFIED","session_id":"","aml_info":{"recordsFound":0,"matches":[​]}},"session_id":"9d831b7c-0584-7c3a-29ce-10a685de","facematch":{"valid":true,"state":"VERIFIED"}}],"phone_step":{"valid":true,"phone_number":"632336247","country":"33","state":"VALIDATED","session_id":"5aa9f8a9-80c7-9b8d-6b74-f5ed40c3"},"liveness_step":{"probability": 0.9,"file": "<SYNAPS_SIGNED_LINK>","session_id":"7968bc7e-d75b-fc56-9317-18db6ff4","valid":true,"state":"VALIDATED"}}
Last updated 3 months ago