Corporate Progress

get
Get Corporate Progress

https://corporate-api.synaps.io/v2/corporate/progress
Get allowed document types
Request
Response
Request
Headers
Session-Id
required
string
Session-Id that you want retrieve info
Response
200: OK

API Response

Field

Type

Description

submissible

boolean

true - Corporate meets requirements to be submitted

false - Corporate requires additional information to be uploaded to be submitted

residency_status

string

Corporate Creator (owner) residency verification status

PENDING - Residency in review

VALIDATED - Residency valid

REJECTED - Residency rejected

NOT_STARTED - Residency not yet submitted

identity_status

string

Corporate Creator (owner) identity verification status

PENDING - Identity in review

VALIDATED - Identity valid

REJECTED - Identity rejected

NOT_STARTED - Identity not yet submitted

liveness_status

string

Corporate Creator (owner) liveness verification status

PENDING - Liveness in review

VALIDATED - Liveness valid

REJECTED - Liveness rejected

NOT_STARTED - Liveness not yet submitted

corporate_status

string

Corporate Creator (owner) liveness verification status

PENDING - Corporate in review

VALIDATED - Corporate valid

REJECTED - Corporate rejected

NOT_STARTED - Corporate not yet submitted

session_status

string

Session Status

LOCKED - Upload is not possible

UNLOCKED - Upload is possible

corporate

corporate Object

Corporate Object with corporate information and beneficial owners

Corporate Object

Field

Type

Description

corporate_id

number

Corporate Unique ID

corporate_name

string

Corporate Name

beneficial_owners

beneficial_owners object

Beneficial Owners

documents

array of corporate document object

Corporate Documents

Beneficial Owner Object

Field

Type

Description

members

Array of member object

Individual Beneficial Owners

corporates

Array of corporate object

Corporate Beneficial Owners

Member object

Field

Type

Description

corporate_id

Array of member object

Individual Beneficial Owners

member_id

Array of corporate object

Corporate Beneficial Owners

firstname

string

Member firstname

lastname

string

Member lastname

shares

number

Shares owned by individual beneficial owners in percent (%)

identity_status

string

PENDING - Identity in review

VALIDATED - Identity valid

REJECTED - Identity rejected

NOT_STARTED - Identity not yet submitted

residency_status

string

PENDING - Residency in review

VALIDATED - Residency valid

REJECTED - Residency rejected

NOT_STARTED - Residency not yet submitted

{
"identity_status": "VALIDATED",
"residency_status": "VALIDATED",
"liveness_status": "VALIDATED",
"corporate_status": "VALIDATED",
"session_status": "UNLOCKED",
"submissible": true,
"corporate": {
"corporate_id": 15,
"corporate_name": "Global Exchange Inc",
"shares": 0,
"beneficial_owners": {
"members": [
{
"corporate_id": 15,
"member_id": 8,
"firstname": "Mark",
"lastname": "Twain",
"shares": 23,
"identity_status": "VALIDATED",
"residency_status": "VALIDATED"
}
],
"corporates": [
{
"corporate_id": 16,
"corporate_name": "Floza",
"shares": 23,
"beneficial_owners": {
"members": [
{
"corporate_id": 16,
"member_id": 9,
"firstname": "John",
"lastname": "Doe",
"shares": 23,
"identity_status": "VALIDATED",
"residency_status": "VALIDATED"
}
],
"corporates": []
},
"documents": [
{
"document_status": "VALIDATED",
"document": "certificate-incorporation"
},
{
"document_status": "VALIDATED",
"document": "memorandum-association"
},
{
"document_status": "VALIDATED",
"document": "account-bank-statement"
},
{
"document_status": "VALIDATED",
"document": "annual-return"
}
]
}
]
},
"documents": [
{
"document_status": "VALIDATED",
"document": "memorandum-association"
},
{
"document_status": "VALIDATED",
"document": "certificate-incorporation"
},
{
"document_status": "VALIDATED",
"document": "account-bank-statement"
},
{
"document_status": "VALIDATED",
"document": "annual-return"
}
]
}
}