NAV Navbar
curl JavaScript Node.JS Python PHP
Api landing
API reference

Overview

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The Glassboard API is organized around REST. Our API has predictable resource-oriented URLs, accepts and returns JSON-encoded request and responses bodies, and uses standard HTTP response codes, authentication, and verbs.

The Glassboard API may differ for every account as we release new versions and tailor functionality based on customer needs. The API specification below is universally available.

Cross-Origin Resource Sharing

This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with W3C spec. And that allows cross-domain communication from the browser.

All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.

Request Basics

Headers

Currently, this API only communicates with JSON, so in some situations you may need to set Accept or Content-Type to application/json. Glassboard Technology enables platforms and applications for a variety of organizations and users. To ensure an orderly separation of resource ownership this API requires a tenant identification in all requests. In the request header, set the value x-tenant-id to your id. All requests without this value will be rejected with a 401 response.

Additional Resources:

Authentication

This API only supports OAuth 2.0 for authentication and authorization. Specifically, it supports two options for OAuth2 grants, Client Credential and Authorization Code OAuth 2.0 is the industry-standard protocol for authorization. OAuth 2.0 focuses on client developer simplicity while providing specific authorization flows for web applications, desktop applications, mobile phones, and living room devices. This list describes the components of an OAuth2 grant flow:

The Client Credentials grant type is used by clients to obtain an access token outside of the context of a user. This is typically used by clients to access resources about themselves rather than to access a user's resources. The process to obtain a token:

  1. The Client Application sends an request to the Authorization Endpoing (/oauth2/token) with the client id and client secret in the request body. This request may include requested scopes.
  2. In the response, the Authorization Endpoint sends an Access Token (JWT).
  3. The Client Application uses the Access Token to call Resource Endpoints.

The Authorization Code grant type is used by confidential and public clients to exchange an authorization code for an access token. After the user returns to the client via the redirect URL, the application will get the authorization code from the URL and use it to request an access token.

  1. The Client initiates the flow by redirecting the User Agent of the Resource Owner to the Authorization Server. The Client includes its Client ID, requested scopes, and the redirect URI.
  2. Resource Owner authorizes the Client by granting permissions requested by the Client.
  3. Authorization Server redirects the User Agent back to the Client (using redirect URI from point 1). The redirect URI includes a temporary Authorization Code (as a query param).
  4. Client requests an Access Token from the Authorization Server. The request includes Client ID, Client Secret, and Authorization Code received in the previous step.
  5. If everything is valid, the Authorization Server returns Access Token and, optionally, a Refresh Token.
  6. The client uses the Access Token to call the Resource Server on behalf of the Resource Owner.

Scope Scope Description
Scope Scope Description
read Grant read-only access to all your data except for the account and user info
write Grant write-only access to all your data except for the account and user info

Example Usage

Find example usage, guides and tips in our developer getting started guide.

Endpoints

API endpoints are described in the next section

OAuth2

This set of authorization endpoints describe how to securely communicate with the API.

Refresh an Auth Token

Code samples

# You can also use wget
curl -X POST /oauth2/refresh \
  -H 'Content-Type: application/json'

var headers = {
  'Content-Type':'application/json'

};

$.ajax({
  url: '/oauth2/refresh',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{}';
const headers = {
  'Content-Type':'application/json'

};

fetch('/oauth2/refresh',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/oauth2/refresh', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/oauth2/refresh', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Endpoint

POST /oauth2/refresh

Body parameter

{}

Parameters

Parameter In Type Required Description
body body object false none

Responses

Status Meaning Description Schema
200 OK Return value of AuthController.refreshToken None

Create an Auth Token

Code samples

# You can also use wget
curl -X POST /oauth2/token \
  -H 'Content-Type: application/json'

var headers = {
  'Content-Type':'application/json'

};

$.ajax({
  url: '/oauth2/token',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{}';
const headers = {
  'Content-Type':'application/json'

};

fetch('/oauth2/token',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json'
}

r = requests.post('/oauth2/token', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/oauth2/token', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Endpoint

POST /oauth2/token

Body parameter

{}

Parameters

Parameter In Type Required Description
body body object false none

Responses

Status Meaning Description Schema
200 OK Return value of AuthController.createToken None

Assets

Assets represent the investment vehicle for a deal. An asset can take one of many forms, such as, shares of common stock in a company, real estate, crypocurrency, or even fractional ownership in a private jet. The object specification is general enough to include a complete description of the asset, supporting documentation, and profiles of the key team members.

List Assets

Code samples

# You can also use wget
curl -X GET /assets \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/assets',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/assets',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/assets', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/assets', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

List current user's assets to which the authentication method has access.

Endpoint

GET /assets

Parameters

Parameter In Type Required Description
perPage query number false none
page query number false none

Example responses

200 Response

{
  "data": [
    {
      "additionalProperties": {},
      "advisors": "string",
      "allocationAmount": 0,
      "appraisedValue": 0,
      "artist": {},
      "assetUrl": "string",
      "banner": "string",
      "category": "string",
      "companyMarketSector": "COMMUNICATION_SERVICES",
      "contact": {},
      "costsHistory": [
        "string"
      ],
      "createdAt": "2021-04-23T17:28:11Z",
      "dealId": "string",
      "deletedAt": "2021-04-23T17:28:11Z",
      "description": "string",
      "details": [
        {}
      ],
      "files": [
        "string"
      ],
      "fractionalOwnershipAmount": 0,
      "funding": {},
      "id": "string",
      "images": [
        "string"
      ],
      "invitedOrganizers": [
        "string"
      ],
      "isDeleted": true,
      "isPublic": true,
      "logo": "string",
      "name": "string",
      "ownerId": "string",
      "pitchDoc": "string",
      "primaryContact": {},
      "properties": [
        {}
      ],
      "revenueHistory": [
        "string"
      ],
      "sector": "string",
      "size": "string",
      "subType": "string",
      "team": [
        {
          "image": "string",
          "linkedInUrl": "string",
          "name": "string",
          "role": "string"
        }
      ],
      "tenantId": "string",
      "type": "COMPANY",
      "unitCount": 0,
      "updatedAt": "2021-04-23T17:28:11Z",
      "video": "string",
      "videoURL": "string"
    }
  ],
  "page": 0,
  "perPage": 0,
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request AssetsList

Create an Asset

Code samples

# You can also use wget
curl -X POST /assets \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/assets',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "additionalProperties": {},
  "advisors": "string",
  "allocationAmount": 0,
  "appraisedValue": 0,
  "artist": {},
  "assetUrl": "string",
  "banner": "string",
  "category": "string",
  "companyMarketSector": "COMMUNICATION_SERVICES",
  "contact": {},
  "costsHistory": [
    "string"
  ],
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "description": "string",
  "details": [
    {}
  ],
  "files": [
    "string"
  ],
  "fractionalOwnershipAmount": 0,
  "funding": {},
  "images": [
    "string"
  ],
  "invitedOrganizers": [
    "string"
  ],
  "isDeleted": true,
  "isPublic": true,
  "logo": "string",
  "name": "string",
  "ownerId": "string",
  "pitchDoc": "string",
  "primaryContact": {},
  "properties": [
    {}
  ],
  "revenueHistory": [
    "string"
  ],
  "sector": "string",
  "size": "string",
  "subType": "string",
  "team": [
    {
      "image": "string",
      "linkedInUrl": "string",
      "name": "string",
      "role": "string"
    }
  ],
  "tenantId": "string",
  "type": "COMPANY",
  "unitCount": 0,
  "updatedAt": "2021-04-23T17:28:11Z",
  "video": "string",
  "videoURL": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/assets',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/assets', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/assets', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Create an asset for the current user

Endpoint

POST /assets

Body parameter

{
  "additionalProperties": {},
  "advisors": "string",
  "allocationAmount": 0,
  "appraisedValue": 0,
  "artist": {},
  "assetUrl": "string",
  "banner": "string",
  "category": "string",
  "companyMarketSector": "COMMUNICATION_SERVICES",
  "contact": {},
  "costsHistory": [
    "string"
  ],
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "description": "string",
  "details": [
    {}
  ],
  "files": [
    "string"
  ],
  "fractionalOwnershipAmount": 0,
  "funding": {},
  "images": [
    "string"
  ],
  "invitedOrganizers": [
    "string"
  ],
  "isDeleted": true,
  "isPublic": true,
  "logo": "string",
  "name": "string",
  "ownerId": "string",
  "pitchDoc": "string",
  "primaryContact": {},
  "properties": [
    {}
  ],
  "revenueHistory": [
    "string"
  ],
  "sector": "string",
  "size": "string",
  "subType": "string",
  "team": [
    {
      "image": "string",
      "linkedInUrl": "string",
      "name": "string",
      "role": "string"
    }
  ],
  "tenantId": "string",
  "type": "COMPANY",
  "unitCount": 0,
  "updatedAt": "2021-04-23T17:28:11Z",
  "video": "string",
  "videoURL": "string"
}

Parameters

Parameter In Type Required Description
body body NewAsset false none

Example responses

200 Response

{
  "additionalProperties": {},
  "advisors": "string",
  "allocationAmount": 0,
  "appraisedValue": 0,
  "artist": {},
  "assetUrl": "string",
  "banner": "string",
  "category": "string",
  "companyMarketSector": "COMMUNICATION_SERVICES",
  "contact": {},
  "costsHistory": [
    "string"
  ],
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "description": "string",
  "details": [
    {}
  ],
  "files": [
    "string"
  ],
  "fractionalOwnershipAmount": 0,
  "funding": {},
  "id": "string",
  "images": [
    "string"
  ],
  "invitedOrganizers": [
    "string"
  ],
  "isDeleted": true,
  "isPublic": true,
  "logo": "string",
  "name": "string",
  "ownerId": "string",
  "pitchDoc": "string",
  "primaryContact": {},
  "properties": [
    {}
  ],
  "revenueHistory": [
    "string"
  ],
  "sector": "string",
  "size": "string",
  "subType": "string",
  "team": [
    {
      "image": "string",
      "linkedInUrl": "string",
      "name": "string",
      "role": "string"
    }
  ],
  "tenantId": "string",
  "type": "COMPANY",
  "unitCount": 0,
  "updatedAt": "2021-04-23T17:28:11Z",
  "video": "string",
  "videoURL": "string"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Asset

Add Documents to an Asset

Code samples

# You can also use wget
curl -X PUT /assets/documents-upload/{assetId} \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/assets/documents-upload/{assetId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "file": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/assets/documents-upload/{assetId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'multipart/form-data',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/assets/documents-upload/{assetId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/assets/documents-upload/{assetId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Upload documents for the specified asset

Endpoint

PUT /assets/documents-upload/{assetId}

Body parameter

file: string

Parameters

Parameter In Type Required Description
assetId path string true none
body body object true Request body for multipart/form-data based file upload
» file body string(binary) false none

Example responses

200 Response

{
  "additionalProperties": {},
  "advisors": "string",
  "allocationAmount": 0,
  "appraisedValue": 0,
  "artist": {},
  "assetUrl": "string",
  "banner": "string",
  "category": "string",
  "companyMarketSector": "COMMUNICATION_SERVICES",
  "contact": {},
  "costsHistory": [
    "string"
  ],
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "description": "string",
  "details": [
    {}
  ],
  "files": [
    "string"
  ],
  "fractionalOwnershipAmount": 0,
  "funding": {},
  "id": "string",
  "images": [
    "string"
  ],
  "invitedOrganizers": [
    "string"
  ],
  "isDeleted": true,
  "isPublic": true,
  "logo": "string",
  "name": "string",
  "ownerId": "string",
  "pitchDoc": "string",
  "primaryContact": {},
  "properties": [
    {}
  ],
  "revenueHistory": [
    "string"
  ],
  "sector": "string",
  "size": "string",
  "subType": "string",
  "team": [
    {
      "image": "string",
      "linkedInUrl": "string",
      "name": "string",
      "role": "string"
    }
  ],
  "tenantId": "string",
  "type": "COMPANY",
  "unitCount": 0,
  "updatedAt": "2021-04-23T17:28:11Z",
  "video": "string",
  "videoURL": "string"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Asset

Search Assets

Code samples

# You can also use wget
curl -X POST /assets/search \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/assets/search',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/assets/search',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/assets/search', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/assets/search', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Search assets

Endpoint

POST /assets/search

Body parameter

{}

Parameters

Parameter In Type Required Description
body body object false none

Example responses

200 Response

{
  "data": [
    {
      "additionalProperties": {},
      "advisors": "string",
      "allocationAmount": 0,
      "appraisedValue": 0,
      "artist": {},
      "assetUrl": "string",
      "banner": "string",
      "category": "string",
      "companyMarketSector": "COMMUNICATION_SERVICES",
      "contact": {},
      "costsHistory": [
        "string"
      ],
      "createdAt": "2021-04-23T17:28:11Z",
      "dealId": "string",
      "deletedAt": "2021-04-23T17:28:11Z",
      "description": "string",
      "details": [
        {}
      ],
      "files": [
        "string"
      ],
      "fractionalOwnershipAmount": 0,
      "funding": {},
      "id": "string",
      "images": [
        "string"
      ],
      "invitedOrganizers": [
        "string"
      ],
      "isDeleted": true,
      "isPublic": true,
      "logo": "string",
      "name": "string",
      "ownerId": "string",
      "pitchDoc": "string",
      "primaryContact": {},
      "properties": [
        {}
      ],
      "revenueHistory": [
        "string"
      ],
      "sector": "string",
      "size": "string",
      "subType": "string",
      "team": [
        {
          "image": "string",
          "linkedInUrl": "string",
          "name": "string",
          "role": "string"
        }
      ],
      "tenantId": "string",
      "type": "COMPANY",
      "unitCount": 0,
      "updatedAt": "2021-04-23T17:28:11Z",
      "video": "string",
      "videoURL": "string"
    }
  ],
  "page": 0,
  "perPage": 0,
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request AssetsList

Delete an Asset

Code samples

# You can also use wget
curl -X DELETE /assets/{assetId} \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/assets/{assetId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/assets/{assetId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/assets/{assetId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/assets/{assetId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Delete an asset for the current user

Endpoint

DELETE /assets/{assetId}

Parameters

Parameter In Type Required Description
assetId path string true none

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request None

Get an Asset by Id

Code samples

# You can also use wget
curl -X GET /assets/{assetId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/assets/{assetId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/assets/{assetId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/assets/{assetId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/assets/{assetId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Get an Asset for the current user by Id

Endpoint

GET /assets/{assetId}

Parameters

Parameter In Type Required Description
assetId path string true none

Example responses

200 Response

{
  "additionalProperties": {},
  "advisors": "string",
  "allocationAmount": 0,
  "appraisedValue": 0,
  "artist": {},
  "assetUrl": "string",
  "banner": "string",
  "category": "string",
  "companyMarketSector": "COMMUNICATION_SERVICES",
  "contact": {},
  "costsHistory": [
    "string"
  ],
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "description": "string",
  "details": [
    {}
  ],
  "files": [
    "string"
  ],
  "fractionalOwnershipAmount": 0,
  "funding": {},
  "id": "string",
  "images": [
    "string"
  ],
  "invitedOrganizers": [
    "string"
  ],
  "isDeleted": true,
  "isPublic": true,
  "logo": "string",
  "name": "string",
  "ownerId": "string",
  "pitchDoc": "string",
  "primaryContact": {},
  "properties": [
    {}
  ],
  "revenueHistory": [
    "string"
  ],
  "sector": "string",
  "size": "string",
  "subType": "string",
  "team": [
    {
      "image": "string",
      "linkedInUrl": "string",
      "name": "string",
      "role": "string"
    }
  ],
  "tenantId": "string",
  "type": "COMPANY",
  "unitCount": 0,
  "updatedAt": "2021-04-23T17:28:11Z",
  "video": "string",
  "videoURL": "string"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Asset

Update an Asset by Id

Code samples

# You can also use wget
curl -X PUT /assets/{assetId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/assets/{assetId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "additionalProperties": {},
  "advisors": "string",
  "allocationAmount": 0,
  "appraisedValue": 0,
  "artist": {},
  "assetUrl": "string",
  "banner": "string",
  "category": "string",
  "companyMarketSector": "COMMUNICATION_SERVICES",
  "contact": {},
  "costsHistory": [
    "string"
  ],
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "description": "string",
  "details": [
    {}
  ],
  "files": [
    "string"
  ],
  "fractionalOwnershipAmount": 0,
  "funding": {},
  "id": "string",
  "images": [
    "string"
  ],
  "invitedOrganizers": [
    "string"
  ],
  "isDeleted": true,
  "isPublic": true,
  "logo": "string",
  "name": "string",
  "ownerId": "string",
  "pitchDoc": "string",
  "primaryContact": {},
  "properties": [
    {}
  ],
  "revenueHistory": [
    "string"
  ],
  "sector": "string",
  "size": "string",
  "subType": "string",
  "team": [
    {
      "image": "string",
      "linkedInUrl": "string",
      "name": "string",
      "role": "string"
    }
  ],
  "tenantId": "string",
  "type": "COMPANY",
  "unitCount": 0,
  "updatedAt": "2021-04-23T17:28:11Z",
  "video": "string",
  "videoURL": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/assets/{assetId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/assets/{assetId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/assets/{assetId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Update an asset for the current user

Endpoint

PUT /assets/{assetId}

Body parameter

{
  "additionalProperties": {},
  "advisors": "string",
  "allocationAmount": 0,
  "appraisedValue": 0,
  "artist": {},
  "assetUrl": "string",
  "banner": "string",
  "category": "string",
  "companyMarketSector": "COMMUNICATION_SERVICES",
  "contact": {},
  "costsHistory": [
    "string"
  ],
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "description": "string",
  "details": [
    {}
  ],
  "files": [
    "string"
  ],
  "fractionalOwnershipAmount": 0,
  "funding": {},
  "id": "string",
  "images": [
    "string"
  ],
  "invitedOrganizers": [
    "string"
  ],
  "isDeleted": true,
  "isPublic": true,
  "logo": "string",
  "name": "string",
  "ownerId": "string",
  "pitchDoc": "string",
  "primaryContact": {},
  "properties": [
    {}
  ],
  "revenueHistory": [
    "string"
  ],
  "sector": "string",
  "size": "string",
  "subType": "string",
  "team": [
    {
      "image": "string",
      "linkedInUrl": "string",
      "name": "string",
      "role": "string"
    }
  ],
  "tenantId": "string",
  "type": "COMPANY",
  "unitCount": 0,
  "updatedAt": "2021-04-23T17:28:11Z",
  "video": "string",
  "videoURL": "string"
}

Parameters

Parameter In Type Required Description
assetId path string true none
body body AssetPartial false none

Example responses

200 Response

{
  "additionalProperties": {},
  "advisors": "string",
  "allocationAmount": 0,
  "appraisedValue": 0,
  "artist": {},
  "assetUrl": "string",
  "banner": "string",
  "category": "string",
  "companyMarketSector": "COMMUNICATION_SERVICES",
  "contact": {},
  "costsHistory": [
    "string"
  ],
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "description": "string",
  "details": [
    {}
  ],
  "files": [
    "string"
  ],
  "fractionalOwnershipAmount": 0,
  "funding": {},
  "id": "string",
  "images": [
    "string"
  ],
  "invitedOrganizers": [
    "string"
  ],
  "isDeleted": true,
  "isPublic": true,
  "logo": "string",
  "name": "string",
  "ownerId": "string",
  "pitchDoc": "string",
  "primaryContact": {},
  "properties": [
    {}
  ],
  "revenueHistory": [
    "string"
  ],
  "sector": "string",
  "size": "string",
  "subType": "string",
  "team": [
    {
      "image": "string",
      "linkedInUrl": "string",
      "name": "string",
      "role": "string"
    }
  ],
  "tenantId": "string",
  "type": "COMPANY",
  "unitCount": 0,
  "updatedAt": "2021-04-23T17:28:11Z",
  "video": "string",
  "videoURL": "string"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Asset

Delete an Asset Document

Code samples

# You can also use wget
curl -X DELETE /assets/{assetId}/delete-documents/{fileId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/assets/{assetId}/delete-documents/{fileId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/assets/{assetId}/delete-documents/{fileId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/assets/{assetId}/delete-documents/{fileId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/assets/{assetId}/delete-documents/{fileId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Delete a Document for an Asset

Endpoint

DELETE /assets/{assetId}/delete-documents/{fileId}

Parameters

Parameter In Type Required Description
assetId path string true none
fileId path string true none

Example responses

200 Response

{
  "additionalProperties": {},
  "advisors": "string",
  "allocationAmount": 0,
  "appraisedValue": 0,
  "artist": {},
  "assetUrl": "string",
  "banner": "string",
  "category": "string",
  "companyMarketSector": "COMMUNICATION_SERVICES",
  "contact": {},
  "costsHistory": [
    "string"
  ],
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "description": "string",
  "details": [
    {}
  ],
  "files": [
    "string"
  ],
  "fractionalOwnershipAmount": 0,
  "funding": {},
  "id": "string",
  "images": [
    "string"
  ],
  "invitedOrganizers": [
    "string"
  ],
  "isDeleted": true,
  "isPublic": true,
  "logo": "string",
  "name": "string",
  "ownerId": "string",
  "pitchDoc": "string",
  "primaryContact": {},
  "properties": [
    {}
  ],
  "revenueHistory": [
    "string"
  ],
  "sector": "string",
  "size": "string",
  "subType": "string",
  "team": [
    {
      "image": "string",
      "linkedInUrl": "string",
      "name": "string",
      "role": "string"
    }
  ],
  "tenantId": "string",
  "type": "COMPANY",
  "unitCount": 0,
  "updatedAt": "2021-04-23T17:28:11Z",
  "video": "string",
  "videoURL": "string"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Asset

Update Documents for an Asset

Code samples

# You can also use wget
curl -X PUT /assets/{assetId}/update-documents/{fileId} \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/assets/{assetId}/update-documents/{fileId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "file": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/assets/{assetId}/update-documents/{fileId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'multipart/form-data',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/assets/{assetId}/update-documents/{fileId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/assets/{assetId}/update-documents/{fileId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Update documents on an asset

Endpoint

PUT /assets/{assetId}/update-documents/{fileId}

Body parameter

file: string

Parameters

Parameter In Type Required Description
assetId path string true none
fileId path string true none
body body object true Request body for multipart/form-data based file upload
» file body string(binary) false none

Example responses

200 Response

{
  "additionalProperties": {},
  "advisors": "string",
  "allocationAmount": 0,
  "appraisedValue": 0,
  "artist": {},
  "assetUrl": "string",
  "banner": "string",
  "category": "string",
  "companyMarketSector": "COMMUNICATION_SERVICES",
  "contact": {},
  "costsHistory": [
    "string"
  ],
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "description": "string",
  "details": [
    {}
  ],
  "files": [
    "string"
  ],
  "fractionalOwnershipAmount": 0,
  "funding": {},
  "id": "string",
  "images": [
    "string"
  ],
  "invitedOrganizers": [
    "string"
  ],
  "isDeleted": true,
  "isPublic": true,
  "logo": "string",
  "name": "string",
  "ownerId": "string",
  "pitchDoc": "string",
  "primaryContact": {},
  "properties": [
    {}
  ],
  "revenueHistory": [
    "string"
  ],
  "sector": "string",
  "size": "string",
  "subType": "string",
  "team": [
    {
      "image": "string",
      "linkedInUrl": "string",
      "name": "string",
      "role": "string"
    }
  ],
  "tenantId": "string",
  "type": "COMPANY",
  "unitCount": 0,
  "updatedAt": "2021-04-23T17:28:11Z",
  "video": "string",
  "videoURL": "string"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Asset

Closes

A Close groups Subscriptions together for completion of the investment process. A close can represent the close of the entire deal or just a subset of investments (i.e. a tranche).

List closes

Code samples

# You can also use wget
curl -X GET /closes \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/closes',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/closes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/closes', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/closes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

List closes to which the authentication method has access.

Endpoint

GET /closes

Parameters

Parameter In Type Required Description
perPage query number false none
page query number false none

Example responses

200 Response

{
  "data": [
    {
      "blueSky": {},
      "createdAt": "2021-04-23T17:28:11Z",
      "dateClosed": "2021-04-23T17:28:11Z",
      "dealId": "string",
      "deletedAt": "2021-04-23T17:28:11Z",
      "entityId": "string",
      "files": [
        "string"
      ],
      "formD": {},
      "fundManagerSigned": true,
      "fundsWiredDate": "2021-04-23T17:28:11Z",
      "id": "string",
      "isDeleted": true,
      "ownerId": "string",
      "purchaseDocsSignedDate": "2021-04-23T17:28:11Z",
      "readyToCounterSign": true,
      "sequence": 0,
      "subscriptions": [
        "string"
      ],
      "tenantId": "string",
      "updatedAt": "2021-04-23T17:28:11Z"
    }
  ],
  "page": 0,
  "perPage": 0,
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request ClosesList
400 Bad Request Invalid Request None
401 Unauthorized Unauthorized None
403 Forbidden Forbidden None
default Default none None

Create a Close

Code samples

# You can also use wget
curl -X POST /closes \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/closes',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/closes',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/closes', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/closes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Create an Close object for the specified deal

Endpoint

POST /closes

Body parameter

null

Parameters

Parameter In Type Required Description
body body any false none

Example responses

200 Response

{
  "blueSky": {},
  "createdAt": "2021-04-23T17:28:11Z",
  "dateClosed": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "entityId": "string",
  "files": [
    "string"
  ],
  "formD": {},
  "fundManagerSigned": true,
  "fundsWiredDate": "2021-04-23T17:28:11Z",
  "id": "string",
  "isDeleted": true,
  "ownerId": "string",
  "purchaseDocsSignedDate": "2021-04-23T17:28:11Z",
  "readyToCounterSign": true,
  "sequence": 0,
  "subscriptions": [
    "string"
  ],
  "tenantId": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Close

Get Closes by Deal Id

Code samples

# You can also use wget
curl -X GET /closes-by-deal/{dealId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/closes-by-deal/{dealId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/closes-by-deal/{dealId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/closes-by-deal/{dealId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/closes-by-deal/{dealId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Get the Close objects associated with a Deal by Deal Id

Endpoint

GET /closes-by-deal/{dealId}

Parameters

Parameter In Type Required Description
perPage query number false none
page query number false none
dealId path string true none

Example responses

200 Response

{
  "data": [
    {
      "blueSky": {},
      "createdAt": "2021-04-23T17:28:11Z",
      "dateClosed": "2021-04-23T17:28:11Z",
      "dealId": "string",
      "deletedAt": "2021-04-23T17:28:11Z",
      "entityId": "string",
      "files": [
        "string"
      ],
      "formD": {},
      "fundManagerSigned": true,
      "fundsWiredDate": "2021-04-23T17:28:11Z",
      "id": "string",
      "isDeleted": true,
      "ownerId": "string",
      "purchaseDocsSignedDate": "2021-04-23T17:28:11Z",
      "readyToCounterSign": true,
      "sequence": 0,
      "subscriptions": [
        "string"
      ],
      "tenantId": "string",
      "updatedAt": "2021-04-23T17:28:11Z"
    }
  ],
  "page": 0,
  "perPage": 0,
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request ClosesList

Delete a Close

Code samples

# You can also use wget
curl -X DELETE /closes/{closeId} \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/closes/{closeId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/closes/{closeId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/closes/{closeId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/closes/{closeId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Delete the Close matching the specified ID

Endpoint

DELETE /closes/{closeId}

Parameters

Parameter In Type Required Description
closeId path string true none

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request None

Get a Close by ID

Code samples

# You can also use wget
curl -X GET /closes/{closeId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/closes/{closeId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/closes/{closeId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/closes/{closeId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/closes/{closeId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Get Close by ID

Endpoint

GET /closes/{closeId}

Parameters

Parameter In Type Required Description
closeId path string true none

Example responses

200 Response

{
  "blueSky": {},
  "createdAt": "2021-04-23T17:28:11Z",
  "dateClosed": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "entityId": "string",
  "files": [
    "string"
  ],
  "formD": {},
  "fundManagerSigned": true,
  "fundsWiredDate": "2021-04-23T17:28:11Z",
  "id": "string",
  "isDeleted": true,
  "ownerId": "string",
  "purchaseDocsSignedDate": "2021-04-23T17:28:11Z",
  "readyToCounterSign": true,
  "sequence": 0,
  "subscriptions": [
    "string"
  ],
  "tenantId": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Close

Update Close by ID

Code samples

# You can also use wget
curl -X PUT /closes/{closeId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/closes/{closeId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "blueSky": {},
  "createdAt": "2021-04-23T17:28:11Z",
  "dateClosed": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "entityId": "string",
  "files": [
    "string"
  ],
  "formD": {},
  "fundManagerSigned": true,
  "fundsWiredDate": "2021-04-23T17:28:11Z",
  "id": "string",
  "isDeleted": true,
  "ownerId": "string",
  "purchaseDocsSignedDate": "2021-04-23T17:28:11Z",
  "readyToCounterSign": true,
  "sequence": 0,
  "subscriptions": [
    "string"
  ],
  "tenantId": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/closes/{closeId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/closes/{closeId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/closes/{closeId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Update a close with the supplied information

Endpoint

PUT /closes/{closeId}

Body parameter

{
  "blueSky": {},
  "createdAt": "2021-04-23T17:28:11Z",
  "dateClosed": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "entityId": "string",
  "files": [
    "string"
  ],
  "formD": {},
  "fundManagerSigned": true,
  "fundsWiredDate": "2021-04-23T17:28:11Z",
  "id": "string",
  "isDeleted": true,
  "ownerId": "string",
  "purchaseDocsSignedDate": "2021-04-23T17:28:11Z",
  "readyToCounterSign": true,
  "sequence": 0,
  "subscriptions": [
    "string"
  ],
  "tenantId": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Parameters

Parameter In Type Required Description
closeId path string true none
body body ClosePartial false none

Example responses

200 Response

{
  "blueSky": {},
  "createdAt": "2021-04-23T17:28:11Z",
  "dateClosed": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "entityId": "string",
  "files": [
    "string"
  ],
  "formD": {},
  "fundManagerSigned": true,
  "fundsWiredDate": "2021-04-23T17:28:11Z",
  "id": "string",
  "isDeleted": true,
  "ownerId": "string",
  "purchaseDocsSignedDate": "2021-04-23T17:28:11Z",
  "readyToCounterSign": true,
  "sequence": 0,
  "subscriptions": [
    "string"
  ],
  "tenantId": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Close

Sign a Close as the Fund Manager

Code samples

# You can also use wget
curl -X POST /closes/{closeId}/fund-manager-sign \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/closes/{closeId}/fund-manager-sign',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/closes/{closeId}/fund-manager-sign',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/closes/{closeId}/fund-manager-sign', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/closes/{closeId}/fund-manager-sign', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Signs the Close documents as the Fund Manager

Endpoint

POST /closes/{closeId}/fund-manager-sign

Body parameter

{}

Parameters

Parameter In Type Required Description
closeId path string true none
body body object false none

Example responses

200 Response

{
  "blueSky": {},
  "createdAt": "2021-04-23T17:28:11Z",
  "dateClosed": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "entityId": "string",
  "files": [
    "string"
  ],
  "formD": {},
  "fundManagerSigned": true,
  "fundsWiredDate": "2021-04-23T17:28:11Z",
  "id": "string",
  "isDeleted": true,
  "ownerId": "string",
  "purchaseDocsSignedDate": "2021-04-23T17:28:11Z",
  "readyToCounterSign": true,
  "sequence": 0,
  "subscriptions": [
    "string"
  ],
  "tenantId": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Close

Companies

This object can store general information about a Company for a variety of purposes. Some examples include fund managers, portfolio companies, or registered agents.

List Companies

Code samples

# You can also use wget
curl -X GET /companies \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/companies',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/companies',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/companies', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/companies', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Get a list of Companies for the current user

Endpoint

GET /companies

Parameters

Parameter In Type Required Description
perPage query number false none
page query number false none

Example responses

200 Response

{
  "data": [
    {
      "additionalProperties": {},
      "address": {},
      "arbitrationCity": "string",
      "arbitrationState": "string",
      "createdAt": "2021-04-23T17:28:11Z",
      "email": "string",
      "entityType": "string",
      "id": "string",
      "legalIncOrder": {},
      "name": "string",
      "ownerId": "string",
      "phone": "string",
      "primaryContact": {},
      "seriesNumber": 0,
      "stateOfFormation": "string",
      "taxContact": {},
      "tenantId": "string",
      "type": "MASTER_ENTITY",
      "updatedAt": "2021-04-23T17:28:11Z",
      "website": "string"
    }
  ],
  "page": 0,
  "perPage": 0,
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request CompaniesList

Create a Company

Code samples

# You can also use wget
curl -X POST /companies \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/companies',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "additionalProperties": {},
  "address": {},
  "arbitrationCity": "string",
  "arbitrationState": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "email": "string",
  "entityType": "string",
  "legalIncOrder": {},
  "name": "string",
  "ownerId": "string",
  "phone": "string",
  "primaryContact": {},
  "seriesNumber": 0,
  "stateOfFormation": "string",
  "taxContact": {},
  "tenantId": "string",
  "type": "MASTER_ENTITY",
  "updatedAt": "2021-04-23T17:28:11Z",
  "website": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/companies',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/companies', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/companies', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Create a Company Object from the supplied data

Endpoint

POST /companies

Body parameter

{
  "additionalProperties": {},
  "address": {},
  "arbitrationCity": "string",
  "arbitrationState": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "email": "string",
  "entityType": "string",
  "legalIncOrder": {},
  "name": "string",
  "ownerId": "string",
  "phone": "string",
  "primaryContact": {},
  "seriesNumber": 0,
  "stateOfFormation": "string",
  "taxContact": {},
  "tenantId": "string",
  "type": "MASTER_ENTITY",
  "updatedAt": "2021-04-23T17:28:11Z",
  "website": "string"
}

Parameters

Parameter In Type Required Description
body body NewCompany false none

Example responses

200 Response

{
  "additionalProperties": {},
  "address": {},
  "arbitrationCity": "string",
  "arbitrationState": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "email": "string",
  "entityType": "string",
  "id": "string",
  "legalIncOrder": {},
  "name": "string",
  "ownerId": "string",
  "phone": "string",
  "primaryContact": {},
  "seriesNumber": 0,
  "stateOfFormation": "string",
  "taxContact": {},
  "tenantId": "string",
  "type": "MASTER_ENTITY",
  "updatedAt": "2021-04-23T17:28:11Z",
  "website": "string"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Company

Search for a Company

Code samples

# You can also use wget
curl -X POST /companies/search \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/companies/search',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/companies/search',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/companies/search', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/companies/search', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Search Companies for the current user by the supplied paramters

Endpoint

POST /companies/search

Body parameter

{}

Parameters

Parameter In Type Required Description
body body object false none

Example responses

200 Response

{
  "data": [
    {
      "additionalProperties": {},
      "address": {},
      "arbitrationCity": "string",
      "arbitrationState": "string",
      "createdAt": "2021-04-23T17:28:11Z",
      "email": "string",
      "entityType": "string",
      "id": "string",
      "legalIncOrder": {},
      "name": "string",
      "ownerId": "string",
      "phone": "string",
      "primaryContact": {},
      "seriesNumber": 0,
      "stateOfFormation": "string",
      "taxContact": {},
      "tenantId": "string",
      "type": "MASTER_ENTITY",
      "updatedAt": "2021-04-23T17:28:11Z",
      "website": "string"
    }
  ],
  "page": 0,
  "perPage": 0,
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request CompaniesList

Delete a Company

Code samples

# You can also use wget
curl -X DELETE /companies/{companyId} \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/companies/{companyId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/companies/{companyId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/companies/{companyId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/companies/{companyId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Delete the Specified Company

Endpoint

DELETE /companies/{companyId}

Parameters

Parameter In Type Required Description
companyId path string true none

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request None

Get a Company by Id

Code samples

# You can also use wget
curl -X GET /companies/{companyId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/companies/{companyId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/companies/{companyId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/companies/{companyId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/companies/{companyId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Get a Company matching the supplied Id

Endpoint

GET /companies/{companyId}

Parameters

Parameter In Type Required Description
companyId path string true none

Example responses

200 Response

{
  "additionalProperties": {},
  "address": {},
  "arbitrationCity": "string",
  "arbitrationState": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "email": "string",
  "entityType": "string",
  "id": "string",
  "legalIncOrder": {},
  "name": "string",
  "ownerId": "string",
  "phone": "string",
  "primaryContact": {},
  "seriesNumber": 0,
  "stateOfFormation": "string",
  "taxContact": {},
  "tenantId": "string",
  "type": "MASTER_ENTITY",
  "updatedAt": "2021-04-23T17:28:11Z",
  "website": "string"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Company

Update a Company

Code samples

# You can also use wget
curl -X PUT /companies/{companyId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/companies/{companyId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "additionalProperties": {},
  "address": {},
  "arbitrationCity": "string",
  "arbitrationState": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "email": "string",
  "entityType": "string",
  "id": "string",
  "legalIncOrder": {},
  "name": "string",
  "ownerId": "string",
  "phone": "string",
  "primaryContact": {},
  "seriesNumber": 0,
  "stateOfFormation": "string",
  "taxContact": {},
  "tenantId": "string",
  "type": "MASTER_ENTITY",
  "updatedAt": "2021-04-23T17:28:11Z",
  "website": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/companies/{companyId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/companies/{companyId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/companies/{companyId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Update the specified Company with supplied data

Endpoint

PUT /companies/{companyId}

Body parameter

{
  "additionalProperties": {},
  "address": {},
  "arbitrationCity": "string",
  "arbitrationState": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "email": "string",
  "entityType": "string",
  "id": "string",
  "legalIncOrder": {},
  "name": "string",
  "ownerId": "string",
  "phone": "string",
  "primaryContact": {},
  "seriesNumber": 0,
  "stateOfFormation": "string",
  "taxContact": {},
  "tenantId": "string",
  "type": "MASTER_ENTITY",
  "updatedAt": "2021-04-23T17:28:11Z",
  "website": "string"
}

Parameters

Parameter In Type Required Description
companyId path string true none
body body CompanyPartial false none

Example responses

200 Response

{
  "additionalProperties": {},
  "address": {},
  "arbitrationCity": "string",
  "arbitrationState": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "email": "string",
  "entityType": "string",
  "id": "string",
  "legalIncOrder": {},
  "name": "string",
  "ownerId": "string",
  "phone": "string",
  "primaryContact": {},
  "seriesNumber": 0,
  "stateOfFormation": "string",
  "taxContact": {},
  "tenantId": "string",
  "type": "MASTER_ENTITY",
  "updatedAt": "2021-04-23T17:28:11Z",
  "website": "string"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Company

Deals

A deal is a fundamental object that represents the opportunity into which user make an investment.

List Deals

Code samples

# You can also use wget
curl -X GET /deals \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/deals',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/deals',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/deals', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/deals', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

List current user's deals to which the authentication method has access.

Endpoint

GET /deals

Parameters

Parameter In Type Required Description
perPage query number false none
page query number false none

Example responses

200 Response

{
  "data": [
    {
      "additionalCarryRecipients": [
        {
          "carryPercentage": 0,
          "individual": {
            "address": {},
            "countryOfFormation": "string",
            "dateOfBirth": "string",
            "email": "string",
            "isUSBased": true,
            "name": "string",
            "passport": "string",
            "phone": "string",
            "stateOfFormation": "string",
            "taxDetails": {},
            "taxId": "string",
            "taxIdType": "string",
            "title": "string",
            "type": "string"
          }
        }
      ],
      "additionalProperties": {},
      "assetIds": [
        "string"
      ],
      "closes": [
        "string"
      ],
      "createdAt": "2021-04-23T17:28:11Z",
      "deletedAt": "2021-04-23T17:28:11Z",
      "description": "string",
      "entityId": "string",
      "estimatedCloseDate": "2021-04-23T17:28:11Z",
      "files": [
        "string"
      ],
      "gbtRole": "string",
      "id": "string",
      "isDeleted": true,
      "isPublic": true,
      "marketing": {},
      "minInvestmentAmount": 0,
      "name": "string",
      "organizerCarryPercentage": 0,
      "ownerId": "string",
      "portfolioCompanyContact": {},
      "portfolioCompanyEntity": "LIMITED_LIABILITY_COMPANY",
      "portfolioCompanyName": "string",
      "portfolioCompanyState": "string",
      "previouslyRaisedAmount": 0,
      "profileId": "string",
      "securityType": "COMMON_STOCK",
      "status": "DRAFT",
      "targetRaiseAmount": 0,
      "tenantId": "string",
      "updatedAt": "2021-04-23T17:28:11Z"
    }
  ],
  "page": 0,
  "perPage": 0,
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request DealsList

Create a Deal

Code samples

# You can also use wget
curl -X POST /deals \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/deals',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "additionalCarryRecipients": [
    {
      "carryPercentage": 0,
      "individual": {
        "address": {},
        "countryOfFormation": "string",
        "dateOfBirth": "string",
        "email": "string",
        "isUSBased": true,
        "name": "string",
        "passport": "string",
        "phone": "string",
        "stateOfFormation": "string",
        "taxDetails": {},
        "taxId": "string",
        "taxIdType": "string",
        "title": "string",
        "type": "string"
      }
    }
  ],
  "additionalProperties": {},
  "assetIds": [
    "string"
  ],
  "closes": [
    "string"
  ],
  "createdAt": "2021-04-23T17:28:11Z",
  "deletedAt": "2021-04-23T17:28:11Z",
  "description": "string",
  "entityId": "string",
  "estimatedCloseDate": "2021-04-23T17:28:11Z",
  "files": [
    "string"
  ],
  "gbtRole": "string",
  "isDeleted": true,
  "isPublic": true,
  "marketing": {},
  "minInvestmentAmount": 0,
  "name": "string",
  "organizerCarryPercentage": 0,
  "ownerId": "string",
  "portfolioCompanyContact": {},
  "portfolioCompanyEntity": "LIMITED_LIABILITY_COMPANY",
  "portfolioCompanyName": "string",
  "portfolioCompanyState": "string",
  "previouslyRaisedAmount": 0,
  "profileId": "string",
  "securityType": "COMMON_STOCK",
  "status": "DRAFT",
  "targetRaiseAmount": 0,
  "tenantId": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/deals',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/deals', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/deals', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Create a new deal for the user

Endpoint

POST /deals

Body parameter

{
  "additionalCarryRecipients": [
    {
      "carryPercentage": 0,
      "individual": {
        "address": {},
        "countryOfFormation": "string",
        "dateOfBirth": "string",
        "email": "string",
        "isUSBased": true,
        "name": "string",
        "passport": "string",
        "phone": "string",
        "stateOfFormation": "string",
        "taxDetails": {},
        "taxId": "string",
        "taxIdType": "string",
        "title": "string",
        "type": "string"
      }
    }
  ],
  "additionalProperties": {},
  "assetIds": [
    "string"
  ],
  "closes": [
    "string"
  ],
  "createdAt": "2021-04-23T17:28:11Z",
  "deletedAt": "2021-04-23T17:28:11Z",
  "description": "string",
  "entityId": "string",
  "estimatedCloseDate": "2021-04-23T17:28:11Z",
  "files": [
    "string"
  ],
  "gbtRole": "string",
  "isDeleted": true,
  "isPublic": true,
  "marketing": {},
  "minInvestmentAmount": 0,
  "name": "string",
  "organizerCarryPercentage": 0,
  "ownerId": "string",
  "portfolioCompanyContact": {},
  "portfolioCompanyEntity": "LIMITED_LIABILITY_COMPANY",
  "portfolioCompanyName": "string",
  "portfolioCompanyState": "string",
  "previouslyRaisedAmount": 0,
  "profileId": "string",
  "securityType": "COMMON_STOCK",
  "status": "DRAFT",
  "targetRaiseAmount": 0,
  "tenantId": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Parameters

Parameter In Type Required Description
body body NewDeal false none

Example responses

200 Response

{
  "additionalCarryRecipients": [
    {
      "carryPercentage": 0,
      "individual": {
        "address": {},
        "countryOfFormation": "string",
        "dateOfBirth": "string",
        "email": "string",
        "isUSBased": true,
        "name": "string",
        "passport": "string",
        "phone": "string",
        "stateOfFormation": "string",
        "taxDetails": {},
        "taxId": "string",
        "taxIdType": "string",
        "title": "string",
        "type": "string"
      }
    }
  ],
  "additionalProperties": {},
  "assetIds": [
    "string"
  ],
  "closes": [
    "string"
  ],
  "createdAt": "2021-04-23T17:28:11Z",
  "deletedAt": "2021-04-23T17:28:11Z",
  "description": "string",
  "entityId": "string",
  "estimatedCloseDate": "2021-04-23T17:28:11Z",
  "files": [
    "string"
  ],
  "gbtRole": "string",
  "id": "string",
  "isDeleted": true,
  "isPublic": true,
  "marketing": {},
  "minInvestmentAmount": 0,
  "name": "string",
  "organizerCarryPercentage": 0,
  "ownerId": "string",
  "portfolioCompanyContact": {},
  "portfolioCompanyEntity": "LIMITED_LIABILITY_COMPANY",
  "portfolioCompanyName": "string",
  "portfolioCompanyState": "string",
  "previouslyRaisedAmount": 0,
  "profileId": "string",
  "securityType": "COMMON_STOCK",
  "status": "DRAFT",
  "targetRaiseAmount": 0,
  "tenantId": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Deal

Search for Deals

Code samples

# You can also use wget
curl -X POST /deals/search \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/deals/search',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/deals/search',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/deals/search', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/deals/search', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Search Deals for the current user

Endpoint

POST /deals/search

Body parameter

{}

Parameters

Parameter In Type Required Description
body body object false none

Example responses

200 Response

{
  "data": [
    {
      "additionalCarryRecipients": [
        {
          "carryPercentage": 0,
          "individual": {
            "address": {},
            "countryOfFormation": "string",
            "dateOfBirth": "string",
            "email": "string",
            "isUSBased": true,
            "name": "string",
            "passport": "string",
            "phone": "string",
            "stateOfFormation": "string",
            "taxDetails": {},
            "taxId": "string",
            "taxIdType": "string",
            "title": "string",
            "type": "string"
          }
        }
      ],
      "additionalProperties": {},
      "assetIds": [
        "string"
      ],
      "closes": [
        "string"
      ],
      "createdAt": "2021-04-23T17:28:11Z",
      "deletedAt": "2021-04-23T17:28:11Z",
      "description": "string",
      "entityId": "string",
      "estimatedCloseDate": "2021-04-23T17:28:11Z",
      "files": [
        "string"
      ],
      "gbtRole": "string",
      "id": "string",
      "isDeleted": true,
      "isPublic": true,
      "marketing": {},
      "minInvestmentAmount": 0,
      "name": "string",
      "organizerCarryPercentage": 0,
      "ownerId": "string",
      "portfolioCompanyContact": {},
      "portfolioCompanyEntity": "LIMITED_LIABILITY_COMPANY",
      "portfolioCompanyName": "string",
      "portfolioCompanyState": "string",
      "previouslyRaisedAmount": 0,
      "profileId": "string",
      "securityType": "COMMON_STOCK",
      "status": "DRAFT",
      "targetRaiseAmount": 0,
      "tenantId": "string",
      "updatedAt": "2021-04-23T17:28:11Z"
    }
  ],
  "page": 0,
  "perPage": 0,
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request DealsList

Delete a Deal

Code samples

# You can also use wget
curl -X DELETE /deals/{dealId} \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/deals/{dealId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/deals/{dealId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/deals/{dealId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/deals/{dealId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Delete the specified deal

Endpoint

DELETE /deals/{dealId}

Parameters

Parameter In Type Required Description
dealId path string true none

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request None

Get a Deal by Id

Code samples

# You can also use wget
curl -X GET /deals/{dealId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/deals/{dealId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/deals/{dealId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/deals/{dealId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/deals/{dealId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Get a Deal by Id

Endpoint

GET /deals/{dealId}

Parameters

Parameter In Type Required Description
dealId path string true none

Example responses

200 Response

{
  "additionalCarryRecipients": [
    {
      "carryPercentage": 0,
      "individual": {
        "address": {},
        "countryOfFormation": "string",
        "dateOfBirth": "string",
        "email": "string",
        "isUSBased": true,
        "name": "string",
        "passport": "string",
        "phone": "string",
        "stateOfFormation": "string",
        "taxDetails": {},
        "taxId": "string",
        "taxIdType": "string",
        "title": "string",
        "type": "string"
      }
    }
  ],
  "additionalProperties": {},
  "assetIds": [
    "string"
  ],
  "closes": [
    "string"
  ],
  "createdAt": "2021-04-23T17:28:11Z",
  "deletedAt": "2021-04-23T17:28:11Z",
  "description": "string",
  "entityId": "string",
  "estimatedCloseDate": "2021-04-23T17:28:11Z",
  "files": [
    "string"
  ],
  "gbtRole": "string",
  "id": "string",
  "isDeleted": true,
  "isPublic": true,
  "marketing": {},
  "minInvestmentAmount": 0,
  "name": "string",
  "organizerCarryPercentage": 0,
  "ownerId": "string",
  "portfolioCompanyContact": {},
  "portfolioCompanyEntity": "LIMITED_LIABILITY_COMPANY",
  "portfolioCompanyName": "string",
  "portfolioCompanyState": "string",
  "previouslyRaisedAmount": 0,
  "profileId": "string",
  "securityType": "COMMON_STOCK",
  "status": "DRAFT",
  "targetRaiseAmount": 0,
  "tenantId": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Deal

Update a Deal Asset

Code samples

# You can also use wget
curl -X PUT /deals/{dealId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/deals/{dealId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "additionalCarryRecipients": [
    {
      "carryPercentage": 0,
      "individual": {
        "address": {},
        "countryOfFormation": "string",
        "dateOfBirth": "string",
        "email": "string",
        "isUSBased": true,
        "name": "string",
        "passport": "string",
        "phone": "string",
        "stateOfFormation": "string",
        "taxDetails": {},
        "taxId": "string",
        "taxIdType": "string",
        "title": "string",
        "type": "string"
      }
    }
  ],
  "additionalProperties": {},
  "assetIds": [
    "string"
  ],
  "closes": [
    "string"
  ],
  "createdAt": "2021-04-23T17:28:11Z",
  "deletedAt": "2021-04-23T17:28:11Z",
  "description": "string",
  "entityId": "string",
  "estimatedCloseDate": "2021-04-23T17:28:11Z",
  "files": [
    "string"
  ],
  "gbtRole": "string",
  "id": "string",
  "isDeleted": true,
  "isPublic": true,
  "marketing": {},
  "minInvestmentAmount": 0,
  "name": "string",
  "organizerCarryPercentage": 0,
  "ownerId": "string",
  "portfolioCompanyContact": {},
  "portfolioCompanyEntity": "LIMITED_LIABILITY_COMPANY",
  "portfolioCompanyName": "string",
  "portfolioCompanyState": "string",
  "previouslyRaisedAmount": 0,
  "profileId": "string",
  "securityType": "COMMON_STOCK",
  "status": "DRAFT",
  "targetRaiseAmount": 0,
  "tenantId": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/deals/{dealId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/deals/{dealId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/deals/{dealId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Update a Deal with the supplied data

Endpoint

PUT /deals/{dealId}

Body parameter

{
  "additionalCarryRecipients": [
    {
      "carryPercentage": 0,
      "individual": {
        "address": {},
        "countryOfFormation": "string",
        "dateOfBirth": "string",
        "email": "string",
        "isUSBased": true,
        "name": "string",
        "passport": "string",
        "phone": "string",
        "stateOfFormation": "string",
        "taxDetails": {},
        "taxId": "string",
        "taxIdType": "string",
        "title": "string",
        "type": "string"
      }
    }
  ],
  "additionalProperties": {},
  "assetIds": [
    "string"
  ],
  "closes": [
    "string"
  ],
  "createdAt": "2021-04-23T17:28:11Z",
  "deletedAt": "2021-04-23T17:28:11Z",
  "description": "string",
  "entityId": "string",
  "estimatedCloseDate": "2021-04-23T17:28:11Z",
  "files": [
    "string"
  ],
  "gbtRole": "string",
  "id": "string",
  "isDeleted": true,
  "isPublic": true,
  "marketing": {},
  "minInvestmentAmount": 0,
  "name": "string",
  "organizerCarryPercentage": 0,
  "ownerId": "string",
  "portfolioCompanyContact": {},
  "portfolioCompanyEntity": "LIMITED_LIABILITY_COMPANY",
  "portfolioCompanyName": "string",
  "portfolioCompanyState": "string",
  "previouslyRaisedAmount": 0,
  "profileId": "string",
  "securityType": "COMMON_STOCK",
  "status": "DRAFT",
  "targetRaiseAmount": 0,
  "tenantId": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Parameters

Parameter In Type Required Description
dealId path string true none
body body DealPartial false none

Example responses

200 Response

{
  "additionalCarryRecipients": [
    {
      "carryPercentage": 0,
      "individual": {
        "address": {},
        "countryOfFormation": "string",
        "dateOfBirth": "string",
        "email": "string",
        "isUSBased": true,
        "name": "string",
        "passport": "string",
        "phone": "string",
        "stateOfFormation": "string",
        "taxDetails": {},
        "taxId": "string",
        "taxIdType": "string",
        "title": "string",
        "type": "string"
      }
    }
  ],
  "additionalProperties": {},
  "assetIds": [
    "string"
  ],
  "closes": [
    "string"
  ],
  "createdAt": "2021-04-23T17:28:11Z",
  "deletedAt": "2021-04-23T17:28:11Z",
  "description": "string",
  "entityId": "string",
  "estimatedCloseDate": "2021-04-23T17:28:11Z",
  "files": [
    "string"
  ],
  "gbtRole": "string",
  "id": "string",
  "isDeleted": true,
  "isPublic": true,
  "marketing": {},
  "minInvestmentAmount": 0,
  "name": "string",
  "organizerCarryPercentage": 0,
  "ownerId": "string",
  "portfolioCompanyContact": {},
  "portfolioCompanyEntity": "LIMITED_LIABILITY_COMPANY",
  "portfolioCompanyName": "string",
  "portfolioCompanyState": "string",
  "previouslyRaisedAmount": 0,
  "profileId": "string",
  "securityType": "COMMON_STOCK",
  "status": "DRAFT",
  "targetRaiseAmount": 0,
  "tenantId": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Deal

Entities

An entity (typically a fund) is the legal entity that gets generated during the deal creation process.

List Entities

Code samples

# You can also use wget
curl -X GET /entities \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/entities',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/entities',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/entities', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/entities', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

List Entities for the current user

Endpoint

GET /entities

Parameters

Parameter In Type Required Description
perPage query number false none
page query number false none

Example responses

200 Response

{
  "data": [
    {
      "additionalProperties": {},
      "arbitration": {},
      "assetComposition": "string",
      "bankAccount": {},
      "countryOfFormation": "string",
      "createdAt": "2021-04-23T17:28:11Z",
      "dealId": "string",
      "deletedAt": "2021-04-23T17:28:11Z",
      "ein": "string",
      "entityDocuments": {},
      "entityType": "LIMITED_LIABILITY_COMPANY",
      "expenseReserve": {},
      "files": [
        "string"
      ],
      "id": "string",
      "isDeleted": true,
      "legalIncOrder": {},
      "managementFee": {},
      "manager": "string",
      "masterEntity": "string",
      "minInvestmentAmount": 0,
      "name": "string",
      "ownerId": "string",
      "regDExemption": "string",
      "registeredAgent": "string",
      "regulationType": "REGULATION_D",
      "stateOfFormation": "string",
      "tenantId": "string",
      "updatedAt": "2021-04-23T17:28:11Z"
    }
  ],
  "page": 0,
  "perPage": 0,
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request EntitiesList

Create an Entity

Code samples

# You can also use wget
curl -X POST /entities \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/entities',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "additionalProperties": {},
  "arbitration": {},
  "assetComposition": "string",
  "bankAccount": {},
  "countryOfFormation": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "ein": "string",
  "entityDocuments": {},
  "entityType": "LIMITED_LIABILITY_COMPANY",
  "expenseReserve": {},
  "files": [
    "string"
  ],
  "isDeleted": true,
  "legalIncOrder": {},
  "managementFee": {},
  "manager": "string",
  "masterEntity": "string",
  "minInvestmentAmount": 0,
  "name": "string",
  "ownerId": "string",
  "regDExemption": "string",
  "registeredAgent": "string",
  "regulationType": "REGULATION_D",
  "stateOfFormation": "string",
  "tenantId": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/entities',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/entities', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/entities', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Create an entity with the supplied data

Endpoint

POST /entities

Body parameter

{
  "additionalProperties": {},
  "arbitration": {},
  "assetComposition": "string",
  "bankAccount": {},
  "countryOfFormation": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "ein": "string",
  "entityDocuments": {},
  "entityType": "LIMITED_LIABILITY_COMPANY",
  "expenseReserve": {},
  "files": [
    "string"
  ],
  "isDeleted": true,
  "legalIncOrder": {},
  "managementFee": {},
  "manager": "string",
  "masterEntity": "string",
  "minInvestmentAmount": 0,
  "name": "string",
  "ownerId": "string",
  "regDExemption": "string",
  "registeredAgent": "string",
  "regulationType": "REGULATION_D",
  "stateOfFormation": "string",
  "tenantId": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Parameters

Parameter In Type Required Description
body body NewEntity false none

Example responses

200 Response

{
  "additionalProperties": {},
  "arbitration": {},
  "assetComposition": "string",
  "bankAccount": {},
  "countryOfFormation": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "ein": "string",
  "entityDocuments": {},
  "entityType": "LIMITED_LIABILITY_COMPANY",
  "expenseReserve": {},
  "files": [
    "string"
  ],
  "id": "string",
  "isDeleted": true,
  "legalIncOrder": {},
  "managementFee": {},
  "manager": "string",
  "masterEntity": "string",
  "minInvestmentAmount": 0,
  "name": "string",
  "ownerId": "string",
  "regDExemption": "string",
  "registeredAgent": "string",
  "regulationType": "REGULATION_D",
  "stateOfFormation": "string",
  "tenantId": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Entities

Delete an Entity

Code samples

# You can also use wget
curl -X DELETE /entities/{entityId} \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/entities/{entityId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/entities/{entityId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/entities/{entityId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/entities/{entityId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Delete the Entity with the specified Id

Endpoint

DELETE /entities/{entityId}

Parameters

Parameter In Type Required Description
entityId path string true none

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request None

Get an Entity by Id

Code samples

# You can also use wget
curl -X GET /entities/{entityId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/entities/{entityId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/entities/{entityId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/entities/{entityId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/entities/{entityId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Get the Entity

Endpoint

GET /entities/{entityId}

Parameters

Parameter In Type Required Description
entityId path string true none

Example responses

200 Response

{
  "additionalProperties": {},
  "arbitration": {},
  "assetComposition": "string",
  "bankAccount": {},
  "countryOfFormation": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "ein": "string",
  "entityDocuments": {},
  "entityType": "LIMITED_LIABILITY_COMPANY",
  "expenseReserve": {},
  "files": [
    "string"
  ],
  "id": "string",
  "isDeleted": true,
  "legalIncOrder": {},
  "managementFee": {},
  "manager": "string",
  "masterEntity": "string",
  "minInvestmentAmount": 0,
  "name": "string",
  "ownerId": "string",
  "regDExemption": "string",
  "registeredAgent": "string",
  "regulationType": "REGULATION_D",
  "stateOfFormation": "string",
  "tenantId": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Entities

Update an Entity

Code samples

# You can also use wget
curl -X PUT /entities/{entityId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/entities/{entityId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "additionalProperties": {},
  "arbitration": {},
  "assetComposition": "string",
  "bankAccount": {},
  "countryOfFormation": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "ein": "string",
  "entityDocuments": {},
  "entityType": "LIMITED_LIABILITY_COMPANY",
  "expenseReserve": {},
  "files": [
    "string"
  ],
  "id": "string",
  "isDeleted": true,
  "legalIncOrder": {},
  "managementFee": {},
  "manager": "string",
  "masterEntity": "string",
  "minInvestmentAmount": 0,
  "name": "string",
  "ownerId": "string",
  "regDExemption": "string",
  "registeredAgent": "string",
  "regulationType": "REGULATION_D",
  "stateOfFormation": "string",
  "tenantId": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/entities/{entityId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/entities/{entityId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/entities/{entityId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Update an Entity with the supplied data

Endpoint

PUT /entities/{entityId}

Body parameter

{
  "additionalProperties": {},
  "arbitration": {},
  "assetComposition": "string",
  "bankAccount": {},
  "countryOfFormation": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "ein": "string",
  "entityDocuments": {},
  "entityType": "LIMITED_LIABILITY_COMPANY",
  "expenseReserve": {},
  "files": [
    "string"
  ],
  "id": "string",
  "isDeleted": true,
  "legalIncOrder": {},
  "managementFee": {},
  "manager": "string",
  "masterEntity": "string",
  "minInvestmentAmount": 0,
  "name": "string",
  "ownerId": "string",
  "regDExemption": "string",
  "registeredAgent": "string",
  "regulationType": "REGULATION_D",
  "stateOfFormation": "string",
  "tenantId": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Parameters

Parameter In Type Required Description
entityId path string true none
body body EntitiesPartial false none

Example responses

200 Response

{
  "additionalProperties": {},
  "arbitration": {},
  "assetComposition": "string",
  "bankAccount": {},
  "countryOfFormation": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "ein": "string",
  "entityDocuments": {},
  "entityType": "LIMITED_LIABILITY_COMPANY",
  "expenseReserve": {},
  "files": [
    "string"
  ],
  "id": "string",
  "isDeleted": true,
  "legalIncOrder": {},
  "managementFee": {},
  "manager": "string",
  "masterEntity": "string",
  "minInvestmentAmount": 0,
  "name": "string",
  "ownerId": "string",
  "regDExemption": "string",
  "registeredAgent": "string",
  "regulationType": "REGULATION_D",
  "stateOfFormation": "string",
  "tenantId": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Entities

Create a Bank Account for an Entity

Code samples

# You can also use wget
curl -X POST /entities/{entityId}/bank-account \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/entities/{entityId}/bank-account',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/entities/{entityId}/bank-account',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/entities/{entityId}/bank-account', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/entities/{entityId}/bank-account', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Creates a Bank Account for the Series Entity. An EIN for the entity is required for this request to succeed. Only one Bank Account is allowed per Entity

Endpoint

POST /entities/{entityId}/bank-account

Parameters

Parameter In Type Required Description
entityId path string true none

Responses

Status Meaning Description Schema
204 No Content Expected response to a valid request None

Get the Transactions from the Entity Bank Account

Code samples

# You can also use wget
curl -X GET /entities/{entityId}/bank-account/transactions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/entities/{entityId}/bank-account/transactions',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/entities/{entityId}/bank-account/transactions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/entities/{entityId}/bank-account/transactions', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/entities/{entityId}/bank-account/transactions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Returns the Transaction Listing from the Entity Bank Account (if present)

Endpoint

GET /entities/{entityId}/bank-account/transactions

Parameters

Parameter In Type Required Description
entityId path string true none

Example responses

200 Response

[
  null
]

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Inline

Response Schema

Generate a document for an Entity

Code samples

# You can also use wget
curl -X POST /entities/{entityId}/generate-documents/{documentType} \
  -H 'Content-Type: application/json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'text/plain',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/entities/{entityId}/generate-documents/{documentType}',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'text/plain',
  'Authorization':'Bearer {access-token}'

};

fetch('/entities/{entityId}/generate-documents/{documentType}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/entities/{entityId}/generate-documents/{documentType}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'text/plain',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/entities/{entityId}/generate-documents/{documentType}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Generate the specified documentType for the Entity

Endpoint

POST /entities/{entityId}/generate-documents/{documentType}

Body parameter

{}

Parameters

Parameter In Type Required Description
entityId path string true none
documentType path string true none
body body object false none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request string

Create an EIN for the Series Entity

Code samples

# You can also use wget
curl -X POST /entities/{entityId}/series-ein \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/entities/{entityId}/series-ein',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/entities/{entityId}/series-ein',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/entities/{entityId}/series-ein', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/entities/{entityId}/series-ein', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Creates a request for an EIN on the specified Entity

Endpoint

POST /entities/{entityId}/series-ein

Parameters

Parameter In Type Required Description
entityId path string true none

Responses

Status Meaning Description Schema
204 No Content Expected response to a valid request None

Files

Files of all kinds that can be attached to other objects or stand alone.

Get Files for the current User

Code samples

# You can also use wget
curl -X GET /files \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/files',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/files',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/files', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/files', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Get a list of Files for the current user

Endpoint

GET /files

Parameters

Parameter In Type Required Description
perPage query number false none
page query number false none

Example responses

200 Response

{
  "data": [
    {
      "additionalProperties": {},
      "createdAt": "2021-04-23T17:28:11Z",
      "deletedAt": "2021-04-23T17:28:11Z",
      "generating": true,
      "id": "string",
      "isDeleted": true,
      "isPublic": true,
      "key": "string",
      "lastModified": "string",
      "name": "string",
      "ownerId": "string",
      "size": "string",
      "tenantId": "string",
      "thumbnail": "string",
      "type": "string",
      "updatedAt": "2021-04-23T17:28:11Z"
    }
  ],
  "page": 0,
  "perPage": 0,
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request FilesList

Create a File

Code samples

# You can also use wget
curl -X POST /files \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/files',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "additionalProperties": {},
  "createdAt": "2021-04-23T17:28:11Z",
  "deletedAt": "2021-04-23T17:28:11Z",
  "generating": true,
  "isDeleted": true,
  "isPublic": true,
  "key": "string",
  "lastModified": "string",
  "name": "string",
  "ownerId": "string",
  "size": "string",
  "tenantId": "string",
  "thumbnail": "string",
  "type": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/files',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/files', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/files', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Create a File record

Endpoint

POST /files

Body parameter

{
  "additionalProperties": {},
  "createdAt": "2021-04-23T17:28:11Z",
  "deletedAt": "2021-04-23T17:28:11Z",
  "generating": true,
  "isDeleted": true,
  "isPublic": true,
  "key": "string",
  "lastModified": "string",
  "name": "string",
  "ownerId": "string",
  "size": "string",
  "tenantId": "string",
  "thumbnail": "string",
  "type": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Parameters

Parameter In Type Required Description
body body NewFile false none

Example responses

200 Response

{
  "additionalProperties": {},
  "createdAt": "2021-04-23T17:28:11Z",
  "deletedAt": "2021-04-23T17:28:11Z",
  "generating": true,
  "id": "string",
  "isDeleted": true,
  "isPublic": true,
  "key": "string",
  "lastModified": "string",
  "name": "string",
  "ownerId": "string",
  "size": "string",
  "tenantId": "string",
  "thumbnail": "string",
  "type": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request File

Upload a File

Code samples

# You can also use wget
curl -X POST /files/upload \
  -H 'Content-Type: multipart/form-data'

var headers = {
  'Content-Type':'multipart/form-data'

};

$.ajax({
  url: '/files/upload',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "file": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data'

};

fetch('/files/upload',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'multipart/form-data'
}

r = requests.post('/files/upload', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/form-data',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/files/upload', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Endpoint

POST /files/upload

Body parameter

file: string

Parameters

Parameter In Type Required Description
body body object true Request body for multipart/form-data based file upload
» file body string(binary) false none

Responses

Status Meaning Description Schema
200 OK Return value of FileUploadController.fileUpload None

Delete a File

Code samples

# You can also use wget
curl -X DELETE /files/{fileId} \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/files/{fileId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/files/{fileId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/files/{fileId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/files/{fileId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Deletes the File with the specified Id

Endpoint

DELETE /files/{fileId}

Parameters

Parameter In Type Required Description
fileId path string true none

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request None

Get a File by Id

Code samples

# You can also use wget
curl -X GET /files/{fileId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/files/{fileId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/files/{fileId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/files/{fileId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/files/{fileId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Returns a File with the specified Id

Endpoint

GET /files/{fileId}

Parameters

Parameter In Type Required Description
fileId path string true none

Example responses

200 Response

{
  "additionalProperties": {},
  "createdAt": "2021-04-23T17:28:11Z",
  "deletedAt": "2021-04-23T17:28:11Z",
  "generating": true,
  "id": "string",
  "isDeleted": true,
  "isPublic": true,
  "key": "string",
  "lastModified": "string",
  "name": "string",
  "ownerId": "string",
  "size": "string",
  "tenantId": "string",
  "thumbnail": "string",
  "type": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request File

Update a File

Code samples

# You can also use wget
curl -X PUT /files/{fileId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/files/{fileId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "additionalProperties": {},
  "createdAt": "2021-04-23T17:28:11Z",
  "deletedAt": "2021-04-23T17:28:11Z",
  "generating": true,
  "id": "string",
  "isDeleted": true,
  "isPublic": true,
  "key": "string",
  "lastModified": "string",
  "name": "string",
  "ownerId": "string",
  "size": "string",
  "tenantId": "string",
  "thumbnail": "string",
  "type": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/files/{fileId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/files/{fileId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/files/{fileId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Update a File with the supplied data

Endpoint

PUT /files/{fileId}

Body parameter

{
  "additionalProperties": {},
  "createdAt": "2021-04-23T17:28:11Z",
  "deletedAt": "2021-04-23T17:28:11Z",
  "generating": true,
  "id": "string",
  "isDeleted": true,
  "isPublic": true,
  "key": "string",
  "lastModified": "string",
  "name": "string",
  "ownerId": "string",
  "size": "string",
  "tenantId": "string",
  "thumbnail": "string",
  "type": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Parameters

Parameter In Type Required Description
fileId path string true none
body body FilePartial false none

Example responses

200 Response

{
  "additionalProperties": {},
  "createdAt": "2021-04-23T17:28:11Z",
  "deletedAt": "2021-04-23T17:28:11Z",
  "generating": true,
  "id": "string",
  "isDeleted": true,
  "isPublic": true,
  "key": "string",
  "lastModified": "string",
  "name": "string",
  "ownerId": "string",
  "size": "string",
  "tenantId": "string",
  "thumbnail": "string",
  "type": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request File

Download a File

Code samples

# You can also use wget
curl -X GET /files/{fileId}/download \
  -H 'Accept: application/octet-stream'

var headers = {
  'Accept':'application/octet-stream'

};

$.ajax({
  url: '/files/{fileId}/download',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/octet-stream'

};

fetch('/files/{fileId}/download',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/octet-stream'
}

r = requests.get('/files/{fileId}/download', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/octet-stream',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/files/{fileId}/download', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Endpoint

GET /files/{fileId}/download

Parameters

Parameter In Type Required Description
fileId path string true none

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK The file content string

Profiles

A Profile contains all the details for a individual, trust, joint account, etc. These profiles can be defined and used for a variety of purposes, such as, organizing deals, making investments, or creating assets. A profile is used to complete tasks such as generating documents and performing KYC/KYB

List Profiles

Code samples

# You can also use wget
curl -X GET /profiles \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/profiles',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/profiles',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/profiles', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/profiles', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

List current user's profiles.

Endpoint

GET /profiles

Parameters

Parameter In Type Required Description
perPage query number false none
page query number false none

Example responses

200 Response

{
  "data": [
    {
      "ERAStatus": "string",
      "address": {},
      "bankingUser": {
        "accounts": [
          {}
        ],
        "id": "string"
      },
      "beneficialOwner": {
        "address": {},
        "countryOfFormation": "string",
        "dateOfBirth": "string",
        "email": "string",
        "isUSBased": true,
        "name": "string",
        "passport": "string",
        "phone": "string",
        "stateOfFormation": "string",
        "taxDetails": {},
        "taxId": "string",
        "taxIdType": "string",
        "title": "string",
        "type": "string"
      },
      "countryOfFormation": "string",
      "createdAt": "2021-04-23T17:28:11Z",
      "dateOfBirth": "string",
      "dateOfFormation": "string",
      "deletedAt": "2021-04-23T17:28:11Z",
      "deliveryAddress": {},
      "email": "string",
      "firstName": "string",
      "id": "string",
      "image": "string",
      "investorStatus": [
        0
      ],
      "isDeleted": true,
      "isERA": true,
      "isRIA": true,
      "isSingleMemberLLC": true,
      "isUSBased": true,
      "jointAccountName": "string",
      "kycAml": {},
      "lastName": "string",
      "manager": "string",
      "masterEntity": "string",
      "name": "string",
      "ownerId": "string",
      "passportId": "string",
      "phone": "string",
      "primaryContact": {},
      "primarySignatory": {
        "address": {},
        "countryOfFormation": "string",
        "dateOfBirth": "string",
        "email": "string",
        "isUSBased": true,
        "name": "string",
        "passport": "string",
        "phone": "string",
        "stateOfFormation": "string",
        "taxDetails": {},
        "taxId": "string",
        "taxIdType": "string",
        "title": "string",
        "type": "string"
      },
      "profileType": "ORGANIZER",
      "secondarySignatory": {
        "address": {},
        "countryOfFormation": "string",
        "dateOfBirth": "string",
        "email": "string",
        "isUSBased": true,
        "name": "string",
        "passport": "string",
        "phone": "string",
        "stateOfFormation": "string",
        "taxDetails": {},
        "taxId": "string",
        "taxIdType": "string",
        "title": "string",
        "type": "string"
      },
      "signers": [
        {
          "address": {},
          "countryOfFormation": "string",
          "dateOfBirth": "string",
          "email": "string",
          "isUSBased": true,
          "name": "string",
          "passport": "string",
          "phone": "string",
          "stateOfFormation": "string",
          "taxDetails": {},
          "taxId": "string",
          "taxIdType": "string",
          "title": "string",
          "type": "string"
        }
      ],
      "stateOfFormation": "string",
      "taxDetails": {},
      "tenantId": "string",
      "title": "string",
      "typeOfEntity": "string",
      "updatedAt": "2021-04-23T17:28:11Z"
    }
  ],
  "page": 0,
  "perPage": 0,
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request ProfilesList

Create a Profile

Code samples

# You can also use wget
curl -X POST /profiles \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/profiles',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "ERAStatus": "string",
  "address": {},
  "bankingUser": {
    "accounts": [
      {}
    ],
    "id": "string"
  },
  "beneficialOwner": {
    "address": {},
    "countryOfFormation": "string",
    "dateOfBirth": "string",
    "email": "string",
    "isUSBased": true,
    "name": "string",
    "passport": "string",
    "phone": "string",
    "stateOfFormation": "string",
    "taxDetails": {},
    "taxId": "string",
    "taxIdType": "string",
    "title": "string",
    "type": "string"
  },
  "countryOfFormation": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "dateOfBirth": "string",
  "dateOfFormation": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "deliveryAddress": {},
  "email": "string",
  "firstName": "string",
  "image": "string",
  "investorStatus": [
    0
  ],
  "isDeleted": true,
  "isERA": true,
  "isRIA": true,
  "isSingleMemberLLC": true,
  "isUSBased": true,
  "jointAccountName": "string",
  "kycAml": {},
  "lastName": "string",
  "manager": "string",
  "masterEntity": "string",
  "name": "string",
  "ownerId": "string",
  "passportId": "string",
  "phone": "string",
  "primaryContact": {},
  "primarySignatory": {
    "address": {},
    "countryOfFormation": "string",
    "dateOfBirth": "string",
    "email": "string",
    "isUSBased": true,
    "name": "string",
    "passport": "string",
    "phone": "string",
    "stateOfFormation": "string",
    "taxDetails": {},
    "taxId": "string",
    "taxIdType": "string",
    "title": "string",
    "type": "string"
  },
  "profileType": "ORGANIZER",
  "secondarySignatory": {
    "address": {},
    "countryOfFormation": "string",
    "dateOfBirth": "string",
    "email": "string",
    "isUSBased": true,
    "name": "string",
    "passport": "string",
    "phone": "string",
    "stateOfFormation": "string",
    "taxDetails": {},
    "taxId": "string",
    "taxIdType": "string",
    "title": "string",
    "type": "string"
  },
  "signers": [
    {
      "address": {},
      "countryOfFormation": "string",
      "dateOfBirth": "string",
      "email": "string",
      "isUSBased": true,
      "name": "string",
      "passport": "string",
      "phone": "string",
      "stateOfFormation": "string",
      "taxDetails": {},
      "taxId": "string",
      "taxIdType": "string",
      "title": "string",
      "type": "string"
    }
  ],
  "stateOfFormation": "string",
  "taxDetails": {},
  "tenantId": "string",
  "title": "string",
  "typeOfEntity": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/profiles',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/profiles', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/profiles', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Creates a new profile for the current user.

Endpoint

POST /profiles

Body parameter

{
  "ERAStatus": "string",
  "address": {},
  "bankingUser": {
    "accounts": [
      {}
    ],
    "id": "string"
  },
  "beneficialOwner": {
    "address": {},
    "countryOfFormation": "string",
    "dateOfBirth": "string",
    "email": "string",
    "isUSBased": true,
    "name": "string",
    "passport": "string",
    "phone": "string",
    "stateOfFormation": "string",
    "taxDetails": {},
    "taxId": "string",
    "taxIdType": "string",
    "title": "string",
    "type": "string"
  },
  "countryOfFormation": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "dateOfBirth": "string",
  "dateOfFormation": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "deliveryAddress": {},
  "email": "string",
  "firstName": "string",
  "image": "string",
  "investorStatus": [
    0
  ],
  "isDeleted": true,
  "isERA": true,
  "isRIA": true,
  "isSingleMemberLLC": true,
  "isUSBased": true,
  "jointAccountName": "string",
  "kycAml": {},
  "lastName": "string",
  "manager": "string",
  "masterEntity": "string",
  "name": "string",
  "ownerId": "string",
  "passportId": "string",
  "phone": "string",
  "primaryContact": {},
  "primarySignatory": {
    "address": {},
    "countryOfFormation": "string",
    "dateOfBirth": "string",
    "email": "string",
    "isUSBased": true,
    "name": "string",
    "passport": "string",
    "phone": "string",
    "stateOfFormation": "string",
    "taxDetails": {},
    "taxId": "string",
    "taxIdType": "string",
    "title": "string",
    "type": "string"
  },
  "profileType": "ORGANIZER",
  "secondarySignatory": {
    "address": {},
    "countryOfFormation": "string",
    "dateOfBirth": "string",
    "email": "string",
    "isUSBased": true,
    "name": "string",
    "passport": "string",
    "phone": "string",
    "stateOfFormation": "string",
    "taxDetails": {},
    "taxId": "string",
    "taxIdType": "string",
    "title": "string",
    "type": "string"
  },
  "signers": [
    {
      "address": {},
      "countryOfFormation": "string",
      "dateOfBirth": "string",
      "email": "string",
      "isUSBased": true,
      "name": "string",
      "passport": "string",
      "phone": "string",
      "stateOfFormation": "string",
      "taxDetails": {},
      "taxId": "string",
      "taxIdType": "string",
      "title": "string",
      "type": "string"
    }
  ],
  "stateOfFormation": "string",
  "taxDetails": {},
  "tenantId": "string",
  "title": "string",
  "typeOfEntity": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Parameters

Parameter In Type Required Description
body body NewProfile false none

Example responses

200 Response

{
  "ERAStatus": "string",
  "address": {},
  "bankingUser": {
    "accounts": [
      {}
    ],
    "id": "string"
  },
  "beneficialOwner": {
    "address": {},
    "countryOfFormation": "string",
    "dateOfBirth": "string",
    "email": "string",
    "isUSBased": true,
    "name": "string",
    "passport": "string",
    "phone": "string",
    "stateOfFormation": "string",
    "taxDetails": {},
    "taxId": "string",
    "taxIdType": "string",
    "title": "string",
    "type": "string"
  },
  "countryOfFormation": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "dateOfBirth": "string",
  "dateOfFormation": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "deliveryAddress": {},
  "email": "string",
  "firstName": "string",
  "id": "string",
  "image": "string",
  "investorStatus": [
    0
  ],
  "isDeleted": true,
  "isERA": true,
  "isRIA": true,
  "isSingleMemberLLC": true,
  "isUSBased": true,
  "jointAccountName": "string",
  "kycAml": {},
  "lastName": "string",
  "manager": "string",
  "masterEntity": "string",
  "name": "string",
  "ownerId": "string",
  "passportId": "string",
  "phone": "string",
  "primaryContact": {},
  "primarySignatory": {
    "address": {},
    "countryOfFormation": "string",
    "dateOfBirth": "string",
    "email": "string",
    "isUSBased": true,
    "name": "string",
    "passport": "string",
    "phone": "string",
    "stateOfFormation": "string",
    "taxDetails": {},
    "taxId": "string",
    "taxIdType": "string",
    "title": "string",
    "type": "string"
  },
  "profileType": "ORGANIZER",
  "secondarySignatory": {
    "address": {},
    "countryOfFormation": "string",
    "dateOfBirth": "string",
    "email": "string",
    "isUSBased": true,
    "name": "string",
    "passport": "string",
    "phone": "string",
    "stateOfFormation": "string",
    "taxDetails": {},
    "taxId": "string",
    "taxIdType": "string",
    "title": "string",
    "type": "string"
  },
  "signers": [
    {
      "address": {},
      "countryOfFormation": "string",
      "dateOfBirth": "string",
      "email": "string",
      "isUSBased": true,
      "name": "string",
      "passport": "string",
      "phone": "string",
      "stateOfFormation": "string",
      "taxDetails": {},
      "taxId": "string",
      "taxIdType": "string",
      "title": "string",
      "type": "string"
    }
  ],
  "stateOfFormation": "string",
  "taxDetails": {},
  "tenantId": "string",
  "title": "string",
  "typeOfEntity": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Profile

Search for the current users profiles

Code samples

# You can also use wget
curl -X POST /profiles/search \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/profiles/search',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/profiles/search',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/profiles/search', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/profiles/search', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Search for the users profiles given a searchObj.

Endpoint

POST /profiles/search

Body parameter

{}

Parameters

Parameter In Type Required Description
body body object false none

Example responses

200 Response

{
  "data": [
    {
      "ERAStatus": "string",
      "address": {},
      "bankingUser": {
        "accounts": [
          {}
        ],
        "id": "string"
      },
      "beneficialOwner": {
        "address": {},
        "countryOfFormation": "string",
        "dateOfBirth": "string",
        "email": "string",
        "isUSBased": true,
        "name": "string",
        "passport": "string",
        "phone": "string",
        "stateOfFormation": "string",
        "taxDetails": {},
        "taxId": "string",
        "taxIdType": "string",
        "title": "string",
        "type": "string"
      },
      "countryOfFormation": "string",
      "createdAt": "2021-04-23T17:28:11Z",
      "dateOfBirth": "string",
      "dateOfFormation": "string",
      "deletedAt": "2021-04-23T17:28:11Z",
      "deliveryAddress": {},
      "email": "string",
      "firstName": "string",
      "id": "string",
      "image": "string",
      "investorStatus": [
        0
      ],
      "isDeleted": true,
      "isERA": true,
      "isRIA": true,
      "isSingleMemberLLC": true,
      "isUSBased": true,
      "jointAccountName": "string",
      "kycAml": {},
      "lastName": "string",
      "manager": "string",
      "masterEntity": "string",
      "name": "string",
      "ownerId": "string",
      "passportId": "string",
      "phone": "string",
      "primaryContact": {},
      "primarySignatory": {
        "address": {},
        "countryOfFormation": "string",
        "dateOfBirth": "string",
        "email": "string",
        "isUSBased": true,
        "name": "string",
        "passport": "string",
        "phone": "string",
        "stateOfFormation": "string",
        "taxDetails": {},
        "taxId": "string",
        "taxIdType": "string",
        "title": "string",
        "type": "string"
      },
      "profileType": "ORGANIZER",
      "secondarySignatory": {
        "address": {},
        "countryOfFormation": "string",
        "dateOfBirth": "string",
        "email": "string",
        "isUSBased": true,
        "name": "string",
        "passport": "string",
        "phone": "string",
        "stateOfFormation": "string",
        "taxDetails": {},
        "taxId": "string",
        "taxIdType": "string",
        "title": "string",
        "type": "string"
      },
      "signers": [
        {
          "address": {},
          "countryOfFormation": "string",
          "dateOfBirth": "string",
          "email": "string",
          "isUSBased": true,
          "name": "string",
          "passport": "string",
          "phone": "string",
          "stateOfFormation": "string",
          "taxDetails": {},
          "taxId": "string",
          "taxIdType": "string",
          "title": "string",
          "type": "string"
        }
      ],
      "stateOfFormation": "string",
      "taxDetails": {},
      "tenantId": "string",
      "title": "string",
      "typeOfEntity": "string",
      "updatedAt": "2021-04-23T17:28:11Z"
    }
  ],
  "page": 0,
  "perPage": 0,
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request ProfilesList

Delete a profile

Code samples

# You can also use wget
curl -X DELETE /profiles/{profileId} \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/profiles/{profileId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/profiles/{profileId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/profiles/{profileId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/profiles/{profileId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Deletes a specific profile by id.

Endpoint

DELETE /profiles/{profileId}

Parameters

Parameter In Type Required Description
profileId path string true none

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request None

Get a profile by ID

Code samples

# You can also use wget
curl -X GET /profiles/{profileId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/profiles/{profileId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/profiles/{profileId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/profiles/{profileId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/profiles/{profileId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Returns a specific profile for the current user.

Endpoint

GET /profiles/{profileId}

Parameters

Parameter In Type Required Description
profileId path string true none

Example responses

200 Response

{
  "ERAStatus": "string",
  "address": {},
  "bankingUser": {
    "accounts": [
      {}
    ],
    "id": "string"
  },
  "beneficialOwner": {
    "address": {},
    "countryOfFormation": "string",
    "dateOfBirth": "string",
    "email": "string",
    "isUSBased": true,
    "name": "string",
    "passport": "string",
    "phone": "string",
    "stateOfFormation": "string",
    "taxDetails": {},
    "taxId": "string",
    "taxIdType": "string",
    "title": "string",
    "type": "string"
  },
  "countryOfFormation": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "dateOfBirth": "string",
  "dateOfFormation": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "deliveryAddress": {},
  "email": "string",
  "firstName": "string",
  "id": "string",
  "image": "string",
  "investorStatus": [
    0
  ],
  "isDeleted": true,
  "isERA": true,
  "isRIA": true,
  "isSingleMemberLLC": true,
  "isUSBased": true,
  "jointAccountName": "string",
  "kycAml": {},
  "lastName": "string",
  "manager": "string",
  "masterEntity": "string",
  "name": "string",
  "ownerId": "string",
  "passportId": "string",
  "phone": "string",
  "primaryContact": {},
  "primarySignatory": {
    "address": {},
    "countryOfFormation": "string",
    "dateOfBirth": "string",
    "email": "string",
    "isUSBased": true,
    "name": "string",
    "passport": "string",
    "phone": "string",
    "stateOfFormation": "string",
    "taxDetails": {},
    "taxId": "string",
    "taxIdType": "string",
    "title": "string",
    "type": "string"
  },
  "profileType": "ORGANIZER",
  "secondarySignatory": {
    "address": {},
    "countryOfFormation": "string",
    "dateOfBirth": "string",
    "email": "string",
    "isUSBased": true,
    "name": "string",
    "passport": "string",
    "phone": "string",
    "stateOfFormation": "string",
    "taxDetails": {},
    "taxId": "string",
    "taxIdType": "string",
    "title": "string",
    "type": "string"
  },
  "signers": [
    {
      "address": {},
      "countryOfFormation": "string",
      "dateOfBirth": "string",
      "email": "string",
      "isUSBased": true,
      "name": "string",
      "passport": "string",
      "phone": "string",
      "stateOfFormation": "string",
      "taxDetails": {},
      "taxId": "string",
      "taxIdType": "string",
      "title": "string",
      "type": "string"
    }
  ],
  "stateOfFormation": "string",
  "taxDetails": {},
  "tenantId": "string",
  "title": "string",
  "typeOfEntity": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Profile

Update a profile by ID

Code samples

# You can also use wget
curl -X PUT /profiles/{profileId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/profiles/{profileId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "ERAStatus": "string",
  "address": {},
  "bankingUser": {
    "accounts": [
      {}
    ],
    "id": "string"
  },
  "beneficialOwner": {
    "address": {},
    "countryOfFormation": "string",
    "dateOfBirth": "string",
    "email": "string",
    "isUSBased": true,
    "name": "string",
    "passport": "string",
    "phone": "string",
    "stateOfFormation": "string",
    "taxDetails": {},
    "taxId": "string",
    "taxIdType": "string",
    "title": "string",
    "type": "string"
  },
  "countryOfFormation": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "dateOfBirth": "string",
  "dateOfFormation": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "deliveryAddress": {},
  "email": "string",
  "firstName": "string",
  "id": "string",
  "image": "string",
  "investorStatus": [
    0
  ],
  "isDeleted": true,
  "isERA": true,
  "isRIA": true,
  "isSingleMemberLLC": true,
  "isUSBased": true,
  "jointAccountName": "string",
  "kycAml": {},
  "lastName": "string",
  "manager": "string",
  "masterEntity": "string",
  "name": "string",
  "ownerId": "string",
  "passportId": "string",
  "phone": "string",
  "primaryContact": {},
  "primarySignatory": {
    "address": {},
    "countryOfFormation": "string",
    "dateOfBirth": "string",
    "email": "string",
    "isUSBased": true,
    "name": "string",
    "passport": "string",
    "phone": "string",
    "stateOfFormation": "string",
    "taxDetails": {},
    "taxId": "string",
    "taxIdType": "string",
    "title": "string",
    "type": "string"
  },
  "profileType": "ORGANIZER",
  "secondarySignatory": {
    "address": {},
    "countryOfFormation": "string",
    "dateOfBirth": "string",
    "email": "string",
    "isUSBased": true,
    "name": "string",
    "passport": "string",
    "phone": "string",
    "stateOfFormation": "string",
    "taxDetails": {},
    "taxId": "string",
    "taxIdType": "string",
    "title": "string",
    "type": "string"
  },
  "signers": [
    {
      "address": {},
      "countryOfFormation": "string",
      "dateOfBirth": "string",
      "email": "string",
      "isUSBased": true,
      "name": "string",
      "passport": "string",
      "phone": "string",
      "stateOfFormation": "string",
      "taxDetails": {},
      "taxId": "string",
      "taxIdType": "string",
      "title": "string",
      "type": "string"
    }
  ],
  "stateOfFormation": "string",
  "taxDetails": {},
  "tenantId": "string",
  "title": "string",
  "typeOfEntity": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/profiles/{profileId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/profiles/{profileId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/profiles/{profileId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Update a profile with the provided information.

Endpoint

PUT /profiles/{profileId}

Body parameter

{
  "ERAStatus": "string",
  "address": {},
  "bankingUser": {
    "accounts": [
      {}
    ],
    "id": "string"
  },
  "beneficialOwner": {
    "address": {},
    "countryOfFormation": "string",
    "dateOfBirth": "string",
    "email": "string",
    "isUSBased": true,
    "name": "string",
    "passport": "string",
    "phone": "string",
    "stateOfFormation": "string",
    "taxDetails": {},
    "taxId": "string",
    "taxIdType": "string",
    "title": "string",
    "type": "string"
  },
  "countryOfFormation": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "dateOfBirth": "string",
  "dateOfFormation": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "deliveryAddress": {},
  "email": "string",
  "firstName": "string",
  "id": "string",
  "image": "string",
  "investorStatus": [
    0
  ],
  "isDeleted": true,
  "isERA": true,
  "isRIA": true,
  "isSingleMemberLLC": true,
  "isUSBased": true,
  "jointAccountName": "string",
  "kycAml": {},
  "lastName": "string",
  "manager": "string",
  "masterEntity": "string",
  "name": "string",
  "ownerId": "string",
  "passportId": "string",
  "phone": "string",
  "primaryContact": {},
  "primarySignatory": {
    "address": {},
    "countryOfFormation": "string",
    "dateOfBirth": "string",
    "email": "string",
    "isUSBased": true,
    "name": "string",
    "passport": "string",
    "phone": "string",
    "stateOfFormation": "string",
    "taxDetails": {},
    "taxId": "string",
    "taxIdType": "string",
    "title": "string",
    "type": "string"
  },
  "profileType": "ORGANIZER",
  "secondarySignatory": {
    "address": {},
    "countryOfFormation": "string",
    "dateOfBirth": "string",
    "email": "string",
    "isUSBased": true,
    "name": "string",
    "passport": "string",
    "phone": "string",
    "stateOfFormation": "string",
    "taxDetails": {},
    "taxId": "string",
    "taxIdType": "string",
    "title": "string",
    "type": "string"
  },
  "signers": [
    {
      "address": {},
      "countryOfFormation": "string",
      "dateOfBirth": "string",
      "email": "string",
      "isUSBased": true,
      "name": "string",
      "passport": "string",
      "phone": "string",
      "stateOfFormation": "string",
      "taxDetails": {},
      "taxId": "string",
      "taxIdType": "string",
      "title": "string",
      "type": "string"
    }
  ],
  "stateOfFormation": "string",
  "taxDetails": {},
  "tenantId": "string",
  "title": "string",
  "typeOfEntity": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Parameters

Parameter In Type Required Description
profileId path string true none
body body ProfilePartial false none

Example responses

200 Response

{
  "ERAStatus": "string",
  "address": {},
  "bankingUser": {
    "accounts": [
      {}
    ],
    "id": "string"
  },
  "beneficialOwner": {
    "address": {},
    "countryOfFormation": "string",
    "dateOfBirth": "string",
    "email": "string",
    "isUSBased": true,
    "name": "string",
    "passport": "string",
    "phone": "string",
    "stateOfFormation": "string",
    "taxDetails": {},
    "taxId": "string",
    "taxIdType": "string",
    "title": "string",
    "type": "string"
  },
  "countryOfFormation": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "dateOfBirth": "string",
  "dateOfFormation": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "deliveryAddress": {},
  "email": "string",
  "firstName": "string",
  "id": "string",
  "image": "string",
  "investorStatus": [
    0
  ],
  "isDeleted": true,
  "isERA": true,
  "isRIA": true,
  "isSingleMemberLLC": true,
  "isUSBased": true,
  "jointAccountName": "string",
  "kycAml": {},
  "lastName": "string",
  "manager": "string",
  "masterEntity": "string",
  "name": "string",
  "ownerId": "string",
  "passportId": "string",
  "phone": "string",
  "primaryContact": {},
  "primarySignatory": {
    "address": {},
    "countryOfFormation": "string",
    "dateOfBirth": "string",
    "email": "string",
    "isUSBased": true,
    "name": "string",
    "passport": "string",
    "phone": "string",
    "stateOfFormation": "string",
    "taxDetails": {},
    "taxId": "string",
    "taxIdType": "string",
    "title": "string",
    "type": "string"
  },
  "profileType": "ORGANIZER",
  "secondarySignatory": {
    "address": {},
    "countryOfFormation": "string",
    "dateOfBirth": "string",
    "email": "string",
    "isUSBased": true,
    "name": "string",
    "passport": "string",
    "phone": "string",
    "stateOfFormation": "string",
    "taxDetails": {},
    "taxId": "string",
    "taxIdType": "string",
    "title": "string",
    "type": "string"
  },
  "signers": [
    {
      "address": {},
      "countryOfFormation": "string",
      "dateOfBirth": "string",
      "email": "string",
      "isUSBased": true,
      "name": "string",
      "passport": "string",
      "phone": "string",
      "stateOfFormation": "string",
      "taxDetails": {},
      "taxId": "string",
      "taxIdType": "string",
      "title": "string",
      "type": "string"
    }
  ],
  "stateOfFormation": "string",
  "taxDetails": {},
  "tenantId": "string",
  "title": "string",
  "typeOfEntity": "string",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Profile

Add a banking account to a profile

Code samples

# You can also use wget
curl -X POST /profiles/{profileId}/addBankAccount/{accountId}/{subAccountId}


$.ajax({
  url: '/profiles/{profileId}/addBankAccount/{accountId}/{subAccountId}',
  method: 'post',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

fetch('/profiles/{profileId}/addBankAccount/{accountId}/{subAccountId}',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests

r = requests.post('/profiles/{profileId}/addBankAccount/{accountId}/{subAccountId}', params={

)

print r.json()

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/profiles/{profileId}/addBankAccount/{accountId}/{subAccountId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Endpoint

POST /profiles/{profileId}/addBankAccount/{accountId}/{subAccountId}

Parameters

Parameter In Type Required Description
profileId path string true none
accountId path string true none
subAccountId path string true none

Responses

Status Meaning Description Schema
204 No Content POST Add Profile Bank Account Success None

ProfilesController.addBankingUser

Code samples

# You can also use wget
curl -X POST /profiles/{profileId}/addBankingUser


$.ajax({
  url: '/profiles/{profileId}/addBankingUser',
  method: 'post',

  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

fetch('/profiles/{profileId}/addBankingUser',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests

r = requests.post('/profiles/{profileId}/addBankingUser', params={

)

print r.json()

<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/profiles/{profileId}/addBankingUser', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Endpoint

POST /profiles/{profileId}/addBankingUser

Parameters

Parameter In Type Required Description
profileId path string true none

Responses

Status Meaning Description Schema
204 No Content POST Add Profile Bank Account User Success None

Subscriptions

A Subscription is the investment into a Deal.

List Subscriptions

Code samples

# You can also use wget
curl -X GET /subscriptions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/subscriptions',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/subscriptions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/subscriptions', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/subscriptions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

List the current users subscriptions.

Endpoint

GET /subscriptions

Parameters

Parameter In Type Required Description
perPage query number false none
page query number false none

Example responses

200 Response

{
  "data": [
    {
      "accountTransaction": {},
      "acquisitionMethod": "DIRECT_LINK",
      "additionalProperties": {},
      "amount": 0,
      "bankAccount": {},
      "closeDoc": "string",
      "createdAt": "2021-04-23T17:28:11Z",
      "dealId": "string",
      "deletedAt": "2021-04-23T17:28:11Z",
      "documents": {},
      "email": "string",
      "files": [
        "string"
      ],
      "id": "string",
      "isDeleted": true,
      "isDocsSigned": true,
      "isKycAmlPassed": true,
      "name": "string",
      "ownerId": "string",
      "packageId": "string",
      "phone": "string",
      "profileId": "string",
      "reconciledAmount": 0,
      "reverseTransactionId": "string",
      "signers": [
        {
          "address": {},
          "countryOfFormation": "string",
          "dateOfBirth": "string",
          "email": "string",
          "isUSBased": true,
          "name": "string",
          "passport": "string",
          "phone": "string",
          "stateOfFormation": "string",
          "taxDetails": {},
          "taxId": "string",
          "taxIdType": "string",
          "title": "string",
          "type": "string"
        }
      ],
      "status": "INVITED",
      "tenantId": "string",
      "transactionId": "string",
      "transactionIds": [
        "string"
      ],
      "type": "INDIVIDUAL",
      "updatedAt": "2021-04-23T17:28:11Z"
    }
  ],
  "page": 0,
  "perPage": 0,
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request SubscriptionsList

Create a subscription

Code samples

# You can also use wget
curl -X POST /subscriptions \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/subscriptions',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "accountTransaction": {},
  "acquisitionMethod": "DIRECT_LINK",
  "additionalProperties": {},
  "amount": 0,
  "bankAccount": {},
  "closeDoc": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "documents": {},
  "email": "string",
  "files": [
    "string"
  ],
  "isDeleted": true,
  "isDocsSigned": true,
  "isKycAmlPassed": true,
  "name": "string",
  "ownerId": "string",
  "packageId": "string",
  "phone": "string",
  "profileId": "string",
  "reconciledAmount": 0,
  "reverseTransactionId": "string",
  "signers": [
    {
      "address": {},
      "countryOfFormation": "string",
      "dateOfBirth": "string",
      "email": "string",
      "isUSBased": true,
      "name": "string",
      "passport": "string",
      "phone": "string",
      "stateOfFormation": "string",
      "taxDetails": {},
      "taxId": "string",
      "taxIdType": "string",
      "title": "string",
      "type": "string"
    }
  ],
  "status": "INVITED",
  "tenantId": "string",
  "transactionId": "string",
  "transactionIds": [
    "string"
  ],
  "type": "INDIVIDUAL",
  "updatedAt": "2021-04-23T17:28:11Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/subscriptions',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/subscriptions', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/subscriptions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Creates a subscription for a specific deal if one doesn't already exist.

Endpoint

POST /subscriptions

Body parameter

{
  "accountTransaction": {},
  "acquisitionMethod": "DIRECT_LINK",
  "additionalProperties": {},
  "amount": 0,
  "bankAccount": {},
  "closeDoc": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "documents": {},
  "email": "string",
  "files": [
    "string"
  ],
  "isDeleted": true,
  "isDocsSigned": true,
  "isKycAmlPassed": true,
  "name": "string",
  "ownerId": "string",
  "packageId": "string",
  "phone": "string",
  "profileId": "string",
  "reconciledAmount": 0,
  "reverseTransactionId": "string",
  "signers": [
    {
      "address": {},
      "countryOfFormation": "string",
      "dateOfBirth": "string",
      "email": "string",
      "isUSBased": true,
      "name": "string",
      "passport": "string",
      "phone": "string",
      "stateOfFormation": "string",
      "taxDetails": {},
      "taxId": "string",
      "taxIdType": "string",
      "title": "string",
      "type": "string"
    }
  ],
  "status": "INVITED",
  "tenantId": "string",
  "transactionId": "string",
  "transactionIds": [
    "string"
  ],
  "type": "INDIVIDUAL",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Parameters

Parameter In Type Required Description
body body NewSubscription false none

Example responses

200 Response

{
  "accountTransaction": {},
  "acquisitionMethod": "DIRECT_LINK",
  "additionalProperties": {},
  "amount": 0,
  "bankAccount": {},
  "closeDoc": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "documents": {},
  "email": "string",
  "files": [
    "string"
  ],
  "id": "string",
  "isDeleted": true,
  "isDocsSigned": true,
  "isKycAmlPassed": true,
  "name": "string",
  "ownerId": "string",
  "packageId": "string",
  "phone": "string",
  "profileId": "string",
  "reconciledAmount": 0,
  "reverseTransactionId": "string",
  "signers": [
    {
      "address": {},
      "countryOfFormation": "string",
      "dateOfBirth": "string",
      "email": "string",
      "isUSBased": true,
      "name": "string",
      "passport": "string",
      "phone": "string",
      "stateOfFormation": "string",
      "taxDetails": {},
      "taxId": "string",
      "taxIdType": "string",
      "title": "string",
      "type": "string"
    }
  ],
  "status": "INVITED",
  "tenantId": "string",
  "transactionId": "string",
  "transactionIds": [
    "string"
  ],
  "type": "INDIVIDUAL",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Subscription

List Subscriptions by a deal Id

Code samples

# You can also use wget
curl -X GET /subscriptions-by-deal/{dealId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/subscriptions-by-deal/{dealId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/subscriptions-by-deal/{dealId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/subscriptions-by-deal/{dealId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/subscriptions-by-deal/{dealId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

List user's subscriptions that are part of a deal.

Endpoint

GET /subscriptions-by-deal/{dealId}

Parameters

Parameter In Type Required Description
perPage query number false none
page query number false none
dealId path string true none
filter query Subscription.Filter false none

Example responses

200 Response

{
  "data": [
    {
      "accountTransaction": {},
      "acquisitionMethod": "DIRECT_LINK",
      "additionalProperties": {},
      "amount": 0,
      "bankAccount": {},
      "closeDoc": "string",
      "createdAt": "2021-04-23T17:28:11Z",
      "dealId": "string",
      "deletedAt": "2021-04-23T17:28:11Z",
      "documents": {},
      "email": "string",
      "files": [
        "string"
      ],
      "id": "string",
      "isDeleted": true,
      "isDocsSigned": true,
      "isKycAmlPassed": true,
      "name": "string",
      "ownerId": "string",
      "packageId": "string",
      "phone": "string",
      "profileId": "string",
      "reconciledAmount": 0,
      "reverseTransactionId": "string",
      "signers": [
        {
          "address": {},
          "countryOfFormation": "string",
          "dateOfBirth": "string",
          "email": "string",
          "isUSBased": true,
          "name": "string",
          "passport": "string",
          "phone": "string",
          "stateOfFormation": "string",
          "taxDetails": {},
          "taxId": "string",
          "taxIdType": "string",
          "title": "string",
          "type": "string"
        }
      ],
      "status": "INVITED",
      "tenantId": "string",
      "transactionId": "string",
      "transactionIds": [
        "string"
      ],
      "type": "INDIVIDUAL",
      "updatedAt": "2021-04-23T17:28:11Z"
    }
  ],
  "page": 0,
  "perPage": 0,
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request SubscriptionsList

Code samples

# You can also use wget
curl -X POST /subscriptions/search \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/subscriptions/search',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/subscriptions/search',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/subscriptions/search', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/subscriptions/search', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Search for a list of subscriptions with a search object of parameters that you provide.

Endpoint

POST /subscriptions/search

Body parameter

{}

Parameters

Parameter In Type Required Description
body body object false none

Example responses

200 Response

{
  "data": [
    {
      "accountTransaction": {},
      "acquisitionMethod": "DIRECT_LINK",
      "additionalProperties": {},
      "amount": 0,
      "bankAccount": {},
      "closeDoc": "string",
      "createdAt": "2021-04-23T17:28:11Z",
      "dealId": "string",
      "deletedAt": "2021-04-23T17:28:11Z",
      "documents": {},
      "email": "string",
      "files": [
        "string"
      ],
      "id": "string",
      "isDeleted": true,
      "isDocsSigned": true,
      "isKycAmlPassed": true,
      "name": "string",
      "ownerId": "string",
      "packageId": "string",
      "phone": "string",
      "profileId": "string",
      "reconciledAmount": 0,
      "reverseTransactionId": "string",
      "signers": [
        {
          "address": {},
          "countryOfFormation": "string",
          "dateOfBirth": "string",
          "email": "string",
          "isUSBased": true,
          "name": "string",
          "passport": "string",
          "phone": "string",
          "stateOfFormation": "string",
          "taxDetails": {},
          "taxId": "string",
          "taxIdType": "string",
          "title": "string",
          "type": "string"
        }
      ],
      "status": "INVITED",
      "tenantId": "string",
      "transactionId": "string",
      "transactionIds": [
        "string"
      ],
      "type": "INDIVIDUAL",
      "updatedAt": "2021-04-23T17:28:11Z"
    }
  ],
  "page": 0,
  "perPage": 0,
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request SubscriptionsList

Get a profile by id

Code samples

# You can also use wget
curl -X GET /subscriptions/{id}/profile \
  -H 'Accept: application/json'

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: '/subscriptions/{id}/profile',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('/subscriptions/{id}/profile',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/subscriptions/{id}/profile', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/subscriptions/{id}/profile', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Endpoint

GET /subscriptions/{id}/profile

Parameters

Parameter In Type Required Description
id path string true none

Example responses

200 Response

[
  {
    "ERAStatus": "string",
    "address": {},
    "bankingUser": {
      "accounts": [
        {}
      ],
      "id": "string"
    },
    "beneficialOwner": {
      "address": {},
      "countryOfFormation": "string",
      "dateOfBirth": "string",
      "email": "string",
      "isUSBased": true,
      "name": "string",
      "passport": "string",
      "phone": "string",
      "stateOfFormation": "string",
      "taxDetails": {},
      "taxId": "string",
      "taxIdType": "string",
      "title": "string",
      "type": "string"
    },
    "countryOfFormation": "string",
    "createdAt": "2021-04-23T17:28:11Z",
    "dateOfBirth": "string",
    "dateOfFormation": "string",
    "deletedAt": "2021-04-23T17:28:11Z",
    "deliveryAddress": {},
    "email": "string",
    "firstName": "string",
    "id": "string",
    "image": "string",
    "investorStatus": [
      0
    ],
    "isDeleted": true,
    "isERA": true,
    "isRIA": true,
    "isSingleMemberLLC": true,
    "isUSBased": true,
    "jointAccountName": "string",
    "kycAml": {},
    "lastName": "string",
    "manager": "string",
    "masterEntity": "string",
    "name": "string",
    "ownerId": "string",
    "passportId": "string",
    "phone": "string",
    "primaryContact": {},
    "primarySignatory": {
      "address": {},
      "countryOfFormation": "string",
      "dateOfBirth": "string",
      "email": "string",
      "isUSBased": true,
      "name": "string",
      "passport": "string",
      "phone": "string",
      "stateOfFormation": "string",
      "taxDetails": {},
      "taxId": "string",
      "taxIdType": "string",
      "title": "string",
      "type": "string"
    },
    "profileType": "ORGANIZER",
    "secondarySignatory": {
      "address": {},
      "countryOfFormation": "string",
      "dateOfBirth": "string",
      "email": "string",
      "isUSBased": true,
      "name": "string",
      "passport": "string",
      "phone": "string",
      "stateOfFormation": "string",
      "taxDetails": {},
      "taxId": "string",
      "taxIdType": "string",
      "title": "string",
      "type": "string"
    },
    "signers": [
      {
        "address": {},
        "countryOfFormation": "string",
        "dateOfBirth": "string",
        "email": "string",
        "isUSBased": true,
        "name": "string",
        "passport": "string",
        "phone": "string",
        "stateOfFormation": "string",
        "taxDetails": {},
        "taxId": "string",
        "taxIdType": "string",
        "title": "string",
        "type": "string"
      }
    ],
    "stateOfFormation": "string",
    "taxDetails": {},
    "tenantId": "string",
    "title": "string",
    "typeOfEntity": "string",
    "updatedAt": "2021-04-23T17:28:11Z"
  }
]

Responses

Status Meaning Description Schema
200 OK Profile belonging to Subscription Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Profile] false none none
» Profile Profile false none none
»» ERAStatus string false none none
»» address object false none none
»»» address1 string true none none
»»» address2 string false none none
»»» city string true none none
»»» country string true none none
»»» postalCode string true none none
»»» state string false none none
»» bankingUser object false none none
»»» accounts [object] false none none
»»»» BankAccount object false none none
»»»»» accountName string false none none
»»»»» accountNumber string false none none
»»»»» bankName string false none none
»»»»» counterpartyId string true none none
»»»»» providerMeta object false none none
»»»»» routingNumber string false none none
»»»» id string false none none
»»» beneficialOwner object false none none
»»»» address object false none none
»»»»» address1 string true none none
»»»»» address2 string false none none
»»»»» city string true none none
»»»»» country string true none none
»»»»» postalCode string true none none
»»»»» state string false none none
»»»» countryOfFormation string false none none
»»»» dateOfBirth string false none none
»»»» email string false none none
»»»» isUSBased boolean false none none
»»»» name string false none none
»»»» passport string false none none
»»»» phone string false none none
»»»» stateOfFormation string false none none
»»»» taxDetails object false none none
»»»»» type string true none none
»»»»» value string true none none
»»»» taxId string false none none
»»»» taxIdType string false none none
»»»» title string false none none
»»»» type string false none none
»»» countryOfFormation string false none none
»»» createdAt string(date-time) false none none
»»» dateOfBirth string false none none
»»» dateOfFormation string false none none
»»» deletedAt string(date-time) false none none
»»» deliveryAddress object false none none
»»»» address1 string true none none
»»»» address2 string false none none
»»»» city string true none none
»»»» country string true none none
»»»» postalCode string true none none
»»»» state string false none none
»»» email string false none none
»»» firstName string false none none
»»» id string false none none
»»» image string false none none
»»» investorStatus [number] false none none
»»» isDeleted boolean false none none
»»» isERA boolean false none none
»»» isRIA boolean false none none
»»» isSingleMemberLLC boolean false none none
»»» isUSBased boolean false none none
»»» jointAccountName string false none none
»»» kycAml object false none none
»»»» applicantId string true none none
»»»» checkId string true none none
»»»» lastDateChecked string true none none
»»»» result string true none none
»»»» status string false none none
»»» lastName string false none none
»»» manager string false none none
»»» masterEntity string false none none
»»» name string false none none
»»» ownerId string false none none
»»» passportId string false none none
»»» phone string false none none
»»» primaryContact object false none none
»»» primarySignatory object false none none
»»»» address object false none none
»»»»» address1 string true none none
»»»»» address2 string false none none
»»»»» city string true none none
»»»»» country string true none none
»»»»» postalCode string true none none
»»»»» state string false none none
»»»» countryOfFormation string false none none
»»»» dateOfBirth string false none none
»»»» email string false none none
»»»» isUSBased boolean false none none
»»»» name string false none none
»»»» passport string false none none
»»»» phone string false none none
»»»» stateOfFormation string false none none
»»»» taxDetails object false none none
»»»»» type string true none none
»»»»» value string true none none
»»»» taxId string false none none
»»»» taxIdType string false none none
»»»» title string false none none
»»»» type string false none none
»»» profileType string false none none
»»» secondarySignatory object false none none
»»»» address object false none none
»»»»» address1 string true none none
»»»»» address2 string false none none
»»»»» city string true none none
»»»»» country string true none none
»»»»» postalCode string true none none
»»»»» state string false none none
»»»» countryOfFormation string false none none
»»»» dateOfBirth string false none none
»»»» email string false none none
»»»» isUSBased boolean false none none
»»»» name string false none none
»»»» passport string false none none
»»»» phone string false none none
»»»» stateOfFormation string false none none
»»»» taxDetails object false none none
»»»»» type string true none none
»»»»» value string true none none
»»»» taxId string false none none
»»»» taxIdType string false none none
»»»» title string false none none
»»»» type string false none none
»»» signers [Individual] false none none
»»»» Individual Individual false none none
»»»»» address object false none none
»»»»»» address1 string true none none
»»»»»» address2 string false none none
»»»»»» city string true none none
»»»»»» country string true none none
»»»»»» postalCode string true none none
»»»»»» state string false none none
»»»»» countryOfFormation string false none none
»»»»» dateOfBirth string false none none
»»»»» email string false none none
»»»»» isUSBased boolean false none none
»»»»» name string false none none
»»»»» passport string false none none
»»»»» phone string false none none
»»»»» stateOfFormation string false none none
»»»»» taxDetails object false none none
»»»»»» type string true none none
»»»»»» value string true none none
»»»»» taxId string false none none
»»»»» taxIdType string false none none
»»»»» title string false none none
»»»»» type string false none none
»»»» stateOfFormation string false none none
»»»» taxDetails object false none none
»»»»» registrationType string true none none
»»»»» taxIdentification object true none none
»»»»»» type any false none none
»»»»»» value string false none none
»»»»» tenantId string false none none
»»»»» title string false none none
»»»»» typeOfEntity string false none none
»»»»» updatedAt string(date-time) false none none

Enumerated Values

Property Value
status in_progress
status awaiting_applicant
status complete
status withdrawn
status paused
status reopened
profileType ORGANIZER
profileType INVESTOR
registrationType INDIVIDUAL
registrationType ENTITY
registrationType TRUST
registrationType JOINT
type ssn
type giin
type itin
type ftin
type ein

Delete a subscription

Code samples

# You can also use wget
curl -X DELETE /subscriptions/{subscriptionId} \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/subscriptions/{subscriptionId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/subscriptions/{subscriptionId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/subscriptions/{subscriptionId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/subscriptions/{subscriptionId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Delete a subscription using a subscriptionId.

Endpoint

DELETE /subscriptions/{subscriptionId}

Parameters

Parameter In Type Required Description
subscriptionId path string true none

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request None

Get a subscription by id

Code samples

# You can also use wget
curl -X GET /subscriptions/{subscriptionId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/subscriptions/{subscriptionId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/subscriptions/{subscriptionId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/subscriptions/{subscriptionId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/subscriptions/{subscriptionId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Returns a subscription given a specific subscriptionId

Endpoint

GET /subscriptions/{subscriptionId}

Parameters

Parameter In Type Required Description
subscriptionId path string true none

Example responses

200 Response

{
  "accountTransaction": {},
  "acquisitionMethod": "DIRECT_LINK",
  "additionalProperties": {},
  "amount": 0,
  "bankAccount": {},
  "closeDoc": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "documents": {},
  "email": "string",
  "files": [
    "string"
  ],
  "id": "string",
  "isDeleted": true,
  "isDocsSigned": true,
  "isKycAmlPassed": true,
  "name": "string",
  "ownerId": "string",
  "packageId": "string",
  "phone": "string",
  "profileId": "string",
  "reconciledAmount": 0,
  "reverseTransactionId": "string",
  "signers": [
    {
      "address": {},
      "countryOfFormation": "string",
      "dateOfBirth": "string",
      "email": "string",
      "isUSBased": true,
      "name": "string",
      "passport": "string",
      "phone": "string",
      "stateOfFormation": "string",
      "taxDetails": {},
      "taxId": "string",
      "taxIdType": "string",
      "title": "string",
      "type": "string"
    }
  ],
  "status": "INVITED",
  "tenantId": "string",
  "transactionId": "string",
  "transactionIds": [
    "string"
  ],
  "type": "INDIVIDUAL",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Subscription

Update a subscription

Code samples

# You can also use wget
curl -X PUT /subscriptions/{subscriptionId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/subscriptions/{subscriptionId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "accountTransaction": {},
  "acquisitionMethod": "DIRECT_LINK",
  "additionalProperties": {},
  "amount": 0,
  "bankAccount": {},
  "closeDoc": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "documents": {},
  "email": "string",
  "files": [
    "string"
  ],
  "id": "string",
  "isDeleted": true,
  "isDocsSigned": true,
  "isKycAmlPassed": true,
  "name": "string",
  "ownerId": "string",
  "packageId": "string",
  "phone": "string",
  "profileId": "string",
  "reconciledAmount": 0,
  "reverseTransactionId": "string",
  "signers": [
    {
      "address": {},
      "countryOfFormation": "string",
      "dateOfBirth": "string",
      "email": "string",
      "isUSBased": true,
      "name": "string",
      "passport": "string",
      "phone": "string",
      "stateOfFormation": "string",
      "taxDetails": {},
      "taxId": "string",
      "taxIdType": "string",
      "title": "string",
      "type": "string"
    }
  ],
  "status": "INVITED",
  "tenantId": "string",
  "transactionId": "string",
  "transactionIds": [
    "string"
  ],
  "type": "INDIVIDUAL",
  "updatedAt": "2021-04-23T17:28:11Z"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('/subscriptions/{subscriptionId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/subscriptions/{subscriptionId}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/subscriptions/{subscriptionId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Update a subscription with new information.

Endpoint

PUT /subscriptions/{subscriptionId}

Body parameter

{
  "accountTransaction": {},
  "acquisitionMethod": "DIRECT_LINK",
  "additionalProperties": {},
  "amount": 0,
  "bankAccount": {},
  "closeDoc": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "documents": {},
  "email": "string",
  "files": [
    "string"
  ],
  "id": "string",
  "isDeleted": true,
  "isDocsSigned": true,
  "isKycAmlPassed": true,
  "name": "string",
  "ownerId": "string",
  "packageId": "string",
  "phone": "string",
  "profileId": "string",
  "reconciledAmount": 0,
  "reverseTransactionId": "string",
  "signers": [
    {
      "address": {},
      "countryOfFormation": "string",
      "dateOfBirth": "string",
      "email": "string",
      "isUSBased": true,
      "name": "string",
      "passport": "string",
      "phone": "string",
      "stateOfFormation": "string",
      "taxDetails": {},
      "taxId": "string",
      "taxIdType": "string",
      "title": "string",
      "type": "string"
    }
  ],
  "status": "INVITED",
  "tenantId": "string",
  "transactionId": "string",
  "transactionIds": [
    "string"
  ],
  "type": "INDIVIDUAL",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Parameters

Parameter In Type Required Description
subscriptionId path string true none
body body SubscriptionPartial false none

Example responses

200 Response

{
  "accountTransaction": {},
  "acquisitionMethod": "DIRECT_LINK",
  "additionalProperties": {},
  "amount": 0,
  "bankAccount": {},
  "closeDoc": "string",
  "createdAt": "2021-04-23T17:28:11Z",
  "dealId": "string",
  "deletedAt": "2021-04-23T17:28:11Z",
  "documents": {},
  "email": "string",
  "files": [
    "string"
  ],
  "id": "string",
  "isDeleted": true,
  "isDocsSigned": true,
  "isKycAmlPassed": true,
  "name": "string",
  "ownerId": "string",
  "packageId": "string",
  "phone": "string",
  "profileId": "string",
  "reconciledAmount": 0,
  "reverseTransactionId": "string",
  "signers": [
    {
      "address": {},
      "countryOfFormation": "string",
      "dateOfBirth": "string",
      "email": "string",
      "isUSBased": true,
      "name": "string",
      "passport": "string",
      "phone": "string",
      "stateOfFormation": "string",
      "taxDetails": {},
      "taxId": "string",
      "taxIdType": "string",
      "title": "string",
      "type": "string"
    }
  ],
  "status": "INVITED",
  "tenantId": "string",
  "transactionId": "string",
  "transactionIds": [
    "string"
  ],
  "type": "INDIVIDUAL",
  "updatedAt": "2021-04-23T17:28:11Z"
}

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request Subscription

Cancel a subscription

Code samples

# You can also use wget
curl -X POST /subscriptions/{subscriptionId}/cancel \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/subscriptions/{subscriptionId}/cancel',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'

};

fetch('/subscriptions/{subscriptionId}/cancel',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/subscriptions/{subscriptionId}/cancel', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/subscriptions/{subscriptionId}/cancel', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Cancel a subscription by a specific id.

Endpoint

POST /subscriptions/{subscriptionId}/cancel

Parameters

Parameter In Type Required Description
subscriptionId path string true none

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request None

Generate a signing document

Code samples

# You can also use wget
curl -X POST /subscriptions/{subscriptionId}/generate-signing-document/{documentType} \
  -H 'Content-Type: application/json' \
  -H 'Accept: 0' \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Content-Type':'application/json',
  'Accept':'0',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/subscriptions/{subscriptionId}/generate-signing-document/{documentType}',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'0',
  'Authorization':'Bearer {access-token}'

};

fetch('/subscriptions/{subscriptionId}/generate-signing-document/{documentType}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '0',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/subscriptions/{subscriptionId}/generate-signing-document/{documentType}', params={

}, headers = headers)

print r.json()

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => '0',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/subscriptions/{subscriptionId}/generate-signing-document/{documentType}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

Generate a signing document for a specific subscription, of the type you provide.

Endpoint

POST /subscriptions/{subscriptionId}/generate-signing-document/{documentType}

Body parameter

{}

Parameters

Parameter In Type Required Description
subscriptionId path string true none
documentType path string true none
body body object false none

Example responses

Responses

Status Meaning Description Schema
200 OK Expected response to a valid request None

Response Schema

Create a transfer

Code samples

# You can also use wget
curl -X POST /subscriptions/{subscriptionId}/initTransfer \
  -H 'Authorization: Bearer {access-token}'

var headers = {
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/subscriptions/{subscriptionId}/initTransfer',
  method: 'post',

  headers: headers,
  success: function(data) {
    con