Synaps Docs
Synaps Docs
Synaps Docs
Synaps Docs
Synaps
Manager
Introduction
Apps
Sessions
Team
Webhooks
Integration
Verification Flow
API Integration
Web Integration
Mobile Integration
Know Your Customer
Sessions
Submit Identity Document
Identity Allowed Documents
Submit Residency Document
Residency Allowed Documents
Liveness Verification
Verify Phone Number
Verification Progress
Flow Details
Settings
Know Your Business
Sessions
Create Corporate
Corporate Documents
Corporate Officer Verification
Individual Beneficial Owner
Corporate Beneficial Owner
Submit Corporate
Corporate Details
Corporate Progress
Settings
Auto ID
Sessions
Supported Documents
Verify Document
Details
Certificate
AML
AML Check
References
Country Code (ISO-3166)
Countries
Country calling codes
Nationalities
Rate Limiting
Powered by GitBook

Individual Beneficial Owner

post
Create new beneficial owner

https://corporate-api.synaps.io/v2/corporate/member/create/:id
Create new beneficial owner for a company
Request
Response
Request
Path Parameters
id
required
string
Corporate ID
Headers
Session-Id
required
string
Initialized Session-Id
Form Data Parameters
firstname
required
string
Beneficial owner firstname
lastname
required
string
Beneficial owner lastname
shares
required
string
Shares (in percent %) owned by the member
Response
200: OK
​

post
Submit beneficial owner identity verification

https://corporate-api.synaps.io/v2/corporate/member/identity/:id
Send identity document of beneficial owner
Request
Response
Request
Path Parameters
id
required
string
Member ID
Headers
Session-Id
required
string
Initialized Session-Id
Form Data Parameters
back_document
optional
object
must be a valid file (image/jpg, image/jpeg, image/png) max 4MB
front_document
required
object
must be a valid file (image/jpg, image/jpeg, image/png) max 4MB
document_type
required
string
Type of document PASSPORT NATIONAL_ID DRIVER_LICENSE RESIDENT_PERMIT
country
required
string
Country of document in alpha 3 code (ISO-3166) (e.g. for France send FRA as country value)
Response
200: OK
​

post
Submit beneficial owner residency verification

https://corporate-api.synaps.io/v2/corporate/member/residency/:id
Send a proof of residency document of beneficial owner
Request
Response
Request
Path Parameters
id
required
string
Member ID
Headers
Session-Id
required
string
Initialized Session-Id
Form Data Parameters
document
required
object
must be a valid file (image/jpg, image/jpeg, image/png, application/pdf) max 4MB
document_type
required
string
Type of document UTILITY_BILL BANK_STATEMENT
country
required
string
Country of document in alpha 3 code (ISO-3166) (e.g. for France send FRA as country value)
Response
200: OK
​

get
Get identity allowed documents

https://corporate-api.synaps.io/v2/corporate/member/identity/allowed_documents
Get allowed document types
Request
Response
Request
Headers
Session-Id
required
string
Session-Id that you want retrieve info
Response
200: OK
Session information
[
    "PASSPORT",
    "NATIONAL_ID",
    "DRIVER_LICENSE",
    "RESIDENT_PERMIT"
]
400: Bad Request
Invalid Session-Id
{
    "api_code": "SESSION_UNKNOWN",
    "message": "Unknown session"
}

API Response

Returns an array of string containing document type such as :

[
    "PASSPORT",
    "NATIONAL_ID",
    "DRIVER_LICENSE",
    "RESIDENT_PERMIT"
]

get
Get residency allowed documents

https://corporate-api.synaps.io/v2/corporate/member/residency/allowed_documents
Get allowed document types
Request
Response
Request
Headers
Session-Id
required
string
Session-Id that you want retrieve info
Response
200: OK
Session information
[
    "UTILITY_BILL",
    "BANK_STATEMENT",
]
400: Bad Request
Invalid Session-Id
{
    "api_code": "SESSION_UNKNOWN",
    "message": "Unknown session"
}

API Response

Returns an array of string containing document type such as :

[
    "UTILITY_BILL",
    "BANK_STATEMENT",
]
Know Your Business - Previous
Corporate Officer Verification
Next - Know Your Business
Corporate Beneficial Owner
Last updated 4 months ago
Contents
post
Create new beneficial owner
post
Submit beneficial owner identity verification
post
Submit beneficial owner residency verification
get
Get identity allowed documents
get
Get residency allowed documents