Onboarding

get
Overview

https://corporate-api.synaps.io/v3/corporate/overview
Gives access to the state of each steps and settings list
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

VerificationSteps | Object

Details of verification steps

sandbox

boolean

true if session is sandbox

false is session is production

VerificationSteps | Object

Field

Type

Description

corporate_information

CorporateInformation | Object

Corporate information

corporate_officer_verification

CorporateOfficerVerification | Object

Corporate officer verification

corporate_legal_documents

CorporateLegalDocuments | Object

Corporate Legal Documents

beneficial_owners

CorporateBeneficialOwners | Object

Corporate Beneficial Owners

session_state

boolean

LOCKED if pending verification

UNLOCKED if verified or waiting for additional data to be sent

submissible

boolean

true if all information has been sent to be submitted for verification

false if there is missing information

settings

Settings | Object

ID Document and Proof of residency restrictions

CorporateInformation | Object

Field

Type

Description

ID

number

Corporate ID

name

string

Name of the company

state

string

State of the corporate

VALIDATED

NOT_STARTED

PENDING

FINAL_REJECTED

CorporateOfficerVerification | Object

Field

Type

Description

identity

string

State of identity

VALIDATED

NOT_STARTED

PENDING

FINAL_REJECTED

residency

string

State of residency

VALIDATED

NOT_STARTED

PENDING

FINAL_REJECTED

liveness

string

State of liveness

VALIDATED

NOT_STARTED

PENDING

FINAL_REJECTED

global

string

State of all 3 steps

VALIDATED

NOT_STARTED

PENDING

FINAL_REJECTED

CorporateLegalDocuments | Object

Field

Type

Description

documents

CorporateLegalDocumentsDetails | Array

Legal documents details

global

string

State of all documents

VALIDATED

NOT_STARTED

PENDING

FINAL_REJECTED

CorporateLegalDocumentsDetails | Array

Field

Type

Description

title

string

Document title

description

string

Document description

small_description

string

Document small description

slug

string

Document unique identifier

state

string

State of all documents

VALIDATED

NOT_STARTED

PENDING

FINAL_REJECTED

CorporateBeneficialOwners | Object

Field

Type

Description

corporates

CorporateBeneficialCorporate | Array

Sub Corporates

members

CorporateBeneficialMembers | Array

Sub Individuals

CorporateBeneficialMembers | Array

Field

Type

Description

corporate_id

number

Corporate ID

member_id

number

Member ID

firstname

string

Member firstname

lastname

string

Member lastname

shares

number

% of shares

shareholder

boolean

true if shareholder

false if not shareholder

director

boolean

true if director

false if not director

identity_state

string

State of identity

VALIDATED

NOT_STARTED

PENDING

FINAL_REJECTED

residency_state

string

State of residency

VALIDATED

NOT_STARTED

PENDING

FINAL_REJECTED

global

string

State of all documents

VALIDATED

NOT_STARTED

PENDING

FINAL_REJECTED

CorporateBeneficialCorporate | Array

Field

Type

Description

id

number

Corporate ID

name

number

Corporate name

shares

number

% of shares

beneficial_owners

CorporateBeneficialOwners | Object

Beneficial Owners

documents

CorporateLegalDocuments | Object

Legal Documents

global

string

State of all documents

VALIDATED

NOT_STARTED

PENDING

FINAL_REJECTED

CorporateBeneficialCorporate | Array

Field

Type

Description

corporates

CorporateBeneficialCorporate | Array

Sub Corporates

members

CorporateBeneficialMembers | Array

Sub Individuals

Settings | Object

Field

Type

Description

restricted_identity_documents

number

List of IDs restricted documents by countries

restricted_identity_countries

string

List of IDs restricted countries

restricted_residency_documents

RestrictedDocuments | Object

List of Proof of Residency restricted documents by countries

restricted_residency_countries

RestrictedCountries | Object

List of Proof of Residency restricted countries

get
Details

https://corporate-api.synaps.io/v3/corporate/details
Gives access to the state of each steps and settings list
Request
Response
Request
Headers
Api-Key
required
string
Synaps Api-Key
Client-Id
required
string
Synaps Client-Id
Session-Id
required
string
Session-Id
Response
200: OK

API Response

Field

Type

Description

app_id

string

App ID

session_id

string

Session ID

sandbox

boolean

true if session is sandbox

false is session is production

alias

string

Session alias

corporate

CorporateDetails | Object

Corporate Sessions

CorporateDetails | Object

Field

Type

Description

info

CorporateInfo | Object

Corporate Info

documents

CorporateLegalDocs | Object

Corporate Legal Documents

officer

CorporateOfficer | Object

Corporate Officer

beneficial_owners

CorporateBeneficialOwners | Object

Corporate Beneficial Owners

aml

AmlCheck | Object

Corporate AML Check

CorporateInfo | Object

Field

Type

Description

corporate_id

number

Corporate ID

name

string

Name of the corporate

city

string

City of the corporate

country

string

Country of the corporate

address

string

Address of the corporate

registration_number

string

Registration number of the corporate

CorporateLegalDocs | Object

Field

Type

Description

key

string

Document slug

value

CorporateLegalDocsDetails | Object

Corporate Docs Details

CorporateLegalDocsDetails | Object

Field

Type

Description

slug

string

Document slug

name

string

Document name

is_pdf

boolean

true if document is pdf

false if document is not pdf

state

string

State of document

VALIDATED

NOT_STARTED

PENDING

FINAL_REJECTED

CorporateOfficer | Object

Field

Type

Description

identity

IdentityVerificationResponse | Object

See reference

liveness

LivenessVerificationResponse | Object

See reference

residency

ResidencyVerificationResponse | Object

See reference

aml

AmlCheck | Object

See reference

state

string

State of verification

VALIDATED

NOT_STARTED

PENDING

FINAL_REJECTED

CorporateBeneficialOwners | Object

Field

Type

Description

corporates

CorporateBeneficialOwnersCorporates | Array

Corporate Beneficial Owners

members

CorporateBeneficialOwnersMembers | Array

Individual Beneficial Owners

CorporateBeneficialOwnersMembers | Array

Field

Type

Description

member_id

number

Member ID

firstname

string

Firstname

lastname

string

Lastname

shares

number

Shares (%)

director

boolean

true if is director

false if is not director

shareholder

boolean

true if is shareholder

false if is not shareholder

identity

IdentityVerificationResponse | Object

See reference

liveness

LivenessVerificationResponse | Object

See reference

residency

ResidencyVerificationResponse | Object

See reference

aml

AmlCheck | Object

See reference

state

string

State of verification

VALIDATED

NOT_STARTED

PENDING

FINAL_REJECTED

CorporateBeneficialOwnersCorporates | Array

Field

Type

Description

info

CorporateInfo | Object

Corporate Info

documents

CorporateLegalDocs | Object

Corporate Legal Documents

beneficial_owners

CorporateBeneficialOwners | Object

Corporate Beneficial Owners

aml

CorporateAml | Object

Corporate AML Check