Customer Accounts Administration v0.5.1

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 provides administrative management of a customer's relationship with banking accounts.

• setCustomerAccountEntitlements creates a customer's entitlements to one or more accounts, allowing the customer to perform various banking activities with those accounts.

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 Accounts Administration

Banking Customer Accounts Administration

setCustomerAccountEntitlements

Code samples

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

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

const fetch = require('node-fetch');
const inputBody = '{
  "accounts": [
    {
      "accountNumber": "123456789",
      "productType": "checking",
      "productCode": "DDA_01"
    },
    {
      "accountNumber": "123456788",
      "accountMicrNumber": "123456788",
      "productType": "checking",
      "productCode": "DDA_02"
    },
    {
      "accountNumber": "123456787",
      "productType": "checking",
      "productCode": "DDA_03"
    }
  ],
  "assignments": {
    "electronicStatementElection": true,
    "electronicDocumentElection": true,
    "roles": {
      "default": true,
      "billPay": true
    }
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/accountEntitlements',
{
  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}/accountEntitlements',
  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}/accountEntitlements',
  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}/accountEntitlements', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/accountEntitlements");
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}/accountEntitlements", data)
    req.Header = headers

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

Set entitlements for a banking customer with respect to one or more banking accounts

PUT https://api.apiture.com/bankingAdmin/bankingCustomers/{bankingCustomerId}/accountEntitlements

Create or update the entitlements that a banking customer has with respect to one or more banking accounts. These entitlements control what banking activity the customer may conduct with respect to each account.

This operation also creates the account resource in Apiture Digital Banking if the account only exists in the banking core.

Note: The customer must be enabled for digital banking via the Admin Customers API.

Body parameter

{
  "accounts": [
    {
      "accountNumber": "123456789",
      "productType": "checking",
      "productCode": "DDA_01"
    },
    {
      "accountNumber": "123456788",
      "accountMicrNumber": "123456788",
      "productType": "checking",
      "productCode": "DDA_02"
    },
    {
      "accountNumber": "123456787",
      "productType": "checking",
      "productCode": "DDA_03"
    }
  ],
  "assignments": {
    "electronicStatementElection": true,
    "electronicDocumentElection": true,
    "roles": {
      "default": true,
      "billPay": true
    }
  }
}

Parameters

Example responses

200 Response

{
  "items": [
    {
      "account": {
        "id": "52abfb19a4810b8b90e7",
        "accountNumber": "123456789",
        "productType": "checking",
        "productCode": "DDA_01"
      },
      "electronicStatementElection": true,
      "electronicDocumentElection": true,
      "roles": {
        "default": true,
        "billPay": true
      }
    },
    {
      "account": {
        "id": "a1b4067f35ae4f0ac4a6",
        "accountNumber": "234567890",
        "productType": "checking",
        "productCode": "DDA_01"
      },
      "electronicStatementElection": true,
      "electronicDocumentElection": true,
      "roles": {
        "default": true,
        "billPay": 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

Schemas

accountNickname

"Payroll Checking"

Account Nickname (v1.2.0)

The nickname (friendly name) the customer has given this account. Each customer can define their own nickname for the same account. If omitted, the customer has not set a nickname.

type: string(text)

format: text
maxLength: 50

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

bankingCustomerAccountAssignments

{
  "electronicStatementElection": true,
  "electronicDocumentElection": true,
  "roles": {
    "default": true,
    "billPay": true
  }
}

Banking Customer Account Assignments (v1.1.0)

New or replacement banking account role and options/elections to assign to a customer. Each role establishes one or more entitlements for specific banking activity with respect to the given account(s).

Properties

bankingCustomerAccountRoles

{
  "default": true,
  "view": true,
  "basic": true,
  "billPay": true,
  "loanAdvance": false
}

Banking Customer Account Roles (v1.1.0)

Specific account access roles that a customer has relative to a banking account. When updating a customer's account entitlements, roles with a value of false are removed from the customer and permissions omitted from this object are not changed. Each role represents one or more specific entitlements which are dependent upon the type of account. A true value means the customer has that role and therefore the entitlements associated with the role.

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

customerBankingAccountEntitlementItem

{
  "account": {
    "accountNumber": "123456788",
    "accountMicrNumber": "123456788",
    "productType": "checking",
    "productCode": "DDA_01"
  },
  "electronicStatementElection": true,
  "electronicDocumentElection": true,
  "roles": {
    "default": true,
    "billPay": true
  }
}

Customer Banking Account Entitlement Item (v3.0.0)

An customer's banking account and the entitlement the customer has over the account.

Properties

customerBankingAccountEntitlements

{
  "items": [
    {
      "account": {
        "id": "52abfb19a4810b8b90e7",
        "accountNumber": "123456789",
        "productType": "checking",
        "productCode": "DDA_01"
      },
      "electronicStatementElection": true,
      "electronicDocumentElection": true,
      "roles": {
        "default": true,
        "billPay": true
      }
    },
    {
      "account": {
        "id": "a1b4067f35ae4f0ac4a6",
        "accountNumber": "234567890",
        "productType": "checking",
        "productCode": "DDA_01"
      },
      "electronicStatementElection": true,
      "electronicDocumentElection": true,
      "roles": {
        "default": true,
        "billPay": true
      }
    }
  ]
}

Customer Banking Account Entitlements (v4.0.0)

A list of customer banking accounts and their settings and entitlements.

Properties

customerBankingAccountEntitlementsAssignment

{
  "accounts": [
    {
      "accountNumber": "123456789",
      "productType": "checking",
      "productCode": "DDA_01"
    },
    {
      "accountNumber": "123456788",
      "accountMicrNumber": "123456788",
      "productType": "checking",
      "productCode": "DDA_02"
    },
    {
      "accountNumber": "123456787",
      "productType": "checking",
      "productCode": "DDA_03"
    }
  ],
  "assignments": {
    "electronicStatementElection": true,
    "electronicDocumentElection": true,
    "roles": {
      "default": true,
      "billPay": true
    }
  }
}

Customer Banking Account Entitlements Assignment (v3.0.0)

New or updated customer entitlements for one or more customer banking accounts.

Properties

customerBankingAccountReference

{
  "id": "string",
  "accountNumber": "123456789",
  "accountMicrNumber": "string",
  "productType": "savings",
  "productCode": "CD001",
  "nickname": "Payroll Checking"
}

Customer Banking Account Reference (v3.0.0)

A reference for identifying a banking account that is internal to the financial institution.

Properties

fullAccountNumber

"123456789"

Full Account Number (v1.0.0)

A full account number. This is the number that the customer uses to reference the account within the financial institution.

type: string

minLength: 1
maxLength: 32
pattern: "^[- a-zA-Z0-9.]{1,32}$"

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

productType

"savings"

Product Type (v2.2.0)

The type (or category) of banking product.

productType strings may have one of the following enumerated values:

type: string

enum values: savings, checking, cd, ira, loan, creditCard, moneyMarket, healthSavings

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