Organizations v0.38.0

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.

addressMustNotBePreferred

Description: Can not delete the preferred address.
Remediation: Change the organization’s preferred address to another item in order to delete this one.

addressNotFound

Description: No Address was found for the specified addressId.
Remediation: Ensure the supplied addressId corresponds to an address resource.

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.

authorizedSignerNotFound

Description: No authorized signer was found for the specified {authorizedSigner}.
Remediation: Ensure the supplied {authorizedSigner} corresponds to an authorized signer resource.

beneficialOwnerNotFound

Description: No beneficial owner was found for the specified {beneficialOwner}.
Remediation: Ensure the supplied {beneficialOwner} corresponds to a beneficial owner resource.

beneficialOwnersPercentageExceed100

Description: The sum of beneficial owners percentages exceeds 100.
Remediation: Adjust the percentages to total 100 or less.

cannotReplaceTaxAddressWithPoBox

Description: The financial institution may require using a physical address when creating a new address to replace the organization's tax address.
Remediation: Use either a physical address, or do not use the new address to replace the tax address.

duplicateTaxId

Description: There is another organization with the TaxId.
Remediation: Send a unique TaxId.

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.

emailAddressNotFound

Description: No Email Address was found for the specified emailAddressId.
Remediation: Ensure the supplied emailAddressId corresponds to an email address resource.

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

itemStillPending

Description: The selected item cannot be assigned as preferred profile data because it is still pending.
Remediation: Pass the _id of an approved profile item.

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.

noSuchProfileValue

Description: The selected profile value _id does not exist.
Remediation: Pass the _id of an existing item.

organizationNotFound

Description: No Organization was found for the specified organizationId.
Remediation: Ensure the supplied organizationId corresponds to an organization 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.

phoneNumberNotFound

Description: No Phone Number was found for the specified phoneNumberId.
Remediation: Ensure the supplied phoneNumberId corresponds to an phone number resource.

postOfficeBoxNotAllowedForTaxAddress

Description: The financial institution does not allow setting the tax address to a P.O. box.
Remediation: Select an approved physical address for the tax address.

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

tooManyBeneficialOwners

Description: There are too many beneficial owners.
Remediation: The number of beneficial owners must be 10 or less.

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.

Download OpenAPI Definition (YAML)

Base URLs:

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

Email: Apiture Web: Apiture

Authentication

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

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

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

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. `array[string]` 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

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizations/v1.6.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations?start=10&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/organizations/organizations?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/organizations/organizations?start=20&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/organizations/organizations"
    }
  },
  "start": 0,
  "limit": 10,
  "count": 10,
  "name": "organizations",
  "_embedded": {
    "items": {
      "0": {
        "_id": "331af113-8f7b",
        "name": "Cause for Paws",
        "label": "Cause for Paws",
        "type": "trust",
        "state": "pending",
        "_profile": "https://production.api.apiture.com/schemas/organizations/summaryOrganization/v1.6.0/profile.json",
        "_links": {
          "self": {
            "href": "https://production.api.apiture.com/organizations/organizations/331af113-8f7b"
          },
          "apiture:activate": {
            "href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=331af113-8f7b"
          }
        }
      },
      "1": {
        "_id": "a1a6bbef-ac51",
        "name": "Cause for Paws",
        "label": "Cause for Paws",
        "type": "nonprofit",
        "state": "pending",
        "_profile": "https://production.api.apiture.com/schemas/organizations/summaryOrganization/v1.6.0/profile.json",
        "_links": {
          "self": {
            "href": "https://production.api.apiture.com/organizations/organizations/a1a6bbef-ac51"
          },
          "apiture:activate": {
            "href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=a1a6bbef-ac51"
          }
        }
      }
    }
  }
}

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 _error field in the response will contain details about the request error.

This error response may have one of the following type values:

malformedRequestBodyBadRequest

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://production.api.apiture.com/schemas/organizations/createOrganization/v1.6.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:user": {
      "href": "https://api.devbank.apiture.com/users/users/00007276-8b25-4e97-ac82-e1e17a2ff7c2"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": {
    "0": {
      "type": "work",
      "value": "smitties-detailing@example.com"
    }
  },
  "identification": {
    "0": {
      "type": "taxId",
      "value": "00-9999999"
    }
  },
  "phones": {
    "0": {
      "type": "work",
      "number": "+19105550155"
    },
    "1": {
      "type": "mobile",
      "number": "+19105550154"
    }
  },
  "addresses": {
    "0": {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 101,
  "employeeCountUpperBound": 250,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": "trustManagement",
    "subjectToWithholdings": true
  }
}';
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://production.api.apiture.com/schemas/organizations/createOrganization/v1.6.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:user": {
      "href": "https://api.devbank.apiture.com/users/users/00007276-8b25-4e97-ac82-e1e17a2ff7c2"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": {
    "0": {
      "type": "work",
      "value": "smitties-detailing@example.com"
    }
  },
  "identification": {
    "0": {
      "type": "taxId",
      "value": "00-9999999"
    }
  },
  "phones": {
    "0": {
      "type": "work",
      "number": "+19105550155"
    },
    "1": {
      "type": "mobile",
      "number": "+19105550154"
    }
  },
  "addresses": {
    "0": {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 101,
  "employeeCountUpperBound": 250,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": "trustManagement",
    "subjectToWithholdings": true
  }
}

Parameters

Parameter	Description
`body` (body)	`createOrganization` (required) The data necessary to create a new organization.

Try It

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organization/v1.7.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/0399abed-fd3d"
    },
    "apiture:deactivate": {
      "href": "https://api.devbank.apiture.com/organizations/inactiveOrganizations?organization=0399abed-fd3d"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": {
    "0": {
      "type": "work",
      "value": "smitties-detailing@example.com",
      "_id": "ea0"
    }
  },
  "identification": {
    "0": {
      "type": "taxId",
      "value": "00-9999999"
    }
  },
  "phones": {
    "0": {
      "type": "work",
      "number": "+19105550155",
      "_id": "wp0"
    },
    "1": {
      "type": "mobile",
      "number": "+191055501554",
      "_id": "wp1"
    }
  },
  "addresses": {
    "0": {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 1,
  "employeeCountUpperBound": 1,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": {
      "0": "trustManagement"
    },
    "subjectToWithholdings": true
  },
  "_id": "0399abed-fd3d",
  "customerId": "1000489353781",
  "tradeName": "Smith's Auto Detailing",
  "preferredEmailAddressId": "ea0",
  "preferredPhoneNumberId": "wp0",
  "preferredMailingAddressId": "wa0",
  "governmentOwned": false,
  "registeredIn": "NC",
  "publiclyHeld": false,
  "smallBusiness": true,
  "taxExempt": false,
  "type": "corporation",
  "subtype": "soleProprietorship",
  "countryOfOperations": "US",
  "authorizedSigners": {},
  "beneficialOwners": {},
  "coreBanking": {
    "finxact": {
      "customerGroup": "--64964c9c8e8f----2d-5e-",
      "partyOrgId": "--4WS6lkgjD4u-----5F-Bg-"
    }
  },
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_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 _error field in the response will contain details about the request error.

This error response may have one of the following type values:

malformedRequestBodyBadRequest

Schema: errorResponse

Status Description

409 Conflict

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: An organization with the associated taxId already exists. The `state` of a `removed` organization may not be changed. The `state` cannot be updated via a `PUT` or `POST` request. Please use the appropriate endpoint to change the state. Some key fields of the organization record may not be changed or removed, such as their `taxId`. This error response may have one of the following `type` values: `duplicateTaxId` `invalidOrganizationState`

Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:

An organization with the associated taxId already exists.
The state of a removed organization may not be changed.
The state cannot be updated via a PUT or POST request. Please use the appropriate endpoint to change the state.
Some key fields of the organization record may not be changed or removed, such as their taxId.

This error response may have one of the following type values:

duplicateTaxId
invalidOrganizationState

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. This value is the `_id` of the organization.
`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]` , comma (`,`) delimited items 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
array[string] values: authorizedSigners, beneficialOwners|

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organization/v1.7.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/0399abed-fd3d"
    },
    "apiture:deactivate": {
      "href": "https://api.devbank.apiture.com/organizations/inactiveOrganizations?organization=0399abed-fd3d"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": {
    "0": {
      "type": "work",
      "value": "smitties-detailing@example.com",
      "_id": "ea0"
    }
  },
  "identification": {
    "0": {
      "type": "taxId",
      "value": "00-9999999"
    }
  },
  "phones": {
    "0": {
      "type": "work",
      "number": "+19105550155",
      "_id": "wp0"
    },
    "1": {
      "type": "mobile",
      "number": "+191055501554",
      "_id": "wp1"
    }
  },
  "addresses": {
    "0": {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 1,
  "employeeCountUpperBound": 1,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": {
      "0": "trustManagement"
    },
    "subjectToWithholdings": true
  },
  "_id": "0399abed-fd3d",
  "customerId": "1000489353781",
  "tradeName": "Smith's Auto Detailing",
  "preferredEmailAddressId": "ea0",
  "preferredPhoneNumberId": "wp0",
  "preferredMailingAddressId": "wa0",
  "governmentOwned": false,
  "registeredIn": "NC",
  "publiclyHeld": false,
  "smallBusiness": true,
  "taxExempt": false,
  "type": "corporation",
  "subtype": "soleProprietorship",
  "countryOfOperations": "US",
  "authorizedSigners": {},
  "beneficialOwners": {},
  "coreBanking": {
    "finxact": {
      "customerGroup": "--64964c9c8e8f----2d-5e-",
      "partyOrgId": "--4WS6lkgjD4u-----5F-Bg-"
    }
  },
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_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 {organizationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound

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 = '{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organization/v1.7.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/0399abed-fd3d"
    },
    "apiture:deactivate": {
      "href": "https://api.devbank.apiture.com/organizations/inactiveOrganizations?organization=0399abed-fd3d"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": {
    "0": {
      "type": "work",
      "value": "smitties-detailing@example.com",
      "_id": "ea0"
    }
  },
  "identification": {
    "0": {
      "type": "taxId",
      "value": "00-9999999"
    }
  },
  "phones": {
    "0": {
      "type": "work",
      "number": "+19105550155",
      "_id": "wp0"
    },
    "1": {
      "type": "mobile",
      "number": "+191055501554",
      "_id": "wp1"
    }
  },
  "addresses": {
    "0": {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 1,
  "employeeCountUpperBound": 1,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": {
      "0": "trustManagement"
    },
    "subjectToWithholdings": true
  },
  "_id": "0399abed-fd3d",
  "customerId": "1000489353781",
  "tradeName": "Smith's Auto Detailing",
  "preferredEmailAddressId": "ea0",
  "preferredPhoneNumberId": "wp0",
  "preferredMailingAddressId": "wa0",
  "governmentOwned": false,
  "registeredIn": "NC",
  "publiclyHeld": false,
  "smallBusiness": true,
  "taxExempt": false,
  "type": "corporation",
  "subtype": "soleProprietorship",
  "countryOfOperations": "US",
  "authorizedSigners": {},
  "beneficialOwners": {},
  "coreBanking": {
    "finxact": {
      "customerGroup": "--64964c9c8e8f----2d-5e-",
      "partyOrgId": "--4WS6lkgjD4u-----5F-Bg-"
    }
  },
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_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

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organization/v1.7.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/0399abed-fd3d"
    },
    "apiture:deactivate": {
      "href": "https://api.devbank.apiture.com/organizations/inactiveOrganizations?organization=0399abed-fd3d"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": {
    "0": {
      "type": "work",
      "value": "smitties-detailing@example.com",
      "_id": "ea0"
    }
  },
  "identification": {
    "0": {
      "type": "taxId",
      "value": "00-9999999"
    }
  },
  "phones": {
    "0": {
      "type": "work",
      "number": "+19105550155",
      "_id": "wp0"
    },
    "1": {
      "type": "mobile",
      "number": "+191055501554",
      "_id": "wp1"
    }
  },
  "addresses": {
    "0": {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 1,
  "employeeCountUpperBound": 1,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": {
      "0": "trustManagement"
    },
    "subjectToWithholdings": true
  },
  "_id": "0399abed-fd3d",
  "customerId": "1000489353781",
  "tradeName": "Smith's Auto Detailing",
  "preferredEmailAddressId": "ea0",
  "preferredPhoneNumberId": "wp0",
  "preferredMailingAddressId": "wa0",
  "governmentOwned": false,
  "registeredIn": "NC",
  "publiclyHeld": false,
  "smallBusiness": true,
  "taxExempt": false,
  "type": "corporation",
  "subtype": "soleProprietorship",
  "countryOfOperations": "US",
  "authorizedSigners": {},
  "beneficialOwners": {},
  "coreBanking": {
    "finxact": {
      "customerGroup": "--64964c9c8e8f----2d-5e-",
      "partyOrgId": "--4WS6lkgjD4u-----5F-Bg-"
    }
  },
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_embedded": {}
}

Parameters

Parameter	Description
`organizationId` (path)	`string` (required) The unique identifier of this organization. This is an opaque string. This value is the `_id` of the organization.
`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) An organization.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organization/v1.7.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/0399abed-fd3d"
    },
    "apiture:deactivate": {
      "href": "https://api.devbank.apiture.com/organizations/inactiveOrganizations?organization=0399abed-fd3d"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": {
    "0": {
      "type": "work",
      "value": "smitties-detailing@example.com",
      "_id": "ea0"
    }
  },
  "identification": {
    "0": {
      "type": "taxId",
      "value": "00-9999999"
    }
  },
  "phones": {
    "0": {
      "type": "work",
      "number": "+19105550155",
      "_id": "wp0"
    },
    "1": {
      "type": "mobile",
      "number": "+191055501554",
      "_id": "wp1"
    }
  },
  "addresses": {
    "0": {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 1,
  "employeeCountUpperBound": 1,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": {
      "0": "trustManagement"
    },
    "subjectToWithholdings": true
  },
  "_id": "0399abed-fd3d",
  "customerId": "1000489353781",
  "tradeName": "Smith's Auto Detailing",
  "preferredEmailAddressId": "ea0",
  "preferredPhoneNumberId": "wp0",
  "preferredMailingAddressId": "wa0",
  "governmentOwned": false,
  "registeredIn": "NC",
  "publiclyHeld": false,
  "smallBusiness": true,
  "taxExempt": false,
  "type": "corporation",
  "subtype": "soleProprietorship",
  "countryOfOperations": "US",
  "authorizedSigners": {},
  "beneficialOwners": {},
  "coreBanking": {
    "finxact": {
      "customerGroup": "--64964c9c8e8f----2d-5e-",
      "partyOrgId": "--4WS6lkgjD4u-----5F-Bg-"
    }
  },
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_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 _error field in the response will contain details about the request error.

This error response may have one of the following type values:

malformedRequestBodyBadRequest

Schema: errorResponse

Status Description

404 Not Found

Not Found. There is no such organization resource at the specified {organizationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound

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.

This error response may have one of the following type values:

propertyRequired

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 = '{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organization/v1.7.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/0399abed-fd3d"
    },
    "apiture:deactivate": {
      "href": "https://api.devbank.apiture.com/organizations/inactiveOrganizations?organization=0399abed-fd3d"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": {
    "0": {
      "type": "work",
      "value": "smitties-detailing@example.com",
      "_id": "ea0"
    }
  },
  "identification": {
    "0": {
      "type": "taxId",
      "value": "00-9999999"
    }
  },
  "phones": {
    "0": {
      "type": "work",
      "number": "+19105550155",
      "_id": "wp0"
    },
    "1": {
      "type": "mobile",
      "number": "+191055501554",
      "_id": "wp1"
    }
  },
  "addresses": {
    "0": {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 1,
  "employeeCountUpperBound": 1,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": {
      "0": "trustManagement"
    },
    "subjectToWithholdings": true
  },
  "_id": "0399abed-fd3d",
  "customerId": "1000489353781",
  "tradeName": "Smith's Auto Detailing",
  "preferredEmailAddressId": "ea0",
  "preferredPhoneNumberId": "wp0",
  "preferredMailingAddressId": "wa0",
  "governmentOwned": false,
  "registeredIn": "NC",
  "publiclyHeld": false,
  "smallBusiness": true,
  "taxExempt": false,
  "type": "corporation",
  "subtype": "soleProprietorship",
  "countryOfOperations": "US",
  "authorizedSigners": {},
  "beneficialOwners": {},
  "coreBanking": {
    "finxact": {
      "customerGroup": "--64964c9c8e8f----2d-5e-",
      "partyOrgId": "--4WS6lkgjD4u-----5F-Bg-"
    }
  },
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_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

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organization/v1.7.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/0399abed-fd3d"
    },
    "apiture:deactivate": {
      "href": "https://api.devbank.apiture.com/organizations/inactiveOrganizations?organization=0399abed-fd3d"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": {
    "0": {
      "type": "work",
      "value": "smitties-detailing@example.com",
      "_id": "ea0"
    }
  },
  "identification": {
    "0": {
      "type": "taxId",
      "value": "00-9999999"
    }
  },
  "phones": {
    "0": {
      "type": "work",
      "number": "+19105550155",
      "_id": "wp0"
    },
    "1": {
      "type": "mobile",
      "number": "+191055501554",
      "_id": "wp1"
    }
  },
  "addresses": {
    "0": {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 1,
  "employeeCountUpperBound": 1,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": {
      "0": "trustManagement"
    },
    "subjectToWithholdings": true
  },
  "_id": "0399abed-fd3d",
  "customerId": "1000489353781",
  "tradeName": "Smith's Auto Detailing",
  "preferredEmailAddressId": "ea0",
  "preferredPhoneNumberId": "wp0",
  "preferredMailingAddressId": "wa0",
  "governmentOwned": false,
  "registeredIn": "NC",
  "publiclyHeld": false,
  "smallBusiness": true,
  "taxExempt": false,
  "type": "corporation",
  "subtype": "soleProprietorship",
  "countryOfOperations": "US",
  "authorizedSigners": {},
  "beneficialOwners": {},
  "coreBanking": {
    "finxact": {
      "customerGroup": "--64964c9c8e8f----2d-5e-",
      "partyOrgId": "--4WS6lkgjD4u-----5F-Bg-"
    }
  },
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_embedded": {}
}

Parameters

Parameter	Description
`organizationId` (path)	`string` (required) The unique identifier of this organization. This is an opaque string. This value is the `_id` of the organization.
`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) An organization.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organization/v1.7.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/0399abed-fd3d"
    },
    "apiture:deactivate": {
      "href": "https://api.devbank.apiture.com/organizations/inactiveOrganizations?organization=0399abed-fd3d"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": {
    "0": {
      "type": "work",
      "value": "smitties-detailing@example.com",
      "_id": "ea0"
    }
  },
  "identification": {
    "0": {
      "type": "taxId",
      "value": "00-9999999"
    }
  },
  "phones": {
    "0": {
      "type": "work",
      "number": "+19105550155",
      "_id": "wp0"
    },
    "1": {
      "type": "mobile",
      "number": "+191055501554",
      "_id": "wp1"
    }
  },
  "addresses": {
    "0": {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 1,
  "employeeCountUpperBound": 1,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": {
      "0": "trustManagement"
    },
    "subjectToWithholdings": true
  },
  "_id": "0399abed-fd3d",
  "customerId": "1000489353781",
  "tradeName": "Smith's Auto Detailing",
  "preferredEmailAddressId": "ea0",
  "preferredPhoneNumberId": "wp0",
  "preferredMailingAddressId": "wa0",
  "governmentOwned": false,
  "registeredIn": "NC",
  "publiclyHeld": false,
  "smallBusiness": true,
  "taxExempt": false,
  "type": "corporation",
  "subtype": "soleProprietorship",
  "countryOfOperations": "US",
  "authorizedSigners": {},
  "beneficialOwners": {},
  "coreBanking": {
    "finxact": {
      "customerGroup": "--64964c9c8e8f----2d-5e-",
      "partyOrgId": "--4WS6lkgjD4u-----5F-Bg-"
    }
  },
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_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 _error field in the response will contain details about the request error.

This error response may have one of the following type values:

malformedRequestBodyBadRequest

Schema: errorResponse

Status Description

404 Not Found

Not Found. There is no such organization resource at the specified {organizationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound

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. This value is the `_id` of the organization.

Try It

Example responses

404 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_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 {organizationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound

Schema: errorResponse

Status Description

409 Conflict

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: An organization with the associated taxId already exists. The `state` of a `removed` organization may not be changed. The `state` cannot be updated via a `PUT` or `POST` request. Please use the appropriate endpoint to change the state. Some key fields of the organization record may not be changed or removed, such as their `taxId`. This error response may have one of the following `type` values: `duplicateTaxId` `invalidOrganizationState`

Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:

An organization with the associated taxId already exists.
The state of a removed organization may not be changed.
The state cannot be updated via a PUT or POST request. Please use the appropriate endpoint to change the state.
Some key fields of the organization record may not be changed or removed, such as their taxId.

This error response may have one of the following type values:

duplicateTaxId
invalidOrganizationState

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.
`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

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organization/v1.7.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/0399abed-fd3d"
    },
    "apiture:deactivate": {
      "href": "https://api.devbank.apiture.com/organizations/inactiveOrganizations?organization=0399abed-fd3d"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": {
    "0": {
      "type": "work",
      "value": "smitties-detailing@example.com",
      "_id": "ea0"
    }
  },
  "identification": {
    "0": {
      "type": "taxId",
      "value": "00-9999999"
    }
  },
  "phones": {
    "0": {
      "type": "work",
      "number": "+19105550155",
      "_id": "wp0"
    },
    "1": {
      "type": "mobile",
      "number": "+191055501554",
      "_id": "wp1"
    }
  },
  "addresses": {
    "0": {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 1,
  "employeeCountUpperBound": 1,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": {
      "0": "trustManagement"
    },
    "subjectToWithholdings": true
  },
  "_id": "0399abed-fd3d",
  "customerId": "1000489353781",
  "tradeName": "Smith's Auto Detailing",
  "preferredEmailAddressId": "ea0",
  "preferredPhoneNumberId": "wp0",
  "preferredMailingAddressId": "wa0",
  "governmentOwned": false,
  "registeredIn": "NC",
  "publiclyHeld": false,
  "smallBusiness": true,
  "taxExempt": false,
  "type": "corporation",
  "subtype": "soleProprietorship",
  "countryOfOperations": "US",
  "authorizedSigners": {},
  "beneficialOwners": {},
  "coreBanking": {
    "finxact": {
      "customerGroup": "--64964c9c8e8f----2d-5e-",
      "partyOrgId": "--4WS6lkgjD4u-----5F-Bg-"
    }
  },
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_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

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: An organization with the associated taxId already exists. The `state` of a `removed` organization may not be changed. The `state` cannot be updated via a `PUT` or `POST` request. Please use the appropriate endpoint to change the state. Some key fields of the organization record may not be changed or removed, such as their `taxId`. This error response may have one of the following `type` values: `duplicateTaxId` `invalidOrganizationState`

Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:

An organization with the associated taxId already exists.
The state of a removed organization may not be changed.
The state cannot be updated via a PUT or POST request. Please use the appropriate endpoint to change the state.
Some key fields of the organization record may not be changed or removed, such as their taxId.

This error response may have one of the following type values:

duplicateTaxId
invalidOrganizationState

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 \
  -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 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',
  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',
{
  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'
}, 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'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/inactiveOrganizations?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/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.
`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

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organization/v1.7.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/0399abed-fd3d"
    },
    "apiture:deactivate": {
      "href": "https://api.devbank.apiture.com/organizations/inactiveOrganizations?organization=0399abed-fd3d"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": {
    "0": {
      "type": "work",
      "value": "smitties-detailing@example.com",
      "_id": "ea0"
    }
  },
  "identification": {
    "0": {
      "type": "taxId",
      "value": "00-9999999"
    }
  },
  "phones": {
    "0": {
      "type": "work",
      "number": "+19105550155",
      "_id": "wp0"
    },
    "1": {
      "type": "mobile",
      "number": "+191055501554",
      "_id": "wp1"
    }
  },
  "addresses": {
    "0": {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 1,
  "employeeCountUpperBound": 1,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": {
      "0": "trustManagement"
    },
    "subjectToWithholdings": true
  },
  "_id": "0399abed-fd3d",
  "customerId": "1000489353781",
  "tradeName": "Smith's Auto Detailing",
  "preferredEmailAddressId": "ea0",
  "preferredPhoneNumberId": "wp0",
  "preferredMailingAddressId": "wa0",
  "governmentOwned": false,
  "registeredIn": "NC",
  "publiclyHeld": false,
  "smallBusiness": true,
  "taxExempt": false,
  "type": "corporation",
  "subtype": "soleProprietorship",
  "countryOfOperations": "US",
  "authorizedSigners": {},
  "beneficialOwners": {},
  "coreBanking": {
    "finxact": {
      "customerGroup": "--64964c9c8e8f----2d-5e-",
      "partyOrgId": "--4WS6lkgjD4u-----5F-Bg-"
    }
  },
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_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

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: An organization with the associated taxId already exists. The `state` of a `removed` organization may not be changed. The `state` cannot be updated via a `PUT` or `POST` request. Please use the appropriate endpoint to change the state. Some key fields of the organization record may not be changed or removed, such as their `taxId`. This error response may have one of the following `type` values: `duplicateTaxId` `invalidOrganizationState`

Conflict. There is a conflict between the request and the current state of the resource. It may be one of the following:

An organization with the associated taxId already exists.
The state of a removed organization may not be changed.
The state cannot be updated via a PUT or POST request. Please use the appropriate endpoint to change the state.
Some key fields of the organization record may not be changed or removed, such as their taxId.

This error response may have one of the following type values:

duplicateTaxId
invalidOrganizationState

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 \
  -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 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',
  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',
{
  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'
}, 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'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/removedOrganizations?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/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.
`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

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organization/v1.7.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/0399abed-fd3d"
    },
    "apiture:deactivate": {
      "href": "https://api.devbank.apiture.com/organizations/inactiveOrganizations?organization=0399abed-fd3d"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": {
    "0": {
      "type": "work",
      "value": "smitties-detailing@example.com",
      "_id": "ea0"
    }
  },
  "identification": {
    "0": {
      "type": "taxId",
      "value": "00-9999999"
    }
  },
  "phones": {
    "0": {
      "type": "work",
      "number": "+19105550155",
      "_id": "wp0"
    },
    "1": {
      "type": "mobile",
      "number": "+191055501554",
      "_id": "wp1"
    }
  },
  "addresses": {
    "0": {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 1,
  "employeeCountUpperBound": 1,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": {
      "0": "trustManagement"
    },
    "subjectToWithholdings": true
  },
  "_id": "0399abed-fd3d",
  "customerId": "1000489353781",
  "tradeName": "Smith's Auto Detailing",
  "preferredEmailAddressId": "ea0",
  "preferredPhoneNumberId": "wp0",
  "preferredMailingAddressId": "wa0",
  "governmentOwned": false,
  "registeredIn": "NC",
  "publiclyHeld": false,
  "smallBusiness": true,
  "taxExempt": false,
  "type": "corporation",
  "subtype": "soleProprietorship",
  "countryOfOperations": "US",
  "authorizedSigners": {},
  "beneficialOwners": {},
  "coreBanking": {
    "finxact": {
      "customerGroup": "--64964c9c8e8f----2d-5e-",
      "partyOrgId": "--4WS6lkgjD4u-----5F-Bg-"
    }
  },
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_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:

An organization with the associated taxId already exists.
The state of a removed organization may not be changed.
The state cannot be updated via a PUT or POST request. Please use the appropriate endpoint to change the state.
Some key fields of the organization record may not be changed or removed, such as their taxId.

This error response may have one of the following type values:

duplicateTaxId
invalidOrganizationState

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.

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.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "invitees": {
    "0": {
      "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.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "invitees": {
    "0": {
      "firstName": "Lucille",
      "lastName": "Wellphunded",
      "role": "Owner"
    }
  }
}

Parameters

Parameter	Description
`organizationId` (path)	`string` (required) The unique identifier of this organization. This is an opaque string. This value is the `_id` of the organization.
`Accept` (header)	`string` Optional. Only `application/pdf` is currently supported.
`body` (body)	`entityAuthorizationFormRequest` (required)

Try It

Example responses

404 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_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.

Status Description

404 Not Found

Not Found. There is no such organization resource at the specified {organizationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound

Schema: errorResponse

Status	Description
406	Not Acceptable
	Not Acceptable. Indicates that the server cannot produce a response matching the list of acceptable values defined in the request's headers. This operation only supports `Accept: application/pdf`.
	Schema: `errorResponse`

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`

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. This value is the `_id` of the organization.
`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

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/authorizedSigners/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "items": {
    "0": {
      "_id": "as001",
      "userId": "bd9e7a93-32cc-435d-ac57-f21faa082318",
      "customerId": "10047294723672",
      "type": "authorizedSigner",
      "role": "Chief Financial Officer",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "taxId": "*****3333",
      "citizen": true,
      "addresses": {
        "0": {
          "_id": "ha5",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Apt 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        }
      },
      "preferredMailingAddressId": "ha5",
      "emailAddress": "JohnDanielSmith@example.com"
    }
  }
}

Responses

Status	Description
200	OK
	OK.
	Schema: `authorizedSigners`

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 {organizationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound

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.

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 = '{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:user": {
      "href": "https://api.devbank.apiture.com/users/users/bd9e7a93-32cc-435d-ac57-f21faa082318"
    }
  },
  "firstName": "John",
  "middleName": "Daniel",
  "lastName": "Smith",
  "addresses": {
    "0": {
      "_id": "ha5",
      "type": "home",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "_id": "wa1",
      "type": "other",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US",
      "id": "wa0",
      "label": "mailing"
    }
  },
  "preferredMailingAddressId": "ha5",
  "userId": "bd9e7a93-32cc-435d-ac57-f21faa082318",
  "customerId": "10047294723672",
  "type": "joint",
  "role": "Chief Financial Officer",
  "taxId": "*****3333",
  "citizen": true,
  "emailAddress": "JohnDanielSmith@example.com"
}';
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.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:user": {
      "href": "https://api.devbank.apiture.com/users/users/bd9e7a93-32cc-435d-ac57-f21faa082318"
    }
  },
  "firstName": "John",
  "middleName": "Daniel",
  "lastName": "Smith",
  "addresses": {
    "0": {
      "_id": "ha5",
      "type": "home",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "_id": "wa1",
      "type": "other",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US",
      "id": "wa0",
      "label": "mailing"
    }
  },
  "preferredMailingAddressId": "ha5",
  "userId": "bd9e7a93-32cc-435d-ac57-f21faa082318",
  "customerId": "10047294723672",
  "type": "joint",
  "role": "Chief Financial Officer",
  "taxId": "*****3333",
  "citizen": true,
  "emailAddress": "JohnDanielSmith@example.com"
}

Parameters

Parameter	Description
`organizationId` (path)	`string` (required) The unique identifier of this organization. This is an opaque string. This value is the `_id` of the organization.
`body` (body)	`createAuthorizedSigner` (required) The authorized signer object.

Try It

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:user": {
      "href": "https://api.devbank.apiture.com/users/users/bd9e7a93-32cc-435d-ac57-f21faa082318"
    }
  },
  "firstName": "John",
  "middleName": "Daniel",
  "lastName": "Smith",
  "addresses": {
    "0": {
      "_id": "ha5",
      "type": "home",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "_id": "wa1",
      "type": "other",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US",
      "id": "wa0",
      "label": "mailing"
    }
  },
  "preferredMailingAddressId": "ha5",
  "userId": "bd9e7a93-32cc-435d-ac57-f21faa082318",
  "customerId": "10047294723672",
  "type": "joint",
  "role": "Chief Financial Officer",
  "taxId": "*****3333",
  "citizen": true,
  "emailAddress": "JohnDanielSmith@example.com"
}

Responses

Status	Description
201	Created
	Created.
	Schema: `createAuthorizedSigner`

Status Description

400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

malformedRequestBodyBadRequest
userUriInvalid
userUriNotSupplied
authorizedSignerAlreadyExists

Schema: errorResponse

deleteAuthorizedSigner

Code samples

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

DELETE https://api.devbank.apiture.com/organizations/organizations/{organizationId}/authorizedSigners/{authorizedSigner} 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}/authorizedSigners/{authorizedSigner}',
  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}/authorizedSigners/{authorizedSigner}',
{
  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}/authorizedSigners/{authorizedSigner}',
  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}/authorizedSigners/{authorizedSigner}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/authorizedSigners/{authorizedSigner}");
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}/authorizedSigners/{authorizedSigner}", data)
    req.Header = headers

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

Delete an authorized signer

DELETE /organizations/{organizationId}/authorizedSigners/{authorizedSigner}

Remove an authorized signer from an organization.

Parameters

Parameter	Description
`organizationId` (path)	`string` (required) The unique identifier of this organization. This is an opaque string. This value is the `_id` of the organization.
`authorizedSigner` (path)	`string` (required) The identifier of the authorized signer to delete. This value is either the `_id` of the authorized signer, or the zero-based decimal index of the authorized signer within the array of authorized signers. Caution: deleting one authorized signer changes the array offset of remaining authorized signers.

Try It

Example responses

404 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_embedded": {
      "errors": {}
    }
  }
}

Responses

Status	Description
204	No Content
	Deleted.

Status Description

404 Not Found

Not Found. There is no such authorized signer resource at the specified {authorizedSigner}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound
authorizedSignerNotFound

Schema: errorResponse

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. This value is the `_id` of the organization.
`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

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/beneficialOwners/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com//organizations/organizations/0399abed-fd3d/beneficialOwners"
    }
  },
  "items": {
    "0": {
      "_id": "b003",
      "firstName": "William",
      "lastName": "Wellphunded",
      "addresses": {
        "0": {
          "addressLine1": "1234 S Front Street",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "type": "home"
        }
      },
      "role": "Chief Financial Officer",
      "percentage": 35,
      "birthdate": "1982-10-19",
      "identification": {
        "0": {
          "type": "taxId",
          "value": "111-11-1111"
        }
      },
      "contactId": "76e018d8-de7e-4631-aad8-fc1aa1d04bf7"
    }
  }
}

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 {organizationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound

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 = '{
  "_profile": "https://production.api.apiture.com/schemas/organizations/beneficialOwners/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com//organizations/organizations/0399abed-fd3d/beneficialOwners"
    }
  },
  "items": {
    "0": {
      "_id": "b003",
      "firstName": "William",
      "lastName": "Wellphunded",
      "addresses": {
        "0": {
          "addressLine1": "1234 S Front Street",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "type": "home"
        }
      },
      "role": "Chief Financial Officer",
      "percentage": 35,
      "birthdate": "1982-10-19",
      "identification": {
        "0": {
          "type": "taxId",
          "value": "111-11-1111"
        }
      },
      "contactId": "76e018d8-de7e-4631-aad8-fc1aa1d04bf7"
    }
  }
}';
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

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/beneficialOwners/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com//organizations/organizations/0399abed-fd3d/beneficialOwners"
    }
  },
  "items": {
    "0": {
      "_id": "b003",
      "firstName": "William",
      "lastName": "Wellphunded",
      "addresses": {
        "0": {
          "addressLine1": "1234 S Front Street",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "type": "home"
        }
      },
      "role": "Chief Financial Officer",
      "percentage": 35,
      "birthdate": "1982-10-19",
      "identification": {
        "0": {
          "type": "taxId",
          "value": "111-11-1111"
        }
      },
      "contactId": "76e018d8-de7e-4631-aad8-fc1aa1d04bf7"
    }
  }
}

Parameters

Parameter	Description
`organizationId` (path)	`string` (required) The unique identifier of this organization. This is an opaque string. This value is the `_id` of the organization.
`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

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/beneficialOwners/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com//organizations/organizations/0399abed-fd3d/beneficialOwners"
    }
  },
  "items": {
    "0": {
      "_id": "b003",
      "firstName": "William",
      "lastName": "Wellphunded",
      "addresses": {
        "0": {
          "addressLine1": "1234 S Front Street",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "type": "home"
        }
      },
      "role": "Chief Financial Officer",
      "percentage": 35,
      "birthdate": "1982-10-19",
      "identification": {
        "0": {
          "type": "taxId",
          "value": "111-11-1111"
        }
      },
      "contactId": "76e018d8-de7e-4631-aad8-fc1aa1d04bf7"
    }
  }
}

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 _error field in the response will contain details about the request error.

This error response may have one of the following type values:

tooManyBeneficialOwners
beneficialOwnersPercentageExceed100

Schema: errorResponse

Status Description

404 Not Found

Not Found. There is no such organization resource at the specified {organizationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound

Schema: errorResponse

Status Description

409 Conflict

Conflict. There is a conflict in the request to update an organization's beneficial owners:

A user appears more than once
The array contains more users than is allowed by the FI
The sum of ownership percentages exceeds 100%

Schema: errorResponse

Response Headers

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

deleteBeneficialOwner

Code samples

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

DELETE https://api.devbank.apiture.com/organizations/organizations/{organizationId}/beneficialOwners/{beneficialOwner} 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}/beneficialOwners/{beneficialOwner}',
  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}/beneficialOwners/{beneficialOwner}',
{
  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}/beneficialOwners/{beneficialOwner}',
  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}/beneficialOwners/{beneficialOwner}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/beneficialOwners/{beneficialOwner}");
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}/beneficialOwners/{beneficialOwner}", data)
    req.Header = headers

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

Delete beneficial owners

DELETE /organizations/{organizationId}/beneficialOwners/{beneficialOwner}

Remove a beneficial owner from an organization.

Parameters

Parameter	Description
`organizationId` (path)	`string` (required) The unique identifier of this organization. This is an opaque string. This value is the `_id` of the organization.
`beneficialOwner` (path)	`string` (required) The identifier of the beneficial owner to delete. This value is either the `_id` of the beneficial owner, or the zero-based decimal index of the beneficial owner within the array of beneficial owners. Caution: deleting one beneficial owner changes the array offset of remaining beneficial owners.

Try It

Example responses

404 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_embedded": {
      "errors": {}
    }
  }
}

Responses

Status	Description
204	No Content
	Deleted.

Status Description

404 Not Found

Not Found. There is no such beneficial owner resource at the specified {beneficialOwner}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound
beneficialOwnerNotFound

Schema: errorResponse

Addresses

Organization Postal Addresses

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. This value is the `_id` of the organization.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationAddresses/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/addresses"
    }
  },
  "items": {
    "0": {
      "_id": "main",
      "type": "business",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US",
      "state": "approved",
      "_profile": "https://production.api.apiture.com/schemas/organizations/organizationAddress/v1.2.0/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/addresses/main"
        }
      }
    },
    "1": {
      "_id": "billing",
      "type": "billing",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US",
      "_profile": "https://production.api.apiture.com/schemas/organizations/organizationAddress/v1.2.0/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/addresses/billing"
        }
      }
    }
  }
}

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 _error field in the response will contain details about the request error.

This error response may have one of the following type values:

malformedRequestBodyBadRequest

Schema: errorResponse

Status Description

404 Not Found

Not Found. There is no such organization resource at the specified {organizationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound

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 = '{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationAddress/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/addresses/ba1"
    },
    "apiture:setAsPreferred": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/preferredAddress?value=ba1"
    },
    "apiture:setAsTaxAddress": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/taxAddress?value=ba1"
    }
  },
  "addressLine1": "555 N Front Street",
  "addressLine2": "Suite 5555",
  "city": "Wilmington",
  "regionCode": "NC",
  "postalCode": "28401-5405",
  "countryCode": "US",
  "_id": "ba1",
  "type": "business",
  "state": "approved"
}';
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. Note the possible conflict errors listed in the 409 response.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationAddress/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/addresses/ba1"
    },
    "apiture:setAsPreferred": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/preferredAddress?value=ba1"
    },
    "apiture:setAsTaxAddress": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/taxAddress?value=ba1"
    }
  },
  "addressLine1": "555 N Front Street",
  "addressLine2": "Suite 5555",
  "city": "Wilmington",
  "regionCode": "NC",
  "postalCode": "28401-5405",
  "countryCode": "US",
  "_id": "ba1",
  "type": "business",
  "state": "approved"
}

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 or the tax address the `preferredMailingAddressId` or `taxAddressId` is 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. This value is the `_id` of the organization.

Try It

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationAddress/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/addresses/ba1"
    },
    "apiture:setAsPreferred": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/preferredAddress?value=ba1"
    },
    "apiture:setAsTaxAddress": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/taxAddress?value=ba1"
    }
  },
  "addressLine1": "555 N Front Street",
  "addressLine2": "Suite 5555",
  "city": "Wilmington",
  "regionCode": "NC",
  "postalCode": "28401-5405",
  "countryCode": "US",
  "_id": "ba1",
  "type": "business",
  "state": "approved"
}

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 _error field in the response will contain details about the request error.

This error response may have one of the following type values:

malformedRequestBodyBadRequest

Schema: errorResponse

Status Description

404 Not Found

Not Found. There is no such organization resource at the specified {organizationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound

Schema: errorResponse

Status Description

409 Conflict

Conflict. Cannot create the request address or replace the indicate address due to financial institution address constraints.

This error response may have one of the following type values:

cannotReplaceTaxAddressWithPoBox

Schema: challengeErrorResponse

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. This value is the `_id` of the organization.
`addressId` (path)	`string` (required) The unique identifier of this address. This is an opaque string.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationAddress/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/addresses/ba1"
    },
    "apiture:setAsPreferred": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/preferredAddress?value=ba1"
    },
    "apiture:setAsTaxAddress": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/taxAddress?value=ba1"
    }
  },
  "addressLine1": "555 N Front Street",
  "addressLine2": "Suite 5555",
  "city": "Wilmington",
  "regionCode": "NC",
  "postalCode": "28401-5405",
  "countryCode": "US",
  "_id": "ba1",
  "type": "business",
  "state": "approved"
}

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 {addressId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound
addressNotFound

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 organizationId's tax address. If deleting the preferred mailing address, the tax address becomes the preferred mailing address. This operation is only valid if the delete link exists in the address' _links.

Parameters

Parameter	Description
`organizationId` (path)	`string` (required) The unique identifier of this organization. This is an opaque string. This value is the `_id` of the organization.
`addressId` (path)	`string` (required) The unique identifier of this address. This is an opaque string.

Try It

Example responses

404 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_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 {addressId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound
addressNotFound

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 type values:

addressMustNotBePreferred

Schema: errorResponse

setTaxAddress

Code samples

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

PUT https://api.devbank.apiture.com/organizations/organizations/{organizationId}/taxAddress?value=string 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}/taxAddress',
  method: 'put',
  data: '?value=string',
  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}/taxAddress?value=string',
{
  method: 'PUT',

  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.put 'https://api.devbank.apiture.com/organizations/organizations/{organizationId}/taxAddress',
  params: {
  'value' => 'string'
}, headers: headers

p JSON.parse(result)

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

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

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/organizations/{organizationId}/taxAddress?value=string");
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{
        "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}/taxAddress", data)
    req.Header = headers

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

Set Tax Address

PUT /organizations/{organizationId}/taxAddress

Set the organization's tax address. The organization may set their tax address to an approved address by passing its unique _id in the value query parameter. This updates the taxAddressId property of the organization.

This operation is available via the apiture:setAsTaxAddress link on an approved address resources that are eligible to be set as the tax address. Some financial institutions do not allow a P.O. Box to be assigned as the tax address (the address must be a physical address). If so, the link is omitted on P.O. Box addresses.

No changes are made if the specified address is already the tax address.

Parameters

Parameter	Description
`value` (query)	`string` (required) The `_id` of the address to assign as the tax address. Example: `?value=main`. `minLength: 1` `maxLength: 8`
`organizationId` (path)	`string` (required) The unique identifier of this organization. This is an opaque string. This value is the `_id` of the organization.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organization/v1.7.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/0399abed-fd3d"
    },
    "apiture:deactivate": {
      "href": "https://api.devbank.apiture.com/organizations/inactiveOrganizations?organization=0399abed-fd3d"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": {
    "0": {
      "type": "work",
      "value": "smitties-detailing@example.com",
      "_id": "ea0"
    }
  },
  "identification": {
    "0": {
      "type": "taxId",
      "value": "00-9999999"
    }
  },
  "phones": {
    "0": {
      "type": "work",
      "number": "+19105550155",
      "_id": "wp0"
    },
    "1": {
      "type": "mobile",
      "number": "+191055501554",
      "_id": "wp1"
    }
  },
  "addresses": {
    "0": {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 1,
  "employeeCountUpperBound": 1,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": {
      "0": "trustManagement"
    },
    "subjectToWithholdings": true
  },
  "_id": "0399abed-fd3d",
  "customerId": "1000489353781",
  "tradeName": "Smith's Auto Detailing",
  "preferredEmailAddressId": "ea0",
  "preferredPhoneNumberId": "wp0",
  "preferredMailingAddressId": "wa0",
  "governmentOwned": false,
  "registeredIn": "NC",
  "publiclyHeld": false,
  "smallBusiness": true,
  "taxExempt": false,
  "type": "corporation",
  "subtype": "soleProprietorship",
  "countryOfOperations": "US",
  "authorizedSigners": {},
  "beneficialOwners": {},
  "coreBanking": {
    "finxact": {
      "customerGroup": "--64964c9c8e8f----2d-5e-",
      "partyOrgId": "--4WS6lkgjD4u-----5F-Bg-"
    }
  },
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_embedded": {}
}

Responses

Status	Description
200	OK
	OK. The organization's `taxAddressId` is updated to the passed value.
	Schema: `organization`

Status Description

409 Conflict

Conflict. The selected profile value cannot be set as the preferred because it is still pending or not valid for a tax address.

This error response may have one of the following type values:

itemStillPending
postOfficeBoxNotAllowedForTaxAddress

Schema: challengeErrorResponse

Status Description

422 Unprocessable Entity

Unprocessable Entity. The request to set a preferred profile value cannot be processed because no such profile value value exists.

This error response may have one of the following type values:

noSuchProfileValue

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.

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`. `minLength: 1` `maxLength: 8`
`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. This value is the `_id` of the organization.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organization/v1.7.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/0399abed-fd3d"
    },
    "apiture:deactivate": {
      "href": "https://api.devbank.apiture.com/organizations/inactiveOrganizations?organization=0399abed-fd3d"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": {
    "0": {
      "type": "work",
      "value": "smitties-detailing@example.com",
      "_id": "ea0"
    }
  },
  "identification": {
    "0": {
      "type": "taxId",
      "value": "00-9999999"
    }
  },
  "phones": {
    "0": {
      "type": "work",
      "number": "+19105550155",
      "_id": "wp0"
    },
    "1": {
      "type": "mobile",
      "number": "+191055501554",
      "_id": "wp1"
    }
  },
  "addresses": {
    "0": {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 1,
  "employeeCountUpperBound": 1,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": {
      "0": "trustManagement"
    },
    "subjectToWithholdings": true
  },
  "_id": "0399abed-fd3d",
  "customerId": "1000489353781",
  "tradeName": "Smith's Auto Detailing",
  "preferredEmailAddressId": "ea0",
  "preferredPhoneNumberId": "wp0",
  "preferredMailingAddressId": "wa0",
  "governmentOwned": false,
  "registeredIn": "NC",
  "publiclyHeld": false,
  "smallBusiness": true,
  "taxExempt": false,
  "type": "corporation",
  "subtype": "soleProprietorship",
  "countryOfOperations": "US",
  "authorizedSigners": {},
  "beneficialOwners": {},
  "coreBanking": {
    "finxact": {
      "customerGroup": "--64964c9c8e8f----2d-5e-",
      "partyOrgId": "--4WS6lkgjD4u-----5F-Bg-"
    }
  },
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_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 {organizationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound

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.

This error response may have one of the following type values:

itemStillPending

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.

This error response may have one of the following type values:

noSuchProfileValue

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 Numbers

Organization Phone Numbers

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. This value is the `_id` of the organization.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationPhoneNumbers/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/useorganizationsrs/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers"
    }
  },
  "items": {
    "0": {
      "_id": "mp0",
      "type": "mobile",
      "label": "Mobile",
      "number": "+19105550155",
      "state": "approved",
      "_profile": "https://production.api.apiture.com/schemas/organization/organizationPhoneNumber/v1.2.0/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/mp0"
        }
      }
    },
    "1": {
      "_id": "mp2",
      "type": "home",
      "label": "Home",
      "number": "+19105550154",
      "state": "approved",
      "_profile": "https://production.api.apiture.com/schemas/organizations/organizationPhoneNumber/v1.2.0/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/mp2"
        }
      }
    }
  }
}

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 _error field in the response will contain details about the request error.

This error response may have one of the following type values:

malformedRequestBodyBadRequest

Schema: errorResponse

Status Description

404 Not Found

Not Found. There is no such organization resource at the specified {organizationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound

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 = '{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationPhoneNumber/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
    }
  },
  "_id": "hp1",
  "type": "home",
  "number": "+19105550155",
  "state": "approved"
}';
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

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationPhoneNumber/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
    }
  },
  "_id": "hp1",
  "type": "home",
  "number": "+19105550155",
  "state": "approved"
}

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. This value is the `_id` of the organization.

Try It

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationPhoneNumber/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
    }
  },
  "_id": "hp1",
  "type": "home",
  "number": "+19105550155",
  "state": "approved"
}

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 _error field in the response will contain details about the request error.

This error response may have one of the following type values:

malformedRequestBodyBadRequest

Schema: errorResponse

Status Description

404 Not Found

Not Found. There is no such organization resource at the specified {organizationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound

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. This value is the `_id` of the organization.
`phoneNumberId` (path)	`string` (required) The unique identifier of this phone number. This is an opaque string.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationPhoneNumber/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
    }
  },
  "_id": "hp1",
  "type": "home",
  "number": "+19105550155",
  "state": "approved"
}

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 {phoneNumberId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound
phoneNumberNotFound

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. This value is the `_id` of the organization.
`phoneNumberId` (path)	`string` (required) The unique identifier of this phone number. This is an opaque string.

Try It

Example responses

404 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_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 {phoneNumberId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound
phoneNumberNotFound

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 type values:

phoneMustNotBePreferred

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`. `minLength: 1` `maxLength: 8`
`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. This value is the `_id` of the organization.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organization/v1.7.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/0399abed-fd3d"
    },
    "apiture:deactivate": {
      "href": "https://api.devbank.apiture.com/organizations/inactiveOrganizations?organization=0399abed-fd3d"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": {
    "0": {
      "type": "work",
      "value": "smitties-detailing@example.com",
      "_id": "ea0"
    }
  },
  "identification": {
    "0": {
      "type": "taxId",
      "value": "00-9999999"
    }
  },
  "phones": {
    "0": {
      "type": "work",
      "number": "+19105550155",
      "_id": "wp0"
    },
    "1": {
      "type": "mobile",
      "number": "+191055501554",
      "_id": "wp1"
    }
  },
  "addresses": {
    "0": {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 1,
  "employeeCountUpperBound": 1,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": {
      "0": "trustManagement"
    },
    "subjectToWithholdings": true
  },
  "_id": "0399abed-fd3d",
  "customerId": "1000489353781",
  "tradeName": "Smith's Auto Detailing",
  "preferredEmailAddressId": "ea0",
  "preferredPhoneNumberId": "wp0",
  "preferredMailingAddressId": "wa0",
  "governmentOwned": false,
  "registeredIn": "NC",
  "publiclyHeld": false,
  "smallBusiness": true,
  "taxExempt": false,
  "type": "corporation",
  "subtype": "soleProprietorship",
  "countryOfOperations": "US",
  "authorizedSigners": {},
  "beneficialOwners": {},
  "coreBanking": {
    "finxact": {
      "customerGroup": "--64964c9c8e8f----2d-5e-",
      "partyOrgId": "--4WS6lkgjD4u-----5F-Bg-"
    }
  },
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_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 {organizationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound

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.

This error response may have one of the following type values:

itemStillPending

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.

This error response may have one of the following type values:

noSuchProfileValue

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 Addresses

Organization Email Addresses

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. This value is the `_id` of the organization.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationEmailAddresses/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/emailAddresses"
    }
  },
  "items": {
    "0": {
      "_id": "pe0",
      "type": "personal",
      "label": "Personal",
      "number": "user7838@example.com",
      "state": "approved",
      "_profile": "https://production.api.apiture.com/schemas/organizations/organizationEmailAddress/v1.1.0/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com//organizations/organizations/f2d87aa6-458c/emailAddresses/pe0"
        }
      }
    },
    "1": {
      "_id": "pe2",
      "type": "personal",
      "label": "Personal",
      "value": "John.Smith@example.com",
      "state": "approved",
      "_profile": "https://production.api.apiture.com/schemas/organizations/organizationEmailAddress/v1.1.0/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com//organizations/organizations/f2d87aa6-458c/EmailAddresses/pe2"
        }
      }
    }
  }
}

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 _error field in the response will contain details about the request error.

This error response may have one of the following type values:

malformedRequestBodyBadRequest

Schema: errorResponse

Status Description

404 Not Found

Not Found. There is no such organization resource at the specified {organizationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound

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 = '{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationEmailAddress/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/emailAddresses/pe1"
    },
    "delete": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/emailAddresses/pe1"
    },
    "apiture:setAsPreferred": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/preferredEmailAddresses?value=pe1"
    }
  },
  "_id": "pe1",
  "type": "personal",
  "number": "+19105550155",
  "state": "approved"
}';
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

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationEmailAddress/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/emailAddresses/pe1"
    },
    "delete": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/emailAddresses/pe1"
    },
    "apiture:setAsPreferred": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/preferredEmailAddresses?value=pe1"
    }
  },
  "_id": "pe1",
  "type": "personal",
  "number": "+19105550155",
  "state": "approved"
}

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. This value is the `_id` of the organization.

Try It

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationEmailAddress/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/emailAddresses/pe1"
    },
    "delete": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/emailAddresses/pe1"
    },
    "apiture:setAsPreferred": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/preferredEmailAddresses?value=pe1"
    }
  },
  "_id": "pe1",
  "type": "personal",
  "number": "+19105550155",
  "state": "approved"
}

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 _error field in the response will contain details about the request error.

This error response may have one of the following type values:

malformedRequestBodyBadRequest

Schema: errorResponse

Status Description

404 Not Found

Not Found. There is no such organization resource at the specified {organizationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound

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. This value is the `_id` of the organization.
`emailAddressId` (path)	`string` (required) The unique identifier of this email address. This is an opaque string.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationEmailAddress/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/emailAddresses/pe1"
    },
    "delete": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/emailAddresses/pe1"
    },
    "apiture:setAsPreferred": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/preferredEmailAddresses?value=pe1"
    }
  },
  "_id": "pe1",
  "type": "personal",
  "number": "+19105550155",
  "state": "approved"
}

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 {emailAddressId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound
emailAddressNotFound

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. This value is the `_id` of the organization.
`emailAddressId` (path)	`string` (required) The unique identifier of this email address. This is an opaque string.

Try It

Example responses

404 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_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 {emailAddressId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound
emailAddressNotFound

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 type values:

emailAddressMustNotBePreferred

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`. `minLength: 1` `maxLength: 8`
`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. This value is the `_id` of the organization.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organization/v1.7.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/0399abed-fd3d"
    },
    "apiture:deactivate": {
      "href": "https://api.devbank.apiture.com/organizations/inactiveOrganizations?organization=0399abed-fd3d"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": {
    "0": {
      "type": "work",
      "value": "smitties-detailing@example.com",
      "_id": "ea0"
    }
  },
  "identification": {
    "0": {
      "type": "taxId",
      "value": "00-9999999"
    }
  },
  "phones": {
    "0": {
      "type": "work",
      "number": "+19105550155",
      "_id": "wp0"
    },
    "1": {
      "type": "mobile",
      "number": "+191055501554",
      "_id": "wp1"
    }
  },
  "addresses": {
    "0": {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 1,
  "employeeCountUpperBound": 1,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": {
      "0": "trustManagement"
    },
    "subjectToWithholdings": true
  },
  "_id": "0399abed-fd3d",
  "customerId": "1000489353781",
  "tradeName": "Smith's Auto Detailing",
  "preferredEmailAddressId": "ea0",
  "preferredPhoneNumberId": "wp0",
  "preferredMailingAddressId": "wa0",
  "governmentOwned": false,
  "registeredIn": "NC",
  "publiclyHeld": false,
  "smallBusiness": true,
  "taxExempt": false,
  "type": "corporation",
  "subtype": "soleProprietorship",
  "countryOfOperations": "US",
  "authorizedSigners": {},
  "beneficialOwners": {},
  "coreBanking": {
    "finxact": {
      "customerGroup": "--64964c9c8e8f----2d-5e-",
      "partyOrgId": "--4WS6lkgjD4u-----5F-Bg-"
    }
  },
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_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 {organizationId}. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

organizationNotFound

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.

This error response may have one of the following type values:

itemStillPending

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.

This error response may have one of the following type values:

noSuchProfileValue

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.

Configuration

Organizations Service Configuration

getConfiguration

Code samples

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

GET https://api.devbank.apiture.com/organizations/configurations 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/configurations',
  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/configurations',
{
  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/configurations',
  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/configurations', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/configurations");
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/configurations", data)
    req.Header = headers

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

Configuration definition for this API

GET /configurations

Returns the configuration for this API.

Try It

Example responses

200 Response

{
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/configurations/configurations/"
    },
    "apiture:groups": {
      "href": "https://api.devbank.apiture.com/configurations/configurations/groups"
    }
  }
}

Responses

Status	Description
200	OK
	OK.
	Schema: `configuration`

getConfigurationGroups

Code samples

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

GET https://api.devbank.apiture.com/organizations/configurations/groups 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/configurations/groups',
  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/configurations/groups',
{
  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/configurations/groups',
  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/configurations/groups', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/configurations/groups");
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/configurations/groups", data)
    req.Header = headers

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

Return a collection of configuration groups

GET /configurations/groups

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

Parameters

Parameter	Description
`start` (query)	`integer(int64)` The zero-based index of the first configuration group item to include in this page. The default 0 denotes the beginning of the collection.
`limit` (query)	`integer(int32)` The maximum number of configuration group 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.

Try It

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroups/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/configurations/groups?start=10&limit=10"
    },
    "first": {
      "href": "/configurations/configurations/groups?start=0&limit=10"
    },
    "next": {
      "href": "/configurations/configurations/groups?start=20&limit=10"
    },
    "collection": {
      "href": "/configurations/configurations/groups"
    }
  },
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "configurationGroups",
  "_embedded": {
    "items": {
      "0": {
        "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/basic"
          }
        },
        "name": "basic",
        "label": "Basic Settings",
        "description": "The basic settings for the Transfers API"
      },
      "1": {
        "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/calendar"
          }
        },
        "name": "calendar",
        "label": "Calendar",
        "description": "A calendar that specifies which dates are valid for performing transfers (e.g., weekdays excluding federal holidays)"
      }
    }
  }
}

Responses

Status	Description
200	OK
	OK.
	Schema: `configurationGroups`

Status Description

400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

malformedRequestBodyBadRequest

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`

getConfigurationGroup

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/organizations/configurations/groups/{groupName} \
  -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/configurations/groups/{groupName} 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/configurations/groups/{groupName}',
  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/configurations/groups/{groupName}',
{
  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/configurations/groups/{groupName}',
  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/configurations/groups/{groupName}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/configurations/groups/{groupName}");
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/configurations/groups/{groupName}", data)
    req.Header = headers

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

Fetch a representation of this configuration group

GET /configurations/groups/{groupName}

Return a HAL representation of this configuration group resource.

Parameters

Parameter	Description
`groupName` (path)	`string` (required) The unique name of this configuration group.
`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

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/groups/basic"
    }
  },
  "name": "basic",
  "label": "Basic Settings",
  "description": "The basic settings for the Transfers API",
  "schema": {
    "type": "object",
    "properties": {
      "dailyLimit": {
        "type": "number",
        "description": "The daily limit for the number of transfers"
      },
      "cutoffTime": {
        "type": "string",
        "format": "time",
        "description": "The cutoff time for scheduling transfers for the current day"
      }
    }
  },
  "values": {
    "dailyLimit": 5,
    "cutoffTime": 63000
  }
}

Responses

Status	Description
200	OK
	OK.
	Schema: `configurationGroup`

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 configuration group resource at the specified `{groupName}` 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 may be provided in an `If-None-Match` request header for `GET` operations for this configuration group resource.

getConfigurationGroupSchema

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/organizations/configurations/groups/{groupName}/schema \
  -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/configurations/groups/{groupName}/schema 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/configurations/groups/{groupName}/schema',
  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/configurations/groups/{groupName}/schema',
{
  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/configurations/groups/{groupName}/schema',
  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/configurations/groups/{groupName}/schema', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/configurations/groups/{groupName}/schema");
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/configurations/groups/{groupName}/schema", data)
    req.Header = headers

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

Fetch the schema for this configuration group

GET /configurations/groups/{groupName}/schema

Return a HAL representation of this configuration group schema resource.

Parameters

Parameter	Description
`groupName` (path)	`string` (required) The unique name of this configuration group.
`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

{
  "type": "object",
  "properties": {
    "dailyLimit": {
      "type": "number",
      "description": "The daily limit for the number of transfers"
    },
    "cutoffTime": {
      "type": "string",
      "format": "time",
      "description": "The cutoff time for scheduling transfers for the current day"
    }
  }
}

Responses

Status	Description
200	OK
	OK.
	Schema: `configurationSchema`

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 configuration group resource at the specified `{groupName}` 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 may be provided in an `If-Match` request header for `PUT`

getConfigurationGroupValues

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/organizations/configurations/groups/{groupName}/values \
  -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/configurations/groups/{groupName}/values 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/configurations/groups/{groupName}/values',
  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/configurations/groups/{groupName}/values',
{
  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/configurations/groups/{groupName}/values',
  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/configurations/groups/{groupName}/values', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/configurations/groups/{groupName}/values");
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/configurations/groups/{groupName}/values", data)
    req.Header = headers

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

Fetch the values for the specified configuration group

GET /configurations/groups/{groupName}/values

Return a representation of this configuration group values resource.

Parameters

Parameter	Description
`groupName` (path)	`string` (required) The unique name of this configuration group.
`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

{
  "dailyLimit": 5,
  "cutoffTime": 63000
}

Responses

Status	Description
200	OK
	OK.
	Schema: `configurationValues`

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 configuration group resource at the specified `{groupName}` 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 may be provided in an `If-Match` request header for `PUT`

updateConfigurationGroupValues

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/organizations/configurations/groups/{groupName}/values \
  -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/configurations/groups/{groupName}/values 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/configurations/groups/{groupName}/values',
  method: 'put',

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

const fetch = require('node-fetch');
const inputBody = '{
  "dailyLimit": 5,
  "cutoffTime": 63000
}';
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/configurations/groups/{groupName}/values',
{
  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/configurations/groups/{groupName}/values',
  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/configurations/groups/{groupName}/values', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/configurations/groups/{groupName}/values");
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/configurations/groups/{groupName}/values", data)
    req.Header = headers

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

Update the values for the specified configuration group

PUT /configurations/groups/{groupName}/values

Perform a complete replacement of this set of values.

Body parameter

{
  "dailyLimit": 5,
  "cutoffTime": 63000
}

Parameters

Parameter	Description
`groupName` (path)	`string` (required) The unique name of this configuration group.
`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)	`configurationValues` (required)

Try It

Example responses

200 Response

{
  "type": "object",
  "properties": {
    "dailyLimit": {
      "type": "number",
      "description": "The daily limit for the number of transfers"
    },
    "cutoffTime": {
      "type": "string",
      "format": "time",
      "description": "The cutoff time for scheduling transfers for the current day"
    }
  }
}

Responses

Status	Description
200	OK
	OK.
	Schema: `configurationSchema`

Status Description

400 Bad Request

Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.

This error response may have one of the following type values:

malformedRequestBodyBadRequest

Schema: errorResponse

Status	Description
403	Forbidden
	Access denied. Only user allowed to update configurations is an admin.
	Schema: `errorResponse`

Status	Description
404	Not Found
	Not Found. There is no such configuration group resource at the specified `{groupName}` The `_error` field in the response will contain details about the request error.
	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`

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`

getConfigurationGroupValue

Code samples

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

GET https://api.devbank.apiture.com/organizations/configurations/groups/{groupName}/values/{valueName} 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/configurations/groups/{groupName}/values/{valueName}',
  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/configurations/groups/{groupName}/values/{valueName}',
{
  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/configurations/groups/{groupName}/values/{valueName}',
  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/configurations/groups/{groupName}/values/{valueName}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/configurations/groups/{groupName}/values/{valueName}");
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/configurations/groups/{groupName}/values/{valueName}", data)
    req.Header = headers

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

Fetch a single value associated with the specified configuration group

GET /configurations/groups/{groupName}/values/{valueName}

Fetch a single value associated with this configuration group. This provides convenient access to individual values of the configuration group. The response is always a JSON value which can be parsed with a strict JSON parser. The response may be

a primitive number, boolean, or quoted JSON string.
a JSON array.
a JSON object.
null. Examples:
"a string configuration value"
120
true
null
{ "borderWidth": 8, "foregroundColor": "blue" } To update a specific value, use PUT /configurations/groups/{groupName}/values/{valueName} (operation updateConfigurationGroupValue).

Parameters

Parameter	Description
`groupName` (path)	`string` (required) The unique name of this configuration group.
`valueName` (path)	`string` (required) The unique name of a value in a configuration group. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern `letter [letter \| digit \| '-' \| '_']`*.

Try It

Example responses

200 Response

"string"

Responses

Status	Description
200	OK
	OK. The value of the named configuration value as a JSON string, number, boolean, array, or object.
	Schema: `string`

Status	Description
404	Not Found
	Not Found. There is either no such configuration group resource at the specified `{groupName}` or no such value at the specified `{valueName}`. 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 may be provided in an `If-Match` request header for `PUT` or `PATCH` operations which update this configuration group resource.

updateConfigurationGroupValue

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/organizations/configurations/groups/{groupName}/values/{valueName} \
  -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/configurations/groups/{groupName}/values/{valueName} 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/configurations/groups/{groupName}/values/{valueName}',
  method: 'put',

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

const fetch = require('node-fetch');
const inputBody = '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/configurations/groups/{groupName}/values/{valueName}',
{
  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/configurations/groups/{groupName}/values/{valueName}',
  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/configurations/groups/{groupName}/values/{valueName}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/organizations/configurations/groups/{groupName}/values/{valueName}");
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/configurations/groups/{groupName}/values/{valueName}", data)
    req.Header = headers

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

Update a single value associated with the specified configuration group

PUT /configurations/groups/{groupName}/values/{valueName}

Update a single value associated with this configuration group. This provides convenient access to individual values of the configuration group as defined in the configuration group's schema. The request body must conform to the configuration group's schema for the named {valueName}. This operation is idempotent. The request body must be a JSON value which can be parsed with a strict JSON parser. The response may be

a primitive number, boolean, or quoted JSON string.
a JSON array.
a JSON object.
null. Examples:
"a string configuration value"
120
true
null
{ "borderWidth": 8, "foregroundColor": "blue" } To fetch specific value, use GET /configurations/groups/{groupName}/values/{valueName} (operation getConfigurationGroupValue).

Body parameter

"string"

Parameters

Parameter	Description
`groupName` (path)	`string` (required) The unique name of this configuration group.
`valueName` (path)	`string` (required) The unique name of a value in a configuration group. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern `letter [letter \| digit \| '-' \| '_']`*.
`body` (body)	`string` (required) The request body must a valid JSON value and should be parsable with a JSON parser. The result may be a string, number, boolean, array, or object.

Try It

Example responses

200 Response

"string"

Responses

Status	Description
200	OK
	OK.
	Schema: `string`

Status	Description
403	Forbidden
	Access denied. Only administrators may update configurations.
	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 configuration group resource.

API

The Organizations API

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.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "groups": {
    "fristGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "0",
        "hidden": true
      },
      "key1": {
        "label": "Label for Key 1",
        "code": "1",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 1)"
          },
          "fr": {
            "label": "(French label for Key 1)"
          }
        }
      },
      "key2": {
        "label": "Label for Key 2",
        "code": "2",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 2)"
          },
          "fr": {
            "label": "(French label for Key 2)"
          }
        }
      },
      "key3": {
        "label": "Label for Key 3",
        "code": "3",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 3)"
          },
          "fr": {
            "label": "(French label for Key 3)"
          }
        }
      },
      "other": {
        "label": "Other",
        "variants": {
          "es": {
            "label": "(Spanish label for Other)"
          },
          "fr": {
            "label": "(French label for Other)"
          }
        },
        "code": "254"
      }
    },
    "secondGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "?",
        "hidden": true
      },
      "optionA": {
        "label": "Option A",
        "code": "A"
      },
      "optionB": {
        "label": "Option B",
        "code": "B"
      },
      "optionC": {
        "label": "Option C",
        "code": "C"
      },
      "other": {
        "label": "Other",
        "code": "_"
      }
    }
  }
}

Responses

Status	Description
200	OK
	OK.
	Schema: `labelGroups`

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

{
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0"
}

Responses

Status	Description
200	OK
	OK.
	Schema: `root`

getApiDoc

Code samples

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

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

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

};

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

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

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

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

};

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

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

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

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

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

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

Return API definition document

GET /apiDoc

Return the OpenAPI document that describes this API.

Try It

Example responses

200 Response

{}

Responses

Status	Description
200	OK
	OK.
	Schema: `Inline`

Response Schema

Schemas

abstractRequest

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json",
  "_links": {}
}

Abstract Request (v2.0.0)

An abstract schema used to define other request-only schemas. This is a HAL resource representation, minus the _error defined in abstractResource.

This schema was resolved from common/abstractRequest.

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.

This schema was resolved from common/links.

_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.
read-only

abstractResource

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  }
}

Abstract Resource (v2.1.0)

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.

This schema was resolved from common/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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`

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

address

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

Address (v1.0.0)

A postal address with the address type and an identifier.

This schema was resolved from contacts/address.

Properties

Name	Description
`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}$`
`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`
`_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}$`

addressType

"unknown"

Address Type (v1.0.0)

The type of a postal address.

Warning: The enum list will be removed in a future release.

The allowed values for this property are defined at runtime in the label group named addressType in the response from the getLabels operation.

This schema was resolved from contacts/addressType.

Type: string
Enumerated values:
unknown
home
prior
work
school
mailing
vacation
shipping
billing
headquarters
commercial
site
property
other
notApplicable

attributes

{}

Attributes (v2.1.0)

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

This schema was resolved from common/attributes.

Properties

authenticator

{
  "_profile": "https://production.api.apiture.com/schemas/auth/authenticator/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "/auth/challenges/2e61e506-1568-4f1a-a93e-4d0a48a06d0e/authenticators/7fadd35b-6f6b-4901-b1ba-d3b91c9dcee3"
    },
    "apiture:challenge": {
      "href": "/auth/challenges/challenges/b59438cd-5efb-4915-916b-0600bb2a4e1e"
    },
    "apiture:retry": {
      "href": "/auth/challenges/retriedAuthenticators?authenticator=7fadd35b-6f6b-4901-b1ba-d3b91c9dcee3"
    },
    "apiture:verify": {
      "href": "/auth/challenges/verifiedAuthenticators"
    }
  },
  "_id": "7fadd35b-6f6b-4901-b1ba-d3b91c9dcee3",
  "userId": "b2720469-3497-4b82-8b85-30f2155aa66d",
  "state": "started",
  "maskedTarget": "****1234",
  "type": {
    "name": "sms",
    "label": "SMS Code",
    "description": "Enter a code sent via SMS to the user's preferred mobile device.",
    "category": "device",
    "schema": {
      "title": "SMS attributes",
      "description": "Schema for an authenticator's `attributes` when the authenticator type is `sms`.",
      "type": "object",
      "required": {
        "0": "code",
        "1": "length"
      },
      "properties": {
        "code": {
          "type": "string",
          "description": "A code that was sent to the user's mobile device via SMS. The user should enter the code in the app, then set `attributes.code` to that. The length of the code (the number of characters or digits) must equal the `length'.",
          "minLength": 3,
          "maxLength": 10
        },
        "length": {
          "description": "The number of digits/characters that are sent to the user via SMS.",
          "type": "integer",
          "minimum": 3,
          "maximum": 10,
          "example": 6
        }
      }
    }
  },
  "maximumRetries": 3,
  "retryCount": 1,
  "createdAt": "2019-08-23T12:42:50.375Z",
  "expiresAt": "2019-08-23T13:12:50.375Z"
}

Authenticator (v1.2.0)

Representation of authenticators which verify a user's identity.

Links

Response and request bodies using this authenticator schema may contain the following links:

Rel	Summary	Method
`apiture:retry`	Retry an authenticator	`POST`
`apiture:start`	Start an authenticator	`POST`
`apiture:verify`	Verify a user's identity	`POST`
`apiture:challenge`	Fetch a representation of this challenge	`GET`

This schema was resolved from auth/authenticator.

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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`type`	`authenticatorType` The type of this authenticator. This must be one of the items in the `/authenticatorTypes` resource.
`maximumRetries`	`integer` The maximum number of times the user may retry this authenticator. If `0`, the user must authenticate correctly on the first try. When an authenticator is retried, the client should `POST` to the `apiture:retry` link on the authenticators; absence of the link means the user cannot retry the authenticator. The default is `3`. `maximum: 10`
`_id`	`string` The unique identifier for this authenticator resource. This is an immutable opaque string assigned upon creation. `read-only`
`userId`	`string` The user ID of the user who is requested to verify their identity.
`state`	`authenticatorState` The state of this authenticator. This is derived and read-only. `read-only`
`maskedTarget`	`string` A masked value which helps identify the specific authenticator target, such as a masked mobile phone or a masked email address.
`retryCount`	`integer` The actual number of times a user has retried this authenticator. `read-only` `maximum: 10`
`attributes`	`object` Data collected from the user that is used to verify this authenticator. This data conforms to the schema defined in the `type`. For example, for `sms`, the `attributes` must contains a `code`.
`createdAt`	`string(date-time)` The time stamp when authenticator was created, in RFC 3339 UTC date-time format (`YYYY-MM-DDThh:mm:ss.sssZ`). `read-only`
`verifiedAt`	`string(date-time)` The time stamp when authenticator was verified in RFC 3339 UTC date-time format (`YYYY-MM-DDThh:mm:ss.sssZ`). `read-only`
`failedAt`	`string(date-time)` The time stamp when the user failed to verify their identity verification (authentication) for this challenge, in RFC 3339 UTC date-time format (`YYYY-MM-DDThh:mm:ss.sssZ`). `read-only`
`expiresAt`	`string(date-time)` The time stamp when the this challenge expires, in RFC 3339 UTC date-time format (`YYYY-MM-DDThh:mm:ss.sssZ`). `read-only`

authenticatorCategory

"knowledge"

authenticatorCategory (v1.0.0)

Categories which help classify and organize different authenticator types:

knowledge - Something you know, such as a password or answers to personal questions.
biometric - Something you are, such as facial recognition or fingerprints.
device - Something you have, such as a mobile phone (for confirmation via a code sent via text message) or an electronic key.

authenticatorCategory strings may have one of the following enumerated values:

Value	Description
`knowledge`	Knowledge: Authenticate with information the user knows, such as a password or answers to personal questions.
`biometric`	Biometric: Authenticate with physical characteristics of the user, such as fingerprints, voiceprint, or faceprint.
`device`	Device: Authenticate with a device that the user has, such as a mobile phone or an electronic key.

These enumeration values are further described by the label group named authenticatorCategory in the response from the getLabels operation.

This schema was resolved from auth/authenticatorCategory.

Type: string
Enumerated values:
knowledge
biometric
device

authenticatorState

"pending"

Authenticator State (v1.0.0)

The state of a challenge authenticator resource.

The startAuthenticator operation (link apiture:start) changes the state from pending to started.
The retryAuthenticator operation (link apiture:retry) changes the state to started and is only allowed if the authenticator has more retries available.
The verifyAuthenticator operation (link apiture:verify) validates the attributes and changes the state to verified if valid or to failed if invalid.

authenticatorState strings may have one of the following enumerated values:

Value	Description
`pending`	Pending: The authenticator is created but not yet started.
`started`	Started: The user has started the authenticator.
`verified`	Verified: The user corresponding verified the authenticator.
`failed`	Failed: The user failed the authenticators criteria.
`expired`	Expired: The authenticator expired before the user completed the criteria.

These enumeration values are further described by the label group named authenticatorState in the response from the getLabels operation.

This schema was resolved from auth/authenticatorState.

Type: string
Enumerated values:
pending
started
verified
failed
expired

authenticatorType

{
  "name": "sms",
  "label": "SMS code",
  "description": "Enter a code sent via SMS to the user's preferred mobile device.",
  "category": "device",
  "schema": {
    "title": "SMS attributes",
    "description": "Schema for an authenticator's `attributes` when the authenticator type is `sms`.",
    "type": "object",
    "required": [
      "code",
      "length"
    ],
    "properties": {
      "code": {
        "type": "string",
        "description": "A code that was sent to the user's mobile device via SMS. The user should enter the code in the app, then set `attributes.code` to that. The length of the code (the number of characters or digits) must equal the `length'.",
        "minLength": 3,
        "maxLength": 10
      },
      "length": {
        "description": "The number of digits/characters that are sent to the user via SMS.",
        "type": "integer",
        "minimum": 3,
        "maximum": 10,
        "example": 6
      }
    }
  }
}

Authenticator Type (v1.0.0)

An authenticator type description.

This schema was resolved from auth/authenticatorType.

Properties

Name	Description
`name`	`string` The name of this authenticator; also the key in the `authenticatorTypes` object.
`label`	`string` A localized label or title which may be used labels or other UI controls which present a value.
`description`	`string` A more detailed localized description of an authenticator type.
`language`	`string` The actual natural language tag to which this authentication type description is associated, as per RFC 7231. If omitted, this serves as the default.
`category`	`authenticatorCategory` The authentication category.
`schema`	`object` The JSON schema which describe the `attributes` object for all authenticators of this type. For example, for `sms`, the schema defines a required `code` string.

authorization

{
  "firstName": "John",
  "middleName": "Daniel",
  "lastName": "Smith",
  "addresses": {
    "0": {
      "_id": "ha5",
      "type": "home",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "_id": "wa1",
      "type": "other",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US",
      "id": "wa0",
      "label": "mailing"
    }
  },
  "preferredMailingAddressId": "ha5",
  "userId": "bd9e7a93-32cc-435d-ac57-f21faa082318",
  "customerId": "10047294723672",
  "type": "joint",
  "role": "Chief Financial Officer",
  "taxId": "*****3333",
  "citizen": true,
  "emailAddress": "JohnDanielSmith@example.com"
}

Authorization (v1.1.0)

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.

This schema was resolved from contacts/authorization.

Properties

Name	Description
`firstName`	`string` (required) The person's first name (or given name). `maxLength: 80`
`middleName`	`string` The person's middle name. `maxLength: 80`
`lastName`	`string` (required) The person's last name (or surname). `maxLength: 80`
`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. This will return a masked tax ID, where only the last 4 digits are visible. If the `?unmasked=true` query parameter is passed, the full, unmasked tax ID is returned.
`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. `primary` the `contact` is the primary owner of a personal account. There may be only one primary owner. The target of the authorization is a single personal account. `joint` the `contact` is a non-primary joint owner of a personal account. The target of the authorization is a single personal account. `authorizedSigner` the `contact` is an authorized signer for a business account. The target of the authorization is an all business accounts owned by the organization.
`role`	`string` The person's role at the organization. This attribute is required when the authorization type is authorizedSigner.

authorizationType

"primary"

Account Authorization type (v1.0.0)

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.

authorizationType strings may have one of the following enumerated values:

Value	Description
`primary`	Primary Account Holder: The primary account holder of a personal account. There may be only one primary owner.
`joint`	Joint Account Holder: A non-primary joint account holder of a personal account.
`authorizedSigner`	Authorized Signer: Authorized Signer of a business account.

These enumeration values are further described by the label group named authorizationType in the response from the getLabels operation.

This schema was resolved from contacts/authorizationType.

Type: string
Enumerated values:
primary
joint
authorizedSigner

authorizedSigner

{
  "firstName": "John",
  "middleName": "Daniel",
  "lastName": "Smith",
  "addresses": {
    "0": {
      "_id": "ha5",
      "type": "home",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Apt 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "_id": "wa1",
      "type": "other",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US",
      "id": "wa0",
      "label": "mailing"
    }
  },
  "preferredMailingAddressId": "ha5",
  "userId": "bd9e7a93-32cc-435d-ac57-f21faa082318",
  "customerId": "10047294723672",
  "type": "authorizedSigner",
  "role": "Chief Financial Officer",
  "taxId": "*****3333",
  "citizen": true,
  "emailAddress": "JohnDanielSmith@example.com",
  "_id": "as001"
}

Authorized Signer (v1.1.0)

A person who is authorized to perform banking operations on an organization's banking accounts.

Properties

Name	Description
`firstName`	`string` (required) The person's first name (or given name). `maxLength: 80`
`middleName`	`string` The person's middle name. `maxLength: 80`
`lastName`	`string` (required) The person's last name (or surname). `maxLength: 80`
`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. This will return a masked tax ID, where only the last 4 digits are visible. If the `?unmasked=true` query parameter is passed, the full, unmasked tax ID is returned.
`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. `primary` the `contact` is the primary owner of a personal account. There may be only one primary owner. The target of the authorization is a single personal account. `joint` the `contact` is a non-primary joint owner of a personal account. The target of the authorization is a single personal account. `authorizedSigner` the `contact` is an authorized signer for a business account. The target of the authorization is an all business accounts owned by the organization.
`role`	`string` The person's role at the organization. This attribute is required when the authorization type is authorizedSigner.
`_id`	`string` The unique identifier for this authorized signer resource. This is an immutable opaque string. `read-only`

authorizedSigners

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/authorizedSigners/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "items": {
    "0": {
      "_id": "as001",
      "userId": "bd9e7a93-32cc-435d-ac57-f21faa082318",
      "customerId": "10047294723672",
      "type": "authorizedSigner",
      "role": "Chief Financial Officer",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "taxId": "*****3333",
      "citizen": true,
      "addresses": {
        "0": {
          "_id": "ha5",
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Apt 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        }
      },
      "preferredMailingAddressId": "ha5",
      "emailAddress": "JohnDanielSmith@example.com"
    }
  }
}

Authorized Signers (v1.2.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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`items`	`[authorizedSigner]` 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",
  "middleName": "Daniel",
  "lastName": "Wellphunded",
  "addresses": {
    "0": {
      "_id": "ha1",
      "type": "home",
      "addressLine1": "1234 S Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "_id": "wa1",
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "preferredMailingAddressId": "ha1",
  "emailAddresses": {
    "0": {
      "id": "pe0",
      "value": "api@apiture.com",
      "type": "personal"
    },
    "1": {
      "id": "wp1",
      "value": "support@apiture.com",
      "type": "work"
    }
  },
  "preferredEmailAddressId": "pe0",
  "phones": {
    "0": {
      "_id": "hp1",
      "type": "home",
      "number": "+19105550155"
    },
    "1": {
      "_id": "mp1",
      "type": "mobile",
      "number": "+19105550159"
    },
    "2": {
      "_id": "wp1",
      "type": "work",
      "number": "+19105550162",
      "extension": "4512"
    }
  },
  "preferredPhoneId": "hp1",
  "preferredName": "John",
  "suffix": "MD",
  "identification": {
    "0": {
      "type": "taxId",
      "value": "111-11-1111"
    }
  },
  "preferredContactMethod": "email",
  "_id": "b003",
  "role": "Chief Financial Officer",
  "birthdate": "1982-10-19",
  "percentage": 35,
  "contactId": "8bf04d7d-c1bd-4945-b0ac-40ef02bb3953"
}

Beneficial Owner (v1.4.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). `maxLength: 80`
`middleName`	`string` The person's middle name. `maxLength: 80`
`lastName`	`string` (required) The person's last name (or surname). `maxLength: 80`
`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.
`_id`	`string` The unique identifier for this beneficial owner resource. This is an immutable opaque string. `read-only`
`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 owner'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

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/beneficialOwners/v1.4.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com//organizations/organizations/0399abed-fd3d/beneficialOwners"
    }
  },
  "items": {
    "0": {
      "_id": "b003",
      "firstName": "William",
      "lastName": "Wellphunded",
      "addresses": {
        "0": {
          "addressLine1": "1234 S Front Street",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US",
          "type": "home"
        }
      },
      "role": "Chief Financial Officer",
      "percentage": 35,
      "birthdate": "1982-10-19",
      "identification": {
        "0": {
          "type": "taxId",
          "value": "111-11-1111"
        }
      },
      "contactId": "76e018d8-de7e-4631-aad8-fc1aa1d04bf7"
    }
  }
}

Beneficial Owners (v1.4.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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`items`	`[beneficialOwner]` (required) A list of people who own at least 25% of the business, and the percentage owned. `maxLength: 10`

challenge

{
  "_profile": "https://production.api.apiture.com/schemas/auth/challenge/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "/auth/challenges/5d63053d-435c-4455-a0b5-6f88ab729d1a"
    },
    "apiture:redeem": {
      "href": "/auth/redeemedChallenges?challenge=5d63053d-435c-4455-a0b5-6f88ab729d1a"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "reason": "Transfer amount much higher than normal",
  "contextUri": "https://fi.apiture.com/transfers/scheduledTransfers/50b9df19-d6bf-4ac0-b5f4-3e6448b7dacd",
  "minimumAuthenticatorCount": 1,
  "authenticators": {
    "0": {
      "_id": "7fadd35b-6f6b-4901-b1ba-d3b91c9dcee3",
      "_profile": "https://production.api.apiture.com/schemas/auth/authenticator/v1.2.0/profile.json",
      "userId": "b2720469-3497-4b82-8b85-30f2155aa66d",
      "state": "started",
      "type": {
        "name": "sms",
        "label": "SMS Code",
        "description": "Enter a code sent via SMS to the user's preferred mobile device.",
        "category": "device",
        "schema": {
          "title": "SMS attributes",
          "description": "Schema for an authenticator's `attributes` when the authenticator type is `sms`.",
          "type": "object",
          "required": {
            "0": "code",
            "1": "length"
          },
          "properties": {
            "code": {
              "type": "string",
              "description": "A code that was sent to the user's mobile device via SMS. The user should enter the code in the app, then set `attributes.code` to that. The length of the code (the number of characters or digits) must equal the `length'.",
              "minLength": 3,
              "maxLength": 10
            },
            "length": {
              "description": "The number of digits/characters that are sent to the user via SMS.",
              "type": "integer",
              "minimum": 3,
              "maximum": 10,
              "example": 6
            }
          }
        }
      },
      "maximumRetries": 3,
      "retryCount": 1,
      "createdAt": "2019-08-23T12:42:50.375Z",
      "expiresAt": "2019-08-23T13:12:50.375Z",
      "_links": {
        "self": {
          "href": "/auth/challenges/0399abed-fd3d-4830-a88b-30f38b8a365c/authenticators/7fadd35b-6f6b-4901-b1ba-d3b91c9dcee3"
        },
        "apiture:challenge": {
          "href": "/auth/challenges/0399abed-fd3d-4830-a88b-30f38b8a365c"
        },
        "apiture:retry": {
          "href": "/auth/challenges/retriedAuthenticators?authenticator=7fadd35b-6f6b-4901-b1ba-d3b91c9dcee3"
        },
        "apiture:verify": {
          "href": "/auth/challenges/verifiedAuthenticators"
        }
      }
    }
  },
  "maximumRedemptionCount": 1,
  "redemptionCount": 0,
  "state": "pending",
  "createdAt": "2019-08-23T11:37:55.375Z",
  "expiresAt": "2019-08-23T12:37:55.375Z"
}

Challenge (v1.2.0)

A resource which represents an identity verification challenge to a user. The user must verify one or more of the authentication methods defined in this challenge in order to proceed with a banking operation (such as scheduling a larger than normal transfer, adding a joint owner or authorized signer to an account, or changing their mailing address or mobile phone number).

Links

Response and request bodies using this challenge schema may contain the following links:

Rel	Summary	Method
`apiture:redeem`	Redeem or use a challenge	`POST`

This schema was resolved from auth/challenge.

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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`reason`	`string` The reason the application or service has issued a challenge requesting the user verify their identity. This is for labeling or informational purposes.
`contextUri`	`string(uri)` The URI of a resource that establishes the context in which the user is asked to authenticate their identity. For example, for this may be for a pending transfer, a user's mailing address, or an account if adding a joint owner. `maxLength: 2048`
`userId`	`string` The user ID of the user who is requested to verify their identity. The default is the userID of the authenticated person creating the challenge.
`minimumAuthenticatorCount`	`integer` The minimum number of different authenticators the user must verify in order to satisfy the identity challenge. The default is 1. `maximum: 4`
`maximumRedemptionCount`	`integer` The maximum number of times the challenge may be used or redeemed. The default is 1. `minimum: 1`
`_id`	`string` The unique identifier for this challenge resource. This is an immutable opaque string assigned upon creation. `read-only`
`redemptionCount`	`integer` How many times the challenge has been redeemed. `read-only`
`state`	`challengeState` The state of this authenticator. `read-only`
`createdAt`	`string(date-time)` The time stamp when challenge was created, in RFC 3339 UTC date-time format (`YYYY-MM-DDThh:mm:ss.sssZ`). `read-only`
`authenticators`	`[authenticator]` An array of authenticators with which the user can verify their identity. This is derived; the array and the authenticators are constructed in the `createChallenge` operation. `read-only`
`redeemable`	`boolean` `true` if and only if the challenge may be redeemed. This is derived from the states of the challenge's authenticators; if the number of `verified` authenticators meets or exceeds the `minimumAuthenticatorCount`, the challenge becomes `verified` and may be redeemed via a `POST` to href in the challenge's `apiture:redeem` link. `read-only`
`verifiedAt`	`string(date-time)` The time stamp when challenge was verified in RFC 3339 UTC date-time format (`YYYY-MM-DDThh:mm:ss.sssZ`). `read-only`
`failedAt`	`string(date-time)` The time stamp when the user failed to verify their identity verification (authentication) for this challenge, in RFC 3339 UTC date-time format (`YYYY-MM-DDThh:mm:ss.sssZ`). `read-only`
`expiresAt`	`string(date-time)` The time stamp when the this challenge expires, in RFC 3339 UTC date-time format (`YYYY-MM-DDThh:mm:ss.sssZ`). `read-only`
`redemptionHistory`	`[string]` The time stamps when a service or operation redeemed this challenge, in RFC 3339 UTC date-time format (`YYYY-MM-DDThh:mm:ss.sssZ`). Item 0 is the time stamp the challenge was first redeemed, item 1 is the time stamp of the next redemption, and so on. `read-only`
`code`	`string` An optional authentication code which is only returned in the challenge resource if both a) the platform assigned the `code` when constructing the challenge), and b) the user has successfully verified the challenge. The client must re-fetch the verified challenge in order to access this property. `read-only` `minLength: 16` `maxLength: 128`

challengeError

{
  "_id": "2eae46e1575c0a7b0115a4b3",
  "message": "Descriptive error message...",
  "statusCode": 422,
  "type": "errorType1",
  "remediation": "Remediation string...",
  "occurredAt": "2018-01-25T05:50:52.375Z",
  "errors": {
    "0": {
      "_id": "ccdbe2c5c938a230667b3827",
      "message": "An optional embedded error"
    },
    "1": {
      "_id": "dbe9088dcfe2460f229338a3",
      "message": "Another optional embedded error"
    }
  },
  "_links": {
    "describedby": {
      "href": "https://developer.apiture.com/errors/errorType1"
    }
  }
}

Challenge Error (v1.2.0)

The operation error description with an embedded identity challenge.

This schema was resolved from auth/challengeError.

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. This schema was resolved from `common/links`.
`_embedded`	`object` Embedded objects
`» challenge`	`challenge` The details of the identity verification challenge.

challengeErrorResponse

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_embedded": {
      "errors": {}
    }
  }
}

Challenge Error Response (v1.2.0)

When an operation requires an additional identity verification challenge, it returns a 401 Unauthorized response status code and an error response with a challenge resource embedded in the _error._embedded.challenge. This informs the caller that they should verify the challenge via one or more of its authenticators, then retry the operation with the Apiture-Challenge header that references the challenge's _id.

This schema was resolved from auth/challengeErrorResponse.

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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`challengeError` The description of the error.

challengeState

"pending"

Challenge States (v1.0.0)

The state of an identity challenge resource. This is derived based on the state of the challenge's authenticators.

challengeState strings may have one of the following enumerated values:

Value	Description
`pending`	Pending: The challenge is created but not yet started.
`started`	Started: The user has started the challenge and associated authenticator(s).
`verified`	Verified: The user correctly verified the corresponding authenticator(s), marking the challenge as verified.
`failed`	Failed: The challenge has failed, often because the user failed one or more of the authenticators.
`redeemed`	Redeemed: The user has redeemed (used) the challenge.
`expired`	Expired: The challenge has expired without being verified.

These enumeration values are further described by the label group named challengeState in the response from the getLabels operation.

This schema was resolved from auth/challengeState.

Type: string
Enumerated values:
pending
started
verified
failed
redeemed
expired

collection

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  }
}

Collection (v2.1.0)

A collection of resources. This is an abstract model schema which is extended to define specific resource collections.

This schema was resolved from common/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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`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.

configuration

{
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/configurations/configurations/"
    },
    "apiture:groups": {
      "href": "https://api.devbank.apiture.com/configurations/configurations/groups"
    }
  }
}

Configuration

Represents the configuration for various services.

This schema was resolved from configurations/configuration.

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.

This schema was resolved from common/links.

configurationGroup

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/groups/basic"
    }
  },
  "name": "basic",
  "label": "Basic Settings",
  "description": "The basic settings for the Transfers API",
  "schema": {
    "type": "object",
    "properties": {
      "dailyLimit": {
        "type": "number",
        "description": "The daily limit for the number of transfers"
      },
      "cutoffTime": {
        "type": "string",
        "format": "time",
        "description": "The cutoff time for scheduling transfers for the current day"
      }
    }
  },
  "values": {
    "dailyLimit": 5,
    "cutoffTime": 63000
  }
}

Configuration Group (v2.1.0)

Represents a configuration group.

This schema was resolved from configurations/configurationGroup.

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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`name`	`string` The name of this configuration group, must be unique within the set of all resources of this type. `minLength: 1` `maxLength: 48` `pattern: [a-zA-Z][-\w_]*`
`label`	`string` The text label for this resource, suitable for presentation to the client. `minLength: 1` `maxLength: 128`
`description`	`string` The full description for this resource, suitable for presentation to the client. `minLength: 1` `maxLength: 4096`
`schema`	`configurationSchema` The schema which defines the name and types of the variables that are part of this configuration definition. Property names must be simple identifiers which follow the pattern `letter [letter \| digit \| - \| _]*`. This is implicitly a schema for `type: object` and contains the properties. The `values` in a configuration conform to the schema. The names and types are described with a subset of JSON Schema Core and JSON Schema Validation similar to that used to define schemas in OpenAPI Specification 2.0. This schema was resolved from `configurations/configurationSchema`.
`values`	`configurationValues` The data values associated with this configuration group: the group's variable names and values. These values must conform to this item's `schema`. Note: the `schema` may also contain `default` values which, if present, are used if a value is not set in the definition's `values`. For example, multiple configurations may use the same schema that defines values `a`, `b`, and `c`, but each configuration may have their own unique values for `a`, `b`, and `c` which is separate from the schema. This schema was resolved from `configurations/configurationValues`.

configurationGroupSummary

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroupSummary/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/groups/basic"
    }
  },
  "name": "basic",
  "label": "Basic Settings",
  "description": "The basic settings for the Transfers API"
}

Configuration Group Summary (v2.1.0)

A summary of the data contained within a configuration group resource.

This schema was resolved from configurations/configurationGroupSummary.

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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`name`	`string` The name of this configuration group, must be unique within the set of all resources of this type. `minLength: 1` `maxLength: 48` `pattern: [a-zA-Z][-\w_]*`
`label`	`string` The text label for this resource, suitable for presentation to the client. `minLength: 1` `maxLength: 128`
`description`	`string` The full description for this resource, suitable for presentation to the client. `minLength: 1` `maxLength: 4096`

configurationGroups

{
  "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroups/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/configurations/configurations/groups?start=10&limit=10"
    },
    "first": {
      "href": "/configurations/configurations/groups?start=0&limit=10"
    },
    "next": {
      "href": "/configurations/configurations/groups?start=20&limit=10"
    },
    "collection": {
      "href": "/configurations/configurations/groups"
    }
  },
  "start": 10,
  "limit": 10,
  "count": 67,
  "name": "configurationGroups",
  "_embedded": {
    "items": {
      "0": {
        "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/basic"
          }
        },
        "name": "basic",
        "label": "Basic Settings",
        "description": "The basic settings for the Transfers API"
      },
      "1": {
        "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroup/v2.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/configurations/groups/calendar"
          }
        },
        "name": "calendar",
        "label": "Calendar",
        "description": "A calendar that specifies which dates are valid for performing transfers (e.g., weekdays excluding federal holidays)"
      }
    }
  }
}

Configuration Group Collection (v2.1.0)

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

This schema was resolved from configurations/configurationGroups.

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. This schema was resolved from `common/links`.
`_embedded`	`configurationGroupsEmbedded` Embedded objects.
`_profile`	`string(uri)` The URI of a resource profile which describes the representation. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`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.

configurationGroupsEmbedded

{
  "items": [
    {
      "_profile": "https://production.api.apiture.com/schemas/configurations/configurationGroupSummary/v2.1.0/profile.json",
      "_links": {
        "self": {
          "href": "/configurations/groups/basic"
        }
      },
      "name": "basic",
      "label": "Basic Settings",
      "description": "The basic settings for the Transfers API"
    }
  ]
}

Configuration Groups Embedded Objects (v1.1.0)

Objects embedded in the configurationGroupscollection.

This schema was resolved from configurations/configurationGroupsEmbedded.

Properties

Name	Description
`items`	`[configurationGroupSummary]` An array containing a page of configuration group items.

configurationSchema

{
  "type": "object",
  "properties": {
    "dailyLimit": {
      "type": "number",
      "description": "The daily limit for the number of transfers"
    },
    "cutoffTime": {
      "type": "string",
      "format": "time",
      "description": "The cutoff time for scheduling transfers for the current day"
    }
  }
}

Configuration Schema (v2.1.0)

The schema which defines the name and types of the variables that are part of this configuration definition. Property names must be simple identifiers which follow the pattern letter [letter | digit | - | _]*.

This is implicitly a schema for type: object and contains the properties.

The values in a configuration conform to the schema. The names and types are described with a subset of JSON Schema Core and JSON Schema Validation similar to that used to define schemas in OpenAPI Specification 2.0.

This schema was resolved from configurations/configurationSchema.

Properties

Name Description

additionalProperties

configurationSchemaValue
The data associated with this configuration schema.

This schema was resolved from configurations/configurationSchemaValue.

configurationSchemaValue

{}

Configuration Schema Value (v2.0.0)

The data associated with this configuration schema.

This schema was resolved from configurations/configurationSchemaValue.

Properties

configurationValue

{}

Configuration Value (v2.0.0)

The data associated with this configuration.

This schema was resolved from configurations/configurationValue.

Properties

configurationValues

{
  "dailyLimit": 5,
  "cutoffTime": 63000
}

Configuration Values (v2.0.0)

The data values associated with this configuration group: the group's variable names and values. These values must conform to this item's schema.

Note: the schema may also contain default values which, if present, are used if a value is not set in the definition's values.

For example, multiple configurations may use the same schema that defines values a, b, and c, but each configuration may have their own unique values for a, b, and c which is separate from the schema.

This schema was resolved from configurations/configurationValues.

Properties

Name Description

additionalProperties

configurationValue
The data associated with this configuration.

This schema was resolved from configurations/configurationValue.

createAuthorization

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:user": {
      "href": "https://api.devbank.apiture.com/users/users/bd9e7a93-32cc-435d-ac57-f21faa082318"
    }
  },
  "firstName": "John",
  "middleName": "Daniel",
  "lastName": "Smith",
  "addresses": {
    "0": {
      "_id": "ha5",
      "type": "home",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "_id": "wa1",
      "type": "other",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US",
      "id": "wa0",
      "label": "mailing"
    }
  },
  "preferredMailingAddressId": "ha5",
  "userId": "bd9e7a93-32cc-435d-ac57-f21faa082318",
  "customerId": "10047294723672",
  "type": "joint",
  "role": "Chief Financial Officer",
  "taxId": "*****3333",
  "citizen": true,
  "emailAddress": "JohnDanielSmith@example.com"
}

Create Authorization (v1.1.0)

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.

This schema was resolved from contacts/createAuthorization.

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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`firstName`	`string` (required) The person's first name (or given name). `maxLength: 80`
`middleName`	`string` The person's middle name. `maxLength: 80`
`lastName`	`string` (required) The person's last name (or surname). `maxLength: 80`
`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. This will return a masked tax ID, where only the last 4 digits are visible. If the `?unmasked=true` query parameter is passed, the full, unmasked tax ID is returned.
`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. `primary` the `contact` is the primary owner of a personal account. There may be only one primary owner. The target of the authorization is a single personal account. `joint` the `contact` is a non-primary joint owner of a personal account. The target of the authorization is a single personal account. `authorizedSigner` the `contact` is an authorized signer for a business account. The target of the authorization is an all business accounts owned by the organization.
`role`	`string` The person's role at the organization. This attribute is required when the authorization type is authorizedSigner.

createAuthorizedSigner

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:user": {
      "href": "https://api.devbank.apiture.com/users/users/bd9e7a93-32cc-435d-ac57-f21faa082318"
    }
  },
  "firstName": "John",
  "middleName": "Daniel",
  "lastName": "Smith",
  "addresses": {
    "0": {
      "_id": "ha5",
      "type": "home",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "_id": "wa1",
      "type": "other",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US",
      "id": "wa0",
      "label": "mailing"
    }
  },
  "preferredMailingAddressId": "ha5",
  "userId": "bd9e7a93-32cc-435d-ac57-f21faa082318",
  "customerId": "10047294723672",
  "type": "joint",
  "role": "Chief Financial Officer",
  "taxId": "*****3333",
  "citizen": true,
  "emailAddress": "JohnDanielSmith@example.com"
}

New Authorized Signer (v1.1.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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`firstName`	`string` (required) The person's first name (or given name). `maxLength: 80`
`middleName`	`string` The person's middle name. `maxLength: 80`
`lastName`	`string` (required) The person's last name (or surname). `maxLength: 80`
`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. This will return a masked tax ID, where only the last 4 digits are visible. If the `?unmasked=true` query parameter is passed, the full, unmasked tax ID is returned.
`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. `primary` the `contact` is the primary owner of a personal account. There may be only one primary owner. The target of the authorization is a single personal account. `joint` the `contact` is a non-primary joint owner of a personal account. The target of the authorization is a single personal account. `authorizedSigner` the `contact` is an authorized signer for a business account. The target of the authorization is an all business accounts owned by the organization.
`role`	`string` The person's role at the organization. This attribute is required when the authorization type is authorizedSigner.

createOrganization

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/createOrganization/v1.6.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    },
    "apiture:user": {
      "href": "https://api.devbank.apiture.com/users/users/00007276-8b25-4e97-ac82-e1e17a2ff7c2"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": {
    "0": {
      "type": "work",
      "value": "smitties-detailing@example.com"
    }
  },
  "identification": {
    "0": {
      "type": "taxId",
      "value": "00-9999999"
    }
  },
  "phones": {
    "0": {
      "type": "work",
      "number": "+19105550155"
    },
    "1": {
      "type": "mobile",
      "number": "+19105550154"
    }
  },
  "addresses": {
    "0": {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 101,
  "employeeCountUpperBound": 250,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": "trustManagement",
    "subjectToWithholdings": true
  }
}

Create Organization (v1.6.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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`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 `organizationType` value in the response of the `getLabels` operation.
`subtype`	`organizationSubtype` A refinement of the `type`. The enumeration values are described by the `organizationSubtype` value in the response of the `getLabels` operation.
`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`
`taxAddressId`	`string` The `_id` of an address that the financial institution and the organization use for tax purposes. The tax address may differ from the organization's preferred mailing address, but it must be an `approved` physical address, and it may not be a P.O. Box. This value is set with the `setTaxAddress` operation. `minLength: 1` `maxLength: 4`
`establishedOn`	`string(date)` The date the organization was established.
`establishedDate`	`string(date)` The date the organization was established. Warning: The property `establishedDate` was deprecated on version `v1.1.0` of the schema. Use `establishedOn` instead. `establishedDate` will be removed on version `v2.0.0` of the schema. `deprecated`
`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 `employeeCountRange` in the response from the `getLabels` operation.
`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`
`yearsOwned`	`yearsOwned` The number of years the owners/operators have owned the 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.
`physicalLocationsCount`	`physicalLocationsCount` The number of physical sites, offices, or locations the organization owns, operates, or occupies. Warning: the `enum` list will be removed in a future release and the values defined at runtime via the `physicalLocationsCount` group in the response from the `getLabels` operation.
`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 `industrySectors` in the response from the `getLabels` operation.
`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` `true` if mobile check deposits are enabled for the organization.
`achEnabled`	`boolean` `true` if ACH transfers are enabled the organization.
`wireEnabled`	`boolean` `true` if wire transfers are enabled for the organization .
`estimatedMonthlyAmounts`	`estimatedMonthlyAmounts` Estimated monthly amounts for banking services.
`estimatedMonthlyCounts`	`estimatedMonthlyCounts` Estimated banking activity per month.
`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 `regionCodes` in the response from the `getLabels` operation. `minLength: 2` `maxLength: 2` `pattern: ^[a-zA-Z]{2}$`
`attributes`	`object` An optional map of name/value pairs which provide additional metadata about the organization.

emailType

"unknown"

Email Type (v1.0.0)

The kind of email address.

Warning: The enum list will be removed in a future release.

The allowed values for this property are defined at runtime in the label group named emailType in the response from the getLabels operation.

This schema was resolved from contacts/emailType.

Type: string
Enumerated values:
unknown
personal
work
school
other
notApplicable

entityAuthorizationFormRequest

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/entityAuthorizationFormRequest/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "invitees": {
    "0": {
      "firstName": "Lucille",
      "lastName": "Wellphunded",
      "role": "Owner"
    }
  }
}

Entity Authorization Form Request (v1.1.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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`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`

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 (v2.1.0)

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

This schema was resolved from common/error.

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. This schema was resolved from `common/links`.

errorResponse

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_embedded": {
      "errors": {}
    }
  }
}

Error Response (v2.1.0)

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

This schema was resolved from common/errorResponse.

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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`

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

estimatedMonthlyAmounts

{
  "percentGrossRevenue": "string",
  "sentAch": "upToOneHundredThousand",
  "receivedAch": "oneHundredThousandToOneMillion",
  "achTransactions": "oneHundredThousandToOneMillion",
  "mobileCheckDeposit": "oneHundredThousandToOneMillion",
  "remoteCheckDeposit": "oneHundredThousandToOneMillion",
  "sentWire": "oneHundredThousandToOneMillion",
  "receivedWire": "moreThanOneMillion",
  "wireTransfers": "oneHundredThousandToOneMillion"
}

Estimated Monthly Amounts (v1.1.0)

Estimated monthly amounts for banking services.

Properties

Name	Description
`percentGrossRevenue`	`string` The percentage of gross revenue the organization derives from money services per month. Use this or `achTransactions`. The allowed values for this property are defined at runtime in the label group named `percentGrossRevenue` in the response from the `getLabels` operation.
`sentAch`	`string` The estimated total amount sent by ACH per month. The allowed values for this property are defined at runtime in the label group named `estimatedMonthlySentAchAmounts` in the response from the `getLabels` operation.
`receivedAch`	`string` The estimated total amount received by ACH per month. The allowed values for this property are defined at runtime in the label group named `estimatedMonthlyReceivedAchAmounts` in the response from the `getLabels` operation.
`achTransactions`	`string` The estimated total amount sent or received by ACH per month. Use this or `sentAch`/`receivedAch`. The allowed values for this property are defined at runtime in the label group named `estimatedMonthlyAchTransactionAmounts` in the response from the `getLabels` operation.
`mobileCheckDeposit`	`string` The estimated amount deposited by mobile app per month. The allowed values for this property are defined at runtime in the label group named `estimatedMonthlyMobileCheckDepositAmounts` in the response from the `getLabels` operation.
`remoteCheckDeposit`	`string` The estimated amount deposited remotely, via scanned images, per month. The allowed values for this property are defined at runtime in the label group named `estimatedMonthlyRemoteCheckDepositAmounts` in the response from the `getLabels` operation.
`sentWire`	`string` The estimated wire transfer amount sent per month. Use this or `wireTransfers`. The allowed values for this property are defined at runtime in the label group named `estimatedMonthlySentWireAmounts` in the response from the `getLabels` operation.
`receivedWire`	`string` The estimated wire transfers amount received per month. Use this or `wireTransfers`. The allowed values for this property are defined at runtime in the label group named `estimatedMonthlyReceivedWireAmounts` in the response from the `getLabels` operation.
`wireTransfers`	`string` The estimated wire transfer amount sent or received per month. Use this or `sentWire`/`receivedWire`. The allowed values for this property are defined at runtime in the label group named `estimatedMonthlyWireTransferAmounts` in the response from the `getLabels` operation.

estimatedMonthlyCounts

{
  "sentAch": "oneHundredOneToOneThousand",
  "receivedAch": "oneHundredOneToOneThousand",
  "achTransactions": "oneHundredOneToOneThousand",
  "mobileCheckDeposit": "oneHundredOneToOneThousand",
  "remoteCheckDeposit": "oneHundredOneToOneThousand",
  "sentWire": "oneToOneHundred",
  "receivedWire": "oneToOneHundred",
  "wireTransfers": "oneToOneHundred"
}

Estimated Monthly Counts (v1.0.0)

Estimated monthly activity for banking services.

Properties

Name	Description
`sentAch`	`string` The estimated number of ACH transactions sent per month. Use this or `achTransaction`. The allowed values for this property are defined at runtime in the label group named `estimatedMonthlySentAchCount` in the response from the `getLabels` operation.
`receivedAch`	`string` The estimated number of ACH transactions sent per month. Use this or `achTransaction`. The allowed values for this property are defined at runtime in the label group named `estimatedMonthlyReceivedAchCount` in the response from the `getLabels` operation.
`achTransactions`	`string` The estimated total number of ACH transactions per month. Use this or `sendAch`/`receivedAch. The allowed values for this property are defined at runtime in the label group named `estimatedMonthlyAchTransactionCount` in the response from the `getLabels` operation.
`mobileCheckDeposit`	`string` The estimated number of mobile app deposits per month. The allowed values for this property are defined at runtime in the label group named `estimatedMonthlyMobileCheckDepositCount` in the response from the `getLabels` operation.
`remoteCheckDeposit`	`string` The estimated number of remote deposits (via scanned images) per month. The allowed values for this property are defined at runtime in the label group named `estimatedMonthlyRemoteCheckDepositCount` in the response from the `getLabels` operation.
`sentWire`	`string` The estimated number of wires sent per month. Use this or `wireTransfers`. The allowed values for this property are defined at runtime in the label group named `estimatedMonthlySentWireCount` in the response from the `getLabels` operation.
`receivedWire`	`string` The estimated number of wires received per month. Use this or `wireTransfers`. The allowed values for this property are defined at runtime in the label group named `estimatedMonthlyReceivedWireCount` in the response from the `getLabels` operation.
`wireTransfers`	`string` The estimated number of wire transfers sent or received per month. Use this or `sentWire`/`receivedWire`. The allowed values for this property are defined at runtime in the label group named `estimatedMonthlyWireTransferCount` in the response from the `getLabels` operation.

identification

{
  "type": "taxId",
  "value": "112-22-3333",
  "expiration": "2024-12-01"
}

Identification (v1.0.1)

Official identifying information associated with the contact.

This schema was resolved from contacts/identification.

Properties

Name	Description
`value`	`string` (required) The value of this form of identification, such as tax ID as a string. The caller should pass the full `value` (for example `"112-22-3333"`) when creating a contact or user. The input `value` may include `'-'` formatting characters. This is a masked value in API responses, with one or more leading `''` characters and only the last four characters unmasked, such as `"****3333"`.
`type`	`identificationType` (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.

identificationType

"taxId"

Identification Type (v1.0.0)

The type of this form of identification.

identificationType strings may have one of the following enumerated values:

Value	Description
`taxId`	Tax ID: The government tax ID, such as a Social Security Number
`passportNumber`	Passport Number

These enumeration values are further described by the label group named identificationType in the response from the getLabels operation.

This schema was resolved from contacts/identificationType.

Type: string
Enumerated values:
taxId
passportNumber

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

invitedAuthorizedSigner

{
  "firstName": "Lucille",
  "middleName": "Daniel",
  "lastName": "Wellphunded",
  "role": "Owner"
}

Invited Authorized Signer (v1.1.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). `maxLength: 80`
`middleName`	`string` The person's middle name. `maxLength: 80`
`lastName`	`string` (required) The person's last name (or surname). `maxLength: 80`
`role`	`string` (required) The role or job title that the individual holds within the organization.

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 (v1.0.0)

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 derived 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", ... }.

This schema was resolved from common/labelGroup.

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.

This schema was resolved from common/labelItem.

labelGroups

{
  "_profile": "https://production.api.apiture.com/schemas/common/labelGroups/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "groups": {
    "fristGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "0",
        "hidden": true
      },
      "key1": {
        "label": "Label for Key 1",
        "code": "1",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 1)"
          },
          "fr": {
            "label": "(French label for Key 1)"
          }
        }
      },
      "key2": {
        "label": "Label for Key 2",
        "code": "2",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 2)"
          },
          "fr": {
            "label": "(French label for Key 2)"
          }
        }
      },
      "key3": {
        "label": "Label for Key 3",
        "code": "3",
        "variants": {
          "es": {
            "label": "(Spanish label for Key 3)"
          },
          "fr": {
            "label": "(French label for Key 3)"
          }
        }
      },
      "other": {
        "label": "Other",
        "variants": {
          "es": {
            "label": "(Spanish label for Other)"
          },
          "fr": {
            "label": "(French label for Other)"
          }
        },
        "code": "254"
      }
    },
    "secondGroup": {
      "unknown": {
        "label": "Unknown",
        "code": "?",
        "hidden": true
      },
      "optionA": {
        "label": "Option A",
        "code": "A"
      },
      "optionB": {
        "label": "Option B",
        "code": "B"
      },
      "optionC": {
        "label": "Option C",
        "code": "C"
      },
      "other": {
        "label": "Other",
        "code": "_"
      }
    }
  }
}

Label Groups (v1.1.0)

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).

This schema was resolved from common/labelGroups.

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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`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 derived 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", ... }`. This schema was resolved from `common/labelGroup`.

labelItem

{
  "over100Million": {
    "label": "Over $100,000,000.00",
    "code": "4",
    "range": "[100000000.00,]",
    "variants": {
      "fr": {
        "label": "Plus de $10M"
      }
    }
  }
}

Label Item (v1.0.0)

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.

This schema was resolved from common/labelItem.

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.
`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. This schema was resolved from `common/simpleLabel`.
`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]+)?)?[\]$]$`

link

{
  "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
  "title": "Application"
}

Link (v1.0.0)

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.

This schema was resolved from common/link.

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.

links

{
  "property1": {
    "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Application"
  },
  "property2": {
    "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Application"
  }
}

Links (v1.0.0)

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

This schema was resolved from common/links.

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.

This schema was resolved from common/link.

organization

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organization/v1.7.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/0399abed-fd3d"
    },
    "apiture:deactivate": {
      "href": "https://api.devbank.apiture.com/organizations/inactiveOrganizations?organization=0399abed-fd3d"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": {
    "0": {
      "type": "work",
      "value": "smitties-detailing@example.com",
      "_id": "ea0"
    }
  },
  "identification": {
    "0": {
      "type": "taxId",
      "value": "00-9999999"
    }
  },
  "phones": {
    "0": {
      "type": "work",
      "number": "+19105550155",
      "_id": "wp0"
    },
    "1": {
      "type": "mobile",
      "number": "+191055501554",
      "_id": "wp1"
    }
  },
  "addresses": {
    "0": {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 1,
  "employeeCountUpperBound": 1,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": {
      "0": "trustManagement"
    },
    "subjectToWithholdings": true
  },
  "_id": "0399abed-fd3d",
  "customerId": "1000489353781",
  "tradeName": "Smith's Auto Detailing",
  "preferredEmailAddressId": "ea0",
  "preferredPhoneNumberId": "wp0",
  "preferredMailingAddressId": "wa0",
  "governmentOwned": false,
  "registeredIn": "NC",
  "publiclyHeld": false,
  "smallBusiness": true,
  "taxExempt": false,
  "type": "corporation",
  "subtype": "soleProprietorship",
  "countryOfOperations": "US",
  "authorizedSigners": {},
  "beneficialOwners": {},
  "coreBanking": {
    "finxact": {
      "customerGroup": "--64964c9c8e8f----2d-5e-",
      "partyOrgId": "--4WS6lkgjD4u-----5F-Bg-"
    }
  },
  "createdAt": "2018-04-17T10:04:46.375Z",
  "updatedAt": "2018-04-17T10:12:58.375Z",
  "_embedded": {}
}

Organization (v1.7.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. This schema was resolved from `common/links`.
`_embedded`	`organizationEmbeddedObjects` Embedded objects, as selected with the `?embed` query parameter.
`_profile`	`string(uri)` The URI of a resource profile which describes the representation. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`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 `organizationType` value in the response of the `getLabels` operation.
`subtype`	`organizationSubtype` A refinement of the `type`. The enumeration values are described by the `organizationSubtype` value in the response of the `getLabels` operation.
`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`
`taxAddressId`	`string` The `_id` of an address that the financial institution and the organization use for tax purposes. The tax address may differ from the organization's preferred mailing address, but it must be an `approved` physical address, and it may not be a P.O. Box. This value is set with the `setTaxAddress` operation. `minLength: 1` `maxLength: 4`
`establishedOn`	`string(date)` The date the organization was established.
`establishedDate`	`string(date)` The date the organization was established. Warning: The property `establishedDate` was deprecated on version `v1.1.0` of the schema. Use `establishedOn` instead. `establishedDate` will be removed on version `v2.0.0` of the schema. `deprecated`
`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 `employeeCountRange` in the response from the `getLabels` operation.
`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`
`yearsOwned`	`yearsOwned` The number of years the owners/operators have owned the 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.
`physicalLocationsCount`	`physicalLocationsCount` The number of physical sites, offices, or locations the organization owns, operates, or occupies. Warning: the `enum` list will be removed in a future release and the values defined at runtime via the `physicalLocationsCount` group in the response from the `getLabels` operation.
`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 `industrySectors` in the response from the `getLabels` operation.
`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` `true` if mobile check deposits are enabled for the organization.
`achEnabled`	`boolean` `true` if ACH transfers are enabled the organization.
`wireEnabled`	`boolean` `true` if wire transfers are enabled for the organization .
`estimatedMonthlyAmounts`	`estimatedMonthlyAmounts` Estimated monthly amounts for banking services.
`estimatedMonthlyCounts`	`estimatedMonthlyCounts` Estimated banking activity per month.
`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 `regionCodes` in the response from the `getLabels` operation. `minLength: 2` `maxLength: 2` `pattern: ^[a-zA-Z]{2}$`
`_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
`coreBanking`	`organizationCoreBanking` Organization properties that are specific to the banking core provider. `read-only`
`attributes`	`object` An optional map of name/value pairs which provide additional metadata about the organization.

organizationAddress

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationAddress/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/addresses/ba1"
    },
    "apiture:setAsPreferred": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/preferredAddress?value=ba1"
    },
    "apiture:setAsTaxAddress": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/taxAddress?value=ba1"
    }
  },
  "addressLine1": "555 N Front Street",
  "addressLine2": "Suite 5555",
  "city": "Wilmington",
  "regionCode": "NC",
  "postalCode": "28401-5405",
  "countryCode": "US",
  "_id": "ba1",
  "type": "business",
  "state": "approved"
}

Organization Address (v1.2.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`
`apiture:setAsTaxAddress`	Set Tax Address	`PUT`

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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`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}$`
`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`
`_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}$`
`state`	`profileItemState` The state of this address. `pending` addresses may require financial institution approval. Only `approved` addresses may be set as the preferred or tax address.

organizationAddresses

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationAddresses/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/addresses"
    }
  },
  "items": {
    "0": {
      "_id": "main",
      "type": "business",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US",
      "state": "approved",
      "_profile": "https://production.api.apiture.com/schemas/organizations/organizationAddress/v1.2.0/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/addresses/main"
        }
      }
    },
    "1": {
      "_id": "billing",
      "type": "billing",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US",
      "_profile": "https://production.api.apiture.com/schemas/organizations/organizationAddress/v1.2.0/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/addresses/billing"
        }
      }
    }
  }
}

Organization Addresses (v1.2.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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`items`	`[organizationAddress]` An array containing address items. `minItems: 1` `maxItems: 2`

organizationCoreBanking

{
  "finxact": {
    "customerGroup": "--64964c9c8e8f----2d-5e-",
    "partyOrgId": "--4WS6lkgjD4u-----5F-Bg-"
  }
}

Organization Core Banking Properties (v1.0.0)

Organization properties that are specific to the banking core provider. The actual banking core in which the Apiture platform is executing determines what data appears. The sub-object for each banking core is present on a organization only if the Apiture system is connected to the corresponding core banking provider. The name of each sub-object is the name of that provider.

Properties

Name	Description
`finxact`	`organizationFinxactCoreBanking` Organization properties that are specific to the Finxact banking core system. This object is present only if the Apiture platform is connected to a Finxact system. `read-only`

organizationEmailAddress

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationEmailAddress/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/emailAddresses/pe1"
    },
    "delete": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/emailAddresses/pe1"
    },
    "apiture:setAsPreferred": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/preferredEmailAddresses?value=pe1"
    }
  },
  "_id": "pe1",
  "type": "personal",
  "number": "+19105550155",
  "state": "approved"
}

Email Address (v1.1.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
`_links`	`links` An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`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}$`
`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.

organizationEmailAddresses

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationEmailAddresses/v1.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/f2d87aa6-458c/emailAddresses"
    }
  },
  "items": {
    "0": {
      "_id": "pe0",
      "type": "personal",
      "label": "Personal",
      "number": "user7838@example.com",
      "state": "approved",
      "_profile": "https://production.api.apiture.com/schemas/organizations/organizationEmailAddress/v1.1.0/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com//organizations/organizations/f2d87aa6-458c/emailAddresses/pe0"
        }
      }
    },
    "1": {
      "_id": "pe2",
      "type": "personal",
      "label": "Personal",
      "value": "John.Smith@example.com",
      "state": "approved",
      "_profile": "https://production.api.apiture.com/schemas/organizations/organizationEmailAddress/v1.1.0/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com//organizations/organizations/f2d87aa6-458c/EmailAddresses/pe2"
        }
      }
    }
  }
}

The organization's email addresses (v1.1.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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`items`	`[organizationEmailAddress]` An array containing email address items.

organizationEmbeddedObjects

{
  "authorizedSigners": {
    "_profile": "https://production.api.apiture.com/schemas/organizations/authorizedSigners/v1.2.0/profile.json",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
      }
    },
    "items": {
      "0": {
        "_id": "as001",
        "userId": "bd9e7a93-32cc-435d-ac57-f21faa082318",
        "customerId": "10047294723672",
        "type": "authorizedSigner",
        "role": "Chief Financial Officer",
        "firstName": "John",
        "middleName": "Daniel",
        "lastName": "Smith",
        "taxId": "*****3333",
        "citizen": true,
        "addresses": {
          "0": {
            "_id": "ha5",
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Apt 5555",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US"
          }
        },
        "preferredMailingAddressId": "ha5",
        "emailAddress": "JohnDanielSmith@example.com"
      }
    }
  },
  "beneficialOwners": {
    "_profile": "https://production.api.apiture.com/schemas/organizations/beneficialOwners/v1.4.0/profile.json",
    "_links": {
      "self": {
        "href": "https://api.devbank.apiture.com//organizations/organizations/0399abed-fd3d/beneficialOwners"
      }
    },
    "items": {
      "0": {
        "_id": "b003",
        "firstName": "William",
        "lastName": "Wellphunded",
        "addresses": {
          "0": {
            "addressLine1": "1234 S Front Street",
            "city": "Wilmington",
            "regionCode": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US",
            "type": "home"
          }
        },
        "role": "Chief Financial Officer",
        "percentage": 35,
        "birthdate": "1982-10-19",
        "identification": {
          "0": {
            "type": "taxId",
            "value": "111-11-1111"
          }
        },
        "contactId": "76e018d8-de7e-4631-aad8-fc1aa1d04bf7"
      }
    }
  }
}

Organization Embedded Objects (v1.2.0)

Objects that are conditionally embedded within an organization object.

Properties

Name	Description
`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.

organizationFinxactCoreBanking

{
  "customerGroup": "--64964c9c8e8f----2d-5e-",
  "partyOrgId": "--4WS6lkgjD4u-----5F-Bg-"
}

Organization Core Banking Properties (v1.0.0)

Organization properties that are specific to the Finxact banking core system. (Note that the Finxact customerId property is the Apiture organization.customerId.)

Properties

Name	Description
`customerGroup`	`string` Each organization in Finxact belongs to a organization group. This property is the Finxact identifier of the this organization's customer group. `read-only`
`partyOrgId`	`string` The unique identifier for the organization in the Finxact system. (This is analogous to the organization's `_id` in Apiture.) `read-only`

organizationIdentification

{
  "value": "string",
  "type": "taxId",
  "expiresOn": "2019-08-24",
  "expiration": "2019-08-24"
}

Organization Identification (v1.1.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. Warning: The property `expiration` was deprecated on version `v1.1.0` of the schema. Use `expiresOn` instead. `expiration` will be removed on version `v2.0.0` of the schema. `deprecated`

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:

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.

These enumeration values are further described by the label group named organizationIdentificationType in the response from the getLabels operation.

Type: string
Enumerated values:
taxId
dunsNumber

organizationPhoneNumber

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizationPhoneNumber/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/hp1"
    }
  },
  "_id": "hp1",
  "type": "home",
  "number": "+19105550155",
  "state": "approved"
}

Phone Number (v1.2.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
`_links`	`links` An optional map of links, mapping each link relation to a link object. This model defines the `_links` object of HAL representations. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`type`	`phoneNumberType` (required) The type or role of this phone number.
`number`	`string` (required) The phone number, as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is `+1`. Phone numbers are returned in responses in E.164 format with a leading `+`, country code (up to 3 digits) and subscriber number for a total of up to 15 digits. See Phone Number Representations for more information. `minLength: 8` `maxLength: 20`
`extension`	`string` The extension number for a phone number, as a string. An extension is a short internal number assigned to a particular employee, team, or department of the main business number. Extensions are typically only present when the phone `type` is `work`. `minLength: 1` `maxLength: 10` `pattern: ^[0-9]{1,10}$`
`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}$`
`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://production.api.apiture.com/schemas/organizations/organizationPhoneNumbers/v1.2.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/useorganizationsrs/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers"
    }
  },
  "items": {
    "0": {
      "_id": "mp0",
      "type": "mobile",
      "label": "Mobile",
      "number": "+19105550155",
      "state": "approved",
      "_profile": "https://production.api.apiture.com/schemas/organization/organizationPhoneNumber/v1.2.0/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/mp0"
        }
      }
    },
    "1": {
      "_id": "mp2",
      "type": "home",
      "label": "Home",
      "number": "+19105550154",
      "state": "approved",
      "_profile": "https://production.api.apiture.com/schemas/organizations/organizationPhoneNumber/v1.2.0/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/organizations/organizations/9b0387db-8705-469a-852c-ead8bfd872ba/phoneNumbers/mp2"
        }
      }
    }
  }
}

The organization's phone numbers (v1.2.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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`items`	`[organizationPhoneNumber]` An array containing phone number items.

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:

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.

These enumeration values are further described by the label group named organizationState in the response from the getLabels operation.

Type: string
Enumerated values:
pending
inactive
active
merged
removed

organizationSubtype

"string"

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

organizationType

"string"

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

organizations

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/organizations/v1.6.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations?start=10&limit=10"
    },
    "first": {
      "href": "https://api.devbank.apiture.com/organizations/organizations?start=0&limit=10"
    },
    "next": {
      "href": "https://api.devbank.apiture.com/organizations/organizations?start=20&limit=10"
    },
    "collection": {
      "href": "https://api.devbank.apiture.com/organizations/organizations"
    }
  },
  "start": 0,
  "limit": 10,
  "count": 10,
  "name": "organizations",
  "_embedded": {
    "items": {
      "0": {
        "_id": "331af113-8f7b",
        "name": "Cause for Paws",
        "label": "Cause for Paws",
        "type": "trust",
        "state": "pending",
        "_profile": "https://production.api.apiture.com/schemas/organizations/summaryOrganization/v1.6.0/profile.json",
        "_links": {
          "self": {
            "href": "https://production.api.apiture.com/organizations/organizations/331af113-8f7b"
          },
          "apiture:activate": {
            "href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=331af113-8f7b"
          }
        }
      },
      "1": {
        "_id": "a1a6bbef-ac51",
        "name": "Cause for Paws",
        "label": "Cause for Paws",
        "type": "nonprofit",
        "state": "pending",
        "_profile": "https://production.api.apiture.com/schemas/organizations/summaryOrganization/v1.6.0/profile.json",
        "_links": {
          "self": {
            "href": "https://production.api.apiture.com/organizations/organizations/a1a6bbef-ac51"
          },
          "apiture:activate": {
            "href": "https://production.api.apiture.com/organizations/activeOrganizations?organization=a1a6bbef-ac51"
          }
        }
      }
    }
  }
}

Organization Collection (v1.6.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. This schema was resolved from `common/links`.
`_embedded`	`organizationsEmbeddedObjects` Embedded objects.
`_profile`	`string(uri)` The URI of a resource profile which describes the representation. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`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.

organizationsEmbeddedObjects

{
  "items": [
    {
      "_profile": "https://production.api.apiture.com/schemas/organizations/summaryOrganization/v1.6.0/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/organizations/organizations/0399abed-fd3d"
        }
      },
      "name": "Smith's Auto Detailing",
      "label": "Smith's Detailing",
      "emailAddresses": {
        "0": {
          "type": "work",
          "value": "smitties-detailing@example.com"
        }
      },
      "identification": {
        "0": {
          "type": "taxId",
          "value": "00-9999999"
        }
      },
      "phones": {
        "0": {
          "type": "work",
          "number": "+19105550155"
        },
        "1": {
          "type": "mobile",
          "number": "+19105550154"
        }
      },
      "addresses": {
        "0": {
          "type": "work",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        "1": {
          "type": "work",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "regionCode": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      },
      "establishedOn": "2009-07-09",
      "state": "active",
      "currency": "USD",
      "employeeCountRange": "from101to250",
      "employeeCountLowerBound": 101,
      "employeeCountUpperBound": 250,
      "yearsOwned": "two",
      "estimatedAnnualRevenue": "from1to10Million",
      "estimatedMonthlyAmounts": {
        "percentGrossRevenue": "from0to25Percent",
        "sentAch": "moreThanOneMillion",
        "receivedAch": "upToOneHundredThousand",
        "mobileCheckDeposit": "upToOneHundredThousand",
        "remoteCheckDeposit": "upToOneHundredThousand",
        "sentWire": "moreThanOneMillion",
        "receivedWire": "oneHundredThousandToOneMillion"
      },
      "estimatedMonthlyCounts": {
        "sentAch": "oneHundredOneToOneThousand",
        "receivedAch": "oneHundredOneToOneThousand",
        "mobileCheckDeposit": "oneToOneHundred",
        "remoteCheckDeposit": "oneToOneHundred",
        "sentWire": "oneToOneHundred",
        "receivedWire": "oneToOneHundred"
      },
      "physicalLocationsCount": "under10",
      "achEnabled": true,
      "wireEnabled": true,
      "mobileCheckDepositEnabled": true,
      "regulatory": {
        "estimatedAnnualRevenue": "from1to10Million",
        "atmOperator": false,
        "charity": false,
        "cashesChecksMoreThan1000Usd": false,
        "internetGamblingIncorporated": false,
        "marijuanaBusiness": false,
        "moneyOrderMoreThan1000Usd": false,
        "thirdPartyBenefit": false,
        "transmitBehalfOfCustomer": false,
        "virtualCurrency": false,
        "acceptsRcc": false,
        "intermediaryServices": "trustManagement",
        "subjectToWithholdings": true
      },
      "_id": "0399abed-fd3d"
    }
  ]
}

Organizations Embedded Objects (v1.7.0)

Objects that are conditionally embedded within an organizations object.

Properties

Name	Description
`items`	`[summaryOrganization]` An array containing a page of organization items.

phoneNumber

{
  "_id": "hp1",
  "type": "home",
  "number": "+19105550155"
}

Phone Number (v1.1.0)

A phone number and its role.

This schema was resolved from contacts/phoneNumber.

Properties

Name	Description
`type`	`phoneNumberType` (required) The type or role of this phone number.
`number`	`string` (required) The phone number, as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is `+1`. Phone numbers are returned in responses in E.164 format with a leading `+`, country code (up to 3 digits) and subscriber number for a total of up to 15 digits. See Phone Number Representations for more information. `minLength: 8` `maxLength: 20`
`extension`	`string` The extension number for a phone number, as a string. An extension is a short internal number assigned to a particular employee, team, or department of the main business number. Extensions are typically only present when the phone `type` is `work`. `minLength: 1` `maxLength: 10` `pattern: ^[0-9]{1,10}$`
`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}$`

phoneNumberType

"unknown"

Phone Number Type (v1.0.0)

The type or role of this phone number.

Warning: The enum list will be removed in a future release.

The allowed values for this property are defined at runtime in the label group named phoneNumberType in the response from the getLabels operation.

This schema was resolved from contacts/phoneNumberType.

Type: string
Enumerated values:
unknown
home
work
mobile
fax
other

physicalLocationsCount

"unknown"

Physical Locations (v1.0.0)

The number of physical sites, offices, or locations the organization owns, operates, or occupies. Warning: the enum list will be removed in a future release and the values defined at runtime via the physicalLocationsCount group in the response from the getLabels operation.

Type: string
Enumerated values:
unknown
under10
from10to50
from50to100
moreThan100
other
notApplicable

preferredContactMethod

"unknown"

Preferred Contact Method (v1.0.0)

The contact's preferred method of communication.

Warning: The enum list will be removed in a future release.

The allowed values for this property are defined at runtime in the label group named preferredContactMethod in the response from the getLabels operation.

This schema was resolved from contacts/preferredContactMethod.

Type: string
Enumerated values:
unknown
sms
email
other
notApplicable

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

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:

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.

These enumeration values are further described by the label group named profileItemState in the response from the getLabels operation.

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,
  "acceptsRcc": true,
  "intermediaryServices": [
    "unknown"
  ],
  "subjectToWithholdings": false,
  "property1": {},
  "property2": {}
}

Regulatory (v1.1.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.
`acceptsRcc`	`boolean` The organization accepts Remotely Created Checks (RCCs) for goods or services.
`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`

regulatoryValue

{}

Regulatory Value (v1.0.0)

The value associated with this regulatory property.

Properties

root

{
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0"
}

API Root (v2.1.0)

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

This schema was resolved from common/root.

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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`_id`	`string` This API's unique ID. `read-only`
`name`	`string` This API's name.
`apiVersion`	`string` This API's version.

simpleAddress

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

Simple Address (v1.0.0)

A postal address.

This schema was resolved from contacts/simpleAddress.

Properties

Name	Description
`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}$`

simpleContact

{
  "firstName": "John",
  "middleName": "Daniel",
  "lastName": "Smith",
  "addresses": {
    "0": {
      "_id": "ha1",
      "type": "home",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "_id": "wa1",
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "preferredMailingAddressId": "ha1",
  "emailAddresses": {
    "0": {
      "id": "pe0",
      "value": "api@apiture.com",
      "type": "personal"
    },
    "1": {
      "id": "wp1",
      "value": "support@apiture.com",
      "type": "work"
    }
  },
  "preferredEmailAddressId": "pe0",
  "phones": {
    "0": {
      "_id": "hp1",
      "type": "home",
      "number": "+19105550155"
    },
    "1": {
      "_id": "mp1",
      "type": "mobile",
      "number": "+19105550159"
    },
    "2": {
      "_id": "wp1",
      "type": "work",
      "number": "+19105550162",
      "extension": "4512"
    }
  },
  "preferredPhoneId": "hp1",
  "preferredName": "John",
  "suffix": "MD",
  "identification": {
    "0": {
      "type": "taxId",
      "value": "*****3333"
    }
  },
  "preferredContactMethod": "email"
}

Simple Contact (v1.2.0)

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

This schema was resolved from contacts/simpleContact.

Properties

Name	Description
`firstName`	`string` The person's first name (or given name). `maxLength: 80`
`middleName`	`string` The person's middle name. `maxLength: 80`
`lastName`	`string` The person's last name (or surname). `maxLength: 80`
`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.

simpleLabel

{
  "label": "Board of Directors",
  "description": "string"
}

Simple Label (v1.0.0)

A text label and optional description.

This schema was resolved from common/simpleLabel.

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.

simpleOrganization

{
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": {
    "0": {
      "type": "work",
      "value": "smitties-detailing@example.com"
    }
  },
  "identification": {
    "0": {
      "type": "taxId",
      "value": "00-9999999"
    }
  },
  "phones": {
    "0": {
      "type": "work",
      "number": "+19105550155"
    },
    "1": {
      "type": "mobile",
      "number": "+19105550154"
    }
  },
  "addresses": {
    "0": {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "establishedOn": "2009-07-09",
  "_profile": "https://production.api.apiture.com/schemas/organizations/simpleOrganization/v1.4.0/profile.json"
}

Simple Organization (v1.4.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 `organizationType` value in the response of the `getLabels` operation.
`subtype`	`organizationSubtype` A refinement of the `type`. The enumeration values are described by the `organizationSubtype` value in the response of the `getLabels` operation.
`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`
`taxAddressId`	`string` The `_id` of an address that the financial institution and the organization use for tax purposes. The tax address may differ from the organization's preferred mailing address, but it must be an `approved` physical address, and it may not be a P.O. Box. This value is set with the `setTaxAddress` operation. `minLength: 1` `maxLength: 4`
`establishedOn`	`string(date)` The date the organization was established.
`establishedDate`	`string(date)` The date the organization was established. Warning: The property `establishedDate` was deprecated on version `v1.1.0` of the schema. Use `establishedOn` instead. `establishedDate` will be removed on version `v2.0.0` of the schema. `deprecated`

summaryChallenge

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  }
}

Summary Challenge (v1.1.0)

Summary representation of a challenge, used in the challenge collection.

This schema was resolved from auth/summaryChallenge.

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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`reason`	`string` The reason the application or service has issued a challenge requesting the user verify their identity. This is for labeling or informational purposes.
`contextUri`	`string(uri)` The URI of a resource that establishes the context in which the user is asked to authenticate their identity. For example, for this may be for a pending transfer, a user's mailing address, or an account if adding a joint owner. `maxLength: 2048`
`userId`	`string` The user ID of the user who is requested to verify their identity. The default is the userID of the authenticated person creating the challenge.
`minimumAuthenticatorCount`	`integer` The minimum number of different authenticators the user must verify in order to satisfy the identity challenge. The default is 1. `maximum: 4`
`maximumRedemptionCount`	`integer` The maximum number of times the challenge may be used or redeemed. The default is 1. `minimum: 1`
`_id`	`string` The unique identifier for this challenge resource. This is an immutable opaque string assigned upon creation. `read-only`
`redemptionCount`	`integer` How many times the challenge has been redeemed. `read-only`
`state`	`challengeState` The state of this authenticator. `read-only`
`createdAt`	`string(date-time)` The time stamp when challenge was created, in RFC 3339 UTC date-time format (`YYYY-MM-DDThh:mm:ss.sssZ`). `read-only`

summaryOrganization

{
  "_profile": "https://production.api.apiture.com/schemas/organizations/summaryOrganization/v1.6.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/organizations/organizations/0399abed-fd3d"
    }
  },
  "name": "Smith's Auto Detailing",
  "label": "Smith's Detailing",
  "emailAddresses": {
    "0": {
      "type": "work",
      "value": "smitties-detailing@example.com"
    }
  },
  "identification": {
    "0": {
      "type": "taxId",
      "value": "00-9999999"
    }
  },
  "phones": {
    "0": {
      "type": "work",
      "number": "+19105550155"
    },
    "1": {
      "type": "mobile",
      "number": "+19105550154"
    }
  },
  "addresses": {
    "0": {
      "type": "work",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    "1": {
      "type": "work",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "regionCode": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  },
  "establishedOn": "2009-07-09",
  "state": "active",
  "currency": "USD",
  "employeeCountRange": "from101to250",
  "employeeCountLowerBound": 101,
  "employeeCountUpperBound": 250,
  "yearsOwned": "two",
  "estimatedAnnualRevenue": "from1to10Million",
  "estimatedMonthlyAmounts": {
    "percentGrossRevenue": "from0to25Percent",
    "sentAch": "moreThanOneMillion",
    "receivedAch": "upToOneHundredThousand",
    "mobileCheckDeposit": "upToOneHundredThousand",
    "remoteCheckDeposit": "upToOneHundredThousand",
    "sentWire": "moreThanOneMillion",
    "receivedWire": "oneHundredThousandToOneMillion"
  },
  "estimatedMonthlyCounts": {
    "sentAch": "oneHundredOneToOneThousand",
    "receivedAch": "oneHundredOneToOneThousand",
    "mobileCheckDeposit": "oneToOneHundred",
    "remoteCheckDeposit": "oneToOneHundred",
    "sentWire": "oneToOneHundred",
    "receivedWire": "oneToOneHundred"
  },
  "physicalLocationsCount": "under10",
  "achEnabled": true,
  "wireEnabled": true,
  "mobileCheckDepositEnabled": true,
  "regulatory": {
    "estimatedAnnualRevenue": "from1to10Million",
    "atmOperator": false,
    "charity": false,
    "cashesChecksMoreThan1000Usd": false,
    "internetGamblingIncorporated": false,
    "marijuanaBusiness": false,
    "moneyOrderMoreThan1000Usd": false,
    "thirdPartyBenefit": false,
    "transmitBehalfOfCustomer": false,
    "virtualCurrency": false,
    "acceptsRcc": false,
    "intermediaryServices": "trustManagement",
    "subjectToWithholdings": true
  },
  "_id": "0399abed-fd3d"
}

Organization Summary (v1.6.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. This schema was resolved from `common/links`.
`_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. `read-only`
`_error`	`error` An object which describes an error. This value is omitted if the operation succeeded without error. `read-only`
`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 `organizationType` value in the response of the `getLabels` operation.
`subtype`	`organizationSubtype` A refinement of the `type`. The enumeration values are described by the `organizationSubtype` value in the response of the `getLabels` operation.
`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`
`taxAddressId`	`string` The `_id` of an address that the financial institution and the organization use for tax purposes. The tax address may differ from the organization's preferred mailing address, but it must be an `approved` physical address, and it may not be a P.O. Box. This value is set with the `setTaxAddress` operation. `minLength: 1` `maxLength: 4`
`establishedOn`	`string(date)` The date the organization was established.
`establishedDate`	`string(date)` The date the organization was established. Warning: The property `establishedDate` was deprecated on version `v1.1.0` of the schema. Use `establishedOn` instead. `establishedDate` will be removed on version `v2.0.0` of the schema. `deprecated`
`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 `employeeCountRange` in the response from the `getLabels` operation.
`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`
`yearsOwned`	`yearsOwned` The number of years the owners/operators have owned the 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.
`physicalLocationsCount`	`physicalLocationsCount` The number of physical sites, offices, or locations the organization owns, operates, or occupies. Warning: the `enum` list will be removed in a future release and the values defined at runtime via the `physicalLocationsCount` group in the response from the `getLabels` operation.
`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 `industrySectors` in the response from the `getLabels` operation.
`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` `true` if mobile check deposits are enabled for the organization.
`achEnabled`	`boolean` `true` if ACH transfers are enabled the organization.
`wireEnabled`	`boolean` `true` if wire transfers are enabled for the organization .
`estimatedMonthlyAmounts`	`estimatedMonthlyAmounts` Estimated monthly amounts for banking services.
`estimatedMonthlyCounts`	`estimatedMonthlyCounts` Estimated banking activity per month.
`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 `regionCodes` in the response from the `getLabels` operation. `minLength: 2` `maxLength: 2` `pattern: ^[a-zA-Z]{2}$`
`_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`

typedEmailAddress

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

Email Address (v1.0.0)

An email address and the email address type.

This schema was resolved from contacts/typedEmailAddress.

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}$`

yearsOwned

"unknown"

Years Owned (v1.0.0)

The number of years the owners/operators have owned the 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