Organizations v0.10.2

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

Contact information for organizations (businesses, non-profits, trusts, etc.) within the Apiture Banking APIs. This API manages business names, addresses, phone numbers, and email addresses of organizations. This API also tracks additional regulatory information for organizations which conduct banking and own business accounts at the financial institution.

This API also manages beneficial owners of organizations which conduct business banking: people who own at least 25% of the business.

Download OpenAPI Definition (YAML)

Base URLs:

• https://api.devbank.apiture.com/organizations

Terms of service

Email: Apiture Web: Apiture

Authentication

• API Key (apiKey)
  • header parameter: API-Key
  • API Key based authentication. Each client application must pass its private, unique API key, allocated in the developer portal, via the API-Key: {api-key} request header.

• OAuth2 authentication (accessToken)
  • OAuth2 client access token authentication. The client authenticates against the server at authorizationUrl, passing the client's private clientId (and optional clientSecret) as part of this flow. The client obtains an access token from the server at tokenUrl. It then passes the received access token via the Authorization: Bearer {access-token} header in subsequent API calls. The authorization process also returns a refresh token which the client should use to renew the access token before it expires.
  • Flow: authorizationCode
  • Authorization URL = https://auth.apiture.com/oauth2/authorize
  • Token URL = http://auth.apiture.com/auth/oauth2/token

Scope	Scope Description
profiles/read	Read access to user and contact related resources.
profiles/write	Write (update) access to user and contact related resources.
profiles/delete	Delete access to user and contact related resources.
profiles/readPii	Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the profiles/read scope in order to read such data, but is included in the profiles/full scope.
profiles/full	Full access to user and contact related resources.

API

Endpoints which describe this API.

getApi

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/organizations/ \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/organizations/ HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/organizations/',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/organizations/',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/organizations/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY'
}

r = requests.get('https://api.devbank.apiture.com/organizations/', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/organizations/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Top-level resources and operations in this API

GET /

Return links to the top-level resources and operations in this API.

Example responses

200 Response

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0",
  "_profile": "https://api.apiture.com/schemas/common/root/v1.0.0/profile.json",
  "_links": {}
}

Responses

Status	Description
200	OK
	OK
	Schema: root

getApiDoc

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/organizations/apiDoc \
  -H 'Accept: application/json' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/organizations/apiDoc HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/json

var headers = {
  'Accept':'application/json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/organizations/apiDoc',
  method: 'get',

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

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

const headers = {
  'Accept':'application/json',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/organizations/apiDoc',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/organizations/apiDoc',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'API-Key': 'API_KEY'
}

r = requests.get('https://api.devbank.apiture.com/organizations/apiDoc', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/apiDoc");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/organizations/apiDoc", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return API definition document

GET /apiDoc

Return the OpenAPI document that describes this API.

Example responses

200 Response

{}

Responses

Status	Description
200	OK
	OK
	Schema: Inline

Response Schema

getLabels

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/organizations/labels \
  -H 'Accept: application/hal+json' \
  -H 'Accept-Language: string' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/organizations/labels HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
Accept-Language: string

var headers = {
  'Accept':'application/hal+json',
  'Accept-Language':'string',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/organizations/labels',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json',
  'Accept-Language':'string',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/organizations/labels',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'Accept-Language' => 'string',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/organizations/labels',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'Accept-Language': 'string',
  'API-Key': 'API_KEY'
}

r = requests.get('https://api.devbank.apiture.com/organizations/labels', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/labels");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "Accept-Language": []string{"string"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/organizations/labels", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Localized Labels

GET /labels

Return a JSON object which defines labels for enumeration types defined by the schemas defined in this API.

The labels in the response may not all match the requested language; some may be in the default language (en-us).

Parameters

Parameter	Description
Accept-Language (header)	string The weighted language tags which indicate the user's preferred natural language for the localized labels in the response, as per RFC 7231.

Example responses

200 Response

{
  "property1": {
    "label": "Limited Liability Corporation",
    "description": "string",
    "language": "en-us",
    "code": "31"
  },
  "property2": {
    "label": "Limited Liability Corporation",
    "description": "string",
    "language": "en-us",
    "code": "31"
  }
}

Responses

Status	Description
200	OK
	OK
	Schema: localizedLabels

Organization

Organization

getOrganizations

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/organizations/organizations \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/organizations/organizations HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/organizations/organizations',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/organizations/organizations',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/organizations/organizations',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/organizations/organizations', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/organizations/organizations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of organizations

GET /organizations

Return a paginated sortable filterable searchable collection of organizations. The links in the response include pagination links.

Parameters

Parameter	Description
start (query)	integer(int64) The zero-based index of the first organization item to include in this page. The default 0 denotes the beginning of the collection.
limit (query)	integer(int32) The maximum number of organization representations to return in this page.
sortBy (query)	string Optional sort criteria. See sort criteria format, such as ?sortBy=field1,-field2.
filter (query)	string Optional filter criteria. See filtering.
q (query)	string Optional search string. See searching.

Example responses

200 Response

{
  "start": 0,
  "limit": 10,
  "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/organizations/organizations?start=10&limit=10"
    },
    "first": {
      "href": "/organizations/organizations?start=0&limit=10"
    },
    "next": {
      "href": "/organizations/organizations?start=20&limit=10"
    },
    "collection": {
      "href": "/organizations/organizations"
    }
  },
  "count": 10,
  "name": "organizations",
  "_embedded": {
    "items": [
      {
        "_id": "331af113-8f7b-422d-89fe-d0489cc43e5d",
        "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.apiture.com/organizations/organizations/331af113-8f7b-422d-89fe-d0489cc43e5d"
          },
          "apiture:activate": {
            "href": "https://api.apiture.com/organizations/activeOrganizations?organization=331af113-8f7b-422d-89fe-d0489cc43e5d"
          }
        },
        "name": "Apiture",
        "label": "",
        "type": "trust",
        "state": "pending"
      },
      {
        "_id": "a1a6bbef-ac51-4d5f-a30e-4034b0a5aca7",
        "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.apiture.com/organizations/organizations/a1a6bbef-ac51-4d5f-a30e-4034b0a5aca7"
          },
          "apiture:activate": {
            "href": "https://api.apiture.com/organizations/activeOrganizations?organization=a1a6bbef-ac51-4d5f-a30e-4034b0a5aca7"
          }
        },
        "name": "Apiture",
        "label": "",
        "type": "nonprofit",
        "state": "pending"
      },
      {
        "_id": "0c748e89-3180-4d43-927d-5120d39b4fa8",
        "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.apiture.com/organizations/organizations/0c748e89-3180-4d43-927d-5120d39b4fa8"
          },
          "apiture:activate": {
            "href": "https://api.apiture.com/organizations/activeOrganizations?organization=0c748e89-3180-4d43-927d-5120d39b4fa8"
          }
        },
        "name": "Apiture",
        "label": "",
        "type": "nonprofit",
        "state": "pending"
      },
      {
        "_id": "fb602721-ac57-4d68-835d-f649e351e2b5",
        "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.apiture.com/organizations/organizations/fb602721-ac57-4d68-835d-f649e351e2b5"
          },
          "apiture:activate": {
            "href": "https://api.apiture.com/organizations/activeOrganizations?organization=fb602721-ac57-4d68-835d-f649e351e2b5"
          }
        },
        "name": "Apiture",
        "label": "",
        "type": "nonprofit",
        "state": "pending"
      },
      {
        "_id": "64b636ec-cebe-44bc-9962-d4de2329abe3",
        "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.apiture.com/organizations/organizations/64b636ec-cebe-44bc-9962-d4de2329abe3"
          },
          "apiture:activate": {
            "href": "https://api.apiture.com/organizations/activeOrganizations?organization=64b636ec-cebe-44bc-9962-d4de2329abe3"
          }
        },
        "name": "Apiture",
        "label": "",
        "type": "municipality",
        "state": "pending"
      },
      {
        "_id": "c161edaa-293f-4c01-a232-e9a14344b297",
        "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.apiture.com/organizations/organizations/c161edaa-293f-4c01-a232-e9a14344b297"
          },
          "apiture:activate": {
            "href": "https://api.apiture.com/organizations/activeOrganizations?organization=c161edaa-293f-4c01-a232-e9a14344b297"
          }
        },
        "name": "Apiture",
        "label": "",
        "type": "nonprofit",
        "state": "pending"
      },
      {
        "_id": "2b094e5d-d2a7-4a03-8110-64ac9ac457e6",
        "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.apiture.com/organizations/organizations/2b094e5d-d2a7-4a03-8110-64ac9ac457e6"
          },
          "apiture:activate": {
            "href": "https://api.apiture.com/organizations/activeOrganizations?organization=2b094e5d-d2a7-4a03-8110-64ac9ac457e6"
          }
        },
        "name": "example corporation",
        "label": "",
        "type": "corporation",
        "state": "pending"
      },
      {
        "_id": "ccaea92d-5ba0-4f30-a39f-a422ad02e7ad",
        "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.apiture.com/organizations/organizations/ccaea92d-5ba0-4f30-a39f-a422ad02e7ad"
          },
          "apiture:activate": {
            "href": "https://api.apiture.com/organizations/activeOrganizations?organization=ccaea92d-5ba0-4f30-a39f-a422ad02e7ad"
          }
        },
        "name": "example llc",
        "label": "",
        "type": "llc",
        "state": "pending"
      },
      {
        "_id": "43f53a1f-7d00-443b-87ee-04f0704ffb14",
        "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.apiture.com/organizations/organizations/43f53a1f-7d00-443b-87ee-04f0704ffb14"
          },
          "apiture:activate": {
            "href": "https://api.apiture.com/organizations/activeOrganizations?organization=43f53a1f-7d00-443b-87ee-04f0704ffb14"
          }
        },
        "name": "example partnership",
        "label": "",
        "type": "partnership",
        "state": "pending"
      },
      {
        "_id": "741fee0e-7f94-4d30-9fd7-62a318768d23",
        "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.apiture.com/organizations/organizations/741fee0e-7f94-4d30-9fd7-62a318768d23"
          },
          "apiture:activate": {
            "href": "https://api.apiture.com/organizations/activeOrganizations?organization=741fee0e-7f94-4d30-9fd7-62a318768d23"
          }
        },
        "name": "example llp",
        "label": "",
        "type": "llp",
        "state": "pending"
      }
    ]
  }
}

Responses

Status	Description
200	OK
	OK
	Schema: organizations
400	Bad Request
	Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.
	Schema: errorResponse
422	Unprocessable Entity
	Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
	Schema: errorResponse

createOrganization

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/organizations/organizations \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/organizations/organizations HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/organizations/organizations',
  method: 'post',

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

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/organizations/organizations',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/organizations/organizations',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.devbank.apiture.com/organizations/organizations', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/organizations/organizations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Create a new organization

POST /organizations

Create a new organization in the organizations collection.

Body parameter

{
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json"
}

Parameters

Parameter	Description
state (query)	string Subset the accounts or external accounts collection to those whose state matches this value. Use | to separate multiple values. For example, ?state=pending will match only items whose state is pending; ?state=removed|inactive will match items whose state is removed or inactive. This is combined with an implicit and with other filters if they are used. See filtering. Enumerated values: pending active inactive removed merged
type (query)	string Subset the accounts or external accounts collection to those with this exact type value. Use
name (query)	string Subset the accounts or external accounts collection to those with this name value. Use
body (body)	createOrganization (required) The data necessary to create a new organization.

Example responses

201 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}

Responses

Status	Description
201	Created
	Created
	Schema: organization
400	Bad Request
	Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.
	Schema: errorResponse

Response Headers

Status	Description
201	Location string uri
	The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with scheme://host
201	ETag string
	The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update the resource.

getOrganization

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/organizations/organizations/{organizationId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/organizations/organizations/{organizationId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/organizations/organizations/{organizationId}',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/organizations/organizations/{organizationId}',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/organizations/organizations/{organizationId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/organizations/organizations/{organizationId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/organizations/organizations/{organizationId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a representation of this organization

GET /organizations/{organizationId}

Return a HAL representation of this organization resource.

Parameters

Parameter	Description
organizationId (path)	string (required) The unique identifier of this organization. This is an opaque string.
If-None-Match (header)	string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.
embed (query)	string If set, the _embedded object in each account in the items array will include additional embedded objects. This query parameter supports the beneficialOwners option:
* ?embed=beneficialOwners

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}

Responses

Status	Description
200	OK
	OK
	Schema: organization
304	Not Modified
	Not Modified. The resource has not been modified since it was last fetched.
404	Not Found
	Not Found. There is no such organization resource at the specified {organizationId}. The _error field in the response will contain details about the request error.
	Schema: errorResponse

Response Headers

Status	Description
200	ETag string
	The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this organization resource.

updateOrganization

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/organizations/organizations/{organizationId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT https://api.devbank.apiture.com/organizations/organizations/{organizationId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/organizations/organizations/{organizationId}',
  method: 'put',

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

const fetch = require('node-fetch');
const inputBody = '{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/organizations/organizations/{organizationId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.devbank.apiture.com/organizations/organizations/{organizationId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.devbank.apiture.com/organizations/organizations/{organizationId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.devbank.apiture.com/organizations/organizations/{organizationId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update this organization

PUT /organizations/{organizationId}

Perform a complete replacement of this organization.

Body parameter

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}

Parameters

Parameter	Description
organizationId (path)	string (required) The unique identifier of this organization. This is an opaque string.
If-Match (header)	string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
body (body)	organization (required)

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}

Responses

Status	Description
200	OK
	OK
	Schema: organization
400	Bad Request
	Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.
	Schema: errorResponse
404	Not Found
	Not Found. There is no such organization resource at the specified {organizationId}. The _error field in the response will contain details about the request error.
	Schema: errorResponse
412	Precondition Failed
	Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
	Schema: errorResponse
422	Unprocessable Entity
	Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
	Schema: errorResponse

Response Headers

Status	Description
200	ETag string
	The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this organization resource.

patchOrganization

Code samples

# You can also use wget
curl -X PATCH https://api.devbank.apiture.com/organizations/organizations/{organizationId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.devbank.apiture.com/organizations/organizations/{organizationId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/organizations/organizations/{organizationId}',
  method: 'patch',

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

const fetch = require('node-fetch');
const inputBody = '{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/organizations/organizations/{organizationId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.devbank.apiture.com/organizations/organizations/{organizationId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.devbank.apiture.com/organizations/organizations/{organizationId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.devbank.apiture.com/organizations/organizations/{organizationId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update this organization

PATCH /organizations/{organizationId}

Perform a partial update of this organization. Fields which are omitted are not updated. Nested _embedded and _links are ignored if included.

Body parameter

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}

Parameters

Parameter	Description
organizationId (path)	string (required) The unique identifier of this organization. This is an opaque string.
If-Match (header)	string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
body (body)	organization (required)

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}

Responses

Status	Description
200	OK
	OK
	Schema: organization
400	Bad Request
	Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.
	Schema: errorResponse
404	Not Found
	Not Found. There is no such organization resource at the specified {organizationId}. The _error field in the response will contain details about the request error.
	Schema: errorResponse
412	Precondition Failed
	Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
	Schema: errorResponse
422	Unprocessable Entity
	Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
	Schema: errorResponse

Response Headers

Status	Description
200	ETag string
	The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this organization resource.

deleteOrganization

Code samples

# You can also use wget
curl -X DELETE https://api.devbank.apiture.com/organizations/organizations/{organizationId} \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.devbank.apiture.com/organizations/organizations/{organizationId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/organizations/organizations/{organizationId}',
  method: 'delete',

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

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

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/organizations/organizations/{organizationId}',
{
  method: 'DELETE',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.devbank.apiture.com/organizations/organizations/{organizationId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.devbank.apiture.com/organizations/organizations/{organizationId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.devbank.apiture.com/organizations/organizations/{organizationId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Delete this organization resource

DELETE /organizations/{organizationId}

Delete this organization resource.

Parameters

Parameter	Description
If-Match (header)	string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.
organizationId (path)	string (required) The unique identifier of this organization. This is an opaque string.

Example responses

412 Response

{
  "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://api.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Responses

Status	Description
204	No Content
	No Content. The resource was deleted successfully.
412	Precondition Failed
	Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
	Schema: errorResponse

activateOrganization

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/organizations/activeOrganizations?organization=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/organizations/activeOrganizations?organization=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/organizations/activeOrganizations',
  method: 'post',
  data: '?organization=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/organizations/activeOrganizations?organization=string',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/organizations/activeOrganizations',
  params: {
  'organization' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/organizations/activeOrganizations', params={
  'organization': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/activeOrganizations?organization=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/organizations/activeOrganizations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Activate an organization.

POST /activeOrganizations

Activate an organization from an inactive state.

This operation is invoked from the apiture:activate link on an organization resource when that user is eligible to be activated.

This changes the state to active.

Parameters

Parameter	Description
organization (query)	string (required) A string which identifies existing organization whose state is being changed by POSTing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a {organizationId} or a organization URI.
organizationUri (query)	string The URI of an existing organization which is eligible to be activated. This parameter is deprecated. Use the ?organization= query parameter instead.
If-Match (header)	string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}

Responses

Status	Description
200	OK
	OK
	Schema: organization
400	Bad Request
	Bad Request. The organization or organizationUri was malformed or does not refer to an organization.
	Schema: errorResponse
409	Conflict
	Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following: An organization with the associated taxId already exists The state of a removed user may not be changed. The state cannot be updated via a PUT or POST request. Please use the appropriate endpoint to change the state. Some key fields of the user record may not be changed or removed, such as their taxId
412	Precondition Failed
	Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
	Schema: errorResponse
422	Unprocessable Entity
	Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
	Schema: errorResponse

Response Headers

Status	Description
200	ETag string
	The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this user resource.

deactivateOrganization

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/organizations/inactiveOrganizations?organization=string&organizationUri=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/organizations/inactiveOrganizations?organization=string&organizationUri=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/organizations/inactiveOrganizations',
  method: 'post',
  data: '?organization=string&organizationUri=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/organizations/inactiveOrganizations?organization=string&organizationUri=string',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/organizations/inactiveOrganizations',
  params: {
  'organization' => 'string',
'organizationUri' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/organizations/inactiveOrganizations', params={
  'organization': 'string',  'organizationUri': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/inactiveOrganizations?organization=string&organizationUri=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/organizations/inactiveOrganizations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Deactivate an organization.

POST /inactiveOrganizations

Deactivate an organization from an active state.

This operation is invoked from the apiture:deactivate link on an organization resource when that user is eligible to be deactivated.

This changes the state to inactive.

Parameters

Parameter	Description
organization (query)	string (required) A string which identifies existing organization whose state is being changed by POSTing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a {organizationId} or a organization URI.
organizationUri (query)	string (required) The URI of an existing organization which is eligible to be deactivated. This parameter is deprecated. Use the ?organization= query parameter instead.
If-Match (header)	string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}

Responses

Status	Description
200	OK
	OK
	Schema: organization
400	Bad Request
	Bad Request. The organization or organizationUri was malformed or does not refer to an organization.
	Schema: errorResponse
409	Conflict
	Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following: An organization with the associated taxId already exists The state of a removed user may not be changed. The state cannot be updated via a PUT or POST request. Please use the appropriate endpoint to change the state. Some key fields of the user record may not be changed or removed, such as their taxId
412	Precondition Failed
	Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
	Schema: errorResponse
422	Unprocessable Entity
	Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
	Schema: errorResponse

Response Headers

Status	Description
200	ETag string
	The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this user resource.

removeOrganization

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/organizations/removedOrganizations?organization=string&organizationUri=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/organizations/removedOrganizations?organization=string&organizationUri=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/organizations/removedOrganizations',
  method: 'post',
  data: '?organization=string&organizationUri=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

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

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/organizations/removedOrganizations?organization=string&organizationUri=string',
{
  method: 'POST',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/organizations/removedOrganizations',
  params: {
  'organization' => 'string',
'organizationUri' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/organizations/removedOrganizations', params={
  'organization': 'string',  'organizationUri': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/removedOrganizations?organization=string&organizationUri=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/organizations/removedOrganizations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Remove an organization.

POST /removedOrganizations

Remove an organization by setting its state to removed.

This operation is invoked from the apiture:remove link on a organization resource when that user is eligible to be removed. The organization must not be in use (there may not be any active associations to the organization).

This changes the state to removed.

Parameters

Parameter	Description
organization (query)	string (required) A string which identifies existing organization whose state is being changed by POSTing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a {organizationId} or a organization URI.
organizationUri (query)	string (required) The URI of an existing organization which is eligible to be removed. This parameter is deprecated. Use the ?organization= query parameter instead.
If-Match (header)	string The entity tag that was returned in the ETag response. This must match the current entity tag of the resource.

Example responses

200 Response

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}

Responses

Status	Description
200	OK
	OK
	Schema: organization
400	Bad Request
	Bad Request. The organization or organizationUri was malformed or does not refer to an organization.
	Schema: errorResponse
409	Conflict
	Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following: An organization with the associated taxId already exists The state of a removed user may not be changed. The state cannot be updated via a PUT or POST request. Please use the appropriate endpoint to change the state. Some key fields of the user record may not be changed or removed, such as their taxId
412	Precondition Failed
	Precondition Failed. The supplied if-Match header value does not match the most recent ETag response header value. The resource has changed in the interim.
	Schema: errorResponse
422	Unprocessable Entity
	Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
	Schema: errorResponse

Response Headers

Status	Description
200	ETag string
	The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this user resource.

Beneficial Owners

Organization's Beneficial Owners

getBeneficialOwners

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/organizations/organizations/{organizationId}/beneficialOwners \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.devbank.apiture.com/organizations/organizations/{organizationId}/beneficialOwners HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/organizations/organizations/{organizationId}/beneficialOwners',
  method: 'get',

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

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

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/organizations/organizations/{organizationId}/beneficialOwners',
{
  method: 'GET',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.devbank.apiture.com/organizations/organizations/{organizationId}/beneficialOwners',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.devbank.apiture.com/organizations/organizations/{organizationId}/beneficialOwners', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/beneficialOwners");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/organizations/organizations/{organizationId}/beneficialOwners", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch the organization's benefical owners

GET /organizations/{organizationId}/beneficialOwners

Return a HAL representation of the array of the organization's beneficial owners. This is a list of people who own 25% or more of the company. It is tracked for regulatory purposes for all organizations which own business accounts.

Parameters

Parameter	Description
organizationId (path)	string (required) The unique identifier of this organization. This is an opaque string.
If-None-Match (header)	string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Example responses

200 Response

{
  "items": [
    {
      "owner": {
        "firstName": "William",
        "lastName": "Wellphunded",
        "addresses": {
          "addressLine1": "1234 S Front Street",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "type": "home"
        }
      },
      "percentage": 35,
      "identification": {
        "type": "taxid",
        "value": "111-11-1111"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c/beneficialOwners"
    }
  }
}

Responses

Status	Description
200	OK
	OK
	Schema: beneficialOwners
304	Not Modified
	Not Modified. The resource has not been modified since it was last fetched.
404	Not Found
	Not Found. There is no such organization resource at the specified {organizationId}. The _error field in the response will contain details about the request error.
	Schema: errorResponse

Response Headers

Status	Description
200	ETag string
	The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this account resource.

updateBeneficialOwners

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/organizations/organizations/{organizationId}/beneficialOwners \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT https://api.devbank.apiture.com/organizations/organizations/{organizationId}/beneficialOwners HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-None-Match: string

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/organizations/organizations/{organizationId}/beneficialOwners',
  method: 'put',

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

const fetch = require('node-fetch');
const inputBody = '{
  "items": [
    {
      "owner": {
        "firstName": "William",
        "lastName": "Wellphunded",
        "addresses": {
          "addressLine1": "1234 S Front Street",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "type": "home"
        }
      },
      "percentage": 35,
      "identification": {
        "type": "taxid",
        "value": "111-11-1111"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c/beneficialOwners"
    }
  }
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/organizations/organizations/{organizationId}/beneficialOwners',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.devbank.apiture.com/organizations/organizations/{organizationId}/beneficialOwners',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.devbank.apiture.com/organizations/organizations/{organizationId}/beneficialOwners', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/beneficialOwners");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.devbank.apiture.com/organizations/organizations/{organizationId}/beneficialOwners", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update the beneficial owners of an account

PUT /organizations/{organizationId}/beneficialOwners

Update the array of the beneficial owners. This is a list of people who own 25% or more of the company, and the percentage that they own. This operation completely replaces the set of beneficial owners.

Body parameter

{
  "items": [
    {
      "owner": {
        "firstName": "William",
        "lastName": "Wellphunded",
        "addresses": {
          "addressLine1": "1234 S Front Street",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "type": "home"
        }
      },
      "percentage": 35,
      "identification": {
        "type": "taxid",
        "value": "111-11-1111"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c/beneficialOwners"
    }
  }
}

Parameters

Parameter	Description
organizationId (path)	string (required) The unique identifier of this organization. This is an opaque string.
If-None-Match (header)	string The entity tag that was returned in the ETag response. If the resource's current entity tag matches, the GET will return 304 (Not Modified) and no response body, else the resource representation will be returned.
body (body)	beneficialOwners (required) The array of beneficial signers.

Example responses

200 Response

{
  "items": [
    {
      "owner": {
        "firstName": "William",
        "lastName": "Wellphunded",
        "addresses": {
          "addressLine1": "1234 S Front Street",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "type": "home"
        }
      },
      "percentage": 35,
      "identification": {
        "type": "taxid",
        "value": "111-11-1111"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c/beneficialOwners"
    }
  }
}

Responses

Status	Description
200	OK
	OK
	Schema: beneficialOwners
304	Not Modified
	Not Modified. The resource has not been modified since it was last fetched.
404	Not Found
	Not Found. There is no such organization resource at the specified {organizationId}. The _error field in the response will contain details about the request error.
	Schema: errorResponse
409	Conflict
	Conflict. There is a conflict in the request to update an organization's beneficial owners: A user appears more than once The array contains more users than is allowed by the FI The sum of ownership percentages exceeds 100%
	Schema: errorResponse

Response Headers

Status	Description
200	ETag string
	The ETag response header specifies an entity tag which must be provided in an If-Match request header for PUT or PATCH operations which update this account resource.

Schemas

percentGrossRevenue

"unknown"

Percent of Gross Revenue derived from Money Services

The percentage of gross revenue the organization derives from money services.

Type: string
Enumerated values:
unknown
from0to25Percent
from26to50Percent
from51to75Percent
from75to100Percent
other
notApplicable

accountPurpose

"unknown"

Account purpose

The purpose of the account.

Type: string
Enumerated values:
unknown
creditCardProcessing
generalOperatingFunds
lottery
payroll
savings
other
notApplicable

estimatedAnnualRevenue

"unknown"

Estimated Annual Revenue

The estimated annual revenue in USD.

Type: string
Enumerated values:
unknown
under1Million
from1to10Million
from10to100Million
over100Million
other
notApplicable

bankComplianceQuestions

"atmOpererator"

Bank Compliance Questions

Identifiers for compliance questions a financial institution might ask about an organization attempting to open a new business account.

Type: string
Enumerated values:
atmOpererator
charity
checkCashMoreThan1000USD
internetGamblingIncorporated
marijuanaBusiness
moneyOrderMoreThan1000USD
thirdPartyBenefit
transmitBehalfOfCustomer
virtualCurrency

bankingServices

"achAmount"

Banking Services

Identifiers for questions about the amounts related to banking services an organization intends to use for a business account.

Type: string
Enumerated values:
achAmount
mobileDepositAmount
remoteDepositAmount
wireTransactionAmount
achCount
mobileDepositCount
remoteDepositCount
wireTransactionCount

industrySectors

"unknown"

Industry Sectors

The Industry Sector Associated with Organization.

Type: string
Enumerated values:
unknown
accomodationServices
administrativeServices
agriculture
arts
construction
educationalServices
finance
health
information
management
manufacturing
mining
otherServices
professionalServices
publicAdministration
realEstate
retailTrade
transportation
utilities
wholesaleTrade
other
notApplicable

intermediaryServices

"unknown"

Intermediary Services

The intermediary/nonbank financial institution services provided.

Type: string
Enumerated values:
unknown
accounting
foreignCurrency
fundsManagement
gambling
insurance
investment
legal
loanFinance
medical
notary
pawnBrokerage
realEstate
securities
taxPreparation
travelAgency
trustManagement
vehicleSales
other
notApplicable

yearsOwned

"unknown"

Years Owned

The years the organization has owned/managed their business.

Type: string
Enumerated values:
unknown
one
two
three
fourOrMoreYears
other
notApplicable

beneficialOwner

{
  "owner": {
    "firstName": "William",
    "lastName": "Wellphunded",
    "addresses": {
      "addressLine1": "1234 S Front Street",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US",
      "type": "home"
    },
    "identification": {
      "type": "taxid",
      "value": "111-11-1111"
    }
  },
  "percentage": 35
}

Beneficial Owner

A person who owns 25% or more of a business organization.

Properties

Name	Description
owner	simpleContact (required) The contact data for the beneficial owner.
percentage	number(integer) (required) The percent of the business that this person owns. maximum: 100

beneficialOwners

{
  "items": [
    {
      "owner": {
        "firstName": "William",
        "lastName": "Wellphunded",
        "addresses": {
          "addressLine1": "1234 S Front Street",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "type": "home"
        }
      },
      "percentage": 35,
      "identification": {
        "type": "taxid",
        "value": "111-11-1111"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c/beneficialOwners"
    }
  }
}

Beneficial Owners

A list of people who own at least 25% of the business. The sum of the percentages may not exceed 100%. Some items in the list may have ownerhip percentages below 25%, so that the beneficial owner's data can be saved and easily updated if their ownership rises to above 25% again.

Properties

Name	Description
_links	object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
» additionalProperties	link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
items	[beneficialOwner] (required) A list of people who own at least 25% of the business, and the percentage owned. maxLength: 10

simpleOrganization

{
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": [
    {
      "type": "work",
      "value": "smitties-detailing@example.com"
    }
  ],
  "identification": [
    {
      "type": "taxId",
      "value": "00-9999999"
    }
  ],
  "phones": [
    {
      "type": "work",
      "number": "(555) 555-5555"
    },
    {
      "type": "mobile",
      "number": "(999) 555-5555"
    }
  ],
  "addresses": [
    {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  ],
  "establishedDate": "2009-07-09T"
}

Simple Organization

The simplest form of an organization.

Properties

Name	Description
addresses	[address] An array of postal/mailing addresses.
preferredMailingAddressId	string The preferred mailing address. This string is the _id of an address in the addresses array. minLength: 1 maxLength: 4
name	string The organization's official full name
label	string The organization's common name.
type	string Indicates what type of organization this resource represents. The enumeration values are described by the organizationType value in the response of the getLabels operation. Enumerated values: corporation partnership llc llp nonProfit trust municipality custodial financialInstitution publicFunds federalGovernment unknown other notApplicable
subtype	string A refinement of the type. The enumeration values are described by the organizationSubtype value in the response of the getLabels operation. Enumerated values: soleProprietorship partnership limitedPartnership corporation sCorporation limitedLiabilityCompany revokableTrust irrevocableTrust assetProtectionTrust charitableTrust constructiveTrust specialNeedsTrust spendthriftTrust taxBypassTrust tottenTrust other
identification	[object] A collection of official identifying information associated with the contact. This currently only supports government tax ID.
» value	string (required) The value of this form of identification (the tax ID as a string, for example)
» type	string (required) The type of this form of identification. taxId is the only supported type at this time. Enumerated values: taxId dunsNumber
» expiration	string(date) The date when the form of identification expires.
phones	[phoneNumber] An array of phone numbers associated with the contact. The first item, if present, is the default (preferred) contact phone number.
emailAddresses	[typedEmailAddress] An array of email addresses associated with the contact. The first item, if present, is the default (preferred) contact email.
establishedDate	string(date) The date the organization was established.

createOrganization

{
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json"
}

Create Organization

Representation used to create a new organization.

Properties

Name	Description
_links	object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
» additionalProperties	link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
addresses	[address] An array of postal/mailing addresses.
preferredMailingAddressId	string The preferred mailing address. This string is the _id of an address in the addresses array. minLength: 1 maxLength: 4
name	string (required) The organization's official full name
label	string The organization's common name.
type	string Indicates what type of organization this resource represents. The enumeration values are described by the organizationType value in the response of the getLabels operation. Enumerated values: corporation partnership llc llp nonProfit trust municipality custodial financialInstitution publicFunds federalGovernment unknown other notApplicable
subtype	string A refinement of the type. The enumeration values are described by the organizationSubtype value in the response of the getLabels operation. Enumerated values: soleProprietorship partnership limitedPartnership corporation sCorporation limitedLiabilityCompany revokableTrust irrevocableTrust assetProtectionTrust charitableTrust constructiveTrust specialNeedsTrust spendthriftTrust taxBypassTrust tottenTrust other
identification	[object] A collection of official identifying information associated with the contact. This currently only supports government tax ID.
» value	string (required) The value of this form of identification (the tax ID as a string, for example)
» type	string (required) The type of this form of identification. taxId is the only supported type at this time. Enumerated values: taxId dunsNumber
» expiration	string(date) The date when the form of identification expires.
phones	[phoneNumber] An array of phone numbers associated with the contact. The first item, if present, is the default (preferred) contact phone number.
emailAddresses	[typedEmailAddress] An array of email addresses associated with the contact. The first item, if present, is the default (preferred) contact email.
establishedDate	string(date) The date the organization was established.
state	string The state of this organization. The enumeration values are described by the organizationState value in the response of the getLabels operation. Enumerated values: pending inactive active merged removed
tradeName	string The trade name of the organization.
governmentOwned	boolean Indicates whether the organization is a government-owned entity.
publiclyHeld	boolean Indicates whether the organization is publicly held.
smallBusiness	boolean Indicates whether the organization is classified as a small business
taxExempt	boolean Indicates whether the organization is the tax-exempt.
employeeCountLowerBound	number The lower bound of persons employed. minimum: 1
employeeCountUpperBound	number The upper bound of persons employed. maximum: 20000000
homeUrl	string The organization's home page.
industry	string Indicates what industry does this organization work within.
countryOfOperations	string The ISO 3166-1 country code for the organization's operation. minLength: 2 maxLength: 2
regulatory	object An object containing answers to organization specific regulatory questions.
currency	string The ISO 4217 currency code for this monetary value. This is always upper case ASCII. TODO: ISO 4217 defines three-character codes. However, ISO 4217 does not account for cryptocurrencies. Of note, DASH uses 4 characters. minLength: 3 maxLength: 3
estimatedAnnualRevenue	string USD amount of estimated revenue. Enumerated values: unknown under1Million from1to10Million from10to100Million over100Million other notApplicable
mobileCheckDepositEnabled	boolean Indicates that the organization use mobile check deposits.
achEnabled	boolean Indicates that the organization use ACH transfers.
estimatedMonthlyAmounts	object Indicates the estimated monthly amounts for wires, mobile deposits and ACH
» sentWire	string Indicates the estimated monthly minimum wires amount sent.
» receivedWire	string Indicates the estimated monthly minimum wires amount received.
» mobileCheckDeposit	string Indicates the estimated monthly minimum amount to deposit.
» receivedAch	string Indicates the estimated monthly total amount to receive by ACH.
» sentAch	string Indicates the estimated monthly total amount to send by ACH.
accountPurpose	string The purpose of the account. Enumerated values: unknown creditCardProcessing generalOperatingFunds lottery payroll savings other notApplicable
attributes	object An optional map of name/value pairs which provide additional metadata about the organization.

summaryOrganization

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  }
}

Organization Summary

Summary representation of an organization resource in organizations collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

Properties

Name	Description
_links	object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
» additionalProperties	link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
addresses	[address] An array of postal/mailing addresses.
preferredMailingAddressId	string The preferred mailing address. This string is the _id of an address in the addresses array. minLength: 1 maxLength: 4
name	string The organization's official full name
label	string The organization's common name.
type	string Indicates what type of organization this resource represents. The enumeration values are described by the organizationType value in the response of the getLabels operation. Enumerated values: corporation partnership llc llp nonProfit trust municipality custodial financialInstitution publicFunds federalGovernment unknown other notApplicable
subtype	string A refinement of the type. The enumeration values are described by the organizationSubtype value in the response of the getLabels operation. Enumerated values: soleProprietorship partnership limitedPartnership corporation sCorporation limitedLiabilityCompany revokableTrust irrevocableTrust assetProtectionTrust charitableTrust constructiveTrust specialNeedsTrust spendthriftTrust taxBypassTrust tottenTrust other
identification	[object] A collection of official identifying information associated with the contact. This currently only supports government tax ID.
» value	string (required) The value of this form of identification (the tax ID as a string, for example)
» type	string (required) The type of this form of identification. taxId is the only supported type at this time. Enumerated values: taxId dunsNumber
» expiration	string(date) The date when the form of identification expires.
phones	[phoneNumber] An array of phone numbers associated with the contact. The first item, if present, is the default (preferred) contact phone number.
emailAddresses	[typedEmailAddress] An array of email addresses associated with the contact. The first item, if present, is the default (preferred) contact email.
establishedDate	string(date) The date the organization was established.
state	string The state of this organization. The enumeration values are described by the organizationState value in the response of the getLabels operation. Enumerated values: pending inactive active merged removed
tradeName	string The trade name of the organization.
governmentOwned	boolean Indicates whether the organization is a government-owned entity.
publiclyHeld	boolean Indicates whether the organization is publicly held.
smallBusiness	boolean Indicates whether the organization is classified as a small business
taxExempt	boolean Indicates whether the organization is the tax-exempt.
employeeCountLowerBound	number The lower bound of persons employed. minimum: 1
employeeCountUpperBound	number The upper bound of persons employed. maximum: 20000000
homeUrl	string The organization's home page.
industry	string Indicates what industry does this organization work within.
countryOfOperations	string The ISO 3166-1 country code for the organization's operation. minLength: 2 maxLength: 2
regulatory	object An object containing answers to organization specific regulatory questions.
currency	string The ISO 4217 currency code for this monetary value. This is always upper case ASCII. TODO: ISO 4217 defines three-character codes. However, ISO 4217 does not account for cryptocurrencies. Of note, DASH uses 4 characters. minLength: 3 maxLength: 3
estimatedAnnualRevenue	string USD amount of estimated revenue. Enumerated values: unknown under1Million from1to10Million from10to100Million over100Million other notApplicable
mobileCheckDepositEnabled	boolean Indicates that the organization use mobile check deposits.
achEnabled	boolean Indicates that the organization use ACH transfers.
estimatedMonthlyAmounts	object Indicates the estimated monthly amounts for wires, mobile deposits and ACH
» sentWire	string Indicates the estimated monthly minimum wires amount sent.
» receivedWire	string Indicates the estimated monthly minimum wires amount received.
» mobileCheckDeposit	string Indicates the estimated monthly minimum amount to deposit.
» receivedAch	string Indicates the estimated monthly total amount to receive by ACH.
» sentAch	string Indicates the estimated monthly total amount to send by ACH.
accountPurpose	string The purpose of the account. Enumerated values: unknown creditCardProcessing generalOperatingFunds lottery payroll savings other notApplicable
_id	string The unique identifier for this organization resource. This is an immutable opaque string.

updateOrganization

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json"
}

Update Organization

Representation used to update or patch an organization.

Properties

Name	Description
_links	object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
» additionalProperties	link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
_embedded	object Embedded objects, as selected with the ?embed query parameter.
» beneficialOwners	beneficialOwners A list of people who own at least 25% of the business. The sum of the percentages may not exceed 100%. Some items in the list may have ownerhip percentages below 25%, so that the beneficial owner's data can be saved and easily updated if their ownership rises to above 25% again.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
addresses	[address] An array of postal/mailing addresses.
preferredMailingAddressId	string The preferred mailing address. This string is the _id of an address in the addresses array. minLength: 1 maxLength: 4
name	string The organization's official full name
label	string The organization's common name.
type	string Indicates what type of organization this resource represents. The enumeration values are described by the organizationType value in the response of the getLabels operation. Enumerated values: corporation partnership llc llp nonProfit trust municipality custodial financialInstitution publicFunds federalGovernment unknown other notApplicable
subtype	string A refinement of the type. The enumeration values are described by the organizationSubtype value in the response of the getLabels operation. Enumerated values: soleProprietorship partnership limitedPartnership corporation sCorporation limitedLiabilityCompany revokableTrust irrevocableTrust assetProtectionTrust charitableTrust constructiveTrust specialNeedsTrust spendthriftTrust taxBypassTrust tottenTrust other
identification	[object] A collection of official identifying information associated with the contact. This currently only supports government tax ID.
» value	string (required) The value of this form of identification (the tax ID as a string, for example)
» type	string (required) The type of this form of identification. taxId is the only supported type at this time. Enumerated values: taxId dunsNumber
» expiration	string(date) The date when the form of identification expires.
phones	[phoneNumber] An array of phone numbers associated with the contact. The first item, if present, is the default (preferred) contact phone number.
emailAddresses	[typedEmailAddress] An array of email addresses associated with the contact. The first item, if present, is the default (preferred) contact email.
establishedDate	string(date) The date the organization was established.
state	string The state of this organization. The enumeration values are described by the organizationState value in the response of the getLabels operation. Enumerated values: pending inactive active merged removed
tradeName	string The trade name of the organization.
governmentOwned	boolean Indicates whether the organization is a government-owned entity.
publiclyHeld	boolean Indicates whether the organization is publicly held.
smallBusiness	boolean Indicates whether the organization is classified as a small business
taxExempt	boolean Indicates whether the organization is the tax-exempt.
employeeCountLowerBound	number The lower bound of persons employed. minimum: 1
employeeCountUpperBound	number The upper bound of persons employed. maximum: 20000000
homeUrl	string The organization's home page.
industry	string Indicates what industry does this organization work within.
countryOfOperations	string The ISO 3166-1 country code for the organization's operation. minLength: 2 maxLength: 2
regulatory	object An object containing answers to organization specific regulatory questions.
currency	string The ISO 4217 currency code for this monetary value. This is always upper case ASCII. TODO: ISO 4217 defines three-character codes. However, ISO 4217 does not account for cryptocurrencies. Of note, DASH uses 4 characters. minLength: 3 maxLength: 3
estimatedAnnualRevenue	string USD amount of estimated revenue. Enumerated values: unknown under1Million from1to10Million from10to100Million over100Million other notApplicable
mobileCheckDepositEnabled	boolean Indicates that the organization use mobile check deposits.
achEnabled	boolean Indicates that the organization use ACH transfers.
estimatedMonthlyAmounts	object Indicates the estimated monthly amounts for wires, mobile deposits and ACH
» sentWire	string Indicates the estimated monthly minimum wires amount sent.
» receivedWire	string Indicates the estimated monthly minimum wires amount received.
» mobileCheckDeposit	string Indicates the estimated monthly minimum amount to deposit.
» receivedAch	string Indicates the estimated monthly total amount to receive by ACH.
» sentAch	string Indicates the estimated monthly total amount to send by ACH.
accountPurpose	string The purpose of the account. Enumerated values: unknown creditCardProcessing generalOperatingFunds lottery payroll savings other notApplicable
_id	string The unique identifier for this organization resource. This is an immutable opaque string.
createdAt	string(date-time) The date-time when the organization was created.
updatedAt	string(date-time) The date-time when the organization was updated
attributes	object An optional map of name/value pairs which provide additional metadata about the organization.

organization

{
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_links": {
    "self": {
      "href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c"
    },
    "apiture:deactivate": {
      "href": "/organizations/inactiveOrganizations?organization=0399abed-fd3d-4830-a88b-30f38b8a365c"
    }
  },
  "_embedded": {}
}

Organization

Representation of content and descriptive data (mailing addresses, phone numbers, email addresses) for an organization.

Regulations require identifying an organization's _beneficial owners_: people who own 25% or more of a business. These may be listed and updated with the getBeneficialOwners and updateBeneficialOwners operations.

An organization may have the following links in the _links object:

• apiture:activate - Activate a new, pending organization.
• apiture:deactivate - Deactivate an organization (if it is active).
• apiture:remove - Remove an inactive organization.
• apiture:beneficialOwners - List the beneficial owners.

Properties

Name	Description
_links	object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
» additionalProperties	link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
_embedded	object Embedded objects, as selected with the ?embed query parameter.
» beneficialOwners	beneficialOwners A list of people who own at least 25% of the business. The sum of the percentages may not exceed 100%. Some items in the list may have ownerhip percentages below 25%, so that the beneficial owner's data can be saved and easily updated if their ownership rises to above 25% again.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
addresses	[address] An array of postal/mailing addresses.
preferredMailingAddressId	string The preferred mailing address. This string is the _id of an address in the addresses array. minLength: 1 maxLength: 4
name	string The organization's official full name
label	string The organization's common name.
type	string Indicates what type of organization this resource represents. The enumeration values are described by the organizationType value in the response of the getLabels operation. Enumerated values: corporation partnership llc llp nonProfit trust municipality custodial financialInstitution publicFunds federalGovernment unknown other notApplicable
subtype	string A refinement of the type. The enumeration values are described by the organizationSubtype value in the response of the getLabels operation. Enumerated values: soleProprietorship partnership limitedPartnership corporation sCorporation limitedLiabilityCompany revokableTrust irrevocableTrust assetProtectionTrust charitableTrust constructiveTrust specialNeedsTrust spendthriftTrust taxBypassTrust tottenTrust other
identification	[object] A collection of official identifying information associated with the contact. This currently only supports government tax ID.
» value	string (required) The value of this form of identification (the tax ID as a string, for example)
» type	string (required) The type of this form of identification. taxId is the only supported type at this time. Enumerated values: taxId dunsNumber
» expiration	string(date) The date when the form of identification expires.
phones	[phoneNumber] An array of phone numbers associated with the contact. The first item, if present, is the default (preferred) contact phone number.
emailAddresses	[typedEmailAddress] An array of email addresses associated with the contact. The first item, if present, is the default (preferred) contact email.
establishedDate	string(date) The date the organization was established.
state	string The state of this organization. The enumeration values are described by the organizationState value in the response of the getLabels operation. Enumerated values: pending inactive active merged removed
tradeName	string The trade name of the organization.
governmentOwned	boolean Indicates whether the organization is a government-owned entity.
publiclyHeld	boolean Indicates whether the organization is publicly held.
smallBusiness	boolean Indicates whether the organization is classified as a small business
taxExempt	boolean Indicates whether the organization is the tax-exempt.
employeeCountLowerBound	number The lower bound of persons employed. minimum: 1
employeeCountUpperBound	number The upper bound of persons employed. maximum: 20000000
homeUrl	string The organization's home page.
industry	string Indicates what industry does this organization work within.
countryOfOperations	string The ISO 3166-1 country code for the organization's operation. minLength: 2 maxLength: 2
regulatory	object An object containing answers to organization specific regulatory questions.
currency	string The ISO 4217 currency code for this monetary value. This is always upper case ASCII. TODO: ISO 4217 defines three-character codes. However, ISO 4217 does not account for cryptocurrencies. Of note, DASH uses 4 characters. minLength: 3 maxLength: 3
estimatedAnnualRevenue	string USD amount of estimated revenue. Enumerated values: unknown under1Million from1to10Million from10to100Million over100Million other notApplicable
mobileCheckDepositEnabled	boolean Indicates that the organization use mobile check deposits.
achEnabled	boolean Indicates that the organization use ACH transfers.
estimatedMonthlyAmounts	object Indicates the estimated monthly amounts for wires, mobile deposits and ACH
» sentWire	string Indicates the estimated monthly minimum wires amount sent.
» receivedWire	string Indicates the estimated monthly minimum wires amount received.
» mobileCheckDeposit	string Indicates the estimated monthly minimum amount to deposit.
» receivedAch	string Indicates the estimated monthly total amount to receive by ACH.
» sentAch	string Indicates the estimated monthly total amount to send by ACH.
accountPurpose	string The purpose of the account. Enumerated values: unknown creditCardProcessing generalOperatingFunds lottery payroll savings other notApplicable
_id	string The unique identifier for this organization resource. This is an immutable opaque string.
createdAt	string(date-time) The date-time when the organization was created.
updatedAt	string(date-time) The date-time when the organization was updated
attributes	object An optional map of name/value pairs which provide additional metadata about the organization.

organizations

{
  "start": 0,
  "limit": 10,
  "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "/organizations/organizations?start=10&limit=10"
    },
    "first": {
      "href": "/organizations/organizations?start=0&limit=10"
    },
    "next": {
      "href": "/organizations/organizations?start=20&limit=10"
    },
    "collection": {
      "href": "/organizations/organizations"
    }
  },
  "count": 10,
  "name": "organizations",
  "_embedded": {
    "items": [
      {
        "_id": "331af113-8f7b-422d-89fe-d0489cc43e5d",
        "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.apiture.com/organizations/organizations/331af113-8f7b-422d-89fe-d0489cc43e5d"
          },
          "apiture:activate": {
            "href": "https://api.apiture.com/organizations/activeOrganizations?organization=331af113-8f7b-422d-89fe-d0489cc43e5d"
          }
        },
        "name": "Apiture",
        "label": "",
        "type": "trust",
        "state": "pending"
      },
      {
        "_id": "a1a6bbef-ac51-4d5f-a30e-4034b0a5aca7",
        "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.apiture.com/organizations/organizations/a1a6bbef-ac51-4d5f-a30e-4034b0a5aca7"
          },
          "apiture:activate": {
            "href": "https://api.apiture.com/organizations/activeOrganizations?organization=a1a6bbef-ac51-4d5f-a30e-4034b0a5aca7"
          }
        },
        "name": "Apiture",
        "label": "",
        "type": "nonprofit",
        "state": "pending"
      },
      {
        "_id": "0c748e89-3180-4d43-927d-5120d39b4fa8",
        "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.apiture.com/organizations/organizations/0c748e89-3180-4d43-927d-5120d39b4fa8"
          },
          "apiture:activate": {
            "href": "https://api.apiture.com/organizations/activeOrganizations?organization=0c748e89-3180-4d43-927d-5120d39b4fa8"
          }
        },
        "name": "Apiture",
        "label": "",
        "type": "nonprofit",
        "state": "pending"
      },
      {
        "_id": "fb602721-ac57-4d68-835d-f649e351e2b5",
        "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.apiture.com/organizations/organizations/fb602721-ac57-4d68-835d-f649e351e2b5"
          },
          "apiture:activate": {
            "href": "https://api.apiture.com/organizations/activeOrganizations?organization=fb602721-ac57-4d68-835d-f649e351e2b5"
          }
        },
        "name": "Apiture",
        "label": "",
        "type": "nonprofit",
        "state": "pending"
      },
      {
        "_id": "64b636ec-cebe-44bc-9962-d4de2329abe3",
        "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.apiture.com/organizations/organizations/64b636ec-cebe-44bc-9962-d4de2329abe3"
          },
          "apiture:activate": {
            "href": "https://api.apiture.com/organizations/activeOrganizations?organization=64b636ec-cebe-44bc-9962-d4de2329abe3"
          }
        },
        "name": "Apiture",
        "label": "",
        "type": "municipality",
        "state": "pending"
      },
      {
        "_id": "c161edaa-293f-4c01-a232-e9a14344b297",
        "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.apiture.com/organizations/organizations/c161edaa-293f-4c01-a232-e9a14344b297"
          },
          "apiture:activate": {
            "href": "https://api.apiture.com/organizations/activeOrganizations?organization=c161edaa-293f-4c01-a232-e9a14344b297"
          }
        },
        "name": "Apiture",
        "label": "",
        "type": "nonprofit",
        "state": "pending"
      },
      {
        "_id": "2b094e5d-d2a7-4a03-8110-64ac9ac457e6",
        "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.apiture.com/organizations/organizations/2b094e5d-d2a7-4a03-8110-64ac9ac457e6"
          },
          "apiture:activate": {
            "href": "https://api.apiture.com/organizations/activeOrganizations?organization=2b094e5d-d2a7-4a03-8110-64ac9ac457e6"
          }
        },
        "name": "example corporation",
        "label": "",
        "type": "corporation",
        "state": "pending"
      },
      {
        "_id": "ccaea92d-5ba0-4f30-a39f-a422ad02e7ad",
        "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.apiture.com/organizations/organizations/ccaea92d-5ba0-4f30-a39f-a422ad02e7ad"
          },
          "apiture:activate": {
            "href": "https://api.apiture.com/organizations/activeOrganizations?organization=ccaea92d-5ba0-4f30-a39f-a422ad02e7ad"
          }
        },
        "name": "example llc",
        "label": "",
        "type": "llc",
        "state": "pending"
      },
      {
        "_id": "43f53a1f-7d00-443b-87ee-04f0704ffb14",
        "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.apiture.com/organizations/organizations/43f53a1f-7d00-443b-87ee-04f0704ffb14"
          },
          "apiture:activate": {
            "href": "https://api.apiture.com/organizations/activeOrganizations?organization=43f53a1f-7d00-443b-87ee-04f0704ffb14"
          }
        },
        "name": "example partnership",
        "label": "",
        "type": "partnership",
        "state": "pending"
      },
      {
        "_id": "741fee0e-7f94-4d30-9fd7-62a318768d23",
        "_profile": "https://api.apiture.com/schemas/organizations/organizations/v1.0.0/profile.json",
        "_links": {
          "self": {
            "href": "https://api.apiture.com/organizations/organizations/741fee0e-7f94-4d30-9fd7-62a318768d23"
          },
          "apiture:activate": {
            "href": "https://api.apiture.com/organizations/activeOrganizations?organization=741fee0e-7f94-4d30-9fd7-62a318768d23"
          }
        },
        "name": "example llp",
        "label": "",
        "type": "llp",
        "state": "pending"
      }
    ]
  }
}

Organization Collection

Collection of organizations. The items in the collection are ordered in the _embedded.items array; the name is organizations. The top-level _links object may contain pagination links (self, next, prev, first, last, collection).

Properties

Name	Description
_links	object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
» additionalProperties	link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
_embedded	object Embedded objects.
» items	[summaryOrganization] An array containing a page of organization items.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
count	integer The number of items in the collection. This value is optional and my be omitted if the count is not computable efficiently. If a filter is applied to the collection (either implicitly or explicitly), the count, if present, indicates the number of items that satisfy the filter.
start	integer The start index of this page of items.
limit	integer The maximum number of items per page.
name	string The name of the collection.

root

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0",
  "_profile": "https://api.apiture.com/schemas/common/root/v1.0.0/profile.json",
  "_links": {}
}

API Root

A HAL response, with hypermedia _links for the top-level resources and operations in API.

Properties

Name	Description
_links	object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
» additionalProperties	link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.
_id	string This API's unique ID.
name	string This API's name.
apiVersion	string This API's version.

localizedLabels

{
  "property1": {
    "label": "Limited Liability Corporation",
    "description": "string",
    "language": "en-us",
    "code": "31"
  },
  "property2": {
    "label": "Limited Liability Corporation",
    "description": "string",
    "language": "en-us",
    "code": "31"
  }
}

Localized Labels

A map that defines lables for an enumeration or other item in a JSON schema. This is a map which maps enumeration schema names to an localizedLabel object.

Properties

Name	Description
additionalProperties	localizedLabel A localized label and optional description for localizable content defined in this API.

errorResponse

{
  "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://api.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Error Response

Describes an error response, typically returned on 4xx or 5xx errors from API operations. The _error object contains the error details.

Properties

Name	Description
_links	object An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
» additionalProperties	link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.
_embedded	object An optional map of nested resources, mapping each nested resource name to a nested resource representation.
_profile	string(uri) The URI of a resource profile which describes the representation.
_error	error An object which describes an error. This value is omitted if the operation succeeded without error.

simpleContact

{
  "firstName": "John",
  "middleName": "Daniel",
  "lastName": "Smith",
  "preferredName": "John",
  "suffix": "MD",
  "identification": [
    {
      "type": "taxId",
      "value": "111-11-1111"
    }
  ],
  "addresses": [
    {
      "_id": "ha1",
      "type": "home",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    }
  ],
  "preferredMailingAddressId": "ha1",
  "emailAddresses": [
    {
      "id": "pe0",
      "value": "api@apiture.com",
      "type": "personal"
    },
    {
      "id": "wp1",
      "value": "support@apiture.com",
      "type": "work"
    }
  ],
  "preferredEmailAddressId": "pe0",
  "phones": [
    {
      "_id": "hp1",
      "type": "home",
      "number": "(555) 555-5555"
    },
    {
      "_id": "mp1",
      "type": "mobile",
      "number": "(999) 555-5555"
    }
  ],
  "preferredPhoneNumberId": "hp1"
}

Simple Contact

Basic contact and identification information for a person, consisting of the name, mailing address, phone numbers, email addresses, and government identification.

Properties

Name	Description
firstName	string The person's first name (or given name).
middleName	string The person's middle name.
lastName	string The person's last name (or surname).
addresses	[address] An array of postal/mailing addresses.
preferredMailingAddressId	string The preferred mailing address. This string is the _id of an address in the addresses array. minLength: 1 maxLength: 4
emailAddresses	[typedEmailAddress] An array of email addresses.
preferredEmailAddressId	string The preferred email address. This string is the _id of an email address in the emailAddresses array. minLength: 1 maxLength: 4
phones	[phoneNumber] An array of phone numbers.
preferredPhoneId	string The ID of preferred phone number. This string is the _id of a phone number in the phones array. minLength: 1 maxLength: 4
prefix	string A title or honorific prefix such as Dr. or Fr. maxLength: 20
suffix	string A title or honorific suffix such as PhD or DDS. maxLength: 20
preferredName	string The contact's preferred name. This is how the contact's name is presented to the user in the interface. The default is the contact's firstName.
identification	[identification] A collection of official identifying information associated with the contact.

phoneNumber

{
  "_id": "hp1",
  "type": "home",
  "number": "555-555-5555"
}

Phone Number

A phone number and its role.

Properties

Name	Description
type	string (required) The type or role of this phone number. Enumerated values: unknown home work mobile fax other
number	string (required) The phone number, as a string.
label	string A text label, suitable for presentation to the end user. This is also used if type is other.
_id	string An identifier for this phone number, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all phone numbers within the phones array. minLength: 1 maxLength: 8

typedEmailAddress

{
  "value": "JohnBankCustomer@example.com",
  "type": "unknown",
  "_id": "ha3"
}

Email Address

An email address and the email address type.

Properties

Name	Description
value	string(email) The email address, such as JohnBankCustomer@example.com minLength: 8 maxLength: 120
type	string The kind of email address this is. Enumerated values: unknown personal work school other notApplicable
_id	string An identifier for this email address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all email addresses within the emailAddresses array. minLength: 1 maxLength: 8

localizedLabel

{
  "label": "Limited Liability Corporation",
  "description": "string",
  "language": "en-us",
  "code": "31"
}

Localized Label

A localized label and optional description for localizable content defined in this API.

Properties

Name	Description
label	string A localized label or title which may be used labels or other UI controls which present a value.
description	string A more detailed localized description of a localizable label.
language	string The actual natural language tag to which this localized label is associated, as per RFC 7231
code	string If the localized value is associated with an external standard, this is a lookup code or key or URI for that value.

link

{
  "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
  "title": "Applicant"
}

Link

Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.

Properties

Name	Description
href	string(uri) (required) The URI or URI template for the resource/operation this link refers to.
type	string The media type for the resource.
templated	boolean If true, the link's href is a URI template.
title	string An optional human-readable localized title for the link.
deprecation	string(uri) If present, the containing link is deprecated and the value is a URI which provides human-readable text information about the deprecation.
profile	string(uri) The URI of a profile document, a JSON document which describes the target resource/operation.

error

{
  "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
  "message": "The value for deposit must be greater than 0.",
  "statusCode": 422,
  "type": "positiveNumberRequired",
  "attributes": {
    "value": -125.5
  },
  "remediation": "Provide a value which is greater than 0",
  "occurredAt": "2018-01-25T05:50:52.375Z",
  "_links": {
    "describedby": {
      "href": "https://developer.apiture.com/errors/positiveNumberRequired"
    }
  },
  "_embedded": {
    "errors": []
  }
}

Error

Describes an error in an API request or in a service called via the API.

Properties

Name	Description
message	string (required) A localized message string describing the error condition.
_id	string A unique identifier for this error instance. This may be used as a correlation ID with the root cause error (i.e. this ID may be logged at the source of the error). This is is an opaque string.
statusCode	integer The HTTP status code associate with this error. minimum: 100 maximum: 599
type	string An error identifier which indicates the category of error and associate it with API support documentation or which the UI tier can use to render an appropriate message or hint. This provides a finer level of granularity than the statusCode. For example, instead of just 400 Bad Request, the type may be much more specific. such as integerValueNotInAllowedRange or numericValueExceedsMaximum or stringValueNotInAllowedSet.
occurredAt	string(date-time) An RFC 3339 UTC time stamp indicating when the error occurred.
attributes	attributes Informative values or constraints which describe the error. For example, for a value out of range error, the attributes may specify the minimum and maximum values. This allows clients to present error messages as they see fit (the API does not assume the client/presentation tier). The set of attributes varies by error type.
remediation	string An optional localized string which provides hints for how the user or client can resolve the error.
_links	links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
_embedded	object Embedded objects. An error object may contain nested errors. For example, an API which validates its request body may find multiple errors in the request, which are returned with an error response with nested errors. These are held in an items array of errorResponse objects. _embedded or _embedded.items may not exist if the error does not have nested errors.
» items	[errorResponse] An array of error objects.

address

{
  "_id": "ha5",
  "type": "home",
  "addressLine1": "555 N Front Street",
  "addressLine2": "Suite 5555",
  "city": "Wilmington",
  "regionCode": "NC",
  "postalCode": "28401-5405",
  "countryCode": "US"
}

Address

A postal address.

Properties

Name	Description
type	string (required) The type of this address. Enumerated values: unknown home work school postOffice vacation shipping billing headquarters commercial property other notApplicable
label	string A text label, suitable for presentation to the end user. This is derived from type or from otherType if type is other read-only
otherType	string The actual address type if type is other. minLength: 4 maxLength: 32
addressLine1	string The first street address line of the address, normally a house number and street name.
addressLine2	string The optional second street address line of the address.
city	string The name of the city or municipality.
regionCode	string The mailing address region code, such as state in the US, or a province in Canada.
postalCode	string The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
countryCode	string The ISO 3166-1 country code. minLength: 2 maxLength: 2
_id	string An identifier for this address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all addresses within the addresses array. minLength: 1 maxLength: 8

identification

{
  "type": "taxId",
  "value": "111-11-1111",
  "expiration": {}
}

Identification

Official identifying information associated with the contact.

Properties

Name	Description
value	string (required) The value of this form of identification (the tax ID as a string, for example)
type	string (required) The type of this form of identification. Enumerated values: taxId passportNumber
expiration	string(date) The date when the form of identification expires, in RFC 3339 YYYY-MM-DD format.

attributes

{}

Attributes

An optional map of name/value pairs which contains additional dynamic data about the resource.

Properties

links

{
  "property1": {
    "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Applicant"
  },
  "property2": {
    "href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Applicant"
  }
}

Links

An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

Properties

Name	Description
additionalProperties	link Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.