Customer Organizations Administration v0.8.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.

This API administers the banking relationship between a banking customer (member) and an organization (such as a business, non-profit, trust). This API does not manage business roles (such as business owner, chief operating officer, chief financial officer, etc.), only the customer's banking role and the digital banking entitlements that the platform grants to the customer with respect to that business.

Download OpenAPI Definition (YAML)

Base URLs:

• https://api.apiture.com/bankingAdmin

Terms of service

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

• OAuth2 authentication (clientCredentials)
  • Client Credentials OAuth2 flow that allows a secure service application to access resources. (This access is not used with insecure clients such as web or mobile applications.) See details at Secure Access.
  • Flow: clientCredentials
  • Token URL = https://dev-oidc.apiture-comm-nonprod.com/oidc/token

Customer Organizations Administration

Banking Customer Organizations Administration

listCustomerBankingOrganizations

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/organizations \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/organizations HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

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

};

fetch('https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/organizations',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/organizations',
  method: 'get',

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

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

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

r = requests.get('https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/organizations', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/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/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Return a collection of banking organizations for a customer

GET https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/organizations

Return a list of banking organizations associated with the banking customer.

Parameters

Example responses

200 Response

{
  "items": [
    {
      "name": "Peck Plumbing",
      "taxId": "****1234",
      "organizationId": "52abfb19a4810b8b90e7",
      "coreOrganizationId": "a74c11fc11d4ba1311a7",
      "institutionId": "TIBURON",
      "customerId": "6d8eebc5cd2bfbbdc4ef",
      "roles": {
        "superUser": false
      },
      "allows": {
        "openCommercialAccounts": true,
        "manageContact": true,
        "manageAchSettlementType": true,
        "manageRestrictedUsers": false,
        "manageAccountNickname": true,
        "manageBusinessTransfers": false
      }
    },
    {
      "name": "Max Peck Handyman",
      "taxId": "****1234",
      "organizationId": "27b7425d804fd02dfe29",
      "coreOrganizationId": "5b78172d8ce84d04b23e",
      "institutionId": "TIBURON",
      "customerId": "0dd44afe15f754f81cff",
      "roles": {
        "superUser": true
      },
      "allows": {
        "openCommercialAccounts": true,
        "manageContact": true,
        "manageAchSettlementType": true,
        "manageRestrictedUsers": true,
        "manageAccountNickname": true,
        "manageBusinessTransfers": true
      }
    }
  ]
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 404

Status Code 429

Status Code 4XX

Status Code 5XX

setCustomerBankingOrganizations

Code samples

# You can also use wget
curl -X PUT https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/organizations/{bankingOrganizationId}/entitlements \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/organizations/{bankingOrganizationId}/entitlements HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

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

};

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

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

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/organizations/{bankingOrganizationId}/entitlements',
  method: 'put',

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

require 'rest-client'
require 'json'

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

result = RestClient.put 'https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/organizations/{bankingOrganizationId}/entitlements',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.put('https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/organizations/{bankingOrganizationId}/entitlements', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/organizations/{bankingOrganizationId}/entitlements");
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/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Set entitlements for a customer with respect to an organization

PUT https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/organizations/{bankingOrganizationId}/entitlements

Create or set the entitlements that a banking customer has with respect to a banking organization (such as a business, trust, non-profit or other organization which conducts commercial banking). These roles and entitlements control what banking activity the customer may conduct with respect to the organization, such as opening commercial accounts and managing other customers' entitlements to the organization.

Body parameter

{
  "roles": {
    "superUser": true
  }
}

Parameters

Example responses

200 Response

{
  "roles": {
    "superUser": false
  }
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 404

Status Code 429

Status Code 4XX

Status Code 5XX

Schemas

apiProblem

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/accountNotFound/v1.0.0",
  "title": "Account Not Found",
  "status": 422,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "No account exists at the given account_url",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

API Problem (v1.2.1)

API problem or error, as per RFC 7807 application/problem+json.

Properties

bankingCustomerOrganizationAllows

{
  "openCommercialAccounts": false,
  "manageRestrictedUsers": false,
  "manageContact": true,
  "manageAchSettlementType": false,
  "manageAccountNickname": true,
  "manageBusinessTransfers": false
}

Banking Customer Organization Allows (v1.0.0)

Specific permissions the customer has with respect to the organization.

Properties

bankingCustomerOrganizationRoles

{
  "superUser": false
}

Banking Customer Organization Roles (v1.0.0)

The banking-related roles the customer holds with respect to this organization.

Properties

challengeFactor

{
  "type": "sms",
  "labels": [
    "9876"
  ]
}

Challenge Factor (v1.2.1)

A challenge factor. See requiredIdentityChallenge for multiple examples.

Properties

challengeFactorId

"string"

Challenge Factor ID (v1.0.0)

The ID of an a challenge factor. This ID is unique within the factors offered with a challenge.

type: string

minLength: 3
maxLength: 48
pattern: "^[-a-zA-Z0-9$_]{3,48}$"

challengeFactorType

"sms"

Challenge Factor Type (v1.0.0)

The name of challenge factor.

challengeFactorType strings may have one of the following enumerated values:

type: string

enum values: sms, email, voice, securityQuestions, authenticatorToken

challengeOperationId

"string"

Challenge Operation ID (v1.0.1)

The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses.

type: string

minLength: 6
maxLength: 48
pattern: "^[-a-zA-Z0-9$_]{6,48}$"

challengePromptId

"string"

Challenge Prompt ID (v1.0.0)

The unique ID of a prompt (such as a security question) in a challenge factor.

type: string

minLength: 1
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]+$"

challengeSecurityQuestion

{
  "id": "74699fa628911e762ea5",
  "prompt": "What is your mother's maiden name?"
}

Challenge Security Question (v1.0.1)

A single security question within the questions array of the challengeSecurityQuestions

Properties

challengeSecurityQuestions

{
  "questions": [
    {
      "id": "q1",
      "prompt": "What is your mother's maiden name?"
    },
    {
      "id": "q4",
      "prompt": "What is your high school's name?"
    },
    {
      "id": "q9",
      "prompt": "What is the name of your first pet?"
    }
  ]
}

Challenge Security Questions (v1.0.1)

Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.

Properties

customerBankingOrganizationEntitlements

{
  "roles": {
    "superUser": false
  }
}

Customer Banking Organization Entitlements (v1.1.0)

The roles and permissions a banking customer has with respect to a banking organization.

Properties

customerBankingOrganizationEntitlementsUpdate

{
  "roles": {
    "superUser": true
  }
}

Customer Banking Organization Entitlements Update (v1.3.0)

New or replacement banking organization entitlements to assign to a customer.

Properties

customerBankingOrganizationItem

{
  "taxId": "****1234",
  "organizationId": "52abfb19a4810b8b90e7",
  "coreOrganizationId": "a74c11fc11d4ba1311a7",
  "institutionId": "TIBURON",
  "customerId": "6d8eebc5cd2bfbbdc4ef",
  "roles": {
    "superUser": false
  },
  "name": "Peck Plumbing",
  "allows": {
    "openCommercialAccounts": false,
    "manageRestrictedUsers": false,
    "manageContact": true,
    "manageAchSettlementType": false,
    "manageAccountNickname": true,
    "manageBusinessTransfers": false
  }
}

Customer Banking Organization Item (v2.0.0)

Summary representation of a banking organization for which a customer has entitlements.

Properties

customerBankingOrganizations

{
  "items": [
    {
      "name": "Peck Plumbing",
      "taxId": "****1234",
      "organizationId": "52abfb19a4810b8b90e7",
      "coreOrganizationId": "a74c11fc11d4ba1311a7",
      "institutionId": "TIBURON",
      "customerId": "6d8eebc5cd2bfbbdc4ef",
      "roles": {
        "superUser": false
      },
      "allows": {
        "openCommercialAccounts": true,
        "manageContact": true,
        "manageAchSettlementType": true,
        "manageRestrictedUsers": false,
        "manageAccountNickname": true,
        "manageBusinessTransfers": false
      }
    },
    {
      "name": "Max Peck Handyman",
      "taxId": "****1234",
      "organizationId": "27b7425d804fd02dfe29",
      "coreOrganizationId": "5b78172d8ce84d04b23e",
      "institutionId": "TIBURON",
      "customerId": "0dd44afe15f754f81cff",
      "roles": {
        "superUser": true
      },
      "allows": {
        "openCommercialAccounts": true,
        "manageContact": true,
        "manageAchSettlementType": true,
        "manageRestrictedUsers": true,
        "manageAccountNickname": true,
        "manageBusinessTransfers": true
      }
    }
  ]
}

Customer Banking Organization Collection (v2.0.0)

A list of banking organizations for which a customer has banking entitlements.

Properties

externalResourceId

"string"

External Resource Identifier (v1.1.0)

The unique, opaque system identifier for an external resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference an external resource by ID rather than URL.

type: string(text)

read-only
format: text
minLength: 1
maxLength: 256

institutionId

"TIBURON"

Institution ID (v1.1.0)

The unique immutable identifier of a financial institution.

type: string

minLength: 2
maxLength: 8
pattern: "^[A-Z0-9_]{2,8}$"

mutableBankingCustomerOrganizationRoles

{
  "superUser": false
}

Mutable Banking Customer Organization Roles (v1.0.0)

The banking-related roles to assign to the customer with respect to this organization.

Properties

problemResponse

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/noSuchAccount/v1.0.0",
  "title": "Account Not Found",
  "status": 422,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "No account exists for the given account reference",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

Problem Response (v0.4.1)

API problem or error response, as per RFC 9457 application/problem+json.

Properties

readOnlyResourceId

"string"

Read-only Resource Identifier (v1.0.1)

The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is also used in URLs as path parameters or in other properties or parameters that reference a resource by ID rather than URL. Resource IDs are immutable.

type: string

read-only
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

readOnlyTimestamp

"2021-10-30T19:06:04.250Z"

Read-Only Timestamp (v1.0.0)

A readonly or derived timestamp (an instant in time) formatted in RFC 3339 date-time UTC format: YYYY-MM-DDThh:mm:ss.sssZ.

type: string(date-time)

read-only
format: date-time
minLength: 20
maxLength: 30

requiredIdentityChallenge

{
  "operationId": "createTransfer",
  "challengeId": "0504076c566a3cf7009c",
  "factors": [
    {
      "type": "sms",
      "labels": [
        "9876"
      ],
      "id": "85c0ee5753fcd0b0953f"
    },
    {
      "type": "voice",
      "labels": [
        "9876"
      ],
      "id": "d089e10a80a8627df37b"
    },
    {
      "type": "voice",
      "labels": [
        "6754"
      ],
      "id": "10506ecf9d1c2ee00403"
    },
    {
      "type": "email",
      "labels": [
        "an****nk@example.com",
        "an****98@example.com"
      ],
      "id": "e917d671cb2f030b56f1"
    },
    {
      "type": "authenticatorToken",
      "labels": [
        "Acme fob"
      ],
      "id": "fe6c452d7da0bbb4e407"
    },
    {
      "type": "securityQuestions",
      "securityQuestions": {
        "questions": [
          {
            "id": "q1",
            "prompt": "What is your mother's maiden name?"
          },
          {
            "id": "q4",
            "prompt": "What is your high school's name?"
          },
          {
            "id": "q9",
            "prompt": "What is the name of your first pet?"
          }
        ]
      },
      "id": "df33c6f88a37d6b3f0a6"
    }
  ]
}

Required Challenge (v1.2.3)

A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 Unauthorized problem response when the 401 problem type name is challengeRequired. See the "Challenge API" for details.

Properties

resourceId

"string"

Resource Identifier (v1.0.1)

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

type: string

minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"