Corporate

Access corporate information such as Legal Information, Corporate Documents, KYC/AML and proof of residencies of company's directors and ultimate beneficial owners (UBOs).

get
Get corporate information

https://connect.synaps.io/v1/resources/corporate
Return corporate's legal information, documents, KYC/AML and proof of residencies of directors and ultimate beneficial owners.
Request
Response
Headers
Authorization
required
string
User access token Example : Bearer {access_token}
Content-Type
optional
string
application/json
200: OK
Corporate information of an authorized company
{
"data": {
"name": "Globex",
"address": "77 Temple Street",
"country": "Ireland",
"city": "Dublin",
"state": "PENDING",
"registration_number": "FZER8HEZNER723",
"documents": [
{
"category_name": "Certificate of Incorporation",
"state": "VERIFIED"
},
{
"category_name": "Memorandum of Association",
"state": "VERIFIED"
},
{
"category_name": "Company Annual return",
"state": "VERIFIED"
},
{
"category_name": "Company Bank Statement",
"state": "PENDING"
}
],
"directors": [
{
"firstname": "John",
"lastname": "Doe",
"identity": {
"state": "NOT_SUBMITTED",
"firstname": "John",
"lastname": "Doe",
"document_number": "182323NFDC2396",
"document_type": "Passport",
"expiration_date": "2018-05-13T00:00:00Z",
"birth_date": "1998-09-04",
"nationality": "French",
"country": "France",
"gender": "M",
"trust_score": 93,
"check_gender": 1,
"check_document_expiration": 1,
"check_date_of_birth": 1,
"check_mrz": 1,
"check_document_number": 1,
"check_color_picture": 1,
"check_image_quality": 1,
"check_security_features": 1,
"check_firstname": 1,
"check_lastname": 1,
"check_country": 1,
"aml_check": {
"aml_matches": 0,
"aml_response": {
"matches": []
}
},
"aml_compliance": "NOT_SUBMITTED"
},
"residency": {
"state": "NOT_SUBMITTED",
"document_type": "Utility Bill",
"address": "17 Dame Street",
"city": "Dublin",
"country": "Ireland",
"zipcode": "D02W283",
"province": "Leinster",
"document_expiration": "0001-01-01T00:00:00Z"
},
"is_admin": false
}
],
"beneficial_owners": [
{
"firstname": "John",
"lastname": "Doe",
"identity": {
"state": "NOT_SUBMITTED",
"firstname": "John",
"lastname": "Doe",
"document_number": "182323NFDC2396",
"document_type": "Passport",
"expiration_date": "2018-05-13T00:00:00Z",
"birth_date": "1998-09-04",
"nationality": "French",
"country": "France",
"gender": "M",
"trust_score": 93,
"check_gender": 1,
"check_document_expiration": 1,
"check_date_of_birth": 1,
"check_mrz": 1,
"check_document_number": 1,
"check_color_picture": 1,
"check_image_quality": 1,
"check_security_features": 1,
"check_firstname": 1,
"check_lastname": 1,
"check_country": 1,
"aml_check": {
"aml_matches": 0,
"aml_response": {
"matches": []
}
},
"aml_compliance": "NOT_SUBMITTED"
},
"residency": {
"state": "NOT_SUBMITTED",
"document_type": "Utility Bill",
"address": "17 Dame Street",
"city": "Dublin",
"country": "Ireland",
"zipcode": "D02W283",
"province": "Leinster",
"document_expiration": "0001-01-01T00:00:00Z"
},
"is_admin": false
}
]
},
"status": {
"error": false,
"api_code": "SUCCESS",
"type": "success",
"message": "success"
}
}
400: Bad Request
Unauthorized scope
{
"data": null,
"status": {
"error": true,
"api_code": "UNAUTHORIZED_SCOPE",
"type": "error",
"message": "Unauthorized scope"
}
}

API Response

Field

Type

Description

corporate_id

int

Corporate Unique Identifier

name

string

Name of the company

address

string

Address of the company

country

string

Country of the company

city

string

City of the company

registration_number

string

Legal registration number

documents

array of corporate_document object

Corporate legal documents including : Certificate of Incorporation, Memorandum of Association, Company Annual Return and Company Bank Statement.

directors

array of corporate_director object

Company's directors identity and proof of residency verification

beneficial_owners

array of corporate_ubo object

Company's Ultimate Beneficial Owners identity and proof of residency

corporate_directorsobject

Field

Type

Description

firstname

string

director's firstname

lastname

string

director's lastname

identity

user_identity object

Identity verification of the director

residency

user_residency object

Residency verification of the director

is_admin

boolean

true / false if the current user is company administrator

corporate_ubo object

Field

Type

Description

firstname

string

ubo's firstname

lastname

string

ubo's lastname

identity

user_identity object

Identity verification of the ubo

residency

user_residency object

Residency verification of the ubo

is_admin

boolean

true / false if the current user is company administrator

corporate_document object

Field

Type

Description

category_name

string

Corporate Document category :

CERTIFICATE_OF_INCORPORATION- Certificate of Incorporation

MEMORANDUM_OF_ASSOCIATION - Memorandum of association

COMPANY_ANNUAL_RETURN - Company Annual Return

COMPANY_BANK_STATEMENT - Company Bank Statement

state

string

Document verification state

PENDING - pending confirmation

NOT_SUBMITTED - not yet submitted

VERIFIED - verified

EXPIRED - expired

user_identity object

Field

Type

Description

firstname

string

User firstname

lastname

string

User lastname

birth_date

string

User date of birth(Format: YYYY-MM-DD)

country

string

Document issuing country (see full country list available in reference)

nationality

string

User nationality (see full list of nationalities in reference)

gender

string

User gender

M - Male

F - Female

document_number

string

Document number

document_type

string

Identity document type

NATIONAL_ID - National ID Card PASSPORT - International Passport RESIDENT_PERMIT - Resident Permit

expiration_date

string

Document expiration date (Format: YYYY-MM-DD)

NO_EXPIRATION - Document doesn't have expiration date

state

string

Document verification state

PENDING - pending confirmation

NOT_SUBMITTED - not yet submitted

VERIFIED - verified

EXPIRED - expired

REJECTED- rejected

trust_score

int

Verification confidence between 0 and 100

check_gender

int

Check if user gender is correct

1- Correct

-1- Incorrect

check_document_expiration

int

Check if document is not expired

1- Not expired

-1- Expired

check_date_of_birth

int

Check if user birth date is correct

1- Correct

-1- Incorrect

check_mrz

int

Check if MRZ is verified

1- Verified

-1- Not verified

check_document_number

int

Check if document number is verified

1- Verified

-1- Not verified

check_image_quality

int

Check if image quality is good quality

1- Good quality

-1- Bad quality

check_color_picture

int

Check if image is colored

1- Colored image

-1- Black and white image

check_security_features

int

Check document security features

1- Verified

-1- Not verified

check_country

int

Check if document country is correct

1- Correct

-1- Incorrect

aml_compliance

string

AML state given by Synaps

PENDING - pending verification

COMPLIANT- User passed AML compliance

NOT_COMPLIANT - User did not pass AML compliance

aml_check

aml_response object

AML verification details. See AML section

Code Snippets

cURL
Java
Javascript
Node.js
Python
PHP
Ruby
Go
C#
curl --include \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Authorization: Bearer access_token" \
'https://connect.synaps.io/v1/resources/corporate'
// Maven : Add these dependecies to your pom.xml (java6+)
// <dependency>
// <groupId>org.glassfish.jersey.core</groupId>
// <artifactId>jersey-client</artifactId>
// <version>2.8</version>
// </dependency>
// <dependency>
// <groupId>org.glassfish.jersey.media</groupId>
// <artifactId>jersey-media-json-jackson</artifactId>
// <version>2.8</version>
// </dependency>
import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Entity;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.MediaType;
Client client = ClientBuilder.newClient();
Response response = client.target("https://connect.synaps.io/v1/resources/corporate")
.request(MediaType.APPLICATION_JSON_TYPE)
.header("Accept", "application/json")
.header("Authorization", "Bearer access_token")
.get();
System.out.println("status: " + response.getStatus());
System.out.println("headers: " + response.getHeaders());
System.out.println("body:" + response.readEntity(String.class));
var request = new XMLHttpRequest();
request.open('GET', 'https://connect.synaps.io/v1/resources/corporate');
request.setRequestHeader('Content-Type', 'application/json');
request.setRequestHeader('Accept', 'application/json');
request.setRequestHeader('Authorization', 'Bearer access_token');
request.onreadystatechange = function () {
if (this.readyState === 4) {
console.log('Status:', this.status);
console.log('Headers:', this.getAllResponseHeaders());
console.log('Body:', this.responseText);
}
};
request.send();
var request = require('request');
request({
method: 'GET',
url: 'https://connect.synaps.io/v1/resources/corporate',
headers: {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer access_token'
}}, function (error, response, body) {
console.log('Status:', response.statusCode);
console.log('Headers:', JSON.stringify(response.headers));
console.log('Response:', body);
});
from urllib2 import Request, urlopen
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Bearer access_token'
}
request = Request('https://connect.synaps.io/v1/resources/corporate', headers=headers)
response_body = urlopen(request).read()
print response_body
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://connect.synaps.io/v1/resources/corporate");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
"Content-Type: application/json",
"Accept: application/json",
"Authorization: Bearer access_token"
));
$response = curl_exec($ch);
curl_close($ch);
var_dump($response);
require 'rubygems' if RUBY_VERSION < '1.9'
require 'rest_client'
headers = {
:content_type => 'application/json',
:accept => 'application/json',
:authorization => 'Bearer access_token'
}
response = RestClient.get 'https://connect.synaps.io/v1/resources/corporate', headers
puts response
package main
import (
"fmt"
"io/ioutil"
"net/http"
)
func main() {
client := &http.Client{}
req, _ := http.NewRequest("GET", "https://connect.synaps.io/v1/resources/corporate", nil)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Bearer access_token")
resp, err := client.Do(req)
if err != nil {
fmt.Println("Errored when sending request to the server")
return
}
defer resp.Body.Close()
resp_body, _ := ioutil.ReadAll(resp.Body)
fmt.Println(resp.Status)
fmt.Println(string(resp_body))
}
//Common testing requirement. If you are consuming an API in a sandbox/test region, uncomment this line of code ONLY for non production uses.
//System.Net.ServicePointManager.ServerCertificateValidationCallback = delegate { return true; };
//Be sure to run "Install-Package Microsoft.Net.Http" from your nuget command line.
using System;
using System.Net.Http;
var baseAddress = new Uri("https://connect.synaps.io/");
using (var httpClient = new HttpClient{ BaseAddress = baseAddress })
{
httpClient.DefaultRequestHeaders.TryAddWithoutValidation("accept", "application/json");
httpClient.DefaultRequestHeaders.TryAddWithoutValidation("authorization", "Bearer access_token");
using(var response = await httpClient.GetAsync("v1/resources/corporate"))
{
string responseData = await response.Content.ReadAsStringAsync();
}
}