Onboarding

get
Overview
https://individual-api.synaps.io/v3/onboarding/overview
Gives access to the state of each step and settings with document/country restrictions
Request
Response
Request
Headers
Session-Id
required
string
Session-Id
Response
200: OK
{
   "app": {
      "name": "Aribnb",
      "logo_url": "https://storage.googleapis.com/synaps-apps-media-v3-preprod/a9a12146-8c3e26c2-68574021-3fe04899_1627307708587_Xvl22FkoSxNrDqiVtgONOHtHH5lWueEd.png"
   },
   "steps": [
      {
         "state": "NOT_STARTED",
         "name": "LIVENESS",
         "id": "281342966982",
         "dependency": "",
         "history": []
      },
      {
         "state": "NOT_STARTED",
         "name": "IDENTITY",
         "id": "281342968582",
         "dependency": "",
         "history": []
      },
      {
         "state": "NOT_STARTED",
         "name": "RESIDENCY",
         "id": "281342961711",
         "dependency": "",
         "history": []
      }
   ],
   "sandbox": true,
   "settings": {
      "281342961711": {
         "restricted_documents": {
            "ABW": {},
            "AFG": {},
            "AGO": {},
            "AIA": {}
         },
         "restricted_countries": {}
      },
      "281342966982": {
         "restricted_documents": {
            "ABW": {},
            "AFG": {},
            "AGO": {},
            "AIA": {},
            "ALA": {}
         },
         "restricted_countries": {}
      },
      "281342968582": {
         "restricted_documents": {
            "ABW": {},
            "AFG": {},
            "AGO": {},
            "AIA": {},
            "ALA": {},
            "ALB": {},
            "AND": {},
            "FRA": {
               "DRIVER_LICENSE": true,
               "NATIONAL_ID": true,
               "PASSPORT": true,
               "RESIDENT_PERMIT": true
            }
         },
         "restricted_countries": {
            "FRA": true
         }
      }
   },
   "submitted_documents": {
      "identity": [],
      "residency": []
   }
}
API Response
Field
Type
Description
app
AppInfo | Object
App 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
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
   "settings": {
      "281342961711": {
         "restricted_documents": {
            "ABW": {},
            "AFG": {},
            "AGO": {},
            "AIA": {}
         },
         "restricted_countries": {}
      },
      "281342966982": {
         "restricted_documents": {
            "ABW": {},
            "AFG": {},
            "AGO": {},
            "AIA": {},
            "ALA": {}
         },
         "restricted_countries": {}
      },
      "281342968582": {
         "restricted_documents": {
            "ABW": {},
            "AFG": {},
            "AGO": {},
            "AIA": {},
            "ALA": {},
            "ALB": {},
            "AND": {},
            "FRA": {
               "DRIVER_LICENSE": true,
               "NATIONAL_ID": true,
               "PASSPORT": true,
               "RESIDENT_PERMIT": true
            }
         },
         "restricted_countries": {
            "FRA": true
         }
      }
   },
RestrictedDocuments | Object
Field
Type
Description
key
string
ISO-3166 country code
value
boolean
true if restricted
false if allowed
"restricted_countries": {
    "FRA": true
}
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
"FRA": {
   "DRIVER_LICENSE": true,
   "NATIONAL_ID": true,
   "PASSPORT": true,
   "RESIDENT_PERMIT": true
}
get
Details
https://individual-api.synaps.io/v3/onboarding/details
Gives all the details of a verification flow
Request
Response
Request
Headers
Session-Id
required
string
Synaps Session-Id
Api-Key
required
string
Synaps Api-Key
Client-Id
required
string
Synaps Client-Id
Response
200: OK
​
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
aml
AmlCheck | Object
See AML reference​
VerificationSteps | Object
Field
Type
Description
key
string
step_id
value
VerificationStepDetails | Object
Verification step details
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)​
​

Individual - Previous

Sessions

Next - Individual

Steps

Last updated 2 months ago

Field	`Type`	Description
app	`AppInfo \| Object`	App 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

Field	`Type`	Description
name	`string`	Name of app
logo_url	`string`	Logo URL of app

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

Field	`Type`	Description
review_message	`string`	Explanation of rejection
review_date	`string`	Date of review

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

Onboarding

get
Overview

`AppInfo | Object`

`Steps | Array`

`StepsHistory | Array`

`Settings | Object`

`RestrictedDocuments | Object`

`RestrictedCountries | Object`

get
Details

`VerificationSteps | Object`

`VerificationStepDetails | Object`

Field	`Type`	Description
key	`string`	step_id
value	`VerificationStepDetails \| Object`	Verification step details

Step Type	Response Reference
IDENTITY	IdentityVerificationResponse (see reference)
RESIDENCY	ResidencyVerificationResponse (see reference)
PHONE	PhoneVerificationResponse (see reference)
LIVENESS	LivenessVerificationResponse (see reference)

Onboarding

getOverview

AppInfo | Object

Steps | Array

StepsHistory | Array

Settings | Object

RestrictedDocuments | Object

RestrictedCountries | Object

getDetails

VerificationSteps | Object

VerificationStepDetails | Object

get
Overview

`AppInfo | Object`

`Steps | Array`

`StepsHistory | Array`

`Settings | Object`

`RestrictedDocuments | Object`

`RestrictedCountries | Object`

get
Details

`VerificationSteps | Object`

`VerificationStepDetails | Object`