Organizations v0.26.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 authorized signers for the accounts owned by the organization as well as the organization's beneficial owners, which are people who own at least 25% of the business.
Error Types
Error responses in this API may have one of the type
values described below.
See Errors for more information
on error responses and error types.
organizationAccessForbidden
Description: The credentials supplied in the request are insufficient to grant access.
Remediation: Check the supplied credentials for validity.
organizationNotFound
Description: No Organization was found for the specified organizationId.
Remediation: Ensure the supplied organizationId corresponds to an organization resource.
duplicateTaxId
Description: There is another organization with the TaxId.
Remediation: Send a unique TaxId.
invalidOrganizationState
Description: The current state of that organization does not allow to operate that resource.
Remediation: Ensure the supplied organizationId corresponds to an organization resource in the correct state.
The attributes
object in the error may have the following properties:
Property | Type | Description |
---|---|---|
currentState | string | undefined |
allowedStates | [undefined] | undefined |
tooManyBeneficialOwners
Description: There are too many beneficial owners.
Remediation: The number of beneficial owners must be 10 or less.
beneficialOwnersPercentageExceed100
Description: The sum of beneficial owners percentages exceeds 100.
Remediation: Adjust the percentages to total 100 or less.
addressNotFound
Description: No Address was found for the specified addressId.
Remediation: Ensure the supplied addressId corresponds to an address resource.
emailAddressNotFound
Description: No Email Address was found for the specified emailAddressId.
Remediation: Ensure the supplied emailAddressId corresponds to an email address resource.
phoneNumberNotFound
Description: No Phone Number was found for the specified phoneNumberId.
Remediation: Ensure the supplied phoneNumberId corresponds to an phone number resource.
phoneMustNotBePreferred
Description: Can not delete the preferred phone number.
Remediation: Change the organization’s preferred phone number to another item in order to delete this one.
emailAddressMustNotBePreferred
Description: Can not delete the preferred email address.
Remediation: Change the organization’s preferred email address to another item in order to delete this one.
addressMustNotBePreferred
Description: Can not delete the preferred address.
Remediation: Change the organization’s preferred address to another item in order to delete this one.
userUriInvalid
Description: The user cannot be found or the URI is invalid.
Remediation: Check the URI is formed correctly and references a valid user resource.
userUriNotSupplied
Description: A link to the user was not supplied for the organization.
Remediation: Include the 'apiture:user' link to a valid user in the _links object of your request.
malformedRequestBodyBadRequest
Description: The supplied request body was malformed.
Remediation: Check to make sure that your request body exists and that it does not contain syntax errors.
preconditionRequiredIfMatchHeader
Description: The required if-match header was not supplied.
Remediation: Send a valid if-match header.
authorizedSignerAlreadyExists
Description: The authorized signer already exists on the organization.
Remediation: Add an authorized signer with a user not already associated as an authorized signer to the organization.
propertyRequired
Description: A property in the request may not be empty.
Remediation: Include a valid value for the property in the request.
The attributes
object in the error may have the following properties:
Property | Type | Description |
---|---|---|
propertyNames | [string] | The name of the property that was omitted or blank |
Download OpenAPI Definition (YAML)
Base URLs:
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 privateclientId
(and optionalclientSecret
) as part of this flow. The client obtains an access token from the server attokenUrl
. It then passes the received access token via theAuthorization: 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 = /auth/oauth2/authorize
- Token URL = /auth/oauth2/token
- OAuth2 client access token authentication. The client authenticates against the server at
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.
Try It
Example responses
200 Response
{
"id": "apiName",
"name": "API name",
"apiVersion": "1.0.0",
"_profile": "https://production.api.apiture.com/schemas/common/root/v2.0.0/profile.json",
"_links": {}
}
Responses
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.
Try It
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 organization's preferred natural language for the localized labels in the response, as per RFC 7231. |
Try It
Example responses
200 Response
{
"_profile": "https://production.api.apiture.com/schemas/common/labelGroups/v1.0.0/model.json",
"groups": {
"structure": {
"unknown": {
"label": "Unknown",
"code": "0",
"hidden": true
},
"corporation": {
"label": "Corporation",
"code": "1",
"variants": {
"fr": {
"label": "Soci\\u00e9t\\u00e9"
}
}
},
"partnership": {
"label": "Partnership",
"code": "2",
"variants": {
"fr": {
"label": "Partenariat"
}
}
},
"llc": {
"label": "Limited Liability Company",
"code": "2",
"variants": {
"fr": {
"label": "Soci\\u00e9t\\u00e9 \\u00e9 Responsabilit\\u00e9 Limit\\u00e9e"
}
}
},
"nonProfit": {
"label": "Non Profit",
"code": "4",
"variants": {
"fr": {
"label": "Non Lucratif"
}
}
},
"financialInstitution": {
"label": "Financial Institution",
"code": "8",
"variants": {
"fr": {
"label": "Institution financi\\u00e8re"
}
}
},
"soleProprietorship": {
"label": "Sole Proprietorship",
"code": "11",
"variants": {
"fr": {
"label": "Entreprise individuelle"
}
}
},
"other": {
"label": "Other",
"code": "254",
"variants": {
"fr": {
"label": "Autre"
}
}
}
},
"estimatedAnnualRevenue": {
"unknown": {
"label": "Unknown",
"code": "0"
},
"under1Million": {
"label": "Under $1M",
"code": "1",
"range": "[0,1000000.00)"
},
"from1to10Million": {
"label": "$1M to $10M",
"code": "2",
"range": "[1000000.00,10000000.00)"
},
"from10to100Million": {
"label": "$10M to $100M",
"code": "3",
"range": "[10000000.00,100000000.00)"
},
"over100Million": {
"label": "Over $100,000,000.00",
"code": "4",
"range": "[100000000.00,]"
},
"other": {
"label": "Other",
"code": "254"
}
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: labelGroups |
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. Default: 100 |
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. |
type (query) |
string Subset the organizations collection to those with this exact type value. Use | to separate multiple values. For example, ?type=corporation matches only items whose type is corporation ; ?type=llp|llc matches items whose type is llp or llc . This is combined with an implicit and with other filters if they are used. See filtering. |
state (query) |
string Subset the organizations collection to those whose state matches this value. Use | to separate multiple values. For example, ?state=pending matches only items whose state is pending ; ?state=removed|inactive matches 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 |
name (query) |
string Subset the organizations collection to those with this name value. Use | to separate multiple values. For example, ?name=Bartell matches only items whose name is Bartell; ?name=Bartell|kirsten matches items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See filtering. |
customerId (query) |
string Subset the organization collection to those whose customerId matches this value. This is combined with an implicit and with other filters if they are used. See filtering. |
Try It
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 |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters or request body 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",
"_links": {
"apiture:user": {
"href": "/users/users/00007276-8b25-4e97-ac82-e1e17a2ff7c2"
}
}
}';
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",
"_links": {
"apiture:user": {
"href": "/users/users/00007276-8b25-4e97-ac82-e1e17a2ff7c2"
}
}
}
Parameters
Parameter | Description |
---|---|
body (body) |
createOrganization (required) The data necessary to create a new organization. |
Try It
Example responses
201 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"customerId": "000489353781",
"_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"tradeName": "Smith's Auto Detailing",
"emailAddresses": [
{
"_id": "ea0",
"type": "work",
"value": "smitties-detailing@example.com"
}
],
"preferredEmailAddressId": "ea0",
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "wp1"
}
],
"preferredPhoneNumberId": "wp0",
"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"
}
],
"preferredMailingAddressId": "wa0",
"establishedDate": "2009-07-09T",
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"state": "active",
"governmentOwned": false,
"registeredIn": "NC",
"publiclyHeld": false,
"smallBusiness": true,
"taxExempt": false,
"currency": "USD",
"estimatedAnnualRevenue": "from1to10Million",
"estimatedMonthlyAmounts": {
"sentWire": "moreThanOneMillion",
"receivedWire": "oneHundredThousandToOneMillion",
"mobileCheckDeposit": "upToOneHundredThousand",
"receivedAch": "upToOneHundredThousand",
"sentAch": "moreThanOneMillion"
},
"type": "corporation",
"subtype": "soleProprietorship",
"employeeCountLowerBound": 1,
"employeeCountUpperBound": 1,
"countryOfOperations": "US",
"physicalLocationsCount": "under10",
"mobileCheckDepositEnabled": true,
"achEnabled": true,
"authorizedSigners": [],
"beneficialOwners": [],
"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 |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:
This error response may have one of the following |
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) |
array[string] If set, the _embedded object in each organization in the items array will include additional embedded objects. This query parameter supports the authorizedSigners and beneficialOwners options. Examples: |
?embed=beneficialOwners
?embed=authorizedSigners,beneficialOwners
|
Try It
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"customerId": "000489353781",
"_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"tradeName": "Smith's Auto Detailing",
"emailAddresses": [
{
"_id": "ea0",
"type": "work",
"value": "smitties-detailing@example.com"
}
],
"preferredEmailAddressId": "ea0",
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "wp1"
}
],
"preferredPhoneNumberId": "wp0",
"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"
}
],
"preferredMailingAddressId": "wa0",
"establishedDate": "2009-07-09T",
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"state": "active",
"governmentOwned": false,
"registeredIn": "NC",
"publiclyHeld": false,
"smallBusiness": true,
"taxExempt": false,
"currency": "USD",
"estimatedAnnualRevenue": "from1to10Million",
"estimatedMonthlyAmounts": {
"sentWire": "moreThanOneMillion",
"receivedWire": "oneHundredThousandToOneMillion",
"mobileCheckDeposit": "upToOneHundredThousand",
"receivedAch": "upToOneHundredThousand",
"sentAch": "moreThanOneMillion"
},
"type": "corporation",
"subtype": "soleProprietorship",
"employeeCountLowerBound": 1,
"employeeCountUpperBound": 1,
"countryOfOperations": "US",
"physicalLocationsCount": "under10",
"mobileCheckDepositEnabled": true,
"achEnabled": true,
"authorizedSigners": [],
"beneficialOwners": [],
"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 |
Status | Description |
---|---|
304 | Not Modified |
Not Modified. The resource has not been modified since it was last fetched. |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such organization resource at the specified This error response may have one of the following | |
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",
"customerId": "000489353781",
"_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"tradeName": "Smith's Auto Detailing",
"emailAddresses": [
{
"_id": "ea0",
"type": "work",
"value": "smitties-detailing@example.com"
}
],
"preferredEmailAddressId": "ea0",
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "wp1"
}
],
"preferredPhoneNumberId": "wp0",
"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"
}
],
"preferredMailingAddressId": "wa0",
"establishedDate": "2009-07-09T",
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"state": "active",
"governmentOwned": false,
"registeredIn": "NC",
"publiclyHeld": false,
"smallBusiness": true,
"taxExempt": false,
"currency": "USD",
"estimatedAnnualRevenue": "from1to10Million",
"estimatedMonthlyAmounts": {
"sentWire": "moreThanOneMillion",
"receivedWire": "oneHundredThousandToOneMillion",
"mobileCheckDeposit": "upToOneHundredThousand",
"receivedAch": "upToOneHundredThousand",
"sentAch": "moreThanOneMillion"
},
"type": "corporation",
"subtype": "soleProprietorship",
"employeeCountLowerBound": 1,
"employeeCountUpperBound": 1,
"countryOfOperations": "US",
"physicalLocationsCount": "under10",
"mobileCheckDepositEnabled": true,
"achEnabled": true,
"authorizedSigners": [],
"beneficialOwners": [],
"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",
"customerId": "000489353781",
"_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"tradeName": "Smith's Auto Detailing",
"emailAddresses": [
{
"_id": "ea0",
"type": "work",
"value": "smitties-detailing@example.com"
}
],
"preferredEmailAddressId": "ea0",
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "wp1"
}
],
"preferredPhoneNumberId": "wp0",
"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"
}
],
"preferredMailingAddressId": "wa0",
"establishedDate": "2009-07-09T",
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"state": "active",
"governmentOwned": false,
"registeredIn": "NC",
"publiclyHeld": false,
"smallBusiness": true,
"taxExempt": false,
"currency": "USD",
"estimatedAnnualRevenue": "from1to10Million",
"estimatedMonthlyAmounts": {
"sentWire": "moreThanOneMillion",
"receivedWire": "oneHundredThousandToOneMillion",
"mobileCheckDeposit": "upToOneHundredThousand",
"receivedAch": "upToOneHundredThousand",
"sentAch": "moreThanOneMillion"
},
"type": "corporation",
"subtype": "soleProprietorship",
"employeeCountLowerBound": 1,
"employeeCountUpperBound": 1,
"countryOfOperations": "US",
"physicalLocationsCount": "under10",
"mobileCheckDepositEnabled": true,
"achEnabled": true,
"authorizedSigners": [],
"beneficialOwners": [],
"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) |
Try It
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"customerId": "000489353781",
"_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"tradeName": "Smith's Auto Detailing",
"emailAddresses": [
{
"_id": "ea0",
"type": "work",
"value": "smitties-detailing@example.com"
}
],
"preferredEmailAddressId": "ea0",
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "wp1"
}
],
"preferredPhoneNumberId": "wp0",
"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"
}
],
"preferredMailingAddressId": "wa0",
"establishedDate": "2009-07-09T",
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"state": "active",
"governmentOwned": false,
"registeredIn": "NC",
"publiclyHeld": false,
"smallBusiness": true,
"taxExempt": false,
"currency": "USD",
"estimatedAnnualRevenue": "from1to10Million",
"estimatedMonthlyAmounts": {
"sentWire": "moreThanOneMillion",
"receivedWire": "oneHundredThousandToOneMillion",
"mobileCheckDeposit": "upToOneHundredThousand",
"receivedAch": "upToOneHundredThousand",
"sentAch": "moreThanOneMillion"
},
"type": "corporation",
"subtype": "soleProprietorship",
"employeeCountLowerBound": 1,
"employeeCountUpperBound": 1,
"countryOfOperations": "US",
"physicalLocationsCount": "under10",
"mobileCheckDepositEnabled": true,
"achEnabled": true,
"authorizedSigners": [],
"beneficialOwners": [],
"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 |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such organization resource at the specified This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
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 |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters or request body was well formed but otherwise invalid. The This error response may have one of the following | |
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",
"customerId": "000489353781",
"_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"tradeName": "Smith's Auto Detailing",
"emailAddresses": [
{
"_id": "ea0",
"type": "work",
"value": "smitties-detailing@example.com"
}
],
"preferredEmailAddressId": "ea0",
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "wp1"
}
],
"preferredPhoneNumberId": "wp0",
"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"
}
],
"preferredMailingAddressId": "wa0",
"establishedDate": "2009-07-09T",
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"state": "active",
"governmentOwned": false,
"registeredIn": "NC",
"publiclyHeld": false,
"smallBusiness": true,
"taxExempt": false,
"currency": "USD",
"estimatedAnnualRevenue": "from1to10Million",
"estimatedMonthlyAmounts": {
"sentWire": "moreThanOneMillion",
"receivedWire": "oneHundredThousandToOneMillion",
"mobileCheckDeposit": "upToOneHundredThousand",
"receivedAch": "upToOneHundredThousand",
"sentAch": "moreThanOneMillion"
},
"type": "corporation",
"subtype": "soleProprietorship",
"employeeCountLowerBound": 1,
"employeeCountUpperBound": 1,
"countryOfOperations": "US",
"physicalLocationsCount": "under10",
"mobileCheckDepositEnabled": true,
"achEnabled": true,
"authorizedSigners": [],
"beneficialOwners": [],
"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",
"customerId": "000489353781",
"_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"tradeName": "Smith's Auto Detailing",
"emailAddresses": [
{
"_id": "ea0",
"type": "work",
"value": "smitties-detailing@example.com"
}
],
"preferredEmailAddressId": "ea0",
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "wp1"
}
],
"preferredPhoneNumberId": "wp0",
"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"
}
],
"preferredMailingAddressId": "wa0",
"establishedDate": "2009-07-09T",
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"state": "active",
"governmentOwned": false,
"registeredIn": "NC",
"publiclyHeld": false,
"smallBusiness": true,
"taxExempt": false,
"currency": "USD",
"estimatedAnnualRevenue": "from1to10Million",
"estimatedMonthlyAmounts": {
"sentWire": "moreThanOneMillion",
"receivedWire": "oneHundredThousandToOneMillion",
"mobileCheckDeposit": "upToOneHundredThousand",
"receivedAch": "upToOneHundredThousand",
"sentAch": "moreThanOneMillion"
},
"type": "corporation",
"subtype": "soleProprietorship",
"employeeCountLowerBound": 1,
"employeeCountUpperBound": 1,
"countryOfOperations": "US",
"physicalLocationsCount": "under10",
"mobileCheckDepositEnabled": true,
"achEnabled": true,
"authorizedSigners": [],
"beneficialOwners": [],
"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) |
Try It
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"customerId": "000489353781",
"_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"tradeName": "Smith's Auto Detailing",
"emailAddresses": [
{
"_id": "ea0",
"type": "work",
"value": "smitties-detailing@example.com"
}
],
"preferredEmailAddressId": "ea0",
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "wp1"
}
],
"preferredPhoneNumberId": "wp0",
"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"
}
],
"preferredMailingAddressId": "wa0",
"establishedDate": "2009-07-09T",
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"state": "active",
"governmentOwned": false,
"registeredIn": "NC",
"publiclyHeld": false,
"smallBusiness": true,
"taxExempt": false,
"currency": "USD",
"estimatedAnnualRevenue": "from1to10Million",
"estimatedMonthlyAmounts": {
"sentWire": "moreThanOneMillion",
"receivedWire": "oneHundredThousandToOneMillion",
"mobileCheckDeposit": "upToOneHundredThousand",
"receivedAch": "upToOneHundredThousand",
"sentAch": "moreThanOneMillion"
},
"type": "corporation",
"subtype": "soleProprietorship",
"employeeCountLowerBound": 1,
"employeeCountUpperBound": 1,
"countryOfOperations": "US",
"physicalLocationsCount": "under10",
"mobileCheckDepositEnabled": true,
"achEnabled": true,
"authorizedSigners": [],
"beneficialOwners": [],
"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 |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such organization resource at the specified This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
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 |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters or request body 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. |
Try It
Example responses
404 Response
{
"_profile": "https://api.apiture.com/schemas/common/errorResponse/v2.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. |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such organization resource at the specified This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:
This error response may have one of the following |
Status | Description |
---|---|
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 organization 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 POST ing 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 an 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. |
Try It
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"customerId": "000489353781",
"_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"tradeName": "Smith's Auto Detailing",
"emailAddresses": [
{
"_id": "ea0",
"type": "work",
"value": "smitties-detailing@example.com"
}
],
"preferredEmailAddressId": "ea0",
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "wp1"
}
],
"preferredPhoneNumberId": "wp0",
"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"
}
],
"preferredMailingAddressId": "wa0",
"establishedDate": "2009-07-09T",
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"state": "active",
"governmentOwned": false,
"registeredIn": "NC",
"publiclyHeld": false,
"smallBusiness": true,
"taxExempt": false,
"currency": "USD",
"estimatedAnnualRevenue": "from1to10Million",
"estimatedMonthlyAmounts": {
"sentWire": "moreThanOneMillion",
"receivedWire": "oneHundredThousandToOneMillion",
"mobileCheckDeposit": "upToOneHundredThousand",
"receivedAch": "upToOneHundredThousand",
"sentAch": "moreThanOneMillion"
},
"type": "corporation",
"subtype": "soleProprietorship",
"employeeCountLowerBound": 1,
"employeeCountUpperBound": 1,
"countryOfOperations": "US",
"physicalLocationsCount": "under10",
"mobileCheckDepositEnabled": true,
"achEnabled": true,
"authorizedSigners": [],
"beneficialOwners": [],
"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 |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The organization or organizationUri was malformed or does not refer to an organization. | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:
This error response may have one of the following |
Status | Description |
---|---|
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 |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters or request body 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. |
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 or pending state.
This operation is invoked from the apiture:deactivate
link on an
organization resource when that organization 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 POST ing 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 an 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. |
Try It
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"customerId": "000489353781",
"_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"tradeName": "Smith's Auto Detailing",
"emailAddresses": [
{
"_id": "ea0",
"type": "work",
"value": "smitties-detailing@example.com"
}
],
"preferredEmailAddressId": "ea0",
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "wp1"
}
],
"preferredPhoneNumberId": "wp0",
"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"
}
],
"preferredMailingAddressId": "wa0",
"establishedDate": "2009-07-09T",
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"state": "active",
"governmentOwned": false,
"registeredIn": "NC",
"publiclyHeld": false,
"smallBusiness": true,
"taxExempt": false,
"currency": "USD",
"estimatedAnnualRevenue": "from1to10Million",
"estimatedMonthlyAmounts": {
"sentWire": "moreThanOneMillion",
"receivedWire": "oneHundredThousandToOneMillion",
"mobileCheckDeposit": "upToOneHundredThousand",
"receivedAch": "upToOneHundredThousand",
"sentAch": "moreThanOneMillion"
},
"type": "corporation",
"subtype": "soleProprietorship",
"employeeCountLowerBound": 1,
"employeeCountUpperBound": 1,
"countryOfOperations": "US",
"physicalLocationsCount": "under10",
"mobileCheckDepositEnabled": true,
"achEnabled": true,
"authorizedSigners": [],
"beneficialOwners": [],
"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 |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The organization or organizationUri was malformed or does not refer to an organization. | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:
This error response may have one of the following |
Status | Description |
---|---|
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 |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters or request body 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. |
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 organization 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 POST ing 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 an 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. |
Try It
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"customerId": "000489353781",
"_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"tradeName": "Smith's Auto Detailing",
"emailAddresses": [
{
"_id": "ea0",
"type": "work",
"value": "smitties-detailing@example.com"
}
],
"preferredEmailAddressId": "ea0",
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "wp1"
}
],
"preferredPhoneNumberId": "wp0",
"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"
}
],
"preferredMailingAddressId": "wa0",
"establishedDate": "2009-07-09T",
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"state": "active",
"governmentOwned": false,
"registeredIn": "NC",
"publiclyHeld": false,
"smallBusiness": true,
"taxExempt": false,
"currency": "USD",
"estimatedAnnualRevenue": "from1to10Million",
"estimatedMonthlyAmounts": {
"sentWire": "moreThanOneMillion",
"receivedWire": "oneHundredThousandToOneMillion",
"mobileCheckDeposit": "upToOneHundredThousand",
"receivedAch": "upToOneHundredThousand",
"sentAch": "moreThanOneMillion"
},
"type": "corporation",
"subtype": "soleProprietorship",
"employeeCountLowerBound": 1,
"employeeCountUpperBound": 1,
"countryOfOperations": "US",
"physicalLocationsCount": "under10",
"mobileCheckDepositEnabled": true,
"achEnabled": true,
"authorizedSigners": [],
"beneficialOwners": [],
"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 |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The organization or organizationUri was malformed or does not refer to an organization. | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:
This error response may have one of the following |
Status | Description |
---|---|
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 |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters or request body 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. |
Authorized Signers
Organization's Authorized Signers
getAuthorizedSigners
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/organizations/organizations/{organizationId}/authorizedSigners \
-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}/authorizedSigners 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}/authorizedSigners',
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}/authorizedSigners',
{
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}/authorizedSigners',
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}/authorizedSigners', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/authorizedSigners");
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}/authorizedSigners", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Fetch the organization's authorized signers
GET /organizations/{organizationId}/authorizedSigners
Return a HAL representation of the array of the account's authorized signers.
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. |
Try It
Example responses
200 Response
{
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1575c0a7b0115a4b3",
"message": "Descriptive error message...",
"statusCode": 422,
"type": "errorType1",
"remediation": "Remediation string...",
"occurredAt": "2018-01-25T05:50:52.375Z",
"errors": [
{
"_id": "ccdbe2c5c938a230667b3827",
"message": "An optional embedded error"
},
{
"_id": "dbe9088dcfe2460f229338a3",
"message": "Another optional embedded error"
}
],
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/errorType1"
}
}
},
"items": [
{
"userId": "bd9e7a93-32cc-435d-ac57-f21faa082318",
"customerId": "00047294723672",
"type": "joint",
"role": "Chief Financial Officer",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"taxId": "111-11-1111",
"citizen": true,
"addresses": [
{
"_id": "ha5",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"id": "wa0",
"type": "other",
"label": "mailing",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha5",
"emailAddress": "JohnDanielSmith@example.com"
}
]
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: authorizedSigners |
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. |
createAuthorizedSigner
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/organizations/organizations/{organizationId}/authorizedSigners \
-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/{organizationId}/authorizedSigners 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/{organizationId}/authorizedSigners',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1575c0a7b0115a4b3",
"message": "Descriptive error message...",
"statusCode": 422,
"type": "errorType1",
"remediation": "Remediation string...",
"occurredAt": "2018-01-25T05:50:52.375Z",
"errors": [
{
"_id": "ccdbe2c5c938a230667b3827",
"message": "An optional embedded error"
},
{
"_id": "dbe9088dcfe2460f229338a3",
"message": "Another optional embedded error"
}
],
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/errorType1"
}
}
},
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addresses": [
{
"_id": "ha5",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "stri",
"taxId": "string",
"citizen": true,
"emailAddress": "user@example.com",
"userId": "bd9e7a93-32cc-435d-ac57-f21faa082318",
"type": "primary",
"role": "string"
}';
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/{organizationId}/authorizedSigners',
{
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/{organizationId}/authorizedSigners',
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/{organizationId}/authorizedSigners', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/authorizedSigners");
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/{organizationId}/authorizedSigners", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Create a new authorized signer and associate it to an organization.
POST /organizations/{organizationId}/authorizedSigners
This operation will create a new authorized signer as well as associate and provide the user access to an organization. The signer must be a verified user and the user URI must be passed into _links as apiture:user
. An authorized signer will be added through indirect operations such as a successful creation of an organization, or completion of an authorized signer invitation.
This error response may have one of the following type
values:
Body parameter
{
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1575c0a7b0115a4b3",
"message": "Descriptive error message...",
"statusCode": 422,
"type": "errorType1",
"remediation": "Remediation string...",
"occurredAt": "2018-01-25T05:50:52.375Z",
"errors": [
{
"_id": "ccdbe2c5c938a230667b3827",
"message": "An optional embedded error"
},
{
"_id": "dbe9088dcfe2460f229338a3",
"message": "Another optional embedded error"
}
],
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/errorType1"
}
}
},
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addresses": [
{
"_id": "ha5",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "stri",
"taxId": "string",
"citizen": true,
"emailAddress": "user@example.com",
"userId": "bd9e7a93-32cc-435d-ac57-f21faa082318",
"type": "primary",
"role": "string"
}
Parameters
Parameter | Description |
---|---|
organizationId (path) |
string (required) The unique identifier of this organization. This is an opaque string. |
body (body) |
createAuthorizedSigner (required) The authorized signer object. |
Try It
Example responses
201 Response
{
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1575c0a7b0115a4b3",
"message": "Descriptive error message...",
"statusCode": 422,
"type": "errorType1",
"remediation": "Remediation string...",
"occurredAt": "2018-01-25T05:50:52.375Z",
"errors": [
{
"_id": "ccdbe2c5c938a230667b3827",
"message": "An optional embedded error"
},
{
"_id": "dbe9088dcfe2460f229338a3",
"message": "Another optional embedded error"
}
],
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/errorType1"
}
}
},
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addresses": [
{
"_id": "ha5",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "stri",
"taxId": "string",
"citizen": true,
"emailAddress": "user@example.com",
"userId": "bd9e7a93-32cc-435d-ac57-f21faa082318",
"customerId": "00047294723672",
"type": "primary",
"role": "string"
}
Responses
Status | Description |
---|---|
201 | Created |
Created | |
Schema: createAuthorizedSigner |
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 beneficial 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. |
Try It
Example responses
200 Response
{
"items": [
{
"firstName": "William",
"lastName": "Wellphunded",
"addresses": [
{
"addressLine1": "1234 S Front Street",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"type": "home"
}
],
"role": "Chief Financial Officer",
"percentage": 35,
"birthdate": {},
"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 |
Status | Description |
---|---|
304 | Not Modified |
Not Modified. The resource has not been modified since it was last fetched. |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such organization resource at the specified This error response may have one of the following | |
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 organizations 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": [
{
"firstName": "William",
"lastName": "Wellphunded",
"addresses": [
{
"addressLine1": "1234 S Front Street",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"type": "home"
}
],
"role": "Chief Financial Officer",
"percentage": 35,
"birthdate": {},
"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, or who have a major role in the organization. This operation completely replaces the set of beneficial owners.
Body parameter
{
"items": [
{
"firstName": "William",
"lastName": "Wellphunded",
"addresses": [
{
"addressLine1": "1234 S Front Street",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"type": "home"
}
],
"role": "Chief Financial Officer",
"percentage": 35,
"birthdate": {},
"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. |
Try It
Example responses
200 Response
{
"items": [
{
"firstName": "William",
"lastName": "Wellphunded",
"addresses": [
{
"addressLine1": "1234 S Front Street",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"type": "home"
}
],
"role": "Chief Financial Officer",
"percentage": 35,
"birthdate": {},
"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 |
Status | Description |
---|---|
304 | Not Modified |
Not Modified. The resource has not been modified since it was last fetched. |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such organization resource at the specified This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. There is a conflict in the request to update an organization's beneficial owners:
| |
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. |
Address
getAddresses
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/organizations/organizations/{organizationId}/addresses \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
GET https://api.devbank.apiture.com/organizations/organizations/{organizationId}/addresses 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/{organizationId}/addresses',
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/{organizationId}/addresses',
{
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/{organizationId}/addresses',
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/{organizationId}/addresses', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/addresses");
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/{organizationId}/addresses", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Get an organization's addresses
GET /organizations/{organizationId}/addresses
Return the list of the organization's addresses.
Parameters
Parameter | Description |
---|---|
organizationId (path) |
string (required) The unique identifier of this organization. This is an opaque string. |
Try It
Example responses
200 Response
{
"_profile": "https://api.apiture.com/schemas/organizations/organizationAddresses/v1.0.0/profile.json",
"items": [
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"state": "approved",
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
}
}
},
{
"_id": "wa1",
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US",
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/wa1"
}
}
}
],
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: organizationAddresses |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such organization resource at the specified This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters or request body was well formed but otherwise invalid. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
createAddress
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/organizations/organizations/{organizationId}/addresses \
-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/{organizationId}/addresses 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/{organizationId}/addresses',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"state": "approved",
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
}
}
}';
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/{organizationId}/addresses',
{
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/{organizationId}/addresses',
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/{organizationId}/addresses', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/addresses");
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/{organizationId}/addresses", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Create a new address.
POST /organizations/{organizationId}/addresses
Add an address to the list of the organization's addresses. The new address will be pending
until the financial institution has reviewed and approved it, after which it will become approved
.
Body parameter
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"state": "approved",
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
}
}
}
Parameters
Parameter | Description |
---|---|
replaceId (query) |
string An optional _id of an existing address to be replaced with this new address instead of adding a new address, once it has been approved. If replaceId matches the _id of the preferred mailing address the preferredMailingAddressId will also be updated to the value of replaceId once approved. If no existing address matches replaceId , the new address is added to the list of addresses. Example: ?replaceId=ha1 |
body (body) |
organizationAddress (required) The data necessary to create a new address. |
organizationId (path) |
string (required) The unique identifier of this organization. This is an opaque string. |
Try It
Example responses
201 Response
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"state": "approved",
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
}
}
}
Responses
Status | Description |
---|---|
201 | Created |
Created | |
Schema: organizationAddress |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such organization resource at the specified This error response may have one of the following | |
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 may be provided in an If-Match request header for PUT or PATCH operations which update the resource. |
getAddress
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/organizations/organizations/{organizationId}/addresses/{addressId} \
-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}/addresses/{addressId} 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}/addresses/{addressId}',
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}/addresses/{addressId}',
{
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}/addresses/{addressId}',
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}/addresses/{addressId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/addresses/{addressId}");
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}/addresses/{addressId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Fetch a representation of this address
GET /organizations/{organizationId}/addresses/{addressId}
Return a HAL representation of this address resource.
Parameters
Parameter | Description |
---|---|
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. |
organizationId (path) |
string (required) The unique identifier of this organization. This is an opaque string. |
addressId (path) |
string (required) The unique identifier of this address. This is an opaque string. |
Try It
Example responses
200 Response
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"state": "approved",
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: organizationAddress |
Status | Description |
---|---|
304 | Not Modified |
Not Modified. The resource has not been modified since it was last fetched. |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such address resource at the specified This error response may have one of the following | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which may be provided in an If-Match request header for PUT or PATCH operations which update this address resource. |
deleteAddress
Code samples
# You can also use wget
curl -X DELETE https://api.devbank.apiture.com/organizations/organizations/{organizationId}/addresses/{addressId} \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
DELETE https://api.devbank.apiture.com/organizations/organizations/{organizationId}/addresses/{addressId} 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/{organizationId}/addresses/{addressId}',
method: 'delete',
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/{organizationId}/addresses/{addressId}',
{
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',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://api.devbank.apiture.com/organizations/organizations/{organizationId}/addresses/{addressId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://api.devbank.apiture.com/organizations/organizations/{organizationId}/addresses/{addressId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/addresses/{addressId}");
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"},
"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}/addresses/{addressId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Delete this address resource
DELETE /organizations/{organizationId}/addresses/{addressId}
Delete this address. The address can only be deleted if it is not the organization's preferred address.
Parameters
Parameter | Description |
---|---|
organizationId (path) |
string (required) The unique identifier of this organization. This is an opaque string. |
addressId (path) |
string (required) The unique identifier of this address. This is an opaque string. |
Try It
Example responses
404 Response
{
"_profile": "https://api.apiture.com/schemas/common/errorResponse/v2.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. |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such address resource at the specified This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. The selected address cannot be deleted because it is currently the organization's preferred address. This error response may have one of the following | |
Schema: errorResponse |
setPreferredAddress
Code samples
# You can also use wget
curl -X PUT https://api.devbank.apiture.com/organizations/organizations/{organizationId}/preferredAddress \
-H 'Content-Type: application/hal+json' \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
PUT https://api.devbank.apiture.com/organizations/organizations/{organizationId}/preferredAddress 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/{organizationId}/preferredAddress',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = 'pe0';
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/{organizationId}/preferredAddress',
{
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',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://api.devbank.apiture.com/organizations/organizations/{organizationId}/preferredAddress',
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.put('https://api.devbank.apiture.com/organizations/organizations/{organizationId}/preferredAddress', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/preferredAddress");
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"},
"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}/preferredAddress", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Set Preferred mailing Address
PUT /organizations/{organizationId}/preferredAddress
Set the organization's preferred mailing address. The organization may set their preferred address to an approved address by passing its unique _id
in either the value
query parameter or in the request body. This updates the preferredAddressId
property of the organization.
This operation is available via the apiture:setAsPreferred
link on an address if that resource is eligible to be set as the preferred address.
No changes are made if the specified address is already the preferred address.
Body parameter
"pe0"
Parameters
Parameter | Description |
---|---|
value (query) |
string The _id of the address to assign as the preferred address. If this query parameter exists, the request body, if any, is ignored. Example: ?value=ha1 |
body (body) |
preferredResource (required) The _id of the address to assign as the preferred address, as a JSON string (the value must be quoted). minLength: 1 maxLength: 4 |
organizationId (path) |
string (required) The unique identifier of this organization. This is an opaque string. |
Try It
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"customerId": "000489353781",
"_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"tradeName": "Smith's Auto Detailing",
"emailAddresses": [
{
"_id": "ea0",
"type": "work",
"value": "smitties-detailing@example.com"
}
],
"preferredEmailAddressId": "ea0",
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "wp1"
}
],
"preferredPhoneNumberId": "wp0",
"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"
}
],
"preferredMailingAddressId": "wa0",
"establishedDate": "2009-07-09T",
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"state": "active",
"governmentOwned": false,
"registeredIn": "NC",
"publiclyHeld": false,
"smallBusiness": true,
"taxExempt": false,
"currency": "USD",
"estimatedAnnualRevenue": "from1to10Million",
"estimatedMonthlyAmounts": {
"sentWire": "moreThanOneMillion",
"receivedWire": "oneHundredThousandToOneMillion",
"mobileCheckDeposit": "upToOneHundredThousand",
"receivedAch": "upToOneHundredThousand",
"sentAch": "moreThanOneMillion"
},
"type": "corporation",
"subtype": "soleProprietorship",
"employeeCountLowerBound": 1,
"employeeCountUpperBound": 1,
"countryOfOperations": "US",
"physicalLocationsCount": "under10",
"mobileCheckDepositEnabled": true,
"achEnabled": true,
"authorizedSigners": [],
"beneficialOwners": [],
"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. The organization's preferredAddressId is updated to the passed value. | |
Schema: organization |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such organization resource at the specified This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. The selected phone number, address, or email address cannot be set as the preferred because it is still pending . | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The selected phone number, address, or email address cannot be set as the preferred because no such item exists. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which may be provided in an If-Match request header for PUT or PATCH operations which update this organization resource. |
Email Address
getEmailAddresses
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/organizations/organizations/{organizationId}/emailAddresses \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
GET https://api.devbank.apiture.com/organizations/organizations/{organizationId}/emailAddresses 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/{organizationId}/emailAddresses',
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/{organizationId}/emailAddresses',
{
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/{organizationId}/emailAddresses',
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/{organizationId}/emailAddresses', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/emailAddresses");
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/{organizationId}/emailAddresses", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Get organization's email addresses
GET /organizations/{organizationId}/emailAddresses
Return the list of the organization's email addresses.
Parameters
Parameter | Description |
---|---|
organizationId (path) |
string (required) The unique identifier of this organization. This is an opaque string. |
Try It
Example responses
200 Response
{
"_profile": "https://api.apiture.com/schemas/organizations/organizationEmailAddresses/v1.0.0/profile.json",
"items": [
{
"_id": "pe0",
"type": "personal",
"label": "Personal",
"number": "user7838@example.com",
"state": "approved",
"_profile": "https://api.apiture.com/schemas/organizations/organizationEmailAddress/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe0"
}
}
},
{
"_id": "pe2",
"type": "personal",
"label": "Personal",
"value": "John.Smith@example.com",
"state": "approved",
"_profile": "https://api.apiture.com/schemas/organizations/organizationEmailAddress/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/EmailAddresses/pe2"
}
}
}
],
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: organizationEmailAddresses |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such organization resource at the specified This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters or request body was well formed but otherwise invalid. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
createEmailAddress
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/organizations/organizations/{organizationId}/emailAddresses \
-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/{organizationId}/emailAddresses 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/{organizationId}/emailAddresses',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"_id": "pe1",
"_profile": "https://api.apiture.com/schemas/organizations/organizationEmailAddress/v1.0.0/profile.json",
"type": "personal",
"number": "555-555-5555",
"state": "approved",
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
},
"delete": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
},
"apiture:setAsPreferred": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
}
}
}';
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/{organizationId}/emailAddresses',
{
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/{organizationId}/emailAddresses',
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/{organizationId}/emailAddresses', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/emailAddresses");
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/{organizationId}/emailAddresses", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Create a new email address
POST /organizations/{organizationId}/emailAddresses
Add an email address to the list of the organization's email addresses. The new email address will be pending
until the financial institution has reviewed and approved it, after which it will become approved
.
Body parameter
{
"_id": "pe1",
"_profile": "https://api.apiture.com/schemas/organizations/organizationEmailAddress/v1.0.0/profile.json",
"type": "personal",
"number": "555-555-5555",
"state": "approved",
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
},
"delete": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
},
"apiture:setAsPreferred": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
}
}
}
Parameters
Parameter | Description |
---|---|
replaceId (query) |
string An optional _id of an existing email address to be replaced with this new email address instead of adding a new email address, once it has been approved. If replaceId matches the _id of the preferred email address the preferredEmailAddressId will also be updated to the value of replaceId once approved. If no existing email address matches replaceId , the new email address is added to the list of email addresses. Example: ?replaceId=e1 |
body (body) |
organizationEmailAddress (required) The data necessary to create a new email address. |
organizationId (path) |
string (required) The unique identifier of this organization. This is an opaque string. |
Try It
Example responses
201 Response
{
"_id": "pe1",
"_profile": "https://api.apiture.com/schemas/organizations/organizationEmailAddress/v1.0.0/profile.json",
"type": "personal",
"number": "555-555-5555",
"state": "approved",
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
},
"delete": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
},
"apiture:setAsPreferred": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
}
}
}
Responses
Status | Description |
---|---|
201 | Created |
Created | |
Schema: organizationEmailAddress |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such organization resource at the specified This error response may have one of the following | |
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 may be provided in an If-Match request header for PUT or PATCH operations which update the resource. |
getEmailAddress
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/organizations/organizations/{organizationId}/emailAddresses/{emailAddressId} \
-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}/emailAddresses/{emailAddressId} 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}/emailAddresses/{emailAddressId}',
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}/emailAddresses/{emailAddressId}',
{
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}/emailAddresses/{emailAddressId}',
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}/emailAddresses/{emailAddressId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/emailAddresses/{emailAddressId}");
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}/emailAddresses/{emailAddressId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Fetch a representation of this email address
GET /organizations/{organizationId}/emailAddresses/{emailAddressId}
Return a HAL representation of this email address resource.
Parameters
Parameter | Description |
---|---|
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. |
organizationId (path) |
string (required) The unique identifier of this organization. This is an opaque string. |
emailAddressId (path) |
string (required) The unique identifier of this email address. This is an opaque string. |
Try It
Example responses
200 Response
{
"_id": "pe1",
"_profile": "https://api.apiture.com/schemas/organizations/organizationEmailAddress/v1.0.0/profile.json",
"type": "personal",
"number": "555-555-5555",
"state": "approved",
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
},
"delete": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
},
"apiture:setAsPreferred": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: organizationEmailAddress |
Status | Description |
---|---|
304 | Not Modified |
Not Modified. The resource has not been modified since it was last fetched. |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such email address resource at the specified This error response may have one of the following | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which may be provided in an If-Match request header for PUT or PATCH operations which update this email address resource. |
deleteEmailAddress
Code samples
# You can also use wget
curl -X DELETE https://api.devbank.apiture.com/organizations/organizations/{organizationId}/emailAddresses/{emailAddressId} \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
DELETE https://api.devbank.apiture.com/organizations/organizations/{organizationId}/emailAddresses/{emailAddressId} 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/{organizationId}/emailAddresses/{emailAddressId}',
method: 'delete',
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/{organizationId}/emailAddresses/{emailAddressId}',
{
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',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://api.devbank.apiture.com/organizations/organizations/{organizationId}/emailAddresses/{emailAddressId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://api.devbank.apiture.com/organizations/organizations/{organizationId}/emailAddresses/{emailAddressId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/emailAddresses/{emailAddressId}");
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"},
"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}/emailAddresses/{emailAddressId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Delete this email address resource
DELETE /organizations/{organizationId}/emailAddresses/{emailAddressId}
Delete this email address. The email address can only be deleted if it is not the organization's preferred email address.
Parameters
Parameter | Description |
---|---|
organizationId (path) |
string (required) The unique identifier of this organization. This is an opaque string. |
emailAddressId (path) |
string (required) The unique identifier of this email address. This is an opaque string. |
Try It
Example responses
404 Response
{
"_profile": "https://api.apiture.com/schemas/common/errorResponse/v2.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. |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such email address resource at the specified This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. The selected email address cannot be deleted because it is currently the organization's preferred email address. This error response may have one of the following | |
Schema: errorResponse |
setPreferredEmailAddress
Code samples
# You can also use wget
curl -X PUT https://api.devbank.apiture.com/organizations/organizations/{organizationId}/preferredEmailAddress \
-H 'Content-Type: application/hal+json' \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
PUT https://api.devbank.apiture.com/organizations/organizations/{organizationId}/preferredEmailAddress 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/{organizationId}/preferredEmailAddress',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = 'pe0';
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/{organizationId}/preferredEmailAddress',
{
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',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://api.devbank.apiture.com/organizations/organizations/{organizationId}/preferredEmailAddress',
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.put('https://api.devbank.apiture.com/organizations/organizations/{organizationId}/preferredEmailAddress', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/preferredEmailAddress");
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"},
"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}/preferredEmailAddress", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Set Preferred Email Address
PUT /organizations/{organizationId}/preferredEmailAddress
Set the organization's preferred email address. The organization may set their preferred email address to an approved address by passing its unique _id
in either the value
query parameter or in the request body. This updates the preferredEmailAddressId
property of the organization.
This operation is available via the apiture:setAsPreferred
link on an email address if that resource is eligible to be set as the preferred email address.
No changes are made if the specified email address is already the preferred email address.
Body parameter
"pe0"
Parameters
Parameter | Description |
---|---|
value (query) |
string The _id of the email address to assign as the preferred email address. If this query parameter exists, the request body, if any, is ignored. Example: ?value=pe0 |
body (body) |
preferredResource (required) The _id of the email address to assign as the preferred email address, as a JSON string (the value must be quoted). minLength: 1 maxLength: 4 |
organizationId (path) |
string (required) The unique identifier of this organization. This is an opaque string. |
Try It
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"customerId": "000489353781",
"_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"tradeName": "Smith's Auto Detailing",
"emailAddresses": [
{
"_id": "ea0",
"type": "work",
"value": "smitties-detailing@example.com"
}
],
"preferredEmailAddressId": "ea0",
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "wp1"
}
],
"preferredPhoneNumberId": "wp0",
"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"
}
],
"preferredMailingAddressId": "wa0",
"establishedDate": "2009-07-09T",
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"state": "active",
"governmentOwned": false,
"registeredIn": "NC",
"publiclyHeld": false,
"smallBusiness": true,
"taxExempt": false,
"currency": "USD",
"estimatedAnnualRevenue": "from1to10Million",
"estimatedMonthlyAmounts": {
"sentWire": "moreThanOneMillion",
"receivedWire": "oneHundredThousandToOneMillion",
"mobileCheckDeposit": "upToOneHundredThousand",
"receivedAch": "upToOneHundredThousand",
"sentAch": "moreThanOneMillion"
},
"type": "corporation",
"subtype": "soleProprietorship",
"employeeCountLowerBound": 1,
"employeeCountUpperBound": 1,
"countryOfOperations": "US",
"physicalLocationsCount": "under10",
"mobileCheckDepositEnabled": true,
"achEnabled": true,
"authorizedSigners": [],
"beneficialOwners": [],
"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. The organization's preferredEmailAddressId is updated to the passed value. | |
Schema: organization |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such organization resource at the specified This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. The selected phone number, address, or email address cannot be set as the preferred because it is still pending . | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The selected phone number, address, or email address cannot be set as the preferred because no such item exists. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which may be provided in an If-Match request header for PUT or PATCH operations which update this organization resource. |
Phone Number
getPhoneNumbers
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/organizations/organizations/{organizationId}/phoneNumbers \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
GET https://api.devbank.apiture.com/organizations/organizations/{organizationId}/phoneNumbers 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/{organizationId}/phoneNumbers',
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/{organizationId}/phoneNumbers',
{
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/{organizationId}/phoneNumbers',
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/{organizationId}/phoneNumbers', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/phoneNumbers");
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/{organizationId}/phoneNumbers", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Get organization's phone numbers
GET /organizations/{organizationId}/phoneNumbers
Return the list of the organization's phone numbers
Parameters
Parameter | Description |
---|---|
organizationId (path) |
string (required) The unique identifier of this organization. This is an opaque string. |
Try It
Example responses
200 Response
{
"_profile": "https://api.apiture.com/schemas/organizations/organizationPhoneNumbers/v1.0.0/profile.json",
"items": [
{
"_id": "mp0",
"type": "mobile",
"label": "Mobile",
"number": "555-555-5555",
"state": "approved",
"_profile": "https://api.apiture.com/schemas/organization/organizationPhoneNumber/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/mp0"
}
}
},
{
"_id": "mp2",
"type": "home",
"label": "Home",
"number": "555-444-4444",
"state": "approved",
"_profile": "https://api.apiture.com/schemas/organizations/organizationPhoneNumber/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/mp2"
}
}
}
],
"_links": {
"self": {
"href": "/useorganizationsrs/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: organizationPhoneNumbers |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such organization resource at the specified This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. One or more of the query parameters or request body was well formed but otherwise invalid. The _error field in the response will contain details about the request error. | |
Schema: errorResponse |
createPhoneNumber
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/organizations/organizations/{organizationId}/phoneNumbers \
-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/{organizationId}/phoneNumbers 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/{organizationId}/phoneNumbers',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"_id": "hp1",
"_profile": "https://api.apiture.com/schemas/organizations/organizationPhoneNumber/v1.0.0/profile.json",
"type": "home",
"number": "555-555-5555",
"state": "approved",
"_links": {
"self": {
"href": "/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
}
}
}';
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/{organizationId}/phoneNumbers',
{
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/{organizationId}/phoneNumbers',
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/{organizationId}/phoneNumbers', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/phoneNumbers");
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/{organizationId}/phoneNumbers", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Create a new phone number
POST /organizations/{organizationId}/phoneNumbers
Add a phone number to the list of the organization's phone numbers. The new number will be pending
until the financial institution has reviewed and approved it, after which it will become approved
.
Body parameter
{
"_id": "hp1",
"_profile": "https://api.apiture.com/schemas/organizations/organizationPhoneNumber/v1.0.0/profile.json",
"type": "home",
"number": "555-555-5555",
"state": "approved",
"_links": {
"self": {
"href": "/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
}
}
}
Parameters
Parameter | Description |
---|---|
replaceId (query) |
string An optional _id of an existing phone number to be replaced with this new phone number instead of adding a new phone number, once it has been approved. If replaceId matches the _id of the preferred phone number the preferredPhoneId will also be updated to the value of replaceId once approved. If no existing phone number matches replaceId , the new phone number is added to the list of phone numbers. Example: ?replaceId=p1 |
body (body) |
organizationPhoneNumber (required) The data necessary to create a new phone number. |
organizationId (path) |
string (required) The unique identifier of this organization. This is an opaque string. |
Try It
Example responses
201 Response
{
"_id": "hp1",
"_profile": "https://api.apiture.com/schemas/organizations/organizationPhoneNumber/v1.0.0/profile.json",
"type": "home",
"number": "555-555-5555",
"state": "approved",
"_links": {
"self": {
"href": "/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
}
}
}
Responses
Status | Description |
---|---|
201 | Created |
Created | |
Schema: organizationPhoneNumber |
Status | Description |
---|---|
400 | Bad Request |
Bad Request. The request body or one or more of the query parameters was not well formed. The This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such organization resource at the specified This error response may have one of the following | |
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 may be provided in an If-Match request header for PUT or PATCH operations which update the resource. |
getPhoneNumber
Code samples
# You can also use wget
curl -X GET https://api.devbank.apiture.com/organizations/organizations/{organizationId}/phoneNumbers/{phoneNumberId} \
-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}/phoneNumbers/{phoneNumberId} 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}/phoneNumbers/{phoneNumberId}',
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}/phoneNumbers/{phoneNumberId}',
{
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}/phoneNumbers/{phoneNumberId}',
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}/phoneNumbers/{phoneNumberId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/phoneNumbers/{phoneNumberId}");
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}/phoneNumbers/{phoneNumberId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Fetch a representation of this phone number
GET /organizations/{organizationId}/phoneNumbers/{phoneNumberId}
Return a HAL representation of this phone number resource.
Parameters
Parameter | Description |
---|---|
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. |
organizationId (path) |
string (required) The unique identifier of this organization. This is an opaque string. |
phoneNumberId (path) |
string (required) The unique identifier of this phone number. This is an opaque string. |
Try It
Example responses
200 Response
{
"_id": "hp1",
"_profile": "https://api.apiture.com/schemas/organizations/organizationPhoneNumber/v1.0.0/profile.json",
"type": "home",
"number": "555-555-5555",
"state": "approved",
"_links": {
"self": {
"href": "/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
}
}
}
Responses
Status | Description |
---|---|
200 | OK |
OK | |
Schema: organizationPhoneNumber |
Status | Description |
---|---|
304 | Not Modified |
Not Modified. The resource has not been modified since it was last fetched. |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such phone number resource at the specified This error response may have one of the following | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which may be provided in an If-Match request header for PUT or PATCH operations which update this phone number resource. |
deletePhoneNumber
Code samples
# You can also use wget
curl -X DELETE https://api.devbank.apiture.com/organizations/organizations/{organizationId}/phoneNumbers/{phoneNumberId} \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
DELETE https://api.devbank.apiture.com/organizations/organizations/{organizationId}/phoneNumbers/{phoneNumberId} 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/{organizationId}/phoneNumbers/{phoneNumberId}',
method: 'delete',
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/{organizationId}/phoneNumbers/{phoneNumberId}',
{
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',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.delete 'https://api.devbank.apiture.com/organizations/organizations/{organizationId}/phoneNumbers/{phoneNumberId}',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept': 'application/hal+json',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.delete('https://api.devbank.apiture.com/organizations/organizations/{organizationId}/phoneNumbers/{phoneNumberId}', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/phoneNumbers/{phoneNumberId}");
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"},
"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}/phoneNumbers/{phoneNumberId}", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Delete this phone number resource
DELETE /organizations/{organizationId}/phoneNumbers/{phoneNumberId}
Delete this phone number. The number can only be deleted if it is not the organization's preferred phone number.
Parameters
Parameter | Description |
---|---|
organizationId (path) |
string (required) The unique identifier of this organization. This is an opaque string. |
phoneNumberId (path) |
string (required) The unique identifier of this phone number. This is an opaque string. |
Try It
Example responses
404 Response
{
"_profile": "https://api.apiture.com/schemas/common/errorResponse/v2.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. |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such phone number resource at the specified This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. The selected phone number cannot be deleted because it is currently the organization's preferred phone number. This error response may have one of the following | |
Schema: errorResponse |
setPreferredPhoneNumber
Code samples
# You can also use wget
curl -X PUT https://api.devbank.apiture.com/organizations/organization/{organizationId}/preferredPhoneNumber \
-H 'Content-Type: application/hal+json' \
-H 'Accept: application/hal+json' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
PUT https://api.devbank.apiture.com/organizations/organization/{organizationId}/preferredPhoneNumber 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/organization/{organizationId}/preferredPhoneNumber',
method: 'put',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = 'pe0';
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/organization/{organizationId}/preferredPhoneNumber',
{
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',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.put 'https://api.devbank.apiture.com/organizations/organization/{organizationId}/preferredPhoneNumber',
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.put('https://api.devbank.apiture.com/organizations/organization/{organizationId}/preferredPhoneNumber', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/organizations/organization/{organizationId}/preferredPhoneNumber");
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"},
"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/organization/{organizationId}/preferredPhoneNumber", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Set Preferred Phone Number
PUT /organization/{organizationId}/preferredPhoneNumber
Set the organization's preferred phone number. The organization may set their preferred phone number to an approved number by passing its unique _id
in either the value
query parameter or in the request body. This updates the preferredPhoneId
property of the organization.
This operation is available via the apiture:setAsPreferred
link on an phone number if that resource is eligible to be set as the preferred phone number.
No changes are made if the specified phone number is already the preferred phone number.
Body parameter
"pe0"
Parameters
Parameter | Description |
---|---|
value (query) |
string The _id of the number to assign as the preferred phone number. If this query parameter exists, the request body, if any, is ignored. Example: ?value=pe0 |
body (body) |
preferredResource (required) The _id of the number to assign as the preferred phone number, as a JSON string (the value must be quoted). minLength: 1 maxLength: 4 |
organizationId (path) |
string (required) The unique identifier of this organization. This is an opaque string. |
Try It
Example responses
200 Response
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"customerId": "000489353781",
"_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"tradeName": "Smith's Auto Detailing",
"emailAddresses": [
{
"_id": "ea0",
"type": "work",
"value": "smitties-detailing@example.com"
}
],
"preferredEmailAddressId": "ea0",
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "wp1"
}
],
"preferredPhoneNumberId": "wp0",
"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"
}
],
"preferredMailingAddressId": "wa0",
"establishedDate": "2009-07-09T",
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"state": "active",
"governmentOwned": false,
"registeredIn": "NC",
"publiclyHeld": false,
"smallBusiness": true,
"taxExempt": false,
"currency": "USD",
"estimatedAnnualRevenue": "from1to10Million",
"estimatedMonthlyAmounts": {
"sentWire": "moreThanOneMillion",
"receivedWire": "oneHundredThousandToOneMillion",
"mobileCheckDeposit": "upToOneHundredThousand",
"receivedAch": "upToOneHundredThousand",
"sentAch": "moreThanOneMillion"
},
"type": "corporation",
"subtype": "soleProprietorship",
"employeeCountLowerBound": 1,
"employeeCountUpperBound": 1,
"countryOfOperations": "US",
"physicalLocationsCount": "under10",
"mobileCheckDepositEnabled": true,
"achEnabled": true,
"authorizedSigners": [],
"beneficialOwners": [],
"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. The organization's preferredPhoneId is updated to the passed value. | |
Schema: organization |
Status | Description |
---|---|
404 | Not Found |
Not Found. There is no such organization resource at the specified This error response may have one of the following | |
Schema: errorResponse |
Status | Description |
---|---|
409 | Conflict |
Conflict. The selected phone number, address, or email address cannot be set as the preferred because it is still pending . | |
Schema: errorResponse |
Status | Description |
---|---|
422 | Unprocessable Entity |
Unprocessable Entity. The selected phone number, address, or email address cannot be set as the preferred because no such item exists. | |
Schema: errorResponse |
Response Headers
Status | Description |
---|---|
200 | ETag string |
The ETag response header specifies an entity tag which may be provided in an If-Match request header for PUT or PATCH operations which update this organization resource. |
Entity Authorization Form
generateEntityAuthorizationForm
Code samples
# You can also use wget
curl -X POST https://api.devbank.apiture.com/organizations/organizations/{organizationId}/entityAuthorizationForm \
-H 'Content-Type: application/hal+json' \
-H 'Accept: application/hal+json' \
-H 'Accept: string' \
-H 'API-Key: API_KEY' \
-H 'Authorization: Bearer {access-token}'
POST https://api.devbank.apiture.com/organizations/organizations/{organizationId}/entityAuthorizationForm HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
Accept: string
var headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'Accept':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
$.ajax({
url: 'https://api.devbank.apiture.com/organizations/organizations/{organizationId}/entityAuthorizationForm',
method: 'post',
headers: headers,
success: function(data) {
console.log(JSON.stringify(data));
}
})
const fetch = require('node-fetch');
const inputBody = '{
"_profile": "https://production.api.apiture.com/schemas/organizations/entityAuthorizationFormRequest/v1.0.0/profile.json",
"invitees": [
{
"firstName": "Lucille",
"lastName": "Wellphunded",
"role": "Owner"
}
]
}';
const headers = {
'Content-Type':'application/hal+json',
'Accept':'application/hal+json',
'Accept':'string',
'API-Key':'API_KEY',
'Authorization':'Bearer {access-token}'
};
fetch('https://api.devbank.apiture.com/organizations/organizations/{organizationId}/entityAuthorizationForm',
{
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',
'Accept' => 'string',
'API-Key' => 'API_KEY',
'Authorization' => 'Bearer {access-token}'
}
result = RestClient.post 'https://api.devbank.apiture.com/organizations/organizations/{organizationId}/entityAuthorizationForm',
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Content-Type': 'application/hal+json',
'Accept': 'application/hal+json',
'Accept': 'string',
'API-Key': 'API_KEY',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.devbank.apiture.com/organizations/organizations/{organizationId}/entityAuthorizationForm', params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/entityAuthorizationForm");
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"},
"Accept": []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/organizations/{organizationId}/entityAuthorizationForm", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
Generate an entity authorization Form
POST /organizations/{organizationId}/entityAuthorizationForm
Generate an entity authorization form for this organization. The form will include:
- the name and role of the individual requesting the form (derived from the user making the request)
- the names and roles of all existing authorized signers
- the names and roles of individuals being invited to become authorized signers.
If the form has not been generated for this request data, this returns 202 Accepted
and no response body. The response will include a Retry-After
response
header with a recommended retry interval in seconds.
If the form has been generated for this request, the operations returns 200 OK and the response body is the PDF formatted entity authorization form.
Only the authorized signers associated with the owning business organization may invoke this operation.
Body parameter
{
"_profile": "https://production.api.apiture.com/schemas/organizations/entityAuthorizationFormRequest/v1.0.0/profile.json",
"invitees": [
{
"firstName": "Lucille",
"lastName": "Wellphunded",
"role": "Owner"
}
]
}
Parameters
Parameter | Description |
---|---|
organizationId (path) |
string (required) The unique identifier of this organization. This is an opaque string. |
Accept (header) |
string Optional. Only application/pdf is currently supported. |
body (body) |
entityAuthorizationFormRequest (required) |
Try It
Example responses
404 Response
{
"_profile": "https://api.apiture.com/schemas/common/errorResponse/v2.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": []
}
}
}
406 Response
Responses
Status | Description |
---|---|
200 | OK |
OK. The request has succeeded. | |
202 | Accepted |
Accepted. The request has been accepted for processing, but the processing has not been completed. |
Response Headers
Status | Description |
---|---|
200 | Content-Type string |
When the entity authorization form is available, the response body will be the PDF formatted entity authorization form for this organization. | |
202 | Retry-After string |
Indicates a suggested delay in seconds after which the client should retry the operation. Example: Retry-After: 10 |
Schemas
organizationAddress
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"state": "approved",
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
}
}
}
Organization Address (v1.0.0)
Representation of an organization's address resource.
Links
Response and request bodies using this organizationAddress
schema may contain the following links:
Rel | Summary | Method |
---|---|---|
delete | Delete this address resource | DELETE |
apiture:setAsPreferred | Set Preferred mailing Address | PUT |
Properties
Name | Description |
---|---|
type | addressType The type of this address. |
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
minLength: 4
maxLength: 32
|
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. minLength: 4
maxLength: 128
|
addressLine2 | string The optional second street address line of the address. maxLength: 128
|
city | string The name of the city or municipality. minLength: 2
maxLength: 128
|
regionCode | string The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase. minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]{2}$
|
postalCode | string The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code. minLength: 5
maxLength: 10
pattern: ^[0-9]{5}(?:-[0-9]{4})?$
|
countryCode | string The ISO 3166-1 alpha-2 country code. This is normalized to uppercase. minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]{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
pattern: ^[-a-zA-Z0-9_]{1,8}$
|
_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 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. |
state | profileItemState The state of this address. pending addresses require financial institution approval. Only approved addresses may be set as the preferred address.
|
organizationAddresses
{
"_profile": "https://api.apiture.com/schemas/organizations/organizationAddresses/v1.0.0/profile.json",
"items": [
{
"_id": "ha1",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"state": "approved",
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/ha1"
}
}
},
{
"_id": "wa1",
"type": "work",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US",
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses/wa1"
}
}
}
],
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/addresses"
}
}
}
Organization Addresses (v1.0.0)
The list of the organization's addresses.
Properties
Name | Description |
---|---|
_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 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 | [organizationAddress] An array containing address items. minItems: 1
maxItems: 2
|
organizationEmailAddress
{
"_id": "pe1",
"_profile": "https://api.apiture.com/schemas/organizations/organizationEmailAddress/v1.0.0/profile.json",
"type": "personal",
"number": "555-555-5555",
"state": "approved",
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
},
"delete": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe1"
},
"apiture:setAsPreferred": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/preferredEmailAddresses?value=pe1"
}
}
}
Email Address (v1.0.0)
Representation of email address resources. An email address is immutable, although organizations can add new email addresses.
Links
Response and request bodies using this organizationEmailAddress
schema may contain the following links:
Rel | Summary | Method |
---|---|---|
delete | Delete this email address resource | DELETE |
apiture:setAsPreferred | Set Preferred Email Address | PUT |
Properties
Name | Description |
---|---|
value | string(email) The email address, such as JohnBankCustomer@example.com
minLength: 8
maxLength: 120
|
type | emailType The kind of email address. |
_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
pattern: ^[-a-zA-Z0-9_]{1,8}$
|
_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 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. |
state | profileItemState The state of this email address. pending email addresses require financial institution approval. Only approved numbers may be set as the preferred email address.
|
entityAuthorizationFormRequest
{
"_profile": "https://production.api.apiture.com/schemas/organizations/entityAuthorizationFormRequest/v1.0.0/profile.json",
"invitees": [
{
"firstName": "Lucille",
"lastName": "Wellphunded",
"role": "Owner"
}
]
}
Entity Authorization Form Request (v1.0.0)
Data necessary to generate an entity authorization form.
Properties
Name | Description |
---|---|
_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 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. |
invitees | [invitedAuthorizedSigner] A list of zero or more invited authorized signers. If empty or omitted, the form will list only existing authorized signers. maxLength: 8
|
invitedAuthorizedSigner
{
"firstName": "Lucille",
"lastName": "Wellphunded",
"role": "Owner"
}
Invited Authorized Signer (v1.0.0)
The name and role of an individual who is being invited to the organization as an authorized signer.
Properties
Name | Description |
---|---|
firstName | string (required) The person's first name (or given name). |
middleName | string The person's middle name. |
lastName | string (required) The person's last name (or surname). |
role | string (required) The role or job title that the individual holds within the organization. |
preferredResource
"pe0"
Preferred Resource (v1.0.0)
The _id
of an address, email address, or phone number resource to set as the organization's preferred item. The _id
is represented as a JSON string. (Note: the value must be quoted.)
Properties
organizationEmailAddresses
{
"_profile": "https://api.apiture.com/schemas/organizations/organizationEmailAddresses/v1.0.0/profile.json",
"items": [
{
"_id": "pe0",
"type": "personal",
"label": "Personal",
"number": "user7838@example.com",
"state": "approved",
"_profile": "https://api.apiture.com/schemas/organizations/organizationEmailAddress/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses/pe0"
}
}
},
{
"_id": "pe2",
"type": "personal",
"label": "Personal",
"value": "John.Smith@example.com",
"state": "approved",
"_profile": "https://api.apiture.com/schemas/organizations/organizationEmailAddress/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/EmailAddresses/pe2"
}
}
}
],
"_links": {
"self": {
"href": "/organizations/organizations/f2d87aa6-33c8-458c-819b-41bb00f1ec08/emailAddresses"
}
}
}
The organization's email addresses (v1.0.0)
The list of the organization's email addresses.
Properties
Name | Description |
---|---|
_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 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 | [organizationEmailAddress] An array containing email address items. |
organizationPhoneNumber
{
"_id": "hp1",
"_profile": "https://api.apiture.com/schemas/organizations/organizationPhoneNumber/v1.0.0/profile.json",
"type": "home",
"number": "555-555-5555",
"state": "approved",
"_links": {
"self": {
"href": "/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
}
}
}
Phone Number (v1.0.0)
Representation of phone number resources.
Links
Response and request bodies using this organizationPhoneNumber
schema may contain the following links:
Rel | Summary | Method |
---|---|---|
delete | Delete this phone number resource | DELETE |
apiture:setAsPreferred | Set Preferred Phone Number | PUT |
Properties
Name | Description |
---|---|
type | phoneNumberType The type or role of this phone number. |
number | string The phone number, as a string. minLength: 8
maxLength: 16
|
label | string A text label, suitable for presentation to the end user. This is also used if type is other .
maxLength: 32
|
_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
pattern: ^[-a-zA-Z0-9_]{1,8}$
|
_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 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. |
state | profileItemState The state of this phone number. pending numbers require financial institution approval. Only approved numbers may be set as the preferred phone number.
|
organizationPhoneNumbers
{
"_profile": "https://api.apiture.com/schemas/organizations/organizationPhoneNumbers/v1.0.0/profile.json",
"items": [
{
"_id": "mp0",
"type": "mobile",
"label": "Mobile",
"number": "555-555-5555",
"state": "approved",
"_profile": "https://api.apiture.com/schemas/organization/organizationPhoneNumber/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/mp0"
}
}
},
{
"_id": "mp2",
"type": "home",
"label": "Home",
"number": "555-444-4444",
"state": "approved",
"_profile": "https://api.apiture.com/schemas/organizations/organizationPhoneNumber/v1.0.0/profile.json",
"_links": {
"self": {
"href": "/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/mp2"
}
}
}
],
"_links": {
"self": {
"href": "/useorganizationsrs/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers"
}
}
}
The organization's phone numbers (v1.0.0)
The list of the organization's phone numbers.
Properties
Name | Description |
---|---|
_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 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 | [organizationPhoneNumber] An array containing phone number items. |
profileItemState
"approved"
Organization Profile Item State (v1.0.0)
The state of an item (address, email address, or phone number) within the organization's profile. New addresses, email addresses, or phone numbers start with the state pending
, which means approval by the financial institution is pending. After they have been verified, the state becomes approved
. Some normalizing or sanitizing of the value may occur when this happens (for example, a ZIP code may change to ZIP+4 format). pending
items may not be assigned as the preferred item.
profileItemState
strings may have one of the following enumerated values values (described by the named profileItemState)
Value | Description |
---|---|
pending | Pending: A profile item that the financial institution has not yet approved. |
approved | Approved: A profile item that the financial institution has approved. |
Type: string
Enumerated values: pending
approved
regulatory
{
"estimatedAnnualRevenue": "unknown",
"atmOperator": true,
"charity": true,
"cashesChecksMoreThan1000Usd": true,
"internetGamblingIncorporated": true,
"marijuanaBusiness": true,
"moneyOrderMoreThan1000Usd": true,
"thirdPartyBenefit": true,
"transmitBehalfOfCustomer": true,
"virtualCurrency": true,
"intermediaryServices": [
"unknown"
],
"subjectToWithholdings": false,
"property1": {},
"property2": {}
}
Regulatory (v1.0.0)
Responses to regulatory-related questions.
Properties
Name | Description |
---|---|
additionalProperties | regulatoryValue The value associated with this regulatory property. |
estimatedAnnualRevenue | estimatedAnnualRevenue The range of estimated revenue in US dollars. |
atmOperator | boolean The organization operates automated teller machines (ATMs). |
charity | boolean Some of the organization's income depends on a charity. |
cashesChecksMoreThan1000Usd | boolean The organization cashes checks for customers in amounts greater than $1,000. |
internetGamblingIncorporated | boolean The organization derives income from internet gambling. |
marijuanaBusiness | boolean The organization derives income from marijuana or other drugs/controlled substances. |
moneyOrderMoreThan1000Usd | boolean Individuals at the organization may request money orders of more than $1,000. |
thirdPartyBenefit | boolean The organization processes transactions on behalf of third parties. |
transmitBehalfOfCustomer | boolean The organization transmits funds on behalf of third parties. |
virtualCurrency | boolean The organization administers or exchanges virtual currency. |
intermediaryServices | [intermediaryServices] A list of intermediary/non-bank financial institution services provided the organization performs on behalf of others. uniqueItems: true
|
subjectToWithholdings | boolean If true , the organization is subject to tax withholdings.
Default: false
|
accountPurpose
"unknown"
Account purpose (v1.0.0)
The purpose of the account.
Warning: the enum
list will be removed in a future release. and the values defined at runtime via the accountPurpose
group in the response from the getLabels
operation.
Type: string
Enumerated values: unknown
creditCardProcessing
generalOperatingFunds
lottery
payroll
savings
other
notApplicable
estimatedAnnualRevenue
"unknown"
Estimated Annual Revenue (v1.0.0)
The estimated annual revenue in USD.
Warning: the enum
list will be removed in a future release. and the values defined at runtime via the estimatedAnnualRevenue
group in the response from the getLabels
operation.
Type: string
Enumerated values: unknown
under1Million
from1to10Million
from10to100Million
over100Million
other
notApplicable
intermediaryServices
"unknown"
Intermediary Services (v1.0.0)
The intermediary/non-bank financial institution services provided.
Warning: the enum
list will be removed in a future release. and the values defined at runtime via the intermediaryServices
group in the response from the getLabels
operation.
Type: string
Enumerated values: unknown
accounting
fundsManagement
insurance
investment
legal
medical
notary
realEstate
taxPreparation
trustManagement
gambling
securities
loanFinance
pawnBrokerage
travelAgency
vehicleSales
foreignCurrency
preciousMetals
other
notApplicable
yearsOwned
"unknown"
Years Owned (v1.0.0)
The years the organization has owned/managed their business.
Warning: the enum
list will be removed in a future release. and the values defined at runtime via the yearsOwned
group in the response from the getLabels
operation.
Type: string
Enumerated values: unknown
one
two
three
fourOrMoreYears
other
notApplicable
physicalLocationsCount
"unknown"
Physical Locations (v1.0.0)
The number of physical locations, branches, offices, or sites the organization owns.
The allowed values for this property are defined at runtime in the label group named physicalLocationsCount
in the response from the getLabels
operation.
Type: string
Enumerated values: unknown
under10
from10to50
from50to100
moreThan100
other
notApplicable
createAuthorizedSigner
{
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1575c0a7b0115a4b3",
"message": "Descriptive error message...",
"statusCode": 422,
"type": "errorType1",
"remediation": "Remediation string...",
"occurredAt": "2018-01-25T05:50:52.375Z",
"errors": [
{
"_id": "ccdbe2c5c938a230667b3827",
"message": "An optional embedded error"
},
{
"_id": "dbe9088dcfe2460f229338a3",
"message": "Another optional embedded error"
}
],
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/errorType1"
}
}
},
"firstName": "string",
"middleName": "string",
"lastName": "string",
"addresses": [
{
"_id": "ha5",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "stri",
"taxId": "string",
"citizen": true,
"emailAddress": "user@example.com",
"userId": "bd9e7a93-32cc-435d-ac57-f21faa082318",
"customerId": "00047294723672",
"type": "primary",
"role": "string"
}
New Authorized Signer (v1.0.0)
The user authorized for organizational access.
Properties
Name | Description |
---|---|
_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 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. |
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
|
taxId | string Official government identification (tax ID) for this person. |
citizen | boolean Indicates if the person is a (US) citizen. |
emailAddress | string(email) Optional email address. |
userId | string The unique ID of the user. This is the _id value of the user resource from the Users API.
|
customerId | string The unique customer number, also known as the Customer Identification File number or CIF number. This derived value is assigned to the user in the banking core. The customerId differs from the _id (which is the ID of the resource in the Users API).
read-only
minLength: 1
maxLength: 100
|
type | authorizationType The type of this account access authorization.
|
role | string The person's role at the organization. This attribute is required when the authorization type is authorizedSigner. |
authorizedSigners
{
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1575c0a7b0115a4b3",
"message": "Descriptive error message...",
"statusCode": 422,
"type": "errorType1",
"remediation": "Remediation string...",
"occurredAt": "2018-01-25T05:50:52.375Z",
"errors": [
{
"_id": "ccdbe2c5c938a230667b3827",
"message": "An optional embedded error"
},
{
"_id": "dbe9088dcfe2460f229338a3",
"message": "Another optional embedded error"
}
],
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/errorType1"
}
}
},
"items": [
{
"userId": "bd9e7a93-32cc-435d-ac57-f21faa082318",
"customerId": "00047294723672",
"type": "joint",
"role": "Chief Financial Officer",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"taxId": "111-11-1111",
"citizen": true,
"addresses": [
{
"_id": "ha5",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"id": "wa0",
"type": "other",
"label": "mailing",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha5",
"emailAddress": "JohnDanielSmith@example.com"
}
]
}
Authorized Signers (v1.0.0)
The list of users who are authorized to access the organization and its bank accounts.
Properties
Name | Description |
---|---|
_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 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 | [authorization] The array of authorized signers for this business and their role within the organization. These people have account access for all business accounts owned by the business. The items in this array must all have the type of authorizedSigner .
minLength: 1
|
beneficialOwner
{
"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"
}
],
"role": "Chief Financial Officer",
"birthdate": {},
"percentage": 35,
"contactId": "8bf04d7d-c1bd-4945-b0ac-40ef02bb3953"
}
Beneficial Owner (v1.0.0)
A person who owns 25% or more of a business organization.
Properties
Name | Description |
---|---|
firstName | string (required) The person's first name (or given name). |
middleName | string The person's middle name. |
lastName | string (required) 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] (required) A collection of official identifying information associated with the contact. |
preferredContactMethod | preferredContactMethod The contact's preferred method of communication. |
role | string The person's role at the organization. |
percentage | integer (required) The percent of the business that this person owns. maximum: 100
|
birthdate | string(date) The beneficial's birth date in YYYY-MM-DD format.
|
contactId | string (required) The _id of an existing contact resource associated with the beneficial owner. Create the beneficial owner contact resource using the Contacts API.
|
beneficialOwners
{
"items": [
{
"firstName": "William",
"lastName": "Wellphunded",
"addresses": [
{
"addressLine1": "1234 S Front Street",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US",
"type": "home"
}
],
"role": "Chief Financial Officer",
"percentage": 35,
"birthdate": {},
"identification": [
{
"type": "taxId",
"value": "111-11-1111"
}
]
}
],
"_links": {
"self": {
"href": "/organizations/organizations/0399abed-fd3d-4830-a88b-30f38b8a365c/beneficialOwners"
}
}
}
Beneficial Owners (v1.0.0)
A list of people who own at least 25% of the business or who have a major role in the organization. The sum of the percentages may not exceed 100%. The percentage may be less than 25 for non-owners with a major role, or to retain other owners whose percentage may change to 25% in the future.
Properties
Name | Description |
---|---|
_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 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
|
organizationType
{}
Organization Type (v1.0.0)
The primary organization type.
The allowed values for this property are defined at runtime in the label group named organizationType
in the response from the getLabels
operation.
Properties
organizationSubtype
{}
Organization Subtype (v1.0.0)
A refinement of the organization type.
The allowed values for this property are defined at runtime in the label group named organizationSubtype
in the response from the getLabels
operation.
Properties
organizationIdentification
{
"value": "string",
"type": "taxId",
"expiresOn": "2020-06-19",
"expiration": "2020-06-19"
}
Organization Identification (v1.0.0)
The type and value of the organizations unique identification numbers.
Properties
Name | Description |
---|---|
value | string (required) The value of this form of identification (the tax ID as a string, for example) |
type | organizationIdentificationType (required) The type of this form of identification. taxId is the only supported type at this time.
|
expiresOn | string(date) The date when this form of identification expires. |
expiration | string(date) The date when this form of identification expires. Note This property is deprecated; use expiresOn .
|
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 (v1.0.0)
The simplest form of an organization.
Properties
Name | Description |
---|---|
name | string The organization's official full name |
label | string The organization's common name. |
type | organizationType Indicates what type of organization this resource represents. The enumeration values are described by the |
subtype | organizationSubtype A refinement of the type . The enumeration values are described by the |
identification | [organizationIdentification] A collection of official identifying information associated with the organization. This currently only supports government tax ID. |
addresses | [organizationAddress] An array containing address items. |
phones | [organizationPhoneNumber] An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number. |
emailAddresses | [organizationEmailAddress] An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email. |
preferredEmailAddressId | string The ID of the organization's preferred email address. This string is the _id of an email address in the emailAddresses array. This value is set with the setPreferredEmailAddress operation.
read-only
minLength: 1
maxLength: 4
|
preferredPhoneId | string The ID of organization's preferred phone number. This string is the _id of a phone number in the phones array. This value is set with the setPreferredPhoneNumber operation.
read-only
minLength: 1
maxLength: 4
|
preferredMailingAddressId | string The preferred mailing address. This string is the _id of an address in the addresses array. This value is set with the setPreferredMailingAddress operation.
read-only
minLength: 1
maxLength: 4
|
establishedDate | string(date) The date the organization was established. |
organizationIdentificationType
"taxId"
Organization Identification Type (v1.0.0)
The type of the form of an organization's identification. taxId
is the only supported type at this time.
organizationIdentificationType
strings may have one of the following enumerated values values (described by the named organizationIdentificationType)
Value | Description |
---|---|
taxId | Tax Identification Number: The company's federal Tax Identification Number. This is also known as the Employer Identification Number or EIN in the US. It may be the owner's SSN for a sole proprietorship. |
dunsNumber | Dun & Bradstreet D-U-N-S Number: Dun & Bradstreet D-U-N-S Number, a unique nine-digit identifier for businesses. |
Type: string
Enumerated values: taxId
dunsNumber
organizationState
"pending"
Organization State (v1.0.0)
The state of this organization. The enumeration values are described by the organizationState
value in the response of the getLabels
operation.
organizationState
strings may have one of the following enumerated values values (described by the named organizationState)
Value | Description |
---|---|
pending | Pending: The organization resource has been created but is not yet active; it is a draft and may be deleted. |
inactive | Inactive: The organization resource is inactive and not available for use or assignment, such as associated to business account or payee. |
active: | Active: The organization resource is inactive and not available for use or assignment, such as associated to business account or payee. |
merged | Merged: The organization resource is has been merged into another organization and is not available for use or for activating. |
removed | Removed: The inactive organization resource is has been marked as removed. |
Type: string
Enumerated values: pending
inactive
active
merged
removed
regulatoryValue
{}
Regulatory Value (v1.0.0)
The value associated with this regulatory property.
Properties
createOrganization
{
"_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
"_links": {
"apiture:user": {
"href": "/users/users/00007276-8b25-4e97-ac82-e1e17a2ff7c2"
}
}
}
Create Organization (v1.0.0)
Representation used to create a new organization.
Properties
Name | Description |
---|---|
_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 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. |
name | string (required) The organization's official full name |
label | string The organization's common name. |
type | organizationType Indicates what type of organization this resource represents. The enumeration values are described by the |
subtype | organizationSubtype A refinement of the type . The enumeration values are described by the |
identification | [organizationIdentification] A collection of official identifying information associated with the organization. This currently only supports government tax ID. |
addresses | [organizationAddress] An array containing address items. |
phones | [organizationPhoneNumber] An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number. |
emailAddresses | [organizationEmailAddress] An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email. |
preferredEmailAddressId | string The ID of the organization's preferred email address. This string is the _id of an email address in the emailAddresses array. This value is set with the setPreferredEmailAddress operation.
read-only
minLength: 1
maxLength: 4
|
preferredPhoneId | string The ID of organization's preferred phone number. This string is the _id of a phone number in the phones array. This value is set with the setPreferredPhoneNumber operation.
read-only
minLength: 1
maxLength: 4
|
preferredMailingAddressId | string The preferred mailing address. This string is the _id of an address in the addresses array. This value is set with the setPreferredMailingAddress operation.
read-only
minLength: 1
maxLength: 4
|
establishedDate | string(date) The date the organization was established. |
state | organizationState The state of this organization. The enumeration values are described by the organizationState value in the response of the getLabels operation.
|
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. |
employeeCountRange | string Indicates the approximate number of employees, as a range. The allowed values for this property are defined at runtime in the label group named |
employeeCountLowerBound | integer The lower bound of persons employed, derived from the range selected in employeeCountRange .
read-only
minimum: 1
|
employeeCountUpperBound | number The lower bound of persons employed, derived from the range selected in employeeCountRange .
read-only
maximum: 20000000
|
homeUrl | string The organization's home page. |
industry | string Indicates what industry does this organization work within. The allowed values for this property are defined at runtime in the label group named |
countryOfOperations | string The ISO 3166-1 country code for the organization's operation. minLength: 2
maxLength: 2
|
regulatory | regulatory 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
|
mobileCheckDepositEnabled | boolean Indicates that the organization use mobile check deposits. |
achEnabled | boolean Indicates that the organization use ACH transfers. |
estimatedMonthlyAmounts | estimatedMonthlyAmounts Estimated monthly amounts for banking services. |
accountPurpose | accountPurpose The purpose of the account. |
registeredIn | string (required) The US state or other region in which the organization is registered. The allowed values for this property are defined at runtime in the label group named |
attributes | object An optional map of name/value pairs which provide additional metadata about the organization. |
estimatedMonthlyAmounts
{
"percentGrossRevenue": "string",
"sentAch": "upToOneHundredThousand",
"receivedAch": "oneHundredThousandToOneMillion",
"mobileCheckDeposit": "oneHundredThousandToOneMillion",
"sentWire": "oneHundredThousandToOneMillion",
"receivedWire": "moreThanOneMillion"
}
Estimated Monthly Amounts (v1.0.0)
Estimated monthly amounts for banking services.
Properties
Name | Description |
---|---|
percentGrossRevenue | string The percentage of gross revenue the organization derives from money services. The allowed values for this property are defined at runtime in the label group named |
sentAch | string Indicates the estimated monthly total amount to send by ACH. The allowed values for this property are defined at runtime in the label group named |
receivedAch | string Indicates the estimated monthly total amount to receive by ACH. The allowed values for this property are defined at runtime in the label group named |
mobileCheckDeposit | string Indicates the estimated monthly minimum amount to deposit. The allowed values for this property are defined at runtime in the label group named |
sentWire | string Indicates the estimated monthly minimum wires amount sent. The allowed values for this property are defined at runtime in the label group named |
receivedWire | string Indicates the estimated monthly minimum wires amount received. The allowed values for this property are defined at runtime in the label group named |
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 (v1.0.0)
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 | 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 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. |
name | string The organization's official full name |
label | string The organization's common name. |
type | organizationType Indicates what type of organization this resource represents. The enumeration values are described by the |
subtype | organizationSubtype A refinement of the type . The enumeration values are described by the |
identification | [organizationIdentification] A collection of official identifying information associated with the organization. This currently only supports government tax ID. |
addresses | [organizationAddress] An array containing address items. |
phones | [organizationPhoneNumber] An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number. |
emailAddresses | [organizationEmailAddress] An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email. |
preferredEmailAddressId | string The ID of the organization's preferred email address. This string is the _id of an email address in the emailAddresses array. This value is set with the setPreferredEmailAddress operation.
read-only
minLength: 1
maxLength: 4
|
preferredPhoneId | string The ID of organization's preferred phone number. This string is the _id of a phone number in the phones array. This value is set with the setPreferredPhoneNumber operation.
read-only
minLength: 1
maxLength: 4
|
preferredMailingAddressId | string The preferred mailing address. This string is the _id of an address in the addresses array. This value is set with the setPreferredMailingAddress operation.
read-only
minLength: 1
maxLength: 4
|
establishedDate | string(date) The date the organization was established. |
state | organizationState The state of this organization. The enumeration values are described by the organizationState value in the response of the getLabels operation.
|
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. |
employeeCountRange | string Indicates the approximate number of employees, as a range. The allowed values for this property are defined at runtime in the label group named |
employeeCountLowerBound | integer The lower bound of persons employed, derived from the range selected in employeeCountRange .
read-only
minimum: 1
|
employeeCountUpperBound | number The lower bound of persons employed, derived from the range selected in employeeCountRange .
read-only
maximum: 20000000
|
homeUrl | string The organization's home page. |
industry | string Indicates what industry does this organization work within. The allowed values for this property are defined at runtime in the label group named |
countryOfOperations | string The ISO 3166-1 country code for the organization's operation. minLength: 2
maxLength: 2
|
regulatory | regulatory 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
|
mobileCheckDepositEnabled | boolean Indicates that the organization use mobile check deposits. |
achEnabled | boolean Indicates that the organization use ACH transfers. |
estimatedMonthlyAmounts | estimatedMonthlyAmounts Estimated monthly amounts for banking services. |
accountPurpose | accountPurpose The purpose of the account. |
registeredIn | string The US state or other region in which the organization is registered. The allowed values for this property are defined at runtime in the label group named |
_id | string The unique identifier for this organization resource. This is an immutable opaque string. read-only
|
customerId | string The unique customer number, also known as the Customer Identification File number or CIF number. This derived value is assigned to the organization in the banking core. The customerId differs from the _id (which is the ID of the resource in the Organizations API).
read-only
minLength: 1
maxLength: 100
|
organization
{
"_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"customerId": "000489353781",
"_profile": "https://api.apiture.com/schemas/organizations/organization/v1.0.0/profile.json",
"name": "Smith's Auto Detailing",
"label": "Smith's Detailing",
"tradeName": "Smith's Auto Detailing",
"emailAddresses": [
{
"_id": "ea0",
"type": "work",
"value": "smitties-detailing@example.com"
}
],
"preferredEmailAddressId": "ea0",
"phones": [
{
"type": "work",
"number": "(555) 555-5555",
"_id": "wp0"
},
{
"type": "mobile",
"number": "(999) 555-5555",
"_id": "wp1"
}
],
"preferredPhoneNumberId": "wp0",
"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"
}
],
"preferredMailingAddressId": "wa0",
"establishedDate": "2009-07-09T",
"identification": [
{
"type": "taxId",
"value": "00-9999999"
}
],
"state": "active",
"governmentOwned": false,
"registeredIn": "NC",
"publiclyHeld": false,
"smallBusiness": true,
"taxExempt": false,
"currency": "USD",
"estimatedAnnualRevenue": "from1to10Million",
"estimatedMonthlyAmounts": {
"sentWire": "moreThanOneMillion",
"receivedWire": "oneHundredThousandToOneMillion",
"mobileCheckDeposit": "upToOneHundredThousand",
"receivedAch": "upToOneHundredThousand",
"sentAch": "moreThanOneMillion"
},
"type": "corporation",
"subtype": "soleProprietorship",
"employeeCountLowerBound": 1,
"employeeCountUpperBound": 1,
"countryOfOperations": "US",
"physicalLocationsCount": "under10",
"mobileCheckDepositEnabled": true,
"achEnabled": true,
"authorizedSigners": [],
"beneficialOwners": [],
"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 (v1.0.0)
Representation of content and descriptive data (mailing addresses, phone numbers, email addresses) for an organization.
An organization which is used for a business banking account may have authorized signers, which are people authorized to perform banking operations on the business account(s) such as initiating funds transfers.
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 pending or active).apiture:remove
- Remove an inactive organization.apiture:authorizedSigners
- List the authorized signers.apiture:beneficialOwners
- List the beneficial owners.
Properties
Name | Description |
---|---|
_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, as selected with the ?embed query parameter.
|
» authorizedSigners | authorizedSigners The list of users who are authorized to access the organization and its bank accounts. |
» beneficialOwners | beneficialOwners A list of people who own at least 25% of the business or who have a major role in the organization. The sum of the percentages may not exceed 100%. The percentage may be less than 25 for non-owners with a major role, or to retain other owners whose percentage may change to 25% in the future. |
_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. |
name | string The organization's official full name |
label | string The organization's common name. |
type | organizationType Indicates what type of organization this resource represents. The enumeration values are described by the |
subtype | organizationSubtype A refinement of the type . The enumeration values are described by the |
identification | [organizationIdentification] A collection of official identifying information associated with the organization. This currently only supports government tax ID. |
addresses | [organizationAddress] An array containing address items. |
phones | [organizationPhoneNumber] An array of phone numbers associated with the organization. The first item, if present, is the default (preferred) organization phone number. |
emailAddresses | [organizationEmailAddress] An array of email addresses associated with the organization. The first item, if present, is the default (preferred) organization email. |
preferredEmailAddressId | string The ID of the organization's preferred email address. This string is the _id of an email address in the emailAddresses array. This value is set with the setPreferredEmailAddress operation.
read-only
minLength: 1
maxLength: 4
|
preferredPhoneId | string The ID of organization's preferred phone number. This string is the _id of a phone number in the phones array. This value is set with the setPreferredPhoneNumber operation.
read-only
minLength: 1
maxLength: 4
|
preferredMailingAddressId | string The preferred mailing address. This string is the _id of an address in the addresses array. This value is set with the setPreferredMailingAddress operation.
read-only
minLength: 1
maxLength: 4
|
establishedDate | string(date) The date the organization was established. |
state | organizationState The state of this organization. The enumeration values are described by the organizationState value in the response of the getLabels operation.
|
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. |
employeeCountRange | string Indicates the approximate number of employees, as a range. The allowed values for this property are defined at runtime in the label group named |
employeeCountLowerBound | integer The lower bound of persons employed, derived from the range selected in employeeCountRange .
read-only
minimum: 1
|
employeeCountUpperBound | number The lower bound of persons employed, derived from the range selected in employeeCountRange .
read-only
maximum: 20000000
|
homeUrl | string The organization's home page. |
industry | string Indicates what industry does this organization work within. The allowed values for this property are defined at runtime in the label group named |
countryOfOperations | string The ISO 3166-1 country code for the organization's operation. minLength: 2
maxLength: 2
|
regulatory | regulatory 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
|
mobileCheckDepositEnabled | boolean Indicates that the organization use mobile check deposits. |
achEnabled | boolean Indicates that the organization use ACH transfers. |
estimatedMonthlyAmounts | estimatedMonthlyAmounts Estimated monthly amounts for banking services. |
accountPurpose | accountPurpose The purpose of the account. |
registeredIn | string The US state or other region in which the organization is registered. The allowed values for this property are defined at runtime in the label group named |
_id | string The unique identifier for this organization resource. This is an immutable opaque string. read-only
|
customerId | string The unique customer number, also known as the Customer Identification File number or CIF number. This derived value is assigned to the organization in the banking core. The customerId differs from the _id (which is the ID of the resource in the Organizations API).
read-only
minLength: 1
maxLength: 100
|
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 (v1.0.0)
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 | 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. |
» 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 may 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://production.api.apiture.com/schemas/common/root/v2.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 | 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 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. read-only
|
name | string This API's name. |
apiVersion | string This API's version. |
labelGroups
{
"_profile": "https://production.api.apiture.com/schemas/common/labelGroups/v1.0.0/model.json",
"groups": {
"structure": {
"unknown": {
"label": "Unknown",
"code": "0",
"hidden": true
},
"corporation": {
"label": "Corporation",
"code": "1",
"variants": {
"fr": {
"label": "Soci\\u00e9t\\u00e9"
}
}
},
"partnership": {
"label": "Partnership",
"code": "2",
"variants": {
"fr": {
"label": "Partenariat"
}
}
},
"llc": {
"label": "Limited Liability Company",
"code": "2",
"variants": {
"fr": {
"label": "Soci\\u00e9t\\u00e9 \\u00e9 Responsabilit\\u00e9 Limit\\u00e9e"
}
}
},
"nonProfit": {
"label": "Non Profit",
"code": "4",
"variants": {
"fr": {
"label": "Non Lucratif"
}
}
},
"financialInstitution": {
"label": "Financial Institution",
"code": "8",
"variants": {
"fr": {
"label": "Institution financi\\u00e8re"
}
}
},
"soleProprietorship": {
"label": "Sole Proprietorship",
"code": "11",
"variants": {
"fr": {
"label": "Entreprise individuelle"
}
}
},
"other": {
"label": "Other",
"code": "254",
"variants": {
"fr": {
"label": "Autre"
}
}
}
},
"estimatedAnnualRevenue": {
"unknown": {
"label": "Unknown",
"code": "0"
},
"under1Million": {
"label": "Under $1M",
"code": "1",
"range": "[0,1000000.00)"
},
"from1to10Million": {
"label": "$1M to $10M",
"code": "2",
"range": "[1000000.00,10000000.00)"
},
"from10to100Million": {
"label": "$10M to $100M",
"code": "3",
"range": "[10000000.00,100000000.00)"
},
"over100Million": {
"label": "Over $100,000,000.00",
"code": "4",
"range": "[100000000.00,]"
},
"other": {
"label": "Other",
"code": "254"
}
}
}
}
Label Groups
A set of named groups of labels, each of which contains multiple item labels.
The abbreviated example shows two groups, one named structure
and one named estimatedAnnualRevenue
. The first has items with names such as corporation
, llc
and soleProprietorship
, with text labels for each in the default and in French. The second has items for estimated revenue ranges but no localized labels. For example, the item named from1to10Million
has the label
"$1M to $10M" and the range [1000000.00,10000000.00)
.
Properties
Name | Description |
---|---|
_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 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. |
groups | object Groups of localized labels. This maps group names → a group of labels within that group. |
» additionalProperties | labelGroup A map that defines labels for the items in a group. This is a map from each item name → a labelItem object. For example, consider a JSON response that includes a property named revenueEstimate ; the values for revenueEstimate must be one of the items in the group named estimatedAnnualRevenue , with options ranging under1Million , to over100Million . The item name is used as the selected value in an Apiture representation, such as { ..., "revenueEstimate" : "from10to100Million" , ...} , and the item with the name from10to100Million defines the presentation labels for that item, as well as other metadata about that choice: this is the range [10000000.00,100000000.00) . This allows the client to let the user select a value from a list, such as the following derivde from the labels in the example:
Note that the |
errorResponse
{
"_profile": "https://api.apiture.com/schemas/common/errorResponse/v2.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 | 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 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. |
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 | addressType (required) The type of this address. |
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
minLength: 4
maxLength: 32
|
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. minLength: 4
maxLength: 128
|
addressLine2 | string The optional second street address line of the address. maxLength: 128
|
city | string The name of the city or municipality. minLength: 2
maxLength: 128
|
regionCode | string The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase. minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]{2}$
|
postalCode | string The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code. minLength: 5
maxLength: 10
pattern: ^[0-9]{5}(?:-[0-9]{4})?$
|
countryCode | string The ISO 3166-1 alpha-2 country code. This is normalized to uppercase. minLength: 2
maxLength: 2
pattern: ^[a-zA-Z]{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
pattern: ^[-a-zA-Z0-9_]{1,8}$
|
abstractResource
{
"_profile": "{uri of resource profile.json}",
"_links": {
"self": {
"href": "{uri of current resource}"
}
}
}
Abstract Resource
An abstract schema used to define other schemas for request and response bodies. This is a HAL resource representation. This model contains hypermedia _links
, and either optional domain object data with _profile
and optional _embedded
objects, or an _error
object. In responses, if the operation was successful, this object will not include the _error
, but if the operation was a 4xx or 5xx error, this object will not include _embedded
or any data fields, only _error
and optionally _links
.
Properties
Name | Description |
---|---|
_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 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. |
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 | emailType The kind of email address. |
_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
pattern: ^[-a-zA-Z0-9_]{1,8}$
|
phoneNumber
{
"_id": "hp1",
"type": "home",
"number": "555-555-5555"
}
Phone Number
A phone number and its role.
Properties
Name | Description |
---|---|
type | phoneNumberType (required) The type or role of this phone number. |
number | string (required) The phone number, as a string. minLength: 8
maxLength: 16
|
label | string A text label, suitable for presentation to the end user. This is also used if type is other .
maxLength: 32
|
_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
pattern: ^[-a-zA-Z0-9_]{1,8}$
|
createAuthorization
{
"type": "joint",
"role": "Chief Financial Officer",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"taxId": "111-11-1111",
"citizen": true,
"addresses": [
{
"_id": "ha5",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"id": "wa0",
"type": "other",
"label": "mailing",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha5",
"emailAddress": "JohnDanielSmith@example.com",
"_links": {
"apiture:user": {
"href": "/users/users/bd9e7a93-32cc-435d-ac57-f21faa082318"
}
}
}
Create Authorization
The object representation of a newly created authorization. The fields listed will assist in the information needed to gain access to a bank account or organization. A link to the user must be passed in _links as apiture:user
for implementations of this object as it explains the direct association.
Properties
Name | Description |
---|---|
_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 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. |
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
|
taxId | string Official government identification (tax ID) for this person. |
citizen | boolean Indicates if the person is a (US) citizen. |
emailAddress | string(email) Optional email address. |
userId | string The unique ID of the user. This is the _id value of the user resource from the Users API.
|
customerId | string The unique customer number, also known as the Customer Identification File number or CIF number. This derived value is assigned to the user in the banking core. The customerId differs from the _id (which is the ID of the resource in the Users API).
read-only
minLength: 1
maxLength: 100
|
type | authorizationType The type of this account access authorization.
|
role | string The person's role at the organization. This attribute is required when the authorization type is authorizedSigner. |
authorization
{
"userId": "bd9e7a93-32cc-435d-ac57-f21faa082318",
"customerId": "00047294723672",
"type": "joint",
"role": "Chief Financial Officer",
"firstName": "John",
"middleName": "Daniel",
"lastName": "Smith",
"taxId": "111-11-1111",
"citizen": true,
"addresses": [
{
"_id": "ha5",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
},
{
"id": "wa0",
"type": "other",
"label": "mailing",
"addressLine1": "123 S 3rd Street",
"addressLine2": "Apt 42",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28411-5405",
"countryCode": "US"
}
],
"preferredMailingAddressId": "ha5",
"emailAddress": "JohnDanielSmith@example.com"
}
Authorization
Represents a person authorized for account access. This object contains key identification information for the person and the type of access or role that the person has in relation to the banking account or organization.
Properties
Name | Description |
---|---|
firstName | string (required) The person's first name (or given name). |
middleName | string The person's middle name. |
lastName | string (required) The person's last name (or surname). |
addresses | [address] (required) 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
|
taxId | string (required) Official government identification (tax ID) for this person. |
citizen | boolean (required) Indicates if the person is a (US) citizen. |
emailAddress | string(email) Optional email address. |
userId | string (required) The unique ID of the user. This is the _id value of the user resource from the Users API.
|
customerId | string (required) The unique customer number, also known as the Customer Identification File number or CIF number. This derived value is assigned to the user in the banking core. The customerId differs from the _id (which is the ID of the resource in the Users API).
read-only
minLength: 1
maxLength: 100
|
type | authorizationType (required) The type of this account access authorization.
|
role | string The person's role at the organization. This attribute is required when the authorization type is authorizedSigner. |
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"
}
],
"preferredPhoneId": "hp1",
"preferredContactMethod": "email"
}
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. |
preferredContactMethod | preferredContactMethod The contact's preferred method of communication. |
collection
{
"_links": {
"property1": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
},
"property2": {
"href": "/contacts/contacts/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
"title": "Applicant"
}
},
"_embedded": {},
"_profile": "http://example.com",
"_error": {
"_id": "2eae46e1575c0a7b0115a4b3",
"message": "Descriptive error message...",
"statusCode": 422,
"type": "errorType1",
"remediation": "Remediation string...",
"occurredAt": "2018-01-25T05:50:52.375Z",
"errors": [
{
"_id": "ccdbe2c5c938a230667b3827",
"message": "An optional embedded error"
},
{
"_id": "dbe9088dcfe2460f229338a3",
"message": "Another optional embedded error"
}
],
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/errorType1"
}
}
},
"count": 0,
"start": 0,
"limit": 0,
"name": "string"
}
Collection
A collection of resources. This is an abstract model schema which is extended to define specific resource collections.
Properties
Name | Description |
---|---|
_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 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. |
count | integer The number of items in the collection. This value is optional and may 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. |
labelGroup
{
"unknown": {
"label": "Unknown",
"code": "0",
"hidden": true
},
"under1Million": {
"label": "Under $1M",
"code": "1",
"range": "[0,1000000.00)",
"variants": {
"fr": {
"label": "Moins de $1M"
}
}
},
"from1to10Million": {
"label": "$1M to $10M",
"code": "2",
"range": "[1000000.00,10000000.00)",
"variants": {
"fr": {
"label": "$1M \\u00e0 $10M"
}
}
},
"from10to100Million": {
"label": "$10M to $100M",
"code": "3",
"range": "[10000000.00,100000000.00)",
"variants": {
"fr": [
"label $10M \\u00e0 $100M"
]
}
},
"over100Million": {
"label": "Over $100,000,000.00",
"code": "4",
"range": "[100000000.00,]",
"variants": {
"fr": {
"label": "Plus de $10M"
}
}
},
"other": {
"label": "Other",
"code": 254
}
}
Label Group
A map that defines labels for the items in a group. This is a map from each item name → a labelItem
object. For example, consider a JSON response that includes a property named revenueEstimate
; the values for revenueEstimate
must be one of the items in the group named estimatedAnnualRevenue
, with options ranging under1Million
, to over100Million
. The item name is used as the selected value in an Apiture representation, such as { ..., "revenueEstimate" : "from10to100Million" , ...}
, and the item with the name from10to100Million
defines the presentation labels for that item, as well as other metadata about that choice: this is the range [10000000.00,100000000.00)
.
This allows the client to let the user select a value from a list, such as the following derivde from the labels in the example:
- Unknown
- Under $1M
- $1M to $10M
- $10M to $100M
- $100M or more
Note that the other
item is hidden from the selection list, as that item is marked as hidden
. For items which define numeric ranges, a client may instead let the customer directly enter their estimated annual revenue as a number, such as 4,500,000.00. The client can then match that number to one of ranges in the items and set the revenueEstimate
to the corresponding item's name: { ..., "revenueEstimate" : "from1to10Million", ... }
.
Properties
Name | Description |
---|---|
additionalProperties | labelItem An item in a labelGroup , with a set of variants which contains different localized labels for the item. Each (simpleLabel ) variant defines the presentation text label and optional description for a language. Items may also have a lookup code to map to external syststems, a numeric range, and a hidden boolean to indicate the item is normally hidden in the UI.
|
authorizationType
"primary"
Account Authorization type
The type of this account access authorization.
primary
the person is the primary owner of a personal account. There may be only one primary owner.joint
the person is a non-primary joint owner of a personal account.authorizedSigner
the person is an authorized signer for all business accounts owned by the organization.
Type: string
Enumerated values: primary
joint
authorizedSigner
phoneNumberType
"unknown"
Phone Number Type
The type or role of this phone number.
Warning: the enum
list will be removed in a future release. and the values defined at runtime via the phoneNumberType
label group in the response from the getLabels
operation.
Type: string
Enumerated values: unknown
home
work
mobile
fax
other
addressType
"unknown"
Address Type
The type of a postal address.
Warning: the enum
list will be removed in a future release. and the values defined at runtime via the addressType
label group in the response from the getLabels
operation.
Type: string
Enumerated values: unknown
home
prior
work
school
mailing
vacation
shipping
billing
headquarters
commercial
site
property
other
notApplicable
abstractRequest
{
"_profile": "{uri of resource profile.json}",
"_links": {
"self": {
"href": "{uri of current resource}"
}
}
}
Abstract Request
An abstract schema used to define other request-only schemas. This is a HAL resource representation, minus the _error
defined in abstractResource
.
Properties
Name | Description |
---|---|
_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 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
{
"_id": "2eae46e1575c0a7b0115a4b3",
"message": "Descriptive error message...",
"statusCode": 422,
"type": "errorType1",
"remediation": "Remediation string...",
"occurredAt": "2018-01-25T05:50:52.375Z",
"errors": [
{
"_id": "ccdbe2c5c938a230667b3827",
"message": "An optional embedded error"
},
{
"_id": "dbe9088dcfe2460f229338a3",
"message": "Another optional embedded error"
}
],
"_links": {
"describedby": {
"href": "https://developer.apiture.com/errors/errorType1"
}
}
}
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. read-only
|
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. |
errors | [error] An optional array of nested error objects. This property is not always present. |
_links | links An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.
|
emailType
"unknown"
Email Type
The kind of email address.
Warning: the enum
list will be removed in a future release. and the values defined at runtime via the emailType
label group in the response from the getLabels
operation.
Type: string
Enumerated values: unknown
personal
work
school
other
notApplicable
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.
|
attributes
{
"property1": {},
"property2": {}
}
Attributes
An optional map of name/value pairs which contains additional dynamic data about the resource.
Properties
Name | Description |
---|---|
additionalProperties | attributeValue The data associated with this attribute. |
labelItem
{
"over100Million": {
"label": "Over $100,000,000.00",
"code": "4",
"range": "[100000000.00,]",
"variants": {
"fr": {
"label": "Plus de $10M"
}
}
}
}
Label Item
An item in a labelGroup
, with a set of variants
which contains different localized labels for the item. Each (simpleLabel
) variant defines the presentation text label and optional description for a language. Items may also have a lookup code
to map to external syststems, a numeric range, and a hidden
boolean to indicate the item is normally hidden in the UI.
Properties
Name | Description |
---|---|
label | string A label or title which may be used as labels or other UI controls which present a value. |
description | string A more detailed localized description of a localizable label. |
variants | object The language-specific variants of this label. The keys in this object are RFC 7231 language codes. |
» additionalProperties | simpleLabel A text label and optional description. |
code | string If the localized value is associated with an external standard or definition, this is a lookup code or key or URI for that value. minLength: 1
|
hidden | boolean If true , this item is normally hidden from the User Interface.
|
range | string The range of values, if the item describes a bounded numeric value. This is range notation such as [min,max] , (exclusiveMin,max] , [min,exclusiveMax) , or (exclusiveMin,exclusiveMax) . For example, [0,100) is the range greater than or equal to 0 and less than 100. If the min or max value are omitted, that end of the range is unbounded. For example, (,1000.00) means less than 1000.00 and [20000.00,] means 20000.00 or more. The ranges do not overlap or have gaps.
pattern: ^[\[\(](-?(0|[1-9][0-9]*)(\.[0-9]+)?)?,(-?(0|[1-9][0-9]*)(\.[0-9]+)?)?[\]\)]$
|
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.
|
expiration | string(date) The date when the form of identification expires, in RFC 3339 YYYY-MM-DD format.
|
preferredContactMethod
"unknown"
Preferred Contact Method
The contact's preferred method of communication.
Type: string
Enumerated values: unknown
sms
email
other
notApplicable
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. |
attributeValue
{}
Attribute Value
The data associated with this attribute.
Properties
simpleLabel
{
"label": "Board of Directors",
"description": "string"
}
Simple Label
A text label and optional description.
Properties
Name | Description |
---|---|
label | string (required) A label or title which may be used as labels or other UI controls which present a value. |
description | string A more detailed localized description of a localizable label. |