Onboarding
get
https://corporate-api.synaps.io
/v3/corporate/overview
Overview
API Response
Field | Type | Description |
app | AppInfo | Object | App info |
steps | VerificationSteps | Object | Details of verification steps |
sandbox | boolean | true if session is sandboxfalse is session is production |
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 verificationUNLOCKED if verified or waiting for additional data to be sent |
submissible | boolean | true if all information has been sent to be submitted for verificationfalse if there is missing information |
settings | Settings | Object | ID Document and Proof of residency restrictions |
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 |
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 |
Field | Type | Description |
documents | CorporateLegalDocumentsDetails | Array | Legal documents details |
global | string | State of all documents VALIDATED NOT_STARTED PENDING FINAL_REJECTED |
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 |
Field | Type | Description |
corporates | CorporateBeneficialCorporate | Array | Sub Corporates |
members | CorporateBeneficialMembers | Array | Sub Individuals |
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 |
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 |
Field | Type | Description |
corporates | CorporateBeneficialCorporate | Array | Sub Corporates |
members | CorporateBeneficialMembers | Array | Sub Individuals |
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
https://corporate-api.synaps.io
/v3/corporate/details
Details
API Response
Field | Type | Description |
app_id | string | App ID |
session_id | string | Session ID |
sandbox | boolean | true if session is sandboxfalse is session is production |
alias | string | Session alias |
status | string | VERIFIED | PENDING |
corporate | CorporateDetails | Object | Corporate Sessions |
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 |
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 |
Field | Type | Description |
key | string | Document slug |
value | CorporateLegalDocsDetails | Object | Corporate Docs Details |
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 |
Field | Type | Description |
identity | IdentityVerificationResponse | Object | |
liveness | LivenessVerificationResponse | Object | |
residency | ResidencyVerificationResponse | Object | |
aml | AmlCheck | Object | |
state | string | State of verification VALIDATED NOT_STARTED PENDING FINAL_REJECTED |
Field | Type | Description |
corporates | CorporateBeneficialOwnersCorporates | Array | Corporate Beneficial Owners |
members | CorporateBeneficialOwnersMembers | Array | Individual Beneficial Owners |
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 |