Shell HTTP Node.JS JavaScript Ruby Python Java Go

Apiture Xpress Customer Administration v0.1.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.

Bank customer administrative operations including access to customer and access to account entitements.

Download OpenAPI Definition (YAML)

Base URLs:

Terms of service

Email: Apiture Web: Apiture

Customer

Financial Institution customer that is enrolled for digital banking services

getCustomer

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/axbi-admin/customers/{customerId} \
  -H 'Accept: application/json'

GET https://api.apiture.com/axbi-admin/customers/{customerId} HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json'

};

fetch('https://api.apiture.com/axbi-admin/customers/{customerId}',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.apiture.com/axbi-admin/customers/{customerId}',
  method: 'get',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api.apiture.com/axbi-admin/customers/{customerId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.apiture.com/axbi-admin/customers/{customerId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/axbi-admin/customers/{customerId}");
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"},
        
    }

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

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

Returns a digital banking customer

GET https://api.apiture.com/axbi-admin/customers/{customerId}

Return a JSON representation of this customer resource.

Parameters

ParameterDescription
customerId string (required)
The unique identifier of this customer.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: customer
StatusDescription
404 Not Found
Not Found. There is no such user resource at the specified {customerId}. The _error field in the response will contain details about the request error.
Schema: errorResponse

getCustomerAccountEntitlements

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/axbi-admin/customers/{customerId}/entitlements/accounts \
  -H 'Accept: application/json'

GET https://api.apiture.com/axbi-admin/customers/{customerId}/entitlements/accounts HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json'

};

fetch('https://api.apiture.com/axbi-admin/customers/{customerId}/entitlements/accounts',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.apiture.com/axbi-admin/customers/{customerId}/entitlements/accounts',
  method: 'get',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api.apiture.com/axbi-admin/customers/{customerId}/entitlements/accounts',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.apiture.com/axbi-admin/customers/{customerId}/entitlements/accounts', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/axbi-admin/customers/{customerId}/entitlements/accounts");
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"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/axbi-admin/customers/{customerId}/entitlements/accounts", data)
    req.Header = headers

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

Returns a digital banking customer's account entitlements

GET https://api.apiture.com/axbi-admin/customers/{customerId}/entitlements/accounts

Return a JSON representation of this customers account entitlements. # djb: Return a JSON representation of this customer's account entitlements.

Parameters

ParameterDescription
customerId string (required)
The unique identifier of this customer.
unmasked boolean
When requesting an account, the full account number is not included in the response by default, for security reasons. Include this query parameter, with a value of true, to request that the response body includes the full account number. Such requests are auditable.
Default: false

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "45454343",
        "accountNumbers": {
          "full": "2-12345678",
          "masked": "*5678"
        },
        "accountType": {
          "type": "DDA",
          "code": "checking"
        },
        "role": "fraud_notify_ach_debit"
      },
      {
        "_id": "45454344",
        "accountNumbers": {
          "full": "2-12345679",
          "masked": "*5679"
        },
        "accountType": {
          "type": "SAV",
          "code": "savings"
        },
        "accountTypeGeneric": "checking",
        "role": "fraud_notify_ach_credit"
      }
    ]
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: getCustomerAccountEntitlementsResponse
StatusDescription
404 Not Found
Not Found. There is no such user resource at the specified {customerId}. The _error field in the response will contain details about the request error.
Schema: errorResponse

getCustomerCompanyIds

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds \
  -H 'Accept: application/json'

GET https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json'

};

fetch('https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds',
  method: 'get',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds");
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"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds", data)
    req.Header = headers

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

Returns a list of customer's company IDs

GET https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds

Return a JSON representation of this customer's company IDs. A company ID is used to provide additional tracking information on ACH transactions. The ID may or may not exist. The customer's Tax ID is treated as a unique company ID, and they can add additional IDs (such as a DUNS number, user specified ID, or other ID). The resource contains a unique NACHA prefix number for ACH, as well as other identifying information such as the company's name and whether the ID is active for use.

Parameters

ParameterDescription
customerId string (required)
The unique identifier of this customer.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": 123456789,
        "name": "AAA Plumbing",
        "value": "1984719084",
        "type": {
          "nachaPrefix": 10,
          "description": "Other"
        }
      }
    ]
  },
  "types": [
    {
      "nachaPrefix": 1,
      "description": "taxId"
    },
    {
      "nachaPrefix": 3,
      "description": "dunsNumber"
    },
    {
      "nachaPrefix": 9,
      "description": "userSpecifiedId'"
    },
    {
      "nachaPrefix": 10,
      "description": "other"
    }
  ]
}

Responses

StatusDescription
200 OK
OK.
Schema: companyIds

addCustomerCompanyId

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json",
  "_links": {},
  "_id": {},
  "name": "AAA Plumbing",
  "value": "1984719084",
  "inactive": false,
  "type": {
    "nachaPrefix": 10
  },
  "account_ids": [
    "123456789",
    "987654321",
    "123412304"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'

};

fetch('https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds',
{
  method: 'POST',
  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'

};

$.ajax({
  url: 'https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds',
  method: 'post',

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

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds");
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/json"},
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds", data)
    req.Header = headers

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

Add new company ID

POST https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds

Add a Company ID for this customer. A Company ID is information about an ID this customer includes with payments sent or received via ACH. The ID may or may not exist. The user will not be allowed to reuse the customer's Tax ID to create a new company ID, and we don’t store a collection of DUNS Numbers or user specified IDs today. The resource contains a unique prefix number for ACH, as well as other identifying information such as the company's name and whether the ID is active for use.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json",
  "_links": {},
  "_id": {},
  "name": "AAA Plumbing",
  "value": "1984719084",
  "inactive": false,
  "type": {
    "nachaPrefix": 10
  },
  "account_ids": [
    "123456789",
    "987654321",
    "123412304"
  ]
}

Parameters

ParameterDescription
body createCompanyId
A company Id
customerId string (required)
The unique identifier of this customer.

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_id": "123456789",
  "name": "AAA Plumbing",
  "value": "1984719083",
  "inactive": true,
  "type": {
    "nachaPrefix": 10,
    "description": "other"
  }
}

422 Response

Responses

StatusDescription
201 Created
Created.
Schema: companyId
StatusDescription
400 Bad Request
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.
Schema: errorResponse
StatusDescription
409 Conflict
Conflict. A company ID with this value already exists.
Schema: errorResponse
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

getCustomerCompanyId

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId} \
  -H 'Accept: application/json'

GET https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId} HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json'

};

fetch('https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}',
  method: 'get',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}");
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"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}", data)
    req.Header = headers

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

Retrive a company ID

GET https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}

Retrive a company ID for this customer.

Parameters

ParameterDescription
customerId string (required)
The unique identifier of this customer.
companyIdInstanceId string (required)
The unique identifier of this company ID. This is the _id property of the companyId resource, not the value property.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_id": "123456789",
  "name": "AAA Plumbing",
  "value": "1984719083",
  "inactive": true,
  "type": {
    "nachaPrefix": 10,
    "description": "other"
  }
}

Responses

StatusDescription
200 OK
OK.
Schema: companyId
StatusDescription
400 Bad Request
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.
Schema: errorResponse
StatusDescription
404 Not Found
Not Found. There is no such company ID resource at the specified {companyIdInstanceId}. The _error field in the response will contain details about the request error.
Schema: errorResponse

modifyCustomerCompanyId

Code samples

# You can also use wget
curl -X PUT https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

PUT https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId} HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_id": "123456789",
  "name": "AAA Plumbing",
  "value": "1984719083",
  "inactive": true,
  "type": {
    "nachaPrefix": 10,
    "description": "other"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'

};

fetch('https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}',
{
  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'

};

$.ajax({
  url: 'https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}',
  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'
}

result = RestClient.put 'https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.put('https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}");
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"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}", data)
    req.Header = headers

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

Modify an existing company ID

PUT https://api.apiture.com/axbi-admin/customers/{customerId}/companyIds/{companyIdInstanceId}

Modify an existing Company ID for this customer. A company ID cannot be deleted. It can only be marked inactive using the PUT method.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_id": "123456789",
  "name": "AAA Plumbing",
  "value": "1984719083",
  "inactive": true,
  "type": {
    "nachaPrefix": 10,
    "description": "other"
  }
}

Parameters

ParameterDescription
body companyId
A company Id
customerId string (required)
The unique identifier of this customer.
companyIdInstanceId string (required)
The unique identifier of this company ID. This is the _id property of the companyId resource, not the value property.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_id": "123456789",
  "name": "AAA Plumbing",
  "value": "1984719083",
  "inactive": true,
  "type": {
    "nachaPrefix": 10,
    "description": "other"
  }
}

412 Response

Responses

StatusDescription
200 OK
OK.
Schema: companyId
StatusDescription
400 Bad Request
Bad Request. The request body or one or more of the query parameters was not well formed. The _error field in the response will contain details about the request error.
Schema: errorResponse
StatusDescription
404 Not Found
Not Found. There is no such company ID resource at the specified {companyIdInstanceId}. The _error field in the response will contain details about the request error.
Schema: errorResponse
StatusDescription
409 Conflict
Conflict. A company ID with this value already exists.
Schema: errorResponse
StatusDescription
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
StatusDescription
422 Unprocessable Entity
Unprocessable Entity. One or more of the query parameters was well formed but otherwise invalid. The _error field in the response will contain details about the request error.
Schema: errorResponse

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

NameDescription
_links object: 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.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Abstract Resource (v2.0.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

NameDescription
_links object: 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 object: error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only

attributeValue

{}

Attribute Value (v2.0.0)

The data associated with this attribute.

This schema was resolved from common/attributeValue.

Properties

attributes

{
  "property1": {},
  "property2": {}
}

Attributes (v2.0.0)

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

This schema was resolved from common/attributes.

Properties

NameDescription
additionalProperties object: attributeValue
The data associated with this attribute.

This schema was resolved from common/attributeValue.

collection

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Collection (v2.0.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

NameDescription
_links object: 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 object: 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.

companyId

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_id": "123456789",
  "name": "AAA Plumbing",
  "value": "1984719083",
  "inactive": true,
  "type": {
    "nachaPrefix": 10,
    "description": "other"
  }
}

Company Id (v1.0.0)

Representation of a company ID resource for this customer. A Company ID is information about an ID this customer includes with payments sent or received via ACH. The resource contains a unique prefix number for ACH, as well as other identifying information such as the company's name.

Properties

NameDescription
_links object: 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 object: error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
_id string (required)
The Apiture company ID unique identifier. The unique identifier for this user resource. This is an immutable opaque string.
name string (required)
Company Name.
value string (required)
The unique identification number/identifier for this company (tax ID, DUNS Number, user-specified ID, or other).
inactive boolean
Flag representing whether company ID is inactive.
type object: companyIdType (required)
Representation of a company ID type resource.

companyIdType

{
  "nachaPrefix": 3,
  "description": "dunsNumber"
}

Company ID Type (v1.0.0)

Representation of a company ID type resource.

Properties

NameDescription
nachaPrefix any (required)
Company ID prefix number used for NACHA files. 1 = Tax ID, 3 = DUNS #, 9 = User Specified ID, 10 = Other.
enum values: 1, 3, 9, 10
description any
Human-friendly name of company ID type.
enum values: taxId, dunsNumber, userSpecifiedId, other

companyIds

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": 123456789,
        "name": "AAA Plumbing",
        "value": "1984719084",
        "type": {
          "nachaPrefix": 10,
          "description": "Other"
        }
      }
    ]
  },
  "types": [
    {
      "nachaPrefix": 1,
      "description": "taxId"
    },
    {
      "nachaPrefix": 3,
      "description": "dunsNumber"
    },
    {
      "nachaPrefix": 9,
      "description": "userSpecifiedId'"
    },
    {
      "nachaPrefix": 10,
      "description": "other"
    }
  ]
}

Company IDs (v1.0.0)

Returns a list of company IDs and allowed types.

Properties

NameDescription
_links object: 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: companyId
List of company IDs
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error object: 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.
types array: [companyIdType]
List of allowed company types

customer

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  }
}

Customer (v1.0.0)

Representation of an customer resource. A digital banking user.

Properties

NameDescription
_links object: 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 object: error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
_id string
The Apiture customer identifier. The unique identifier for this user resource. This is an immutable opaque string.
address object: addressFields
Fields of an address.
emailAddresses object: emailAddressesFields
A collection of email addresses associated with the customer.
identification object: identificationFields
A collection of identifying information associated with the customer.
name string
The customer's full name
phones object: phoneFields
A collection of phone numbers associated with the customer.

customerAccountEntitlement

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_id": "45454343",
  "accountNumbers": {
    "full": "12345678-9",
    "masked": "*678-9"
  },
  "accountType": {
    "type": "DDA",
    "code": "checking"
  },
  "role": "fraud_notify_ach_debit"
}

Customer Account Entitlement (v1.0.0)

Representation of an entitlement between a customer and an account. This representation normally does not contain any _embedded objects.

Properties

NameDescription
_links object: 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 object: error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only
_id string
The apiture account identifier. The unique identifier for this user resource. This is an immutable opaque string.
accountNumbers object: accountNumberFields (required)
The account number.
accountType object: summaryAccountTypeFields (required)
The account type summary information.
role string (required)
The role ( collection of privileges ) that is granted between the customer and the account.

customerAccountEntitlements

{
  "items": [
    {
      "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
      "_links": {
        "self": {
          "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
        }
      },
      "_id": "45454343",
      "accountNumbers": {
        "full": "12345678-9",
        "masked": "*678-9"
      },
      "accountType": {
        "type": "DDA",
        "code": "checking"
      },
      "role": "fraud_notify_ach_debit"
    }
  ]
}

Customer Account Entitlements (v1.0.0)

A list of customer account entitlements.

Properties

NameDescription
items array: [customerAccountEntitlement] (required)
An array customer account entitlements.

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

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

This schema was resolved from common/error.

Properties

NameDescription
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 object: 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 array: [error]
An optional array of nested error objects. This property is not always present.
_links object: 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://api.apiture.com/schemas/common/errorResponse/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://api.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Error Response (v2.0.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

NameDescription
_links object: 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 object: error
An object which describes an error. This value is omitted if the operation succeeded without error.
read-only

getCustomerAccountEntitlementsResponse

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.0.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "45454343",
        "accountNumbers": {
          "full": "2-12345678",
          "masked": "*5678"
        },
        "accountType": {
          "type": "DDA",
          "code": "checking"
        },
        "role": "fraud_notify_ach_debit"
      },
      {
        "_id": "45454344",
        "accountNumbers": {
          "full": "2-12345679",
          "masked": "*5679"
        },
        "accountType": {
          "type": "SAV",
          "code": "savings"
        },
        "accountTypeGeneric": "checking",
        "role": "fraud_notify_ach_credit"
      }
    ]
  }
}

Account Entitlements Collection (v1.0.0)

Collection of entitements between a customer and an account. The items in the collection are ordered in the _embedded object with name items.

Properties

NameDescription
_links object: 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: customerAccountEntitlements (required)
Embedded objects.
_profile string(uri)
The URI of a resource profile which describes the representation.
read-only
_error object: 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.

{
  "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.

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

{
  "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.

NameDescription
additionalProperties object: 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.