Flow Details

Flow details lets you access all resources for each steps that is part of your verification flow.

get
Verification flow details

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
{
"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"
}
}

API Response

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

Type

Description

session_id

string

Verification flow session_id

residency_step

Array of Residency Details

Residency Details

identity_step

Array of Identity Details

Identity Details

phone_step

Phone Details

Phone Details

liveness_step

Liveness Details

Liveness Details

Identity Details

Field

Type

Description

verification

VerificationObject

Complete verification structure

session_id

string

Session ID of the identity verification

aml

AmlObject

AML Structure available in AML Check Structure Page

state

string

PENDING - Identity in review

VALIDATED - Identity valid

REJECTED - Identity rejected

NOT_STARTED - Identity not yet submitted

history

HistoryArray

Array of history containing all previous verification and reason of invalidity

front_file

string

Synaps Signed Link of the Front File (expires 15min after request)

back_file

string

Synaps Signed Link of the Back File (expires 15min after request)

HistoryArray

Field

Type

Description

notice_date

date

Date of verification

state

string

PENDING - Identity in review

VALIDATED - Identity valid

REJECTED - Identity rejected

NOT_STARTED - Identity not yet submitted

review

string

Empty if VALIDATED

Review message explaining the reason of verification incompletion

VerificationObject

Field

Type

Description

info

InfoObject

Person identity information

valid

boolean

true if there is no inconsistency,

missing information or expiration

authenticity_score

number

overall score of the processed verification

based on our confidence score and cross

checking score when any

features

FeaturesArray

list of security features, data and MRZ that

must be on the document to be genuine

InfoObject Standard information of a processed identity verification

Field

Type

Description

firstname

IdentityInfoObject

Legal firstname

lastname

IdentityInfoObject

Legal lastname

birth_date

IdentityInfoObject

Birth Date (Format YYYY-MM-DD)

document_number

IdentityInfoObject

Document number

document_country

IdentityInfoObject

Document country (ISO-3166 format)

document_type

IdentityInfoObject

Document Type (PASSPORT, NATIONAL_ID, DRIVER_LICENSE, RESIDENT_PERMIT)

document_expiration

IdentityInfoObject

Document Expiration Date (Format YYYY-MM-DD)

nationality

IdentityInfoObject

Nationality country (ISO-3166 format) - Empty if document_type is a Driver License

IdentityInfoObject Value of extracted information

Field

Type

Description

value

string

Value of the field

crosscheck_score

number

Cross-check score (if there is a MRZ, a cross-checking will be processed against OCR value)

cross_checkable

boolean

true if there is multiple source of extraction (OCR + MRZ)

false if there is only one source of extraction (OCR)

if cross_checkable is false, crosscheck_score is equal to 0.00

FeaturesArray Array of features

Field

Type

Description

security

SecurityFeaturesArray

list of all security features included in the document

data

DocumentDataArray

list of all document data included in the document

mrz

MrzArray

list of all MRZ (Machine Readable Zone) included

on the document

SecurityFeaturesArray Array of document security features

Field

Type

Description

value

string

Name of the security feature

confidence_score

number

Percentage (0 to 1) of our AI confidence score

included

boolean

true if the feature is included on the document

false if the feature is missing

DocumentDataArray Array of document data features

Field

Type

Description

value

string

Name of the document data field

confidence_score

number

Percentage (0 to 1) of our AI confidence score

included

boolean

true if the feature is included on the document

false if the feature is missing

MrzArray Array of document MRZ (Machine Readable Zone)

Field

Type

Description

value

string

Name of the Machine Readable Zone

confidence_score

number

Percentage (0 to 1) of our confidence score

included

boolean

true if the feature is included on the document

false if the feature is missing

verified

boolean

true if the MRZ algorithm has been verified

false if the MRZ algorithm is inconsistent

Residency Details

Field

Type

Description

valid

boolean

Document validity

true - valid

false - invalid

firstname

string

Legal firstname

lastname

string

Legal lastname

address

string

Address

city

string

City

country

string

Country

zip_code

string

Zip Code (optional)

issuing_date

string

Issuing Date of proof of residency

Date Format (YYYY-MM-DD)

document_type

string

Document Type

BANK_STATEMENT

UTILITY_BILL

history

array of history object

Array of history containing all previous verification and reason of invalidity

session_id

string

Session ID of the proof of residency verification

state

string

PENDING - Residency in review

VALIDATED - Residency valid

REJECTED - Residency rejected

NOT_STARTED - Residency not yet submitted

file

string

Synaps Signed Link of the Residency File (expires 15min after request)

history object

Field

Type

Description

notice_date

date

Date of verification

state

string

PENDING - Residency in review

VALIDATED - Residency valid

REJECTED - Residency rejected

NOT_STARTED - Residency not yet submitted

review

string

Empty if VALIDATED

Review message explaining the reason of verification incompletion

Phone Details

Field

Type

Description

valid

boolean

Document validity

true - valid

false - invalid

phone_number

string

phone number

country

string

country code number

session_id

string

Session ID of the phone verification

state

string

PENDING - Phone in review

VALIDATED - Phone valid

REJECTED - Phone rejected

NOT_STARTED - Phone not yet submitted

Liveness Details

Field

Type

Description

valid

boolean

Liveness challenge validity

true - valid

false - invalid

session_id

string

Session ID of the liveness

state

string

PENDING - Liveness in review

VALIDATED - Liveness valid

REJECTED - Liveness rejected

NOT_STARTED - Liveness not yet submitted

probability

number

Score between 0 and 1 to determine the probability of liveness the person (higher is better)

file

string

Synaps Signed Link of the Liveness Face (expires 15min after request)