Onboarding

get
https://individual-api.synaps.io
/v3/onboarding/overview
Overview
API Response
Field
Type
Description
app
AppInfo | Object
App info
session
SessionInfo | Object
Session Info
steps
Steps | Array
Details of verification steps
sandbox
boolean
true if session is sandbox
false is session is production
settings
Settings | Object
Settings for verification flow by steps
submitted_documents
SubmittedDocs | Object
Array of document types 
previously submitted
for identity & residency steps
AppInfo | Object
Field
Type
Description
name
string
Name of app
logo_url
string
Logo URL of app
SessionInfo | Object
Field
Type
Description
session_id
string
id of the session
alias
string
alias of the session
status
string
State of the session
VALIDATED
PENDING
CANCELLED
sandbox
boolean
​
Steps | Array
Field
Type
Description
state
string
State of the step
VALIDATED
NOT_STARTED
PENDING
FINAL_REJECTED
name
string
Name of the step
LIVENESS
IDENTITY
RESIDENCY
PHONE
history
StepsHistory | Array
History of steps state
StepsHistory | Array
Field
Type
Description
review_message
string
Explanation of rejection
review_date
string
Date of review
Settings | Object
Field
Type
Description
key
string
ID of step
restricted_documents
RestrictedDocuments | Object
List of restricted documents by countries
restricted_countries
RestrictedCountries | Object
List of restricted countries
1
   "settings": {
2
      "281342961711": {
3
         "restricted_documents": {
4
            "ABW": {},
5
            "AFG": {},
6
            "AGO": {},
7
            "AIA": {}
8
         },
9
         "restricted_countries": {}
10
      },
11
      "281342966982": {
12
         "restricted_documents": {
13
            "ABW": {},
14
            "AFG": {},
15
            "AGO": {},
16
            "AIA": {},
17
            "ALA": {}
18
         },
19
         "restricted_countries": {}
20
      },
21
      "281342968582": {
22
         "restricted_documents": {
23
            "ABW": {},
24
            "AFG": {},
25
            "AGO": {},
26
            "AIA": {},
27
            "ALA": {},
28
            "ALB": {},
29
            "AND": {},
30
            "FRA": {
31
               "DRIVER_LICENSE": true,
32
               "NATIONAL_ID": true,
33
               "PASSPORT": true,
34
               "RESIDENT_PERMIT": true
35
            }
36
         },
37
         "restricted_countries": {
38
            "FRA": true
39
         }
40
      }
41
   },
Copied!
RestrictedDocuments | Object
Field
Type
Description
key
string
ISO-3166 country code
value
boolean
true if restricted
false if allowed
1
"restricted_countries": {
2
    "FRA": true
3
}
Copied!
RestrictedCountries | Object
Field
Type
Description
key
string
ISO-3166 country code
value
boolean
document_type: boolean
​
document_type can be:
PASSPORT
NATIONAL_ID
DRIVER_LICENSE
RESIDENT_PERMIT
1
"FRA": {
2
   "DRIVER_LICENSE": true,
3
   "NATIONAL_ID": true,
4
   "PASSPORT": true,
5
   "RESIDENT_PERMIT": true
6
}
Copied!
get
https://individual-api.synaps.io
/v3/onboarding/details
Details
API Response
Field
Type
Description
app_id
string
App ID
sandbox
boolean
true if session is sandbox
false if session is production
session_id
string
Synaps Session-Id
alias
string
alias (optional) given on
session initialisation
steps
VerificationSteps | Object
map of verification steps with step_id as index
session
SessionInfo | Object
Session Info
aml
AmlCheck | Object
See AML reference​
VerificationSteps | Object
Field
Type
Description
key
string
step_id
value
VerificationStepDetails | Object
Verification step details
SessionInfo | Object
Field
Type
Description
session_id
string
id of the session
alias
string
alias of the sesion
status
string
State of the session
VALIDATED
PENDING
CANCELLED
sandbox
boolean
​
VerificationStepDetails | Object
For each step, you will have a type field and a verification field. Type is made of 4 type step. Each type has its own response structure available on their respective page.
Step Type
Response Reference
IDENTITY
​IdentityVerificationResponse (see reference)​
RESIDENCY
​ResidencyVerificationResponse (see reference)​
PHONE
​PhoneVerificationResponse (see reference)​
LIVENESS
​LivenessVerificationResponse (see reference)​
​