Customers Administration v0.3.2

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

An API for managing the financial institution's customers, also known as members at credit unions. This API only accesses customers enrolled in digital banking. It cannot access financial institution customers that are only in the banking core (for example, those who only bank at the branch or via ATMs).

This API provides one operation:

• getBankingCustomers: an administrative application can fetch information about one or more customers enrolled in Apiture Digital Banking:

Authenticated Access

The operations in this API require an OAuth2 access token, which may either be obtained via the Client Credentials flow (for use by secure headless applications) or by Authorization Code Flow by financial institution (FI) administrative users who authenticate with the financial institution's workforce identity provider. Non-FI partner organizations may only use Client Credentials.

Accessing Customers for a Specific Financial Institution

The access token is associated with a unique Client ID. Client IDs are normally associated with a specific financial institution. If the Client ID is not tied to a specific institution, the client must provide the Institution-Id request header parameter to identify the target institution where the customers and customers are held. This header is ignored otherwise.

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

Banking Customers Admin

Banking Customers Administration

getBankingCustomers

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/bankingCustomers?customers=b0002de89f878411c5f8,29eeb140c5ad8743507d,0afd7e9dba0a838f85d7,120d3b696d5737cc5413,75a7fce04e741365c698 \
  -H 'Accept: application/json' \
  -H 'Institution-Id: TIBURON' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/bankingCustomers?customers=b0002de89f878411c5f8,29eeb140c5ad8743507d,0afd7e9dba0a838f85d7,120d3b696d5737cc5413,75a7fce04e741365c698 HTTP/1.1
Host: api.apiture.com
Accept: application/json
Institution-Id: TIBURON

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

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

};

fetch('https://api.apiture.com/bankingAdmin/bankingCustomers?customers=b0002de89f878411c5f8,29eeb140c5ad8743507d,0afd7e9dba0a838f85d7,120d3b696d5737cc5413,75a7fce04e741365c698',
{
  method: 'GET',

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

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

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/bankingCustomers',
  method: 'get',
  data: '?customers=b0002de89f878411c5f8,29eeb140c5ad8743507d,0afd7e9dba0a838f85d7,120d3b696d5737cc5413,75a7fce04e741365c698',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

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

result = RestClient.get 'https://api.apiture.com/bankingAdmin/bankingCustomers',
  params: {
  'customers' => 'array[string]'
}, headers: headers

p JSON.parse(result)

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

r = requests.get('https://api.apiture.com/bankingAdmin/bankingCustomers', params={
  'customers': [
  "b0002de89f878411c5f8",
  "29eeb140c5ad8743507d",
  "0afd7e9dba0a838f85d7",
  "120d3b696d5737cc5413",
  "75a7fce04e741365c698"
]
}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/bankingCustomers?customers=b0002de89f878411c5f8,29eeb140c5ad8743507d,0afd7e9dba0a838f85d7,120d3b696d5737cc5413,75a7fce04e741365c698");
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"},
        "Institution-Id": []string{"TIBURON"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

List banking customers at a financial institution.

GET https://api.apiture.com/bankingAdmin/bankingCustomers

Return banking customer (member) details for a selected list of banking customer IDs.

Parameters

Example responses

200 Response

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "coreCustomerId": "12299292",
      "username": "peck_plumbing",
      "name": "Peck Plumbing",
      "state": "enabled",
      "type": "commercial",
      "commercial": {
        "contactName": "Max Peck"
      },
      "contactCard": {
        "addresses": {
          "primary": {
            "address1": "1805 Tiburon Dr.",
            "address2": "Building 14, Suite 1500",
            "locality": "Wilmington",
            "regionCode": "NC",
            "countryCode": "US",
            "postalCode": "28412"
          },
          "mailing": {
            "address1": "P.O. Box 0000000",
            "locality": "Wilmington",
            "regionCode": "NC",
            "countryCode": "US",
            "postalCode": "28412"
          }
        },
        "emailAddresses": {
          "primary": "max@example.com",
          "secondary": "plank_plumbing@example.com"
        },
        "phoneNumbers": {
          "primary": "9105555512",
          "mobile": "9105555513",
          "alternate": "910555514",
          "fax": "9105555515"
        }
      },
      "identityChallengeFactors": {
        "email": {
          "primary": true,
          "secondary": false
        },
        "sms": {
          "primary": false,
          "secondary": false,
          "mobile": true,
          "alternate": false
        },
        "voice": {
          "primary": false,
          "secondary": true,
          "mobile": true,
          "alternate": true
        }
      },
      "lastLoggedInAt": "2023-08-14T10:51:48.375Z",
      "lastLoggedInAttemptedAt": "2023-08-14T10:51:48.375Z",
      "createdAt": "2020-05-04T12:37:08.375Z",
      "enrolledAt": "2020-05-04T12:37:08.375Z",
      "employee": "unknown"
    }
  ]
}

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

address

{
  "address1": "1805 Tiburon Dr.",
  "address2": "Building 14, Suite 1500",
  "locality": "Wilmington",
  "regionCode": "NC",
  "countryCode": "US",
  "postalCode": "28403"
}

Address (v1.6.0)

A postal address that can hold a US address or an international (non-US) postal addresses.

Properties

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

bankingCustomerInstitutionEmployeeState

"employee"

Banking Customer FI Employee State (v1.0.0)

Indicates if the banking customer is also an employee of the financial institution.

bankingCustomerInstitutionEmployeeState strings may have one of the following enumerated values:

type: string

enum values: employee, notAnEmployee, unknown

bankingCustomerItem

{
  "id": "0399abed-fd3d",
  "coreCustomerId": "12299292",
  "username": "peck_plumbing",
  "name": "Peck Plumbing",
  "type": "commercial",
  "state": "enabled",
  "commercial": {
    "contactName": "Max Peck"
  },
  "contactCard": {
    "addresses": {
      "primary": {
        "address1": "1805 Tiburon Dr.",
        "address2": "Building 14, Suite 1500",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      },
      "mailing": {
        "address1": "P.O. Box 0000000",
        "locality": "Wilmington",
        "regionCode": "NC",
        "countryCode": "US",
        "postalCode": "28412"
      }
    },
    "emailAddresses": {
      "primary": "max@example.com",
      "secondary": "plank_plumbing@example.com"
    },
    "phoneNumbers": {
      "primary": "+19105555512",
      "mobile": "+19105555513",
      "alternate": "+19105555514",
      "fax": "+19105555514"
    }
  },
  "identityChallengeFactors": {
    "email": {
      "primary": true,
      "secondary": false
    },
    "sms": {
      "primary": false,
      "secondary": false,
      "mobile": true,
      "alternate": false
    },
    "voice": {
      "primary": false,
      "secondary": true,
      "mobile": true,
      "alternate": true
    }
  },
  "employee": "unknown",
  "lastLoggedInAt": "2023-08-14T10:51:48.375Z",
  "lastLoginAttemptedAt": "2023-08-14T10:51:48.375Z",
  "createdAt": "2020-05-04T12:37:08.375Z",
  "enrolledAt": "2020-05-04T12:37:08.375Z"
}

Banking Customer Item (v1.1.3)

Summary representation of a banking customer (member) resource in banking customers collections. To fetch the full representation of this banking customer, use the getBankingCustomer operation, passing this item's id field as the bankingCustomerId path parameter.

Personally Identifiable Information (PII) in the customer record are masked by default. Use ?unmasked=true in the request to unmask the data. The example shows unmasked data.

Properties

bankingCustomerList

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "coreCustomerId": "12299292",
      "username": "peck_plumbing",
      "name": "Peck Plumbing",
      "state": "enabled",
      "type": "commercial",
      "commercial": {
        "contactName": "Max Peck"
      },
      "contactCard": {
        "addresses": {
          "primary": {
            "address1": "1805 Tiburon Dr.",
            "address2": "Building 14, Suite 1500",
            "locality": "Wilmington",
            "regionCode": "NC",
            "countryCode": "US",
            "postalCode": "28412"
          },
          "mailing": {
            "address1": "P.O. Box 0000000",
            "locality": "Wilmington",
            "regionCode": "NC",
            "countryCode": "US",
            "postalCode": "28412"
          }
        },
        "emailAddresses": {
          "primary": "max@example.com",
          "secondary": "plank_plumbing@example.com"
        },
        "phoneNumbers": {
          "primary": "9105555512",
          "mobile": "9105555513",
          "alternate": "910555514",
          "fax": "9105555515"
        }
      },
      "identityChallengeFactors": {
        "email": {
          "primary": true,
          "secondary": false
        },
        "sms": {
          "primary": false,
          "secondary": false,
          "mobile": true,
          "alternate": false
        },
        "voice": {
          "primary": false,
          "secondary": true,
          "mobile": true,
          "alternate": true
        }
      },
      "lastLoggedInAt": "2023-08-14T10:51:48.375Z",
      "lastLoggedInAttemptedAt": "2023-08-14T10:51:48.375Z",
      "createdAt": "2020-05-04T12:37:08.375Z",
      "enrolledAt": "2020-05-04T12:37:08.375Z",
      "employee": "unknown"
    }
  ]
}

Banking Customer List (v1.1.4)

A list of banking customers.

Personally Identifiable Information (PII) in the customer record are masked by default. Use ?unmasked=true in the request to unmask the data. The example shows masked data, although the examples do not imply or dictate any specific masking rules. See the bankingCustomerItem schema for an example with unmasked data.

Properties

bankingCustomerState

"enabled"

Banking Customer State (v1.0.0)

The state of the banking customer at the financial institution.

bankingCustomerState strings may have one of the following enumerated values:

type: string

enum values: enabled, disabled

commercialBankingCustomer

{
  "contactName": "string"
}

Commercial Banking Customer (v1.0.1)

Properties of commercial banking customers.

Properties

coreCustomerId

"string"

Core Customer Id (v1.0.1)

The unique ID of the customer/member in the banking core.

type: string

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

customerAddresses

{
  "primary": {
    "address1": "1805 Tiburon Dr.",
    "locality": "Wilmington",
    "regionCode": "NC",
    "countryCode": "US",
    "postalCode": "28412"
  },
  "mailing": {
    "address1": "P.O. Box 1805",
    "locality": "Wilmington",
    "regionCode": "NC",
    "countryCode": "US",
    "postalCode": "28412"
  }
}

Customer Addresses (v1.0.0)

A customer's postal addresses.

Properties

customerContactCard

{
  "addresses": {
    "primary": {
      "address1": "1805 Tiburon Dr.",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28412"
    },
    "mailing": {
      "address1": "P.O. Box 1805",
      "locality": "Wilmington",
      "regionCode": "NC",
      "countryCode": "US",
      "postalCode": "28412"
    }
  },
  "emailAddresses": {
    "primary": "Max.Pike@example.com",
    "secondary": "MaxwellPike@me.example.com"
  },
  "phoneNumbers": {
    "primary": "+19105550155",
    "mobile": "+19105550150"
  }
}

Customer Contact Card (v1.1.0)

A customer's contact information.

Properties

customerEmailAddress

"Max.Pike@example.com"

Customer Email Address (v1.0.0)

A customer's single email address.

type: string(email)

format: email
maxLength: 255

customerEmailAddresses

{
  "primary": "Max.Pike@example.com",
  "secondary": "MaxwellPike@me.example.com"
}

Customer Email Addresses (v1.1.0)

A customer's email addresses.

Properties

customerEmailChallengeChannels

{
  "primary": true,
  "secondary": false
}

Customer Email Address Challenge Channels (v1.0.0)

Indicates which of the customer's email addresses may be used for email multi-factor authentication or other identity challenges. Each address is a separate channel for the email challenge factor.

Properties

customerIdentityChallengeFactors

{
  "email": {
    "primary": true,
    "secondary": false
  },
  "sms": {
    "primary": false,
    "secondary": false,
    "mobile": true,
    "alternate": false
  },
  "voice": {
    "primary": false,
    "secondary": true,
    "mobile": true,
    "alternate": true
  }
}

Customer Identity Challenge Factors (v1.0.1)

Indicates which which channels (specific email addresses or specific phone numbers) are enabled for the email, sms or voice factors when performing multi-factor authentication and other identity challenges.

Properties

customerPhoneChallengeChannels

{
  "primary": false,
  "secondary": false,
  "mobile": true,
  "alternate": true
}

Customer Phone Challenge Channels (v1.0.1)

Indicates which of the customer's phone numbers may be used for phone-based multi-factor authentication or other identity challenges. Each phone number is a separate channel for the sms and voice challenge factors.

Properties

customerPhoneNumbers

{
  "primary": "+19105550155",
  "mobile": "+19105550150"
}

Customer Phone Numbers (v1.0.0)

A customer's phone numbers.

Properties

customerType

"commercial"

Customer Type (v1.0.0)

Indicates the type of digital banking customer/member.

type: string

enum values: commercial, retail

customerUsername

"string"

Customer Username (v1.0.0)

A customer's login username.

type: string(text)

format: text
maxLength: 20

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

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

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

retailBankingCustomer

{
  "birthdate": "20**-**-*1"
}

Retail Banking Customer (v1.0.1)

Properties of retail banking customers.

Properties

simplePhoneNumber

"+19105550155"

Simple Phone Number (v1.1.0)

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. If the number is masked to hide Personally Identifiable Information, all but the last four digits are replaced with one or more *, such as *1234.

type: string(phone-number)

format: phone-number
minLength: 5
maxLength: 20