System Core Adapter v0.1.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.

This API provides an integration as an adapter into a subset of banking core operations.

Download OpenAPI Definition (YAML)

Base URLs:

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

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

Transfers

Banking Core Transfers

createTransfer

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/system/cores/transfers \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/system/cores/transfers HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "amount": "3456.78",
  "type": "direct",
  "sourceAccount": {
    "accountNumber": "123456789",
    "coreType": "stri",
    "productType": "savings",
    "routingNumber": "123123123"
  },
  "targetAccount": {
    "accountNumber": "123456789",
    "coreType": "stri",
    "productType": "savings",
    "routingNumber": "123123123"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/system/cores/transfers',
{
  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',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/system/cores/transfers',
  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',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.apiture.com/system/cores/transfers',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.apiture.com/system/cores/transfers', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/system/cores/transfers");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.apiture.com/system/cores/transfers", data)
    req.Header = headers

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

Create a transfer between accounts.

POST https://api.apiture.com/system/cores/transfers

Create an account to account transfer in the banking core.

Body parameter

{
  "amount": "3456.78",
  "type": "direct",
  "sourceAccount": {
    "accountNumber": "123456789",
    "coreType": "stri",
    "productType": "savings",
    "routingNumber": "123123123"
  },
  "targetAccount": {
    "accountNumber": "123456789",
    "coreType": "stri",
    "productType": "savings",
    "routingNumber": "123123123"
  }
}

Parameters

Example responses

200 Response

{
  "amount": "3456.78",
  "type": "direct",
  "createdAt": "2021-10-30T19:06:04.250Z",
  "updatedAt": "2021-10-30T19:06:04.250Z",
  "state": "submitted",
  "sourceAccount": {
    "accountNumber": "123456789",
    "routingNumber": "123123123",
    "location": "internal"
  },
  "targetAccount": {
    "accountNumber": "123456789",
    "routingNumber": "123123123",
    "location": "internal"
  }
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 422

Status Code 429

Status Code 4XX

Status Code 5XX

Accounts

Banking Core Accounts

findAccount

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/system/cores/account/find \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/system/cores/account/find HTTP/1.1
Host: api.apiture.com
Content-Type: application/json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "accountNumber": "123456789",
  "coreType": "stri",
  "productType": "savings"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/system/cores/account/find',
{
  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',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/system/cores/account/find',
  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',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.apiture.com/system/cores/account/find',
  params: {
  }, headers: headers

p JSON.parse(result)

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

r = requests.post('https://api.apiture.com/system/cores/account/find', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/system/cores/account/find");
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"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.apiture.com/system/cores/account/find", data)
    req.Header = headers

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

Find an account within the banking core.

POST https://api.apiture.com/system/cores/account/find

Retrieve the details of a single account based on account number, core type and product type. This operation uses the POST over GET pattern for security purposes.

Body parameter

{
  "accountNumber": "123456789",
  "coreType": "stri",
  "productType": "savings"
}

Parameters

Example responses

200 Response

{
  "accountHolder": "Phil Duciary",
  "nickname": "Credit Card Consolidation 9/23",
  "accountNumber": "123456789",
  "routingNumber": "123123123",
  "location": "internal",
  "availableBalance": "-2233.00",
  "currentBalance": "-2233.00",
  "loan": {
    "creditLimit": "2000.00",
    "availableCredit": "1867.00"
  },
  "product": {
    "customerType": "personal",
    "type": "loan",
    "coreType": "LN",
    "code": "24M_LN",
    "label": "24 Month Loan",
    "description": "24 Month Loan account"
  }
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 422

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

accountReference

{
  "accountNumber": "123456789",
  "coreType": "stri",
  "productType": "savings",
  "routingNumber": "123123123"
}

Account Reference (v1.0.0)

Data needed to retrieve an account. Internal accounts to the banking core require coreType and productType. External accounts require routingNumber.

Properties

accountRoutingNumber

"123123123"

Account Routing Number (v1.0.0)

An account ABA routing and transit number.

type: string

minLength: 9
maxLength: 9
pattern: "^[0-9]{9}$"

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

bankingAccountLocation

"internal"

Banking Account Location (v1.1.0)

Indicates where an account is held:

• internal accounts at the current financial institution;
• external accounts at another financial institution;

bankingAccountLocation strings may have one of the following enumerated values:

type: string

enum values: internal, external, peer

bankingProductFields

{
  "type": "cd",
  "coreType": "CD",
  "code": "180D_CDA",
  "label": "180 Day CD",
  "description": "Certificate of Deposit with a 180 day term"
}

Banking Product Fields (v1.3.0)

Common fields of the product resource used to build other model schemas.

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

coreAccount

{
  "accountHolder": "Phil Duciary",
  "nickname": "Credit Card Consolidation 9/23",
  "accountNumber": "123456789",
  "routingNumber": "123123123",
  "location": "internal",
  "availableBalance": "-2233.00",
  "currentBalance": "-2233.00",
  "loan": {
    "creditLimit": "2000.00",
    "availableCredit": "1867.00"
  },
  "product": {
    "customerType": "personal",
    "type": "loan",
    "coreType": "LN",
    "code": "24M_LN",
    "label": "24 Month Loan",
    "description": "24 Month Loan account"
  }
}

Core Account (v1.0.0)

Representation of a banking account within the core.

Properties

coreAccountType

"stri"

Core Account Type (v1.0.0)

The account product type in the banking core. For example, some cores may use "D" for a demand deposit (checking) account, some may use "DDA".

type: string

minLength: 1
maxLength: 4
pattern: "^[A-Z0-9]{1,4}$"

coreProduct

{
  "type": "cd",
  "coreType": "CD",
  "code": "180D_CDA",
  "label": "180 Day CD",
  "description": "Certificate of Deposit with a 180 day term"
}

Core Product (v1.0.0)

Product properties for an internal account.

Properties

creditOrDebitValue

"3456.78"

Credit Or Debit Value (v1.1.1)

The monetary value representing a credit (positive amounts with no prefix or a + prefix) or debit (negative amounts with a - prefix). The numeric value is represented as a string so that it can be exact with no loss of precision.

type: string(decimal)

format: decimal
maxLength: 16
pattern: "^(-|\+)?(0|[1-9][0-9]*)\.[0-9][0-9]$"

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

internalAccountReference

{
  "accountNumber": "123456789",
  "coreType": "stri",
  "productType": "savings"
}

Internal Account Reference (v1.0.0)

Data needed to retrieve an internal account from the banking core.

Properties

loanAccount

{
  "creditLimit": "3456.78",
  "availableCredit": "3456.78"
}

Loan Account (v1.0.0)

Properties specific to loan accounts.

Properties

monetaryValue

"3456.78"

Monetary Value (v1.1.1)

The monetary value, supporting only positive amounts. The numeric value is represented as a string so that it can be exact with no loss of precision.

type: string(decimal)

format: decimal
maxLength: 16
pattern: "^(0|[1-9][0-9]*)\.[0-9][0-9]$"

newTransfer

{
  "amount": "3456.78",
  "type": "direct",
  "sourceAccount": {
    "accountNumber": "123456789",
    "coreType": "stri",
    "productType": "savings",
    "routingNumber": "123123123"
  },
  "targetAccount": {
    "accountNumber": "123456789",
    "coreType": "stri",
    "productType": "savings",
    "routingNumber": "123123123"
  }
}

New Transfer (v1.0.0)

Data required to create a new transfer between accounts within the core.

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

productCustomerType

"personal"

Product Customer Type (v1.0.0)

Indicates the type of customer that uses this banking product: personal (retail) or business (commercial).

productCustomerType strings may have one of the following enumerated values:

type: string

enum values: personal, business, both

productReference

{
  "type": "cd",
  "coreType": "CD",
  "code": "180D_CDA",
  "label": "180 Day CD",
  "description": "Certificate of Deposit with a 180 day term"
}

Product Reference (v2.4.0)

A reference to a banking product.

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

transfer

{
  "amount": "3456.78",
  "type": "direct",
  "createdAt": "2021-10-30T19:06:04.250Z",
  "updatedAt": "2021-10-30T19:06:04.250Z",
  "state": "submitted",
  "sourceAccount": {
    "accountNumber": "123456789",
    "routingNumber": "123123123",
    "location": "internal"
  },
  "targetAccount": {
    "accountNumber": "123456789",
    "routingNumber": "123123123",
    "location": "internal"
  }
}

Transfer (v1.0.0)

Representation of a transfer between accounts within the core.

Properties

transferState

"submitted"

Transfer State (v1.0.0)

The state of a transfer resource.

transferState strings may have one of the following enumerated values:

type: string

enum values: submitted, processing, processed, failed, other

transferType

"direct"

Transfer Type (v1.0.0)

The type of this transfer.

transferType strings may have one of the following enumerated values:

type: string

enum values: direct, peer, loanPayment, loanPayoff, loanAdvance