Corporate Details

get
Get Corporate Details
https://corporate-api.synaps.io/v2/corporate/details
Get all information about corporate, corporate creator (owner) and beneficial owners
Request
Response
Request
Headers
Api-Key
required
string
Synaps application Api-Key
Session-Id
required
string
Session-Id that you want retrieve info
Response
200: OK
​
API Response
Field
Type
Description
identity_resource
Identity Resource object
Identity Resource of corporate creator (owner)
residency_resource
Residency Resource object
Residency Resource of corporate creator (owner)
liveness_resource
Liveness Resource object
Liveness Resource of corporate creator (owner)
corporate_status
string
PENDING - Corporate in review
VALIDATED - Corporate valid
REJECTED - Corporate rejected
NOT_STARTED - Corporate not yet submitted
corporate_notices
Array of Notice object
List of invalidity reasons for corporate resource
corporate
corporate object
Corporate Informations
Identity Resource object
Field
Type
Description
firstname
string
Firstname
lastname
string
Lastname
birth_date
string
Birth Date (Format YYYY-MM-DD)
document_number
string
Document Number
document_country
string
Country in ISO Alpha Code 3 format (e.g. France = FRA)
nationality
string
Country in ISO Alpha Code 3 format (e.g. France = FRA)
document_type
string
Document Type
​
PASSPORT
NATIONAL_ID
RESIDENT_PERMIT
identity_status
string
PENDING - Identity in review
VALIDATED - Identity valid
REJECTED - Identity rejected
NOT_STARTED - Identity not yet submitted
valid
boolean
true - document is invalid
false - document is invalid
Residency Resource object
Field
Type
Description
firstname
string
Firstname
lastname
string
Lastname
address
string
Address
city
string
City
issuing date
string
Issuing Date (Format YYYY-MM-DD)
country
string
Country in ISO Alpha Code 3 format (e.g. France = FRA)
document_type
string
Document Type
​
UTILITY_BILL
BANK_STATEMENT
residency_status
string
PENDING - Residency in review
VALIDATED - Residency valid
REJECTED - Residency rejected
NOT_STARTED - Residency not yet submitted
valid
boolean
true - document is invalid
false - document is invalid
Liveness Resource object
Field
Type
Description
liveness_status
string
PENDING - Liveness in review
VALIDATED - Liveness valid
REJECTED - Liveness rejected
NOT_STARTED - Liveness not yet submitted
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_resource
identity resource object
Identity Resource
residency_resource
residency resource object
Residency resource
{
   "identity_resource":{
      "identity_status":"VALIDATED",
      "valid":true,
      "firstname":"Florian",
      "lastname":"Berthier",
      "document_country":"FRA",
      "document_number":"ERTYUI",
      "document_type":"PASSPORT",
      "birth_date":"1997-10-07",
      "nationality":"FRA",
      "expiration_date":"2024-09-03",
      "aml":{
         "state":"VERIFIED",
         "session_id":"",
         "aml_info":{
            "recordsFound":0,
            "matches":[
​
            ]
         }
      }
   },
   "residency_resource":{
      "residency_status":"VALIDATED",
      "valid":true,
      "firstname":"Florian",
      "lastname":"Berthier",
      "address":"7 allée des Rouges Gorges",
      "country":"FRA",
      "city":"Meyzieu",
      "issuing_date":"2020-06-01",
      "document_type":"BANK_STATEMENT"
   },
   "liveness_resource":{
      "liveness_status":"VALIDATED"
   },
   "corporate_status":"PENDING",
   "corporate_notices":[
      {
         "notice":"Florian - Owner - Identity Verification - Document is expired",
         "date":"2020-06-22T20:40:01.453747Z"
      },
      {
         "notice":"Florian - Owner - Identity Verification - Document is expired. It should be 3 months old maximum",
         "date":"2020-06-22T20:50:37.895852Z"
      },
   ],
   "corporate":{
      "corporate_id": 15,
      "shares": 0,
      "corporate_name": "Global Exchange Inc",
      "address": "18 rue des palais roses",
      "country": "FRA",
      "city": "Paris",
      "registration_number": "829RBHEU3JD",
      "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"
         }
      ],
      "beneficial_owners":{
         "members":[
            {
               "corporate_id": 15,
               "member_id": 8,
               "firstname": "Martin",
               "lastname": "Dupuis",
               "shares": 23,
               "valid": false,
               "identity_resource": {
                  "identity_status": "VALIDATED",
                  "valid": true,
                  "firstname": "Martin",
                  "lastname": "Dupuis",
                  "document_country":"FRA",
                  "document_number":"ZERTYUI",
                  "document_type":"PASSPORT",
                  "birth_date":"1998-09-04",
                  "nationality":"FRA",
                  "expiration_date":"2020-12-12",
                  "aml":{
                     "state":"",
                     "session_id":"",
                     "aml_info":{
                        "recordsFound":0,
                        "matches":null
                     }
                  }
               },
               "residency_resource":{
                  "residency_status":"VALIDATED",
                  "valid":true,
                  "firstname": "Martin",
                  "lastname": "Dupuis",
                  "address": "7 allée des allouettes",
                  "country":"FRA",
                  "city":"Paris",
                  "issuing_date":"2020-10-23",
                  "document_type":"UTILITY_BILL"
               }
            }
         ],
         "corporates":[
            {
               "corporate_id":16,
               "shares":23,
               "corporate_name":"Floza",
               "address":"2 allée dedzdf",
               "country":"FRA",
               "city":"Meyzieu",
               "registration_number":"ERTY",
               "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"
                  }
               ],
               "beneficial_owners":{
                  "members":[
                     {
                        "corporate_id":16,
                        "member_id":9,
                        "firstname":"florian",
                        "lastname":"bis",
                        "shares":23,
                        "valid":false,
                        "identity_resource":{
                           "identity_status":"VALIDATED",
                           "valid":true,
                           "firstname":"florian",
                           "lastname":"bis",
                           "document_country":"FRA",
                           "document_number":"dadzadzad",
                           "document_type":"PASSPORT",
                           "birth_date":"1998-09-12",
                           "nationality":"FRA",
                           "expiration_date":"2020-09-12",
                           "aml":{
                              "state":"VERIFIED",
                              "session_id":"",
                              "aml_info":{
                                 "recordsFound":0,
                                 "matches":[
​
                                 ]
                              }
                           }
                        },
                        "residency_resource":{
                           "residency_status":"VALIDATED",
                           "valid":true,
                           "firstname":"florian",
                           "lastname":"bis",
                           "address":"7 allée des Rouges Gorges",
                           "country":"FRA",
                           "city":"Meyzieu",
                           "issuing_date":"2020-09-23",
                           "document_type":"BANK_STATEMENT"
                        }
                     }
                  ],
                  "corporates":[]
               }
            }
         ]
      }
   }
}

Know Your Business - Previous

Submit Corporate

Next - Know Your Business

Corporate Progress

Last updated 4 months ago

Field	`Type`	Description
identity_resource	`Identity Resource object`	Identity Resource of corporate creator (owner)
residency_resource	`Residency Resource object`	Residency Resource of corporate creator (owner)
liveness_resource	`Liveness Resource object`	Liveness Resource of corporate creator (owner)
corporate_status	`string`	`PENDING` - Corporate in review `VALIDATED` - Corporate valid `REJECTED` - Corporate rejected `NOT_STARTED` - Corporate not yet submitted
corporate_notices	`Array of Notice object`	List of invalidity reasons for corporate resource
corporate	`corporate object`	Corporate Informations

Field	`Type`	Description
firstname	`string`	Firstname
lastname	`string`	Lastname
birth_date	`string`	Birth Date (Format `YYYY-MM-DD`)
document_number	`string`	Document Number
document_country	`string`	Country in ISO Alpha Code 3 format (e.g. France = FRA)
nationality	`string`	Country in ISO Alpha Code 3 format (e.g. France = FRA)
document_type	`string`	Document Type `PASSPORT` `NATIONAL_ID` `RESIDENT_PERMIT`
identity_status	`string`	`PENDING` - Identity in review `VALIDATED` - Identity valid `REJECTED` - Identity rejected `NOT_STARTED` - Identity not yet submitted
valid	`boolean`	`true` - document is invalid `false` - document is invalid

Field	`Type`	Description
firstname	`string`	Firstname
lastname	`string`	Lastname
address	`string`	Address
city	`string`	City
issuing date	`string`	Issuing Date (Format `YYYY-MM-DD`)
country	`string`	Country in ISO Alpha Code 3 format (e.g. France = FRA)
document_type	`string`	Document Type `UTILITY_BILL` `BANK_STATEMENT`
residency_status	`string`	`PENDING` - Residency in review `VALIDATED` - Residency valid `REJECTED` - Residency rejected `NOT_STARTED` - Residency not yet submitted
valid	`boolean`	`true` - document is invalid `false` - document is invalid

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

Field	`Type`	Description
members	`Array of member object`	Individual Beneficial Owners
corporates	`Array of corporate object`	Corporate Beneficial Owners

Corporate Details

get
Get Corporate Details

`Identity Resource object`

`Residency Resource object`

`Liveness Resource object`

`Corporate Object`

`Beneficial Owner Object`

`Member object`

Corporate Details

getGet Corporate Details

Identity Resource object

Residency Resource object

Liveness Resource object

Corporate Object

Beneficial Owner Object

Member object

get
Get Corporate Details

`Identity Resource object`

`Residency Resource object`

`Liveness Resource object`

`Corporate Object`

`Beneficial Owner Object`

`Member object`