Shell HTTP Node.JS JavaScript Ruby Python Java Go

Events Administration v0.38.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.

Describes event message schemas which convey activity in the Apiture Digital Banking platform.

An event is an action that has occurred at a point in time (such as: user logged in, account beneficiary added, payment batch approved, etc.). An event is an abstraction. Each kind of event has an event type. Related events are also organized into categories, such as profile or transfers. Each event type belongs to one category. There can be many event messages over time for each event type.

An event message is a concrete data packet representation of an event that has occurred. The message contains event metadata (such as a unique event ID, timestamp, etc.) and the event's associated data payload. Each event message is defined with the eventMessageItem schema, which includes the metadata. The eventMessageItem object has a data object whose value depends on the eventMessageItem.type. The data value is constrained to the schema whose name is derived from the type. The data event message schema name is the event type name with the suffix EventSchema. For example, an event message with type of userLoggedIn is defined by the userLoggedInEventSchema.

This API provides two access patterns for reading events: by date/time, or reading new events since a previous watermark.

Reading Event History by Date/Time

Use the listEventHistory operation to fetch a paginated list of events between a start and end date/time. This allows filtering by event type, category, and several other fields, as well as sorting by the event's occurredAt time. The response is paginated if there are more events in the filter date/time range than the requested response limit.

The events are not recorded in real time, so new data does not appear immediately.

Reading Event History by Watermark

Use listRecentEventHistory when a scheduled job periodically polls for new events that have been logged since the watermark.

Previously read events are "below" the watermark; newer unread events are "above" the watermark. Each call returns data starting at the watermark point and returns a new watermark. The client should keep the watermark for the next time the job polls for new events.

It is possible for events in later calls to this operation to have an timestamp that is before the timestamp of the last event in the previous call.

Event Types by Category

Events are organized into categories, as follows:

Event category Event type Event Message Schema
accountApplications accountApplicationApproved accountApplicationApprovedEventSchema
accountApplications accountApplicationBlocked accountApplicationBlockedEventSchema
accountApplications accountApplicationCanceled accountApplicationCanceledEventSchema
accountApplications accountApplicationCreated accountApplicationCreatedEventSchema
accountApplications accountApplicationStarted accountApplicationStartedEventSchema
accountApplications jointOwnerApplicationApproved jointOwnerApplicationApprovedEventSchema
accounts fullAccountNumberAccessed fullAccountNumberAccessedEventSchema
authentication identityChallengeCreated identityChallengeCreatedEventSchema
authentication identityChallengeFailed identityChallengeFailedEventSchema
authentication identityChallengeInitiated identityChallengeInitiatedEventSchema
authentication identityChallengeSucceeded identityChallengeSucceededEventSchema
authentication mfaFailed mfaFailedEventSchema
authentication mfaInitiated mfaInitiatedEventSchema
authentication mfaSucceeded mfaSucceededEventSchema
authentication passwordUpdated passwordUpdatedEventSchema
authentication passwordUpdateFailed passwordUpdateFailedEventSchema
authentication userLoggedIn userLoggedInEventSchema
authentication userLoginFailed userLoginFailedEventSchema
authentication usernameUpdated usernameUpdatedEventSchema
businessAchTransfers achBatchPaymentApproved achBatchPaymentApprovedEventSchema
businessAchTransfers achBatchPaymentInitiated achBatchPaymentInitiatedEventSchema
businessAchTransfers achBatchPaymentRejected achBatchPaymentRejectedEventSchema
businessAchTransfers achBatchPaymentReversed achBatchPaymentReversedEventSchema
businessAchTransfers achBatchPaymentScheduled achBatchPaymentScheduledEventSchema
businessAchTransfers achBatchPaymentSubmitted achBatchPaymentSubmittedEventSchema
businessAchTransfers achBatchPaymentUnlocked achBatchPaymentUnlockedEventSchema
entitlements accountOwnerEntitled accountOwnerEntitledEventSchema
entitlements entitlementUpdated entitlementUpdatedEventSchema
entitlements externalAccountEntitled externalAccountEntitledEventSchema
externalAccounts externalAccountActivated externalAccountActivatedEventSchema
externalAccounts externalAccountRemoved externalAccountRemovedEventSchema
externalAccounts externalAccountRequested externalAccountRequestedEventSchema
externalAccounts externalAccountVerificationBlocked externalAccountVerificationBlockedEventSchema
externalAccounts externalAccountVerificationFailed externalAccountVerificationFailedEventSchema
externalAccounts externalAccountVerificationRemoved externalAccountVerificationRemovedEventSchema
externalAccounts externalAccountVerified externalAccountVerifiedEventSchema
externalAccounts fullExternalAccountNumberAccessed fullExternalAccountNumberAccessedEventSchema
profile addressUpdated addressUpdatedEventSchema
profile mobileDeviceRegistrationDeleted mobileDeviceRegistrationDeletedEventSchema
profile phoneNumberUpdated phoneNumberUpdatedEventSchema
profile primaryEmailUpdated primaryEmailUpdatedEventSchema
profile smsConsentUpdated smsConsentUpdatedEventSchema
transfers singleTransferCanceled singleTransferCanceledEventSchema
transfers singleTransferCreated singleTransferCreatedEventSchema
transfers singleTransferFailed singleTransferFailedEventSchema
transfers singleTransferInitiated singleTransferInitiatedEventSchema
transfers singleTransferProcessed singleTransferProcessedEventSchema
transfers singleTransferScheduled singleTransferScheduledEventSchema
transfers singleTransferUpdated singleTransferUpdatedEventSchema
wireTransfers wireTransferApproved wireTransferApprovedEventSchema
wireTransfers wireTransferBeneficiaryUpdated wireTransferBeneficiaryUpdatedEventSchema
wireTransfers wireTransferCreated wireTransferCreatedEventSchema
wireTransfers wireTransferInitiated wireTransferInitiatedEventSchema
wireTransfers wireTransferScheduled wireTransferScheduledEventSchema

Download OpenAPI Definition (YAML)

Base URLs:

Terms of service

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

  • OAuth2 authentication (clientCredentials)
Scope Scope Description
bankingAdmin/read Read a wide variety of banking and other financial institution and customer data.
bankingAdmin/write Write a wide variety of banking and other financial institution and customer data.

  • OAuth2 authentication (webhookClientCredentials)
    • Client Credentials OAuth2 flow that allows the Apiture Digital Banking platform to exchange a client ID and client secret for an access token to use to authorize HTTP calls to a webhook.
    • Flow: clientCredentials
    • Token URL = https://partner.webook.receiver.example.com/oauth2/token
Scope Scope Description

  • HTTP Authentication
    • Scheme: basic
    • The webhook requires Basic HTTP authorization.

Event History

Event History

listRecentEventHistory

Code samples

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


GET https://api.apiture.com/bankingAdmin/recentEventHistory HTTP/1.1
Host: api.apiture.com
Accept: application/restful+json


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

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

};

fetch('https://api.apiture.com/bankingAdmin/recentEventHistory',
{
  method: 'GET',

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


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

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/recentEventHistory',
  method: 'get',

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


require 'rest-client'
require 'json'

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

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

p JSON.parse(result)


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

r = requests.get('https://api.apiture.com/bankingAdmin/recentEventHistory', params={

}, headers = headers)

print r.json()


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

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

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

Fetch new event history since last called

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

Return new event history since this operation was last called. This operation allows clients to poll periodically for new events since they last fetched event history—new events added after the watermark. The watermark represents the position of the most recent event that a client has seen.

Each response provides a new watermark value. The client should pass this watermark value in the watermark query parameter the next time it calls this operation. There is a limit of 10,000 items in each response, but there may be more events still to be read. Clients may call the operation again while the response hasMore property is true. The items in the response are sorted in ascending occurredAt order.

Note: Event records created since the last watermark may have an occurredAt time before the watermark was created. The events had not yet been recorded at that time. The watermark should not be considered a time marker.

Parameters

ParameterDescription
watermark
in: query
 string
The location of the starting point for the requested event items. Clients pass the value of the watermark property that they have saved from the last time calling this operation. Omit this parameter to start a short time earlier then the most recent event history record.
maxLength: 256
default: ""
pattern: "^[-a-zA-Z0-9.,-~=_+:;@$]{0,256}$"
limit
in: query
 integer(int32)
The maximum number of items to return in this paged response.
format: int32
minimum: 0
maximum: 10000
default: 1000
type
in: query
 array[string]
Filter the response to only events whose type is in this pipe-delimited set of type names. See the "Event Types by Category" section above for a list of categories and types.
unique items
minItems: 1
maxItems: 32
pipe-delimited
items: string
» minLength: 4
» maxLength: 48
» pattern: "^[a-z][a-zA-Z0-9]{3,47}$"
category
in: query
 array[string]
Subset the response to events whose category is in this pipe-delimited set of category names. See the "Event Types by Category" section above for a list of categories and types.
unique items
minItems: 1
maxItems: 16
pipe-delimited
items: string
» minLength: 4
» maxLength: 40
» pattern: "^[a-z][a-zA-Z0-9]{3,39}$"
sessionId
in: query
 array[string]
Subset the response to events whose sessionId is in this pipe-delimited set of session ID values. Session IDs identify a session begun at user login/authentication and are initially returned in userLoggedIn events.
unique items
minItems: 1
maxItems: 16
pipe-delimited
items: string
» minLength: 6
» maxLength: 48
» pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
agentId
in: query
 array[string]
Subset the response to event where the agentId has this value.
unique items
minItems: 1
maxItems: 16
pipe-delimited
items: string
» minLength: 6
» maxLength: 48
» pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "version": "0.2.0",
  "watermark": "VGhpcyBpcyBhIHNhbXBsZSBlbmNvZGVkL29wYXF1ZSBldmVudCBoaXN0b3J5IHdhdGVybWFyaw==",
  "limit": 1000,
  "hasMore": true,
  "startsAt": "2022-12-02T11:00:00.000",
  "endsAt": "2022-12-02T11:10:00.000Z",
  "items": [
    {
      "id": "b844b2d641da",
      "institutionId": "TIBURON",
      "category": "authentication",
      "type": "userLoggedIn",
      "occurredAt": "2022-12-02T11:08:00.375Z",
      "correlationId": "0730fd7ac6bfe5a87b0a",
      "sessionId": "2ded0203a8a2b6e7befa",
      "agentId": "4f3ec1daab02eed9de64",
      "coreCustomerId": "12299292",
      "agentType": "customer",
      "host": "13.226.38.34",
      "primaryId": "b844b2d6d9ca818df3c8",
      "data": {
        "browser": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36",
        "operatingSystem": "macos",
        "platform": "web",
        "application": "apitureDigitalBanking",
        "score": 2500
      }
    },
    {
      "id": "0399abed30f38b8a365c",
      "institutionId": "TIBURON",
      "category": "transfers",
      "type": "singleTransferScheduled",
      "occurredAt": "2022-12-02T11:08:00.375Z",
      "correlationId": "2266452a0bfd8150cf64",
      "sessionId": "2ded0203a8a2b6e7befa",
      "agentId": "4f3ec1daab02eed9de64",
      "coreCustomerId": "12299292",
      "agentType": "customer",
      "host": "13.226.38.34",
      "primaryId": "a727ff2aedea60646819",
      "data": {
        "sourceAccount": {
          "id": "a212d3c119148960683d",
          "maskedNumber": "*3210",
          "routingNumber": "021000021"
        },
        "targetAccount": {
          "id": "0c8ad50ab6cf0eb48c25",
          "maskedNumber": "*3219",
          "routingNumber": "021000021"
        }
      }
    }
  ]
}

Responses

StatusDescription
200 OK
OK.
Schema: recentEventHistory
StatusDescription
400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This error response may have one of the following type values:

Schema: Inline
StatusDescription
401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This error response may have one of the following type values:

Schema: Inline
StatusDescription
403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This error response may have one of the following type values:

  • https://production.api.apiture.com/errors/forbidden/v1.0.0
    The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
Schema: Inline
StatusDescription
422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This error response may have one of the following type values:

Schema: problemResponse
StatusDescription
429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This error response may have one of the following type values:

Schema: Inline
StatusDescription
4XX Unknown
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details.
Schema: Inline
StatusDescription
5XX Unknown
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details.
Schema: Inline

Response Schema

Status Code 400

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

listEventHistory

Code samples

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


GET https://api.apiture.com/bankingAdmin/eventHistory HTTP/1.1
Host: api.apiture.com
Accept: application/restful+json


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

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

};

fetch('https://api.apiture.com/bankingAdmin/eventHistory',
{
  method: 'GET',

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


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

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/eventHistory',
  method: 'get',

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


require 'rest-client'
require 'json'

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

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

p JSON.parse(result)


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

r = requests.get('https://api.apiture.com/bankingAdmin/eventHistory', params={

}, headers = headers)

print r.json()


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

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

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

Fetch event history

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

Return a page of event history. The items in the response are sorted in descending occurredAt order by default.

Parameters

ParameterDescription
start
in: query
 string
The location of the next item in the collection. This is an opaque cursor supplied by the API service. Omit this to start at the beginning of the collection. The client does not define this value; the API services automatically pass the ?start= parameter on the nextPage_url.
maxLength: 256
default: ""
pattern: "^[-a-zA-Z0-9.,-=_+:;@$]{0,256}$"
limit
in: query
 integer(int32)
The maximum number of items to return in this paged response.
format: int32
minimum: 0
maximum: 10000
default: 1000
occurredAt
in: query
 dateTimeRange
Filter the response to only events whose occurredAt timestamp is in the range bounded by start and end date-times. The default range is the past one hour. The start and end values are either dates in RFC 3339 YYYY-MM-DD date format, or date-times in YYYY-MM-DDThh:mm:ss.sssZ date-time format.

For example

  • [start,end] between start and end date/times, inclusive of the endpoints
  • (start,end) between start and end date/times, exclusive of the endpoints
  • (start,end] between start and end date/times, exclusive of start and inclusive of the end
  • [start,end) between start and end date/times, inclusive of start and exclusive of the end
  • YYYY-MM-DD equivalent to [YYYY-MM-DD,YYYY-MM-DD]
Dates without a time component are converted to UTC date-time values. If start or end are date values, then start00 is defined as time 00:00:00Z on the start date, start24 is defined as 00:00AM of the day after the start date: end00 is defined as time 00:00:00Z on the end date, end24 is defined as 00:00AM of the day after the end date:

  • [start,end] is the same as [start00,end24)
  • (start,end] is the same as (start24,end24)
  • [start,end) is the same as [start00,end00)
  • (start,end) is the same as (start24,end00)
For example, the range [2023-05-01,2023-06-01) for events which occurred any day/time in May 2023 UTC is equivalent to [2023-05-01T00:00:00.00Z,2023-06-01T00:00:00.00Z).

If start is omitted, the range uses a value of 1 hour before the effective end. If end is omitted, the range uses a value of 1 hour after the effective start.
format: text
minLength: 10
maxLength: 63
pattern: "^((\\d{4}-\\d{2}-\\d{2})|([[(](((\\d{4}-\\d{2}-\\d{2}([Tt]\\d{2}:\\d{2}:\\d{2}(.\\d{1,6})?[Zz])?),(\\d{4}-\\d{2}-\\d{2}([Tt]\\d{2}:\\d{2}:\\d{2}(.\\d{1,6})?[Zz])?)?)|(,(\\d{4}-\\d{2}-\\d{2}([Tt]\\d{2}:\\d{2}:\\d{2}(.\\d{1,6})?[Zz])?)))[)\\]]))$"

type
in: query
 array[string]
Filter the response to only events whose type is in this pipe-delimited set of type names. See the "Event Types by Category" section above for a list of categories and types.
unique items
minItems: 1
maxItems: 32
pipe-delimited
items: string
» minLength: 4
» maxLength: 48
» pattern: "^[a-z][a-zA-Z0-9]{3,47}$"
category
in: query
 array[string]
Subset the response to events whose category is in this pipe-delimited set of category names. See the "Event Types by Category" section above for a list of categories and types.
unique items
minItems: 1
maxItems: 16
pipe-delimited
items: string
» minLength: 4
» maxLength: 40
» pattern: "^[a-z][a-zA-Z0-9]{3,39}$"
sessionId
in: query
 array[string]
Subset the response to events whose sessionId is in this pipe-delimited set of session ID values. Session IDs identify a session begun at user login/authentication and are initially returned in userLoggedIn events.
unique items
minItems: 1
maxItems: 16
pipe-delimited
items: string
» minLength: 6
» maxLength: 48
» pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
agentId
in: query
 array[string]
Subset the response to event where the agentId has this value.
unique items
minItems: 1
maxItems: 16
pipe-delimited
items: string
» minLength: 6
» maxLength: 48
» pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
sortBy
in: query
 array[string]
Specify the sort order for event items in the response. Use ?sortBy=occurredAt to request ascending by occurredAt. The default is ?sortBy=-occurredAt: descending by occurredAt.
unique items
minItems: 1
maxItems: 1
comma-delimited
items: string
» minLength: 10
» maxLength: 11
» pattern: "^-?occurredAt$"

Example responses

200 Response

{
  "start": "460bf6af1c8a632cc0d8",
  "limit": 1000,
  "nextPage_url": "/banking/eventHistory?start=c49b048aea17f0622f06?limit=1000",
  "version": "0.2.0",
  "startsAt": "2022-12-02T11:00:00.000",
  "endsAt": "2022-12-02T11:10:00.000Z",
  "items": [
    {
      "id": "b844b2d641da",
      "institutionId": "TIBURON",
      "category": "authentication",
      "type": "userLoggedIn",
      "occurredAt": "2022-12-02T11:08:00.375Z",
      "correlationId": "0730fd7ac6bfe5a87b0a",
      "sessionId": "2ded0203a8a2b6e7befa",
      "agentId": "4f3ec1daab02eed9de64",
      "coreCustomerId": "12299292",
      "agentType": "customer",
      "host": "13.226.38.34",
      "primaryId": "b844b2d6d9ca818df3c8",
      "data": {
        "browser": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36",
        "operatingSystem": "macos",
        "platform": "web",
        "application": "apitureDigitalBanking",
        "score": 2500
      }
    },
    {
      "id": "0399abed30f38b8a365c",
      "institutionId": "TIBURON",
      "category": "transfers",
      "type": "singleTransferScheduled",
      "occurredAt": "2022-12-02T11:08:00.375Z",
      "correlationId": "2266452a0bfd8150cf64",
      "sessionId": "2ded0203a8a2b6e7befa",
      "agentId": "4f3ec1daab02eed9de64",
      "coreCustomerId": "12299292",
      "agentType": "customer",
      "host": "13.226.38.34",
      "primaryId": "a727ff2aedea60646819",
      "data": {
        "sourceAccount": {
          "id": "a212d3c119148960683d",
          "maskedNumber": "*3210",
          "routingNumber": "021000021"
        },
        "targetAccount": {
          "id": "0c8ad50ab6cf0eb48c25",
          "maskedNumber": "*3219",
          "routingNumber": "021000021"
        }
      }
    }
  ]
}

Responses

StatusDescription
200 OK
OK.
Schema: eventHistory
StatusDescription
400 Bad Request

Bad Request. The request body, request headers, and/or query parameters are not well-formed.

This error response may have one of the following type values:

Schema: Inline
StatusDescription
401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This error response may have one of the following type values:

Schema: Inline
StatusDescription
403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This error response may have one of the following type values:

  • https://production.api.apiture.com/errors/forbidden/v1.0.0
    The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
Schema: Inline
StatusDescription
422 Unprocessable Entity

Unprocessable Entity. The request body and/or query parameters were well-formed but otherwise invalid.

This error response may have one of the following type values:

Schema: problemResponse
StatusDescription
429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This error response may have one of the following type values:

Schema: Inline
StatusDescription
4XX Unknown
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details.
Schema: Inline
StatusDescription
5XX Unknown
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details.
Schema: Inline

Response Schema

Status Code 400

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Event Types

Event Types

listEventTypes

Code samples

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


GET https://api.apiture.com/bankingAdmin/eventTypes HTTP/1.1
Host: api.apiture.com
Accept: application/restful+json


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

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

};

fetch('https://api.apiture.com/bankingAdmin/eventTypes',
{
  method: 'GET',

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


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

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/eventTypes',
  method: 'get',

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


require 'rest-client'
require 'json'

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

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

p JSON.parse(result)


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

r = requests.get('https://api.apiture.com/bankingAdmin/eventTypes', params={

}, headers = headers)

print r.json()


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

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

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

List all event types supported by the platform

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

Return a list of all the different types of events supported by the platform.

Example responses

200 Response

{
  "items": [
    {
      "type": "singleTransferCreated",
      "category": "transfers",
      "description": "Payload for event messages triggered when a user has created a single account-to-account transfer.",
      "primaryIdDescription": "the transfer resource",
      "schemaId": "https://production.api.apiture.com/schemas/bankingEvents/singleTransferCreated"
    },
    {
      "type": "singleTransferScheduled",
      "category": "transfers",
      "description": "Payload for event messages triggered when a customer has scheduled a single account-to-account transfer.",
      "primaryIdDescription": "the transfer resource",
      "schemaId": "https://production.api.apiture.com/schemas/bankingEvents/singleTransferScheduled"
    },
    {
      "type": "wireTransferScheduled",
      "category": "wireTransfers",
      "description": "Payload for event messages triggered when a customer has submitted and approved a wire transfer and it is queued for processing on its scheduled date.",
      "primaryIdDescription": "the wire transfer resource",
      "schemaId": "https://production.api.apiture.com/schemas/bankingEvents/wireTransferScheduled"
    }
  ],
  "eventsEnabled": true
}

Responses

StatusDescription
200 OK
OK.
Schema: eventTypes
StatusDescription
401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This error response may have one of the following type values:

Schema: Inline
StatusDescription
403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This error response may have one of the following type values:

  • https://production.api.apiture.com/errors/forbidden/v1.0.0
    The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
Schema: Inline
StatusDescription
429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This error response may have one of the following type values:

Schema: Inline
StatusDescription
4XX Unknown
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details.
Schema: Inline
StatusDescription
5XX Unknown
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details.
Schema: Inline

Response Schema

Status Code 401

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

getEventTypesJsonSchema

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/eventTypesJsonSchema \
  -H 'Accept: application/schema+json' \
  -H 'If-None-Match: string' \
  -H 'Authorization: Bearer {access-token}'


GET https://api.apiture.com/bankingAdmin/eventTypesJsonSchema HTTP/1.1
Host: api.apiture.com
Accept: application/schema+json
If-None-Match: string


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

const headers = {
  'Accept':'application/schema+json',
  'If-None-Match':'string',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/eventTypesJsonSchema',
{
  method: 'GET',

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


var headers = {
  'Accept':'application/schema+json',
  'If-None-Match':'string',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/eventTypesJsonSchema',
  method: 'get',

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


require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/schema+json',
  'If-None-Match' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

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

p JSON.parse(result)


import requests
headers = {
  'Accept': 'application/schema+json',
  'If-None-Match': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/bankingAdmin/eventTypesJsonSchema', params={

}, headers = headers)

print r.json()


URL obj = new URL("https://api.apiture.com/bankingAdmin/eventTypesJsonSchema");
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/schema+json"},
        "If-None-Match": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

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

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

Return the event message JSON schema document

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

Return a JSON Schema bundle document that contains all the event message schemas. Schemas identified in the listEventTypes response by a schema $id may be accessed from this JSON Schema document. For example, the data value for an event message with event type wireTransferScheduled is found in this schema bundle document via the schema $id https://production.api.apiture.com/schemas/bankingEvents/wireTransferScheduledEventSchema.

Parameters

ParameterDescription
If-None-Match
in: header
 string
The entity tag that was returned in the ETag response header of a previous call. If the resource's current entity tag value matches this header value, the GET will return 304 (Not Modified) and no response body, else the current resource representation and updated ETag is returned.
maxLength: 512
pattern: "^\\P{Cc}{1,512}$"

Example responses

200 Response

{}

Responses

StatusDescription
200 OK
OK.
Schema: Inline
HeaderETag
string
The value of this resource's entity tag, to be passed with If-Match and If-None-Match request headers in other conditional API calls for this resource.
StatusDescription
304 Not Modified
Not Modified. The resource has not been modified since it was last fetched.
StatusDescription
401 Unauthorized

Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

This error response may have one of the following type values:

Schema: Inline
StatusDescription
403 Forbidden

Forbidden. The authenticated caller is not authorized to perform the requested operation.

This error response may have one of the following type values:

  • https://production.api.apiture.com/errors/forbidden/v1.0.0
    The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access. Remediation: Check the user's permissions and entitlements before attempting the operation.
Schema: Inline
StatusDescription
429 Too Many Requests

Too Many Requests. The client has sent too many requests in a given amount of time.

This error response may have one of the following type values:

Schema: Inline
StatusDescription
4XX Unknown
Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the detail in the problem response for additional details.
Schema: Inline
StatusDescription
5XX Unknown
Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the detail in the problem response for additional details.
Schema: Inline

Response Schema

Status Code 401

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name Description
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
» type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
maxLength: 2048
» title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
maxLength: 120
» status integer(int32)
The HTTP status code for this occurrence of the problem.
minimum: 100
maximum: 599
» detail string(text)
A human-readable explanation specific to this occurrence of the problem.
maxLength: 256
» instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
maxLength: 2048
» id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
minLength: 20
maxLength: 30
» problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
» attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Schemas

abstractEventDataSchema

{}

Abstract Event Data Schema (v0.1.1)

Abstract schema used to define other event message data object schemas.

Properties

NameDescription
Abstract Event Data Schema (v0.1.1) object
Abstract schema used to define other event message data object schemas.

accountApplicationApprovedEventSchema

{
  "product": {
    "type": "savings",
    "code": "SAV_003"
  },
  "customerType": "retail",
  "newCustomer": true,
  "trackingId": "29F093B9_E274A168-BE0385"
}

Account Application Approved Event Schema (v1.1.0)

Payload for account application approved events. This schema defines the data object for event messages with category accountApplications and event message type of accountApplicationApproved. The primaryId in the event message is the account application. The secondaryId in the event message is the banking product.

Properties

NameDescription
Account Application Approved Event Schema (v1.1.0) object
Payload for account application approved events. This schema defines the data object for event messages with category accountApplications and event message type of accountApplicationApproved. The primaryId in the event message is the account application. The secondaryId in the event message is the banking product.
Unevaluated Properties: false
product eventProductReference (required)
A reference to a banking product.
customerType customerType (required)
Indicates the type of digital banking customer/member.
enum values: commercial, retail
applicationType applicationType

The type of an application.

applicationType strings may have one of the following enumerated values:

ValueDescription
newAccountNew Account:

An application for a new banking account
jointOwnerJoint Owner:

An application to accept a joint owner invitation to an existing account

enum values: newAccount, jointOwner
newCustomer boolean (required)
true if the applicant is a new financial institution customer/member.
trackingId trackingId(text)
An optional tracking ID which identifies the source of the new account application. This is also known as a Ref ID or Reference ID.
format: text
minLength: 1
maxLength: 256
pattern: "^[-a-zA-Z0-9.,-~=_+:;@$]{1,256}$"

accountApplicationBlockedEventSchema

{
  "product": {
    "type": "savings",
    "code": "SAV_003"
  },
  "customerType": "retail",
  "newCustomer": true,
  "trackingId": "29F093B9_E274A168-BE0385"
}

Account Application Blocked Event Schema (v1.1.0)

Payload for account application blocked events, triggered when the account application has become blocked waiting for the financial institution to review the application, or for the completion of some other external activity that prevents the applicant from proceeding with the application. This schema defines the data object for event messages with category accountApplications and event message type of accountApplicationBlocked. The primaryId in the event message is the account application. The secondaryId in the event message is the banking product.

Properties

NameDescription
Account Application Blocked Event Schema (v1.1.0) object
Payload for account application blocked events, triggered when the account application has become blocked waiting for the financial institution to review the application, or for the completion of some other external activity that prevents the applicant from proceeding with the application. This schema defines the data object for event messages with category accountApplications and event message type of accountApplicationBlocked. The primaryId in the event message is the account application. The secondaryId in the event message is the banking product.
Unevaluated Properties: false
product eventProductReference (required)
A reference to a banking product.
customerType customerType (required)
Indicates the type of digital banking customer/member.
enum values: commercial, retail
applicationType applicationType

The type of an application.

applicationType strings may have one of the following enumerated values:

ValueDescription
newAccountNew Account:

An application for a new banking account
jointOwnerJoint Owner:

An application to accept a joint owner invitation to an existing account

enum values: newAccount, jointOwner
newCustomer boolean (required)
true if the applicant is a new financial institution customer/member.
trackingId trackingId(text)
An optional tracking ID which identifies the source of the new account application. This is also known as a Ref ID or Reference ID.
format: text
minLength: 1
maxLength: 256
pattern: "^[-a-zA-Z0-9.,-~=_+:;@$]{1,256}$"

accountApplicationCanceledEventSchema

{
  "product": {
    "type": "savings",
    "code": "SAV_003"
  },
  "customerType": "retail",
  "newCustomer": true,
  "trackingId": "29F093B9_E274A168-BE0385"
}

Account Application Canceled Event Schema (v1.1.0)

Payload for account application canceled events triggered when an applicant cancels a new account application or a joint owner application. This schema defines the data object for event messages with category accountApplications and event message type of accountApplicationCanceled. The primaryId in the event message is the account application. The secondaryId in the event message is the banking product.

Properties

NameDescription
Account Application Canceled Event Schema (v1.1.0) object
Payload for account application canceled events triggered when an applicant cancels a new account application or a joint owner application. This schema defines the data object for event messages with category accountApplications and event message type of accountApplicationCanceled. The primaryId in the event message is the account application. The secondaryId in the event message is the banking product.
Unevaluated Properties: false
product eventProductReference (required)
A reference to a banking product.
customerType customerType (required)
Indicates the type of digital banking customer/member.
enum values: commercial, retail
applicationType applicationType

The type of an application.

applicationType strings may have one of the following enumerated values:

ValueDescription
newAccountNew Account:

An application for a new banking account
jointOwnerJoint Owner:

An application to accept a joint owner invitation to an existing account

enum values: newAccount, jointOwner
newCustomer boolean (required)
true if the applicant is a new financial institution customer/member.
trackingId trackingId(text)
An optional tracking ID which identifies the source of the new account application. This is also known as a Ref ID or Reference ID.
format: text
minLength: 1
maxLength: 256
pattern: "^[-a-zA-Z0-9.,-~=_+:;@$]{1,256}$"

accountApplicationCreatedEventSchema

{
  "product": {
    "type": "savings",
    "code": "SAV_003"
  },
  "customerType": "retail",
  "newCustomer": true,
  "trackingId": "29F093B9_E274A168-BE0385"
}

Account Application Created Event Schema (v1.1.0)

Payload for account application created events, triggered when a customer creates a new account application or joint owner application. This event is quickly followed by an accountApplicationStarted event. This schema defines the data object for event messages with category accountApplications and event message type of accountApplicationCreated. The primaryId in the event message is the account application. The secondaryId in the event message is the banking product.

Properties

NameDescription
Account Application Created Event Schema (v1.1.0) object
Payload for account application created events, triggered when a customer creates a new account application or joint owner application. This event is quickly followed by an accountApplicationStarted event. This schema defines the data object for event messages with category accountApplications and event message type of accountApplicationCreated. The primaryId in the event message is the account application. The secondaryId in the event message is the banking product.
Unevaluated Properties: false
product eventProductReference (required)
A reference to a banking product.
customerType customerType (required)
Indicates the type of digital banking customer/member.
enum values: commercial, retail
applicationType applicationType

The type of an application.

applicationType strings may have one of the following enumerated values:

ValueDescription
newAccountNew Account:

An application for a new banking account
jointOwnerJoint Owner:

An application to accept a joint owner invitation to an existing account

enum values: newAccount, jointOwner
newCustomer boolean (required)
true if the applicant is a new financial institution customer/member.
trackingId trackingId(text)
An optional tracking ID which identifies the source of the new account application. This is also known as a Ref ID or Reference ID.
format: text
minLength: 1
maxLength: 256
pattern: "^[-a-zA-Z0-9.,-~=_+:;@$]{1,256}$"

accountApplicationPayloadFields

{
  "product": {
    "type": "cd",
    "code": "180D_CDA"
  },
  "customerType": "commercial",
  "applicationType": "newAccount",
  "newCustomer": true,
  "trackingId": "string"
}

Account Application Payload Fields (v1.0.0)

Account Application Payload Fields used to compose other schemas.

Properties

NameDescription
Account Application Payload Fields (v1.0.0) object
Account Application Payload Fields used to compose other schemas.
product eventProductReference (required)
A reference to a banking product.
customerType customerType (required)
Indicates the type of digital banking customer/member.
enum values: commercial, retail
applicationType applicationType

The type of an application.

applicationType strings may have one of the following enumerated values:

ValueDescription
newAccountNew Account:

An application for a new banking account
jointOwnerJoint Owner:

An application to accept a joint owner invitation to an existing account

enum values: newAccount, jointOwner
newCustomer boolean (required)
true if the applicant is a new financial institution customer/member.
trackingId trackingId(text)
An optional tracking ID which identifies the source of the new account application. This is also known as a Ref ID or Reference ID.
format: text
minLength: 1
maxLength: 256
pattern: "^[-a-zA-Z0-9.,-~=_+:;@$]{1,256}$"

accountApplicationStartedEventSchema

{
  "product": {
    "type": "savings",
    "code": "SAV_003"
  },
  "customerType": "retail",
  "newCustomer": true,
  "trackingId": "29F093B9_E274A168-BE0385"
}

Account Application Started Event Schema (v1.1.0)

Payload for account application started events. This schema defines the data object for event messages with category accountApplications and event message type of accountApplicationStarted. The primaryId in the event message is the account application. The secondaryId in the event message is the banking product.

Properties

NameDescription
Account Application Started Event Schema (v1.1.0) object
Payload for account application started events. This schema defines the data object for event messages with category accountApplications and event message type of accountApplicationStarted. The primaryId in the event message is the account application. The secondaryId in the event message is the banking product.
Unevaluated Properties: false
product eventProductReference (required)
A reference to a banking product.
customerType customerType (required)
Indicates the type of digital banking customer/member.
enum values: commercial, retail
applicationType applicationType

The type of an application.

applicationType strings may have one of the following enumerated values:

ValueDescription
newAccountNew Account:

An application for a new banking account
jointOwnerJoint Owner:

An application to accept a joint owner invitation to an existing account

enum values: newAccount, jointOwner
newCustomer boolean (required)
true if the applicant is a new financial institution customer/member.
trackingId trackingId(text)
An optional tracking ID which identifies the source of the new account application. This is also known as a Ref ID or Reference ID.
format: text
minLength: 1
maxLength: 256
pattern: "^[-a-zA-Z0-9.,-~=_+:;@$]{1,256}$"

accountOwnerEntitledEventSchema

{
  "account": {
    "id": "a212d3c119148960683d",
    "maskedNumber": "*3210",
    "type": "checking"
  }
}

Account Ownership Entitled Event Schema (v0.1.0)

Payload for event messages triggered when the system has granted a customer ownership entitlement of a banking account, including joint ownership. This schema defines the data object for event messages with category entitlements and event message type of accountOwnerEntitled. The primaryId in the event message is the banking account. The secondaryId in the event message is the joint owner application, if known.

Properties

NameDescription
Account Ownership Entitled Event Schema (v0.1.0) object
Payload for event messages triggered when the system has granted a customer ownership entitlement of a banking account, including joint ownership. This schema defines the data object for event messages with category entitlements and event message type of accountOwnerEntitled. The primaryId in the event message is the banking account. The secondaryId in the event message is the joint owner application, if known.
Unevaluated Properties: false
account eventInternalAccountReference
Identifies an account held at the current financial institution.

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

achBatchPaymentApprovedEventSchema

{
  "trackingNumber": "3478721",
  "approvalCount": 1,
  "remainingApprovalsCount": 1,
  "factor": "sms"
}

ACH Batch Payment Approved (v1.1.0)

Payload for ACH batch payment approved events. This schema defines the data object for event messages with category businessAchTransfers and event message type of achBatchPaymentApproved. The primaryId in the event message is the payment batch.

Properties

NameDescription
ACH Batch Payment Approved (v1.1.0) object
Payload for ACH batch payment approved events. This schema defines the data object for event messages with category businessAchTransfers and event message type of achBatchPaymentApproved. The primaryId in the event message is the payment batch.
Unevaluated Properties: false
trackingNumber paymentBatchTrackingNumber
A unique tracking number for this batch. Unlike the id, this numeric value is visible to the customer, and can be used to lookup a batch by this ID.
read-only
minLength: 6
maxLength: 9
pattern: "^[0-9]+$"
approvalCount integer(int32) (required)
The number of approvals given for the batch.
read-only
format: int32
minimum: 0
maximum: 3
remainingApprovalsCount integer(int32) (required)
The number of the remaining approvals that are required before the batch can be scheduled. This property only applies if the state of the payment batch is pendingApproval.
read-only
format: int32
minimum: 0
maximum: 3
factor eventAuthenticationChallengeFactor

The name of an authentication challenge factor, which indicates the method used to verify a user's identity when performing an operation that requires identity verification.

eventAuthenticationChallengeFactor strings may have one of the following enumerated values:

ValueDescription
smsSMS:

One-time passcode sent to the primary mobile phone number
emailEmail:

One-time passcode sent to the primary email address
voiceVoice:

One-time passcode communicated via automated voice phone call
softwareTokenSoftware Token:

One-time passcode issued by a pre-registered software authenticator application
hardwareTokenHardware Token:

One-time passcode issued by a pre-registered hardware device such as a token key fob
authenticatorTokenAuthenticator Token:

One-time passcode issued by a pre-registered authenticator
securityQuestionsSecurity Questions:

Prompt the user to answer their registered security questions
twoWaySmsTwo-way SMS:

Prompt the user to verify their identity via a two-way SMS conversation

enum values: sms, email, voice, hardwareToken, softwareToken, authenticatorToken, securityQuestions, twoWaySms

achBatchPaymentInitiatedEventSchema

{
  "name": "Payroll-08",
  "secCode": "ppd",
  "direction": "credit",
  "schedule": {
    "scheduledOn": "2023-11-01",
    "frequency": "occasional",
    "effectiveOn": "2023-10-30"
  },
  "customerId": "c656f2f586c81e68ddf6",
  "settlementAccount": {
    "id": "bf23bc970b78d27691e",
    "maskedNumber": "*1008",
    "routingNumber": "123123123"
  },
  "creditTotal": "92467.50",
  "debitTotal": "0.00",
  "instructionCount": 17,
  "trackingNumber": "3478721"
}

ACH Batch Payment Initiated (v1.3.0)

Payload for ACH batch payment initiated events. This schema defines the data object for event messages with category businessAchTransfers and event message type of achBatchPaymentInitiated. The primaryId in the event message is the payment batch.

Properties

NameDescription
ACH Batch Payment Initiated (v1.3.0) object
Payload for ACH batch payment initiated events. This schema defines the data object for event messages with category businessAchTransfers and event message type of achBatchPaymentInitiated. The primaryId in the event message is the payment batch.
Unevaluated Properties: false
name string(text) (required)
The user-assigned name of this payment batch.
format: text
maxLength: 10
secCode paymentBatchAchSecCode (required)
The SEC code for these ACH payments. This is derived from type.
enum values: arc, boc, ccd, cie, ctx, pop, ppd, rck, tel, web
direction paymentBatchDirection

Indicates the direction of money flow for a payment batch.

paymentBatchDirection strings may have one of the following enumerated values:

ValueDescription
noneNone:

No payment instructions to determine direction
creditcredit:

Payments are credit in the external accounts, debit to the settlement account
debitdebit:

Payments are debits in the external accounts, credit to the settlement account
bothboth:

Payment instructions include both debits and credits

enum values: none, credit, debit, both
schedule paymentBatchSchedule (required)
The scheduled date when the payment should be completed, the recurrence, if any, and other derived dates based on the scheduled date.

If the payment is a NACHA pass-through, the schedule is read-only and reflects the earliest scheduledOn and effectiveOn dates from the NACHA file with a recurrenceType of once.

customerId resourceId
The ID of the banking customer that this payment batch is for. This is typically a business customer ID. Note: This is not the login or access ID of the customer.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
settlementAccount businessTransferSettlementAccountReference
The account where the payment funds are drawn or credited.
creditTotal creditOrDebitValue (required)
The total of all the payment credit amounts in this batch's payment instructions, expressed as a decimal value. These amounts are credits to the remote accounts and a debit to the settlement account. The total omits instructions where hold is true.
read-only
maxLength: 16
pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
debitTotal creditOrDebitValue (required)
The total of all the payment debit amounts in this batch's payment instructions, expressed as a decimal value. These amounts are debits to the remote accounts and a credit to the settlement account. The total omits instructions where hold is true.
read-only
maxLength: 16
pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
instructionCount integer(int32) (required)
The number of ACH transfer instructions in the payment batch.
format: int32
minimum: 0
maximum: 1000
trackingNumber paymentBatchTrackingNumber
A unique tracking number for this batch. Unlike the id, this numeric value is visible to the customer, and can be used to lookup a batch by this ID.
read-only
minLength: 6
maxLength: 9
pattern: "^[0-9]+$"

achBatchPaymentRejectedEventSchema

{
  "trackingNumber": "3478721",
  "reason": "Terminated employee S. Hawkins still in payroll"
}

ACH Batch Payment Rejected (v1.1.0)

Payload for ACH batch payment rejected events. This schema defines the data object for event messages with category businessAchTransfers and event message type of achBatchPaymentRejected. The primaryId in the event message is the payment batch.

Properties

NameDescription
ACH Batch Payment Rejected (v1.1.0) object
Payload for ACH batch payment rejected events. This schema defines the data object for event messages with category businessAchTransfers and event message type of achBatchPaymentRejected. The primaryId in the event message is the payment batch.
Unevaluated Properties: false
trackingNumber paymentBatchTrackingNumber
A unique tracking number for this batch. Unlike the id, this numeric value is visible to the customer, and can be used to lookup a batch by this ID.
read-only
minLength: 6
maxLength: 9
pattern: "^[0-9]+$"
reason string(text)
The optional reason the customer is rejecting these batches.
format: text
maxLength: 80

achBatchPaymentReversedEventSchema

{
  "trackingNumber": "3478721",
  "reversalLevel": "partial",
  "batchReversedCreditsCount": 5,
  "reversedCreditAmount": "43970.10",
  "reversedCreditTotal": "43970.10",
  "reversedDebitsCount": 0,
  "batchReversedDebitsCount": 0,
  "reversedDebitAmount": "0.00",
  "reversedDebitTotal": "0.00"
}

ACH Batch Payment Reversed (v1.2.0)

Payload for ACH batch payment reversed events. The properties reversalLevel, batchReversedCreditsCount, reversedCreditTotal, batchReversedDebitsCount, and reversedDebitTotal are present for both partial and full reversals. The properties reversedCreditsCount, reversedCreditAmount, reversedDebitsCount, and reversedDebitAmount are present only on partial reversals. This schema defines the data object for event messages with category businessAchTransfers and event message type of achBatchPaymentReversed. The primaryId in the event message is the payment batch.

Properties

NameDescription
ACH Batch Payment Reversed (v1.2.0) object
Payload for ACH batch payment reversed events. The properties reversalLevel, batchReversedCreditsCount, reversedCreditTotal, batchReversedDebitsCount, and reversedDebitTotal are present for both partial and full reversals. The properties reversedCreditsCount, reversedCreditAmount, reversedDebitsCount, and reversedDebitAmount are present only on partial reversals. This schema defines the data object for event messages with category businessAchTransfers and event message type of achBatchPaymentReversed. The primaryId in the event message is the payment batch.
Unevaluated Properties: false
trackingNumber paymentBatchTrackingNumber
A unique tracking number for this batch. Unlike the id, this numeric value is visible to the customer, and can be used to lookup a batch by this ID.
read-only
minLength: 6
maxLength: 9
pattern: "^[0-9]+$"
reversalLevel eventAchBatchReversalLevel (required)
Indicates the level of reversal of an ACH payment batch.
enum values: partial, full
reversedCreditsCount integer(int32)
The number the credit transfer instructions that were reversed in this action.
format: int32
minimum: 0
maximum: 1000
batchReversedCreditsCount integer(int32) (required)
The total number of reversed credit transfer instructions in the ACH batch.
format: int32
minimum: 0
maximum: 1000
reversedCreditAmount creditOrDebitValue
The sum of the credit transfer instructions amounts that were reversed in this action, expressed as a decimal value.
maxLength: 16
pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
reversedCreditTotal creditOrDebitValue (required)
The total sum of the reversed credit transfer instructions amounts in the ACH batch, expressed as a decimal value.
maxLength: 16
pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
reversedDebitsCount integer(int32)
The number the debit transfer instructions that were reversed in this action.
format: int32
minimum: 0
maximum: 1000
batchReversedDebitsCount integer(int32) (required)
The total number of reversed debit transfer instructions in the ACH batch.
format: int32
minimum: 0
maximum: 1000
reversedDebitAmount creditOrDebitValue
The sum of the debit transfer instructions amounts that were reversed in this action, expressed as a decimal value.
maxLength: 16
pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
reversedDebitTotal creditOrDebitValue (required)
The total sum of the reversed debit transfer instructions amounts in the ACH batch, expressed as a decimal value.
maxLength: 16
pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"

achBatchPaymentScheduledEventSchema

{
  "name": "Payroll-08",
  "secCode": "ppd",
  "direction": "credit",
  "schedule": {
    "scheduledOn": "2023-11-01",
    "frequency": "occasional",
    "effectiveOn": "2023-10-30"
  },
  "customerId": "c656f2f586c81e68ddf6",
  "settlementAccount": {
    "id": "bf23bc970b78d27691e",
    "maskedNumber": "*1008",
    "routingNumber": "123123123"
  },
  "creditTotal": "92467.50",
  "debitTotal": "0.00",
  "instructionCount": 17,
  "trackingNumber": "3478721"
}

ACH Batch Payment Scheduled (v1.3.0)

Payload for ACH batch payment scheduled events. This schema defines the data object for event messages with category businessAchTransfers and event message type of achBatchPaymentScheduled. The primaryId in the event message is the payment batch.

Properties

NameDescription
ACH Batch Payment Scheduled (v1.3.0) object
Payload for ACH batch payment scheduled events. This schema defines the data object for event messages with category businessAchTransfers and event message type of achBatchPaymentScheduled. The primaryId in the event message is the payment batch.
Unevaluated Properties: false
name string(text) (required)
The user-assigned name of this payment batch.
format: text
maxLength: 10
secCode paymentBatchAchSecCode (required)
The SEC code for these ACH payments. This is derived from type.
enum values: arc, boc, ccd, cie, ctx, pop, ppd, rck, tel, web
direction paymentBatchDirection

Indicates the direction of money flow for a payment batch.

paymentBatchDirection strings may have one of the following enumerated values:

ValueDescription
noneNone:

No payment instructions to determine direction
creditcredit:

Payments are credit in the external accounts, debit to the settlement account
debitdebit:

Payments are debits in the external accounts, credit to the settlement account
bothboth:

Payment instructions include both debits and credits

enum values: none, credit, debit, both
schedule paymentBatchSchedule (required)
The scheduled date when the payment should be completed, the recurrence, if any, and other derived dates based on the scheduled date.

If the payment is a NACHA pass-through, the schedule is read-only and reflects the earliest scheduledOn and effectiveOn dates from the NACHA file with a recurrenceType of once.

customerId resourceId
The ID of the banking customer that this payment batch is for. This is typically a business customer ID. Note: This is not the login or access ID of the customer.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
settlementAccount businessTransferSettlementAccountReference
The account where the payment funds are drawn or credited.
creditTotal creditOrDebitValue (required)
The total of all the payment credit amounts in this batch's payment instructions, expressed as a decimal value. These amounts are credits to the remote accounts and a debit to the settlement account. The total omits instructions where hold is true.
read-only
maxLength: 16
pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
debitTotal creditOrDebitValue (required)
The total of all the payment debit amounts in this batch's payment instructions, expressed as a decimal value. These amounts are debits to the remote accounts and a credit to the settlement account. The total omits instructions where hold is true.
read-only
maxLength: 16
pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
instructionCount integer(int32) (required)
The number of ACH transfer instructions in the payment batch.
format: int32
minimum: 0
maximum: 1000
trackingNumber paymentBatchTrackingNumber
A unique tracking number for this batch. Unlike the id, this numeric value is visible to the customer, and can be used to lookup a batch by this ID.
read-only
minLength: 6
maxLength: 9
pattern: "^[0-9]+$"

achBatchPaymentSubmittedEventSchema

{
  "name": "Payroll-08",
  "secCode": "ppd",
  "direction": "credit",
  "schedule": {
    "scheduledOn": "2023-11-01",
    "frequency": "occasional",
    "effectiveOn": "2023-10-30"
  },
  "customerId": "c656f2f586c81e68ddf6",
  "settlementAccount": {
    "id": "bf23bc970b78d27691e",
    "maskedNumber": "*1008",
    "routingNumber": "123123123"
  },
  "creditTotal": "92467.50",
  "debitTotal": "0.00",
  "instructionCount": 17,
  "trackingNumber": "3478721"
}

ACH Batch Payment Submitted (v1.3.0)

Payload for ACH batch payment submitted events. This schema defines the data object for event messages with category businessAchTransfers and event message type of achBatchPaymentSubmitted. The primaryId in the event message is the payment batch.

Properties

NameDescription
ACH Batch Payment Submitted (v1.3.0) object
Payload for ACH batch payment submitted events. This schema defines the data object for event messages with category businessAchTransfers and event message type of achBatchPaymentSubmitted. The primaryId in the event message is the payment batch.
Unevaluated Properties: false
name string(text) (required)
The user-assigned name of this payment batch.
format: text
maxLength: 10
secCode paymentBatchAchSecCode (required)
The SEC code for these ACH payments. This is derived from type.
enum values: arc, boc, ccd, cie, ctx, pop, ppd, rck, tel, web
direction paymentBatchDirection

Indicates the direction of money flow for a payment batch.

paymentBatchDirection strings may have one of the following enumerated values:

ValueDescription
noneNone:

No payment instructions to determine direction
creditcredit:

Payments are credit in the external accounts, debit to the settlement account
debitdebit:

Payments are debits in the external accounts, credit to the settlement account
bothboth:

Payment instructions include both debits and credits

enum values: none, credit, debit, both
schedule paymentBatchSchedule (required)
The scheduled date when the payment should be completed, the recurrence, if any, and other derived dates based on the scheduled date.

If the payment is a NACHA pass-through, the schedule is read-only and reflects the earliest scheduledOn and effectiveOn dates from the NACHA file with a recurrenceType of once.

customerId resourceId
The ID of the banking customer that this payment batch is for. This is typically a business customer ID. Note: This is not the login or access ID of the customer.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
settlementAccount businessTransferSettlementAccountReference
The account where the payment funds are drawn or credited.
creditTotal creditOrDebitValue (required)
The total of all the payment credit amounts in this batch's payment instructions, expressed as a decimal value. These amounts are credits to the remote accounts and a debit to the settlement account. The total omits instructions where hold is true.
read-only
maxLength: 16
pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
debitTotal creditOrDebitValue (required)
The total of all the payment debit amounts in this batch's payment instructions, expressed as a decimal value. These amounts are debits to the remote accounts and a credit to the settlement account. The total omits instructions where hold is true.
read-only
maxLength: 16
pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
instructionCount integer(int32) (required)
The number of ACH transfer instructions in the payment batch.
format: int32
minimum: 0
maximum: 1000
trackingNumber paymentBatchTrackingNumber
A unique tracking number for this batch. Unlike the id, this numeric value is visible to the customer, and can be used to lookup a batch by this ID.
read-only
minLength: 6
maxLength: 9
pattern: "^[0-9]+$"

achBatchPaymentUnlockedEventSchema

{
  "name": "Payroll-08",
  "secCode": "ppd",
  "direction": "credit",
  "schedule": {
    "scheduledOn": "2023-11-01",
    "frequency": "occasional",
    "effectiveOn": "2023-10-30"
  },
  "customerId": "c656f2f586c81e68ddf6",
  "settlementAccount": {
    "id": "bf23bc970b78d27691e",
    "maskedNumber": "*1008",
    "routingNumber": "123123123"
  },
  "creditTotal": "92467.50",
  "debitTotal": "0.00",
  "instructionCount": 17,
  "trackingNumber": "3478721"
}

ACH Batch Payment Unapproved (v1.3.0)

Payload for ACH batch payment unlocked (unapproved) events. This schema defines the data object for event messages with category businessAchTransfers and event message type of achBatchPaymentUnlocked. The primaryId in the event message is the payment batch.

Properties

NameDescription
ACH Batch Payment Unapproved (v1.3.0) object
Payload for ACH batch payment unlocked (unapproved) events. This schema defines the data object for event messages with category businessAchTransfers and event message type of achBatchPaymentUnlocked. The primaryId in the event message is the payment batch.
Unevaluated Properties: false
name string(text) (required)
The user-assigned name of this payment batch.
format: text
maxLength: 10
secCode paymentBatchAchSecCode (required)
The SEC code for these ACH payments. This is derived from type.
enum values: arc, boc, ccd, cie, ctx, pop, ppd, rck, tel, web
direction paymentBatchDirection

Indicates the direction of money flow for a payment batch.

paymentBatchDirection strings may have one of the following enumerated values:

ValueDescription
noneNone:

No payment instructions to determine direction
creditcredit:

Payments are credit in the external accounts, debit to the settlement account
debitdebit:

Payments are debits in the external accounts, credit to the settlement account
bothboth:

Payment instructions include both debits and credits

enum values: none, credit, debit, both
schedule paymentBatchSchedule (required)
The scheduled date when the payment should be completed, the recurrence, if any, and other derived dates based on the scheduled date.

If the payment is a NACHA pass-through, the schedule is read-only and reflects the earliest scheduledOn and effectiveOn dates from the NACHA file with a recurrenceType of once.

customerId resourceId
The ID of the banking customer that this payment batch is for. This is typically a business customer ID. Note: This is not the login or access ID of the customer.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
settlementAccount businessTransferSettlementAccountReference
The account where the payment funds are drawn or credited.
creditTotal creditOrDebitValue (required)
The total of all the payment credit amounts in this batch's payment instructions, expressed as a decimal value. These amounts are credits to the remote accounts and a debit to the settlement account. The total omits instructions where hold is true.
read-only
maxLength: 16
pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
debitTotal creditOrDebitValue (required)
The total of all the payment debit amounts in this batch's payment instructions, expressed as a decimal value. These amounts are debits to the remote accounts and a credit to the settlement account. The total omits instructions where hold is true.
read-only
maxLength: 16
pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
instructionCount integer(int32) (required)
The number of ACH transfer instructions in the payment batch.
format: int32
minimum: 0
maximum: 1000
trackingNumber paymentBatchTrackingNumber
A unique tracking number for this batch. Unlike the id, this numeric value is visible to the customer, and can be used to lookup a batch by this ID.
read-only
minLength: 6
maxLength: 9
pattern: "^[0-9]+$"

achSecCode

"arc"

ACH SEC Code (v1.0.0)

The ACH transfer type.

achSecCode strings may have one of the following enumerated values:

ValueDescription
arcAccounts Receivable
bocBack Office Conversion
ccdCredit or Debit
cieCustomer-Initiated
ctxCorporate Trade Exchange
popPoint of Purchase
ppdPrearranged Payment and Deposit
rckRe-Presented Check
telTelephone-initiated
webInternet-initiated/Mobile

type: string


enum values: arc, boc, ccd, cie, ctx, pop, ppd, rck, tel, web

addressUpdatedEventSchema

{
  "previousAddress": {
    "address1": "1805 Tiburon Dr.",
    "address2": "Building 14, Suite 1500",
    "locality": "Wilmington",
    "regionCode": "NC",
    "countryCode": "US",
    "postalCode": "28412"
  },
  "newAddress": {
    "address1": "1822 Tiburon Dr.",
    "address2": "Building 9, Suite 100",
    "locality": "Wilmington",
    "regionCode": "NC",
    "countryCode": "US",
    "postalCode": "28412"
  },
  "type": "mailing"
}

Address Updated Event Schema (v0.3.0)

Payload for event messages triggered when a user has updated their postal address. This schema defines the data object for event messages with category profile and event message type of addressUpdated.

Properties

NameDescription
Address Updated Event Schema (v0.3.0) object
Payload for event messages triggered when a user has updated their postal address. This schema defines the data object for event messages with category profile and event message type of addressUpdated.
Unevaluated Properties: false
previousAddress eventAddress (required)
The value of the address prior to the update.
newAddress eventAddress (required)
The value of the address after the update.
type string (required)
Indicates which address associated with this banking customer's profile was updated.
enum values: physical, mailing

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

NameDescription
API Problem (v1.2.1) object
API problem or error, as per RFC 7807 application/problem+json.
type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
format: uri-reference
maxLength: 2048
title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
format: text
maxLength: 120
status integer(int32)
The HTTP status code for this occurrence of the problem.
format: int32
minimum: 100
maximum: 599
detail string(text)
A human-readable explanation specific to this occurrence of the problem.
format: text
maxLength: 256
instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
format: uri-reference
maxLength: 2048
id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
read-only
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
read-only
format: date-time
minLength: 20
maxLength: 30
problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
items: object

applicationType

"newAccount"

Application Type (v1.0.0)

The type of an application.

applicationType strings may have one of the following enumerated values:

ValueDescription
newAccountNew Account:

An application for a new banking account
jointOwnerJoint Owner:

An application to accept a joint owner invitation to an existing account

type: string


enum values: newAccount, jointOwner

businessTransferSettlementAccountReference

{
  "id": "bf23bc970b78d27691e",
  "maskedNumber": "*1008",
  "routingNumber": "123123123"
}

Business Transfer Settlement Account Reference (v1.0.0)

Descriptive fields that identify a business transfer's internal settlement account.

Properties

NameDescription
Business Transfer Settlement Account Reference (v1.0.0) object
Descriptive fields that identify a business transfer's internal settlement account.
id nullableReadOnlyResourceId | null (required)
The account's unique, opaque resource ID.
read-only
minLength: 6
maxLength: 48
nullable
pattern: "^[-_:.~$a-zA-Z0-9]+$"
maskedNumber maskedAccountNumber
The account number, masked for partial display.
read-only
minLength: 2
maxLength: 5
pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$"
routingNumber accountRoutingNumber
An account ABA routing and transit number.
minLength: 9
maxLength: 9
pattern: "^[0-9]{9}$"

challengeFactorType

"sms"

Challenge Factor Type (v1.0.0)

The name of challenge factor.

challengeFactorType strings may have one of the following enumerated values:

ValueDescription
smsSMS:

One-time passcode sent to the primary mobile phone number
emailEmail:

One-time passcode sent to the primary email address
voiceVoice:

One-time passcode communicated via automated voice phone call
authenticatorTokenauthenticator Token:

One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app
securityQuestionsSecurity Questions:

Prompt with the user's security questions registered with their security profile

type: string


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

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

creditOrDebitValue

"3456.78"

Credit Or Debit Value (v1.1.0)

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


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

customerType

"commercial"

Customer Type (v1.0.0)

Indicates the type of digital banking customer/member.

type: string


enum values: commercial, retail

date

"2021-10-30"

Date (v1.0.0)

A date formatted in YYYY-MM-DD RFC 3339 date UTC format.

type: string(date)


format: date
minLength: 10
maxLength: 10

dateTimeRange

"[2023-04-28T00:00:00Z,]"

Date Time Range (v1.0.0)

A query parameter for selecting items in a date-time range. Filter the response to only items that fall in the range bounded by start and end date-times. The start and end values are either dates in RFC 3339 YYYY-MM-DD date format, or date-times in YYYY-MM-DDThh:mm:ss.sssZ date-time format.

For example

  • [start,end] between start and end date/times, inclusive of the endpoints
  • (start,end) between start and end date/times, exclusive of the endpoints
  • (start,end] between start and end date/times, exclusive of start and inclusive of the end
  • [start,end) between start and end date/times, inclusive of start and exclusive of the end
  • YYYY-MM-DD equivalent to [YYYY-MM-DD,YYYY-MM-DD]

Dates without a time component are converted to UTC date-time values. If start or end are date values, then start00 is defined as time 00:00:00Z on the start date, start24 is defined as 00:00AM of the day after the start date: end00 is defined as time 00:00:00Z on the end date, end24 is defined as 00:00AM of the day after the end date:

  • [start,end] is the same as [start00,end24)
  • (start,end] is the same as (start24,end24)
  • [start,end) is the same as [start00,end00)
  • (start,end) is the same as (start24,end00)

For example, the range [2023-05-01,2023-06-01) matches any day/time in May 2023 and is equivalent to [2023-05-01T00:00:00.00Z,2023-06-01T00:00:00.00Z).

type: string(text)


format: text
minLength: 10
maxLength: 63
pattern: "^((\d{4}-\d{2}-\d{2})|([[(](((\d{4}-\d{2}-\d{2}([Tt]\d{2}:\d{2}:\d{2}(.\d{1,6})?[Zz])?),(\d{4}-\d{2}-\d{2}([Tt]\d{2}:\d{2}:\d{2}(.\d{1,6})?[Zz])?)?)|(,(\d{4}-\d{2}-\d{2}([Tt]\d{2}:\d{2}:\d{2}(.\d{1,6})?[Zz])?)))[)\]]))$"

entitlementUpdatedEventSchema

{
  "type": "debit_card_controls",
  "category": "account",
  "state": true
}

Event Schema (v0.1.2)

Payload for event messages triggered when a customer has changed account or customer entitlements for another customer.

A state value of true means the entitlement was set, and false means it was unset. For example, when the entitlement type: view has state: true, the customer's account view access is allowed. Some entitlements (those where the type starts with the prefix "no_") are negative. For example, when the entitlement type: no_stmt_view has a state: true, the customer's statement view access is blocked. This schema defines the data object for event messages with category entitlements and event message type of entitlementUpdated. The primaryId in the event message is the customer whose entitlements were change. The secondaryId in the event message is the ID of the account or customer over which the entitlement was updated.

Properties

NameDescription
Event Schema (v0.1.2) object
Payload for event messages triggered when a customer has changed account or customer entitlements for another customer.

A state value of true means the entitlement was set, and false means it was unset. For example, when the entitlement type: view has state: true, the customer's account view access is allowed. Some entitlements (those where the type starts with the prefix "no_") are negative. For example, when the entitlement type: no_stmt_view has a state: true, the customer's statement view access is blocked. This schema defines the data object for event messages with category entitlements and event message type of entitlementUpdated. The primaryId in the event message is the customer whose entitlements were change. The secondaryId in the event message is the ID of the account or customer over which the entitlement was updated.
Unevaluated Properties: false

type string (required)
The name of the entitlement setting.
minLength: 4
maxLength: 64
pattern: "^[a-z][a-z0-9_]{3,63}$"
category eventEntitlementCategory (required)

Indicates whether the entitlement is over an account or over a customer.

eventEntitlementCategory strings may have one of the following enumerated values:

ValueDescription
accountAccount:

Entitlement is over a banking account
customerCustomer:

Entitlement is over a banking customer

enum values: account, customer
state boolean (required)
The new entitlement setting; true means the entitlement was set, false means it was unset.

eventAccountReference

{
  "id": "a212d3c119148960683d",
  "maskedNumber": "*3210",
  "routingNumber": "021000021"
}

Account Reference (v0.1.0)

A reference to a banking account.

Properties

NameDescription
Account Reference (v0.1.0) object
A reference to a banking account.
Additional Properties: false
id resourceId (required)
The resource ID of the banking account.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
maskedNumber maskedAccountNumber (required)
A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber.
minLength: 2
maxLength: 5
pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$"
routingNumber accountRoutingNumber (required)
The account's routing and transit number.
minLength: 9
maxLength: 9
pattern: "^[0-9]{9}$"

eventAchBatchReversalLevel

"partial"

Event ACH Batch Reversal Level (v1.0.0)

Indicates the level of reversal of an ACH payment batch.

type: string


enum values: partial, full

eventAddress

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

Event Address (v1.1.0)

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

Properties

NameDescription
Event Address (v1.1.0) object
A postal address that can hold a US address or an international (non-US) postal addresses.
address1 string(text)
The first line of the postal address. In the US, this typically includes the building number and street name.
format: text
maxLength: 35
address2 string(text)
The second line of the street address. This should only be used if it has a value. Typical values include building numbers, suite numbers, and other identifying information beyond the first line of the postal address.
format: text
maxLength: 35
locality string(text)
The city/town/municipality of the address.
format: text
maxLength: 30
countryCode string
The ISO-3611 alpha-2 value for the country associated with the postal address.
minLength: 2
maxLength: 2
pattern: "^[A-Za-z]{2}$"
regionName string(text)
The state, district, or outlying area of the postal address. This is required if countryCode is not US. regionCode and regionName are mutually exclusive.
format: text
minLength: 2
maxLength: 20
regionCode string
The state, district, or outlying area of the postal address. This is required if countryCode is US. regionCode and regionName are mutually exclusive.
minLength: 2
maxLength: 2
pattern: "^[A-Za-z]{2}$"
postalCode string
The postal code, which varies in format by country. If countryCode is US, this should be a five digit US ZIP code or ten character ZIP+4.
minLength: 2
maxLength: 20
pattern: "[0-9A-Za-z][- 0-9A-Za-z]{0,18}[0-9A-Za-z]"

eventAgentType

"customer"

Event User Type (v0.1.0)

Describes the type of agent (user or actor) that performed the action that triggered an event.

eventAgentType strings may have one of the following enumerated values:

ValueDescription
customerCustomer:

A banking customer
operatorOperator:

A financial institution operator or administrator
systemSystem:

A system process or job, not an interactive person

type: string


enum values: customer, operator, system

eventAuthenticationChallengeFactor

"sms"

Event Authentication Challenge Factor (v1.0.0)

The name of an authentication challenge factor, which indicates the method used to verify a user's identity when performing an operation that requires identity verification.

eventAuthenticationChallengeFactor strings may have one of the following enumerated values:

ValueDescription
smsSMS:

One-time passcode sent to the primary mobile phone number
emailEmail:

One-time passcode sent to the primary email address
voiceVoice:

One-time passcode communicated via automated voice phone call
softwareTokenSoftware Token:

One-time passcode issued by a pre-registered software authenticator application
hardwareTokenHardware Token:

One-time passcode issued by a pre-registered hardware device such as a token key fob
authenticatorTokenAuthenticator Token:

One-time passcode issued by a pre-registered authenticator
securityQuestionsSecurity Questions:

Prompt the user to answer their registered security questions
twoWaySmsTwo-way SMS:

Prompt the user to verify their identity via a two-way SMS conversation

type: string


enum values: sms, email, voice, hardwareToken, softwareToken, authenticatorToken, securityQuestions, twoWaySms

eventEntitlementCategory

"account"

Entitlement Category (v1.0.0)

Indicates whether the entitlement is over an account or over a customer.

eventEntitlementCategory strings may have one of the following enumerated values:

ValueDescription
accountAccount:

Entitlement is over a banking account
customerCustomer:

Entitlement is over a banking customer

type: string


enum values: account, customer

eventHistory

{
  "start": "460bf6af1c8a632cc0d8",
  "limit": 1000,
  "nextPage_url": "/banking/eventHistory?start=c49b048aea17f0622f06?limit=1000",
  "version": "0.2.0",
  "startsAt": "2022-12-02T11:00:00.000",
  "endsAt": "2022-12-02T11:10:00.000Z",
  "items": [
    {
      "id": "b844b2d641da",
      "institutionId": "TIBURON",
      "category": "authentication",
      "type": "userLoggedIn",
      "occurredAt": "2022-12-02T11:08:00.375Z",
      "correlationId": "0730fd7ac6bfe5a87b0a",
      "sessionId": "2ded0203a8a2b6e7befa",
      "agentId": "4f3ec1daab02eed9de64",
      "coreCustomerId": "12299292",
      "agentType": "customer",
      "host": "13.226.38.34",
      "primaryId": "b844b2d6d9ca818df3c8",
      "data": {
        "browser": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36",
        "operatingSystem": "macos",
        "platform": "web",
        "application": "apitureDigitalBanking",
        "score": 2500
      }
    },
    {
      "id": "0399abed30f38b8a365c",
      "institutionId": "TIBURON",
      "category": "transfers",
      "type": "singleTransferScheduled",
      "occurredAt": "2022-12-02T11:08:00.375Z",
      "correlationId": "2266452a0bfd8150cf64",
      "sessionId": "2ded0203a8a2b6e7befa",
      "agentId": "4f3ec1daab02eed9de64",
      "coreCustomerId": "12299292",
      "agentType": "customer",
      "host": "13.226.38.34",
      "primaryId": "a727ff2aedea60646819",
      "data": {
        "sourceAccount": {
          "id": "a212d3c119148960683d",
          "maskedNumber": "*3210",
          "routingNumber": "021000021"
        },
        "targetAccount": {
          "id": "0c8ad50ab6cf0eb48c25",
          "maskedNumber": "*3219",
          "routingNumber": "021000021"
        }
      }
    }
  ]
}

Event History (v1.4.2)

Representation of the event history resource.

Properties

NameDescription
Event History (v1.4.2) object
Representation of the event history resource.
Unevaluated Properties: false
limit integer(int32) (required)
The number of items requested for this page response. The length of the items array may be less that limit.
format: int32
minimum: 0
maximum: 10000
nextPage_url string(uri-reference)
The URL of the next page of resources. If this URL is omitted, there are no more resources in the collection.
read-only
format: uri-reference
maxLength: 8000
start string(text)
The opaque cursor that specifies the starting location of this page of items.
format: text
maxLength: 256
version string(semver)
The semantic version number of the event metadata structure.
format: semver
minLength: 5
maxLength: 12
enum values: 0.1.0, 0.2.0
startsAt timestamp(date-time)
The beginning date-time for the events in this page of event messages. This is an RFC 3339 UTC date-time string. This is omitted if the items array is empty.
format: date-time
minLength: 20
maxLength: 30
endsAt timestamp(date-time)
The ending date-time for the events in this page of event messages. This is an RFC 3339 UTC date-time string. This is omitted if the items array is empty.
format: date-time
minLength: 20
maxLength: 30
items array: [eventMessageItem]
An array of event items.
maxItems: 10000
items: object
» Unevaluated Properties: false

eventInternalAccountReference

{
  "id": "a212d3c119148960683d",
  "maskedNumber": "*3210",
  "type": "checking"
}

Event Internal Account Reference (v1.0.0)

Identifies an account held at the current financial institution.

Properties

NameDescription
Event Internal Account Reference (v1.0.0) object
Identifies an account held at the current financial institution.
id resourceId
The resource ID of the banking account.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
maskedNumber maskedAccountNumber
A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber.
minLength: 2
maxLength: 5
pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$"
type productType

The type (or category) of banking product.

productType strings may have one of the following enumerated values:

ValueDescription
savingsSavings:

Savings Account
checkingChecking:

Checking Account
cdCD:

Certificate of Deposit Account
iraIRA:

Individual Retirement Account
loanLoan:

Loan Account
creditCardCredit Card:

Credit Card Account

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

eventMessageCategory

"wireTransfers"

Event Message Category (v1.1.0)

An identifier for the category of the event. Multiple message types can belong to a category. This is a lowerCamelCase string.

type: string


minLength: 4
maxLength: 40
pattern: "^[a-z][a-zA-Z0-9]{3,39}$"

eventMessageItem

{
  "id": "0399abed30f38b8a365c",
  "institutionId": "TIBURON",
  "correlationId": "da2da17214b86185fb9e",
  "type": "singleTransferScheduled",
  "category": "transfers",
  "occurredAt": "2019-09-13T05:03:50.375Z",
  "agentId": "4f3ec1daab02eed9de64",
  "agentType": "customer",
  "coreCustomerId": "138929",
  "host": "13.226.38.34",
  "primaryId": "a727ff2aedea60646819",
  "data": {
    "sourceAccount": {
      "id": "14bdbe18a60b58a91982",
      "maskedNumber": "*3210",
      "routingNumber": "021000021"
    },
    "targetAccount": {
      "id": "bd9a225cb9a285e59cb8",
      "maskedNumber": "*3219",
      "routingNumber": "021000021"
    }
  }
}

Event Item (v0.9.2)

A data record representing a banking activity or action performed by a user. This conveys:

  • who did something (agentId, agentType, coreCustomerId)
  • what they did (type, category),
  • when they did it (occurredAt),
  • where they did it (host),
  • what they did it to (primaryId, secondaryId)
  • additional data that is specific to the activity type.

The type is a key into the set of event types . Each type has a corresponding JSON schema that defines the layout of the data object. The schema name is derived from the type name by adding EventSchema. For example, the transferScheduled event type's data is defined by the schema named transferScheduledEventSchema.

Properties

NameDescription
Event Item (v0.9.2) object
A data record representing a banking activity or action performed by a user. This conveys:

  • who did something (agentId, agentType, coreCustomerId)
  • what they did (type, category),
  • when they did it (occurredAt),
  • where they did it (host),
  • what they did it to (primaryId, secondaryId)
  • additional data that is specific to the activity type.

The type is a key into the set of event types . Each type has a corresponding JSON schema that defines the layout of the data object. The schema name is derived from the type name by adding EventSchema. For example, the transferScheduled event type's data is defined by the schema named transferScheduledEventSchema.
Unevaluated Properties: false

id resourceId (required)
The unique identifier for this event. This is an immutable opaque string.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
institutionId institutionId
The unique identifier of the financial institution, if applicable.
minLength: 2
maxLength: 8
pattern: "^[A-Z0-9_]{2,8}$"
correlationId resourceId
An identifier that allows correlating multiple events. This may represent a business process transaction ID or service request ID.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
sessionId resourceId
The customer session ID, if known. User login starts a session.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
type eventMessageType (required)
The type of this event. This is the key into the set of event types. This is a lowerCamelCase string.
minLength: 4
maxLength: 48
pattern: "^[a-z][a-zA-Z0-9]{3,47}$"
category eventMessageCategory (required)
An identifier for the category of the event. Multiple message types can belong to a category. This is a lowerCamelCase string.
minLength: 4
maxLength: 40
pattern: "^[a-z][a-zA-Z0-9]{3,39}$"
occurredAt timestamp(date-time) (required)
The approximate date and time when the action occurred and/or was recorded. This is an RFC 3339 UTC date-time string. The time is approximate. That is, if event a occurs before event b, it is possible that the occurredAt recorded for `b may be before a.
format: date-time
minLength: 20
maxLength: 30
agentId resourceId
The unique immutable ID of the agent that performed the action that triggered this event. If agentType is customer then the agent ID is the customer ID; if agentType is operator then the agent ID is the operator/administrator ID; if agentType is system then the agent ID is the process/job name.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
agentType eventAgentType (required)
Indicates what type of agent or actor performed the operation that triggered this event.
enum values: customer, operator, system
coreCustomerId coreCustomerId
The unique ID of the customer in the banking core. This is only present if agentType is customer and if the banking core supports it.
minLength: 1
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
requesterId resourceId
The unique immutable ID of the operator who is acting on behalf of the user identified by the agentId when the agentType is customer. This is also known as user emulation.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
host string(text)
The host IP address of client which was used for this activity, if known.
format: text
maxLength: 32
primaryId resourceId
The optional unique system ID of the the primary resource that this activity applies to. For example, if a transfer if scheduled or canceled, this is the ID of the transfer.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
secondaryId resourceId
The optional unique system ID of a secondary resource that this activity applies to, if any.
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
data abstractEventDataSchema
Additional properties of the event, represented as a type-specific object.

eventMessageType

"wireTransferScheduled"

Event Message Type (v1.1.0)

The type of this event. This is the key into the set of event types. This is a lowerCamelCase string.

type: string


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

eventMessages

{
  "version": "0.2.0",
  "startsAt": "2022-12-02T11:00:00.000",
  "endsAt": "2022-12-02T11:10:00.000Z",
  "items": [
    {
      "id": "b844b2d641da",
      "institutionId": "TIBURON",
      "category": "authentication",
      "type": "userLoggedIn",
      "occurredAt": "2022-12-02T11:08:00.375Z",
      "correlationId": "0730fd7ac6bfe5a87b0a",
      "sessionId": "2ded0203a8a2b6e7befa",
      "agentId": "4f3ec1daab02eed9de64",
      "coreCustomerId": "12299292",
      "agentType": "customer",
      "host": "13.226.38.34",
      "primaryId": "b844b2d6d9ca818df3c8",
      "data": {
        "browser": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36",
        "operatingSystem": "macos",
        "platform": "web",
        "application": "apitureDigitalBanking",
        "score": 2500
      }
    },
    {
      "id": "0399abed30f38b8a365c",
      "institutionId": "TIBURON",
      "category": "transfers",
      "type": "singleTransferScheduled",
      "occurredAt": "2022-12-02T11:08:00.375Z",
      "correlationId": "2266452a0bfd8150cf64",
      "sessionId": "2ded0203a8a2b6e7befa",
      "agentId": "4f3ec1daab02eed9de64",
      "coreCustomerId": "12299292",
      "agentType": "customer",
      "host": "13.226.38.34",
      "primaryId": "a727ff2aedea60646819",
      "data": {
        "sourceAccount": {
          "id": "a212d3c119148960683d",
          "maskedNumber": "*3210",
          "routingNumber": "021000021"
        },
        "targetAccount": {
          "id": "0c8ad50ab6cf0eb48c25",
          "maskedNumber": "*3219",
          "routingNumber": "021000021"
        }
      }
    }
  ]
}

Event Messages (v0.9.2)

A list of events within a time frame.

Properties

NameDescription
Event Messages (v0.9.2) object
A list of events within a time frame.
Unevaluated Properties: false
version string(semver) (required)
The semantic version number of the event metadata structure.
format: semver
minLength: 5
maxLength: 12
enum values: 0.1.0, 0.2.0
startsAt timestamp(date-time)
The beginning date-time for the events in this page of event messages. This is an RFC 3339 UTC date-time string. This is omitted if the items array is empty.
format: date-time
minLength: 20
maxLength: 30
endsAt timestamp(date-time)
The ending date-time for the events in this page of event messages. This is an RFC 3339 UTC date-time string. This is omitted if the items array is empty.
format: date-time
minLength: 20
maxLength: 30
items array: [eventMessageItem] (required)
An array of event items.
maxItems: 10000
items: object
» Unevaluated Properties: false

eventProductReference

{
  "type": "cd",
  "code": "180D_CDA"
}

Product Reference (v1.0.0)

A reference to a banking product.

Properties

NameDescription
Product Reference (v1.0.0) object
A reference to a banking product.
type productType (required)
The type of account.
enum values: savings, checking, cd, ira, loan, creditCard
code string(text) (required)
The product's product code which uniquely identifies the product from other banking products. Codes are unique to the financial institution. For example, different products with the same type and the same coreType but different rates or other properties have different product codes, such as CD3M, DDA_HI_YLD, P3207.
format: text
minLength: 1
maxLength: 16

eventSingleTransferFailedReason

"nonSufficientFunds"

Event Single Transfer Failed Reason (v1.0.0)

Indicates why a single transfer failed.

eventSingleTransferFailedReason strings may have one of the following enumerated values:

ValueDescription
nonSufficientFundsNon Sufficient Funds:

Non Sufficient Funds (NSF) in the source account
sourceAccountClosedSource Account Closed:

The source (debit) account for the transfer is closed
targetAccountClosedTarget Account Closed:

The target (credit) account for the transfer is closed
otherOther:

Another unspecified reason

type: string


enum values: nonSufficientFunds, sourceAccountClosed, targetAccountClosed, other

eventType

{
  "type": "wireTransferScheduled",
  "category": "wireTransfers",
  "description": "Payload for event messages triggered when a customer has submitted and approved a wire transfer and it is queued for processing on its scheduled date.",
  "primaryIdDescription": "the wire transfer resource",
  "schemaId": "https://production.api.apiture.com/schemas/bankingEvents/wireTransferScheduled"
}

Event Type (v1.2.0)

An object that describes all events that have a given type.

Properties

NameDescription
Event Type (v1.2.0) object
An object that describes all events that have a given type.
type eventMessageType (required)
The type of this event. This is the key into the set of event types. This is a lowerCamelCase string.
minLength: 4
maxLength: 48
pattern: "^[a-z][a-zA-Z0-9]{3,47}$"
category eventMessageCategory (required)
An identifier for the category of the event. Multiple message types can belong to a category. This is a lowerCamelCase string.
minLength: 4
maxLength: 40
pattern: "^[a-z][a-zA-Z0-9]{3,39}$"
description string(text) (required)
A description of the event: what triggers the event and its event message data.
format: text
maxLength: 4000
primaryIdDescription string(text)
A short phrase which describes what the primaryId in an event message refers to.
format: text
minLength: 6
maxLength: 80
secondaryIdDescription string(text)
A short phrase which describes what the secondaryId in an event message refers to.
format: text
minLength: 6
maxLength: 80
schemaId string(uri) (required)
The $id of the JSON schema for event messages of this type. The named schema describes an event message's data object within the eventMessageItem object.

For example, for the event type singleTransferCreated, the schemaId is https://production.api.apiture.com/schemas/bankingEvents/singleTransferCreated. Event schemas are defined in the JSON schema document returned by getEventTypesJsonSchema.
format: uri
maxLength: 128

eventTypes

{
  "items": [
    {
      "type": "singleTransferCreated",
      "category": "transfers",
      "description": "Payload for event messages triggered when a user has created a single account-to-account transfer.",
      "primaryIdDescription": "the transfer resource",
      "schemaId": "https://production.api.apiture.com/schemas/bankingEvents/singleTransferCreated"
    },
    {
      "type": "singleTransferScheduled",
      "category": "transfers",
      "description": "Payload for event messages triggered when a customer has scheduled a single account-to-account transfer.",
      "primaryIdDescription": "the transfer resource",
      "schemaId": "https://production.api.apiture.com/schemas/bankingEvents/singleTransferScheduled"
    },
    {
      "type": "wireTransferScheduled",
      "category": "wireTransfers",
      "description": "Payload for event messages triggered when a customer has submitted and approved a wire transfer and it is queued for processing on its scheduled date.",
      "primaryIdDescription": "the wire transfer resource",
      "schemaId": "https://production.api.apiture.com/schemas/bankingEvents/wireTransferScheduled"
    }
  ],
  "eventsEnabled": true
}

Event Types (v2.1.0)

A list of event types which describe the data in the event history.

Properties

NameDescription
Event Types (v2.1.0) object
A list of event types which describe the data in the event history.
items array: [eventType] (required)
An array of event type objects, sorted by ascending category (primary sort key) and type (secondary sort key).
maxItems: 500
items: object
eventsEnabled boolean (required)
If true, the financial institution is currently capturing events; false if not. There may be historical events if the financial institution captured events in the past.

eventWireBeneficiary

{
  "name": "Fribble Inc.",
  "address": {
    "address1": "1805 Tiburon Dr.",
    "address2": "Building 14, Suite 1500",
    "locality": "Wilmington",
    "regionName": "NC",
    "countryCode": "US",
    "postalCode": "28412"
  }
}

Event Wire Beneficiary (v0.2.0)

The name and address of a wire transfer beneficiary.

Properties

NameDescription
Event Wire Beneficiary (v0.2.0) object
The name and address of a wire transfer beneficiary.
name string(text) (required)
The name of the wire transfer beneficiary.
format: text
maxLength: 35
address eventAddress
A postal address that can hold a US address or an international (non-US) postal addresses.

externalAccountActivatedEventSchema

{
  "account": {
    "id": "a5b383950c769e52a316",
    "maskedNumber": "*3210",
    "routingNumber": "021000021"
  },
  "institutionName": "Third Party Bank",
  "verificationMethod": "instant"
}

External Account Activated Event Schema (v0.1.1)

Payload for event messages triggered when a user has activated an external banking account after successful account verification, or the financial institution has activated the account on behalf of the customer. This schema defines the data object for event messages with category externalAccounts and event message type of externalAccountActivated. The primaryId in the event message is the external account resource. The secondaryId in the event message is the corresponding internal account application, if known.

Properties

NameDescription
External Account Activated Event Schema (v0.1.1) object
Payload for event messages triggered when a user has activated an external banking account after successful account verification, or the financial institution has activated the account on behalf of the customer. This schema defines the data object for event messages with category externalAccounts and event message type of externalAccountActivated. The primaryId in the event message is the external account resource. The secondaryId in the event message is the corresponding internal account application, if known.
Unevaluated Properties: false
account eventAccountReference (required)
The identifying properties of the external account.
Additional Properties: false
verificationMethod externalAccountVerificationMethod (required)

The method used to verify the customer has access to the external account.

externalAccountVerificationMethod strings may have one of the following enumerated values:

ValueDescription
instantInstant Account Verification:

Access to the external account is verified via integration with an account verification service provider.
microDepositsMicro-Deposits:

Access to the external account is verified via verifying a set of micro-deposits.
manualManual:

Access to the external account is verified manually by the financial institution.

enum values: instant, microDeposits, manual
institutionName string(text) (required)
The financial institution's name.
format: text
maxLength: 35

externalAccountEntitledEventSchema

{
  "maskedNumber": "*3210",
  "routingNumber": "123123123",
  "verificationMethod": "instant",
  "type": "savings"
}

External Account Entitled Event Schema (v0.1.0)

Payload for event messages triggered when the system has granted a customer entitlements to an external banking account. This schema defines the data object for event messages with category entitlements and event message type of externalAccountEntitled. The primaryId in the event message is the external banking account. The secondaryId in the event message is the corresponding internal account application, if known.

Properties

NameDescription
External Account Entitled Event Schema (v0.1.0) object
Payload for event messages triggered when the system has granted a customer entitlements to an external banking account. This schema defines the data object for event messages with category entitlements and event message type of externalAccountEntitled. The primaryId in the event message is the external banking account. The secondaryId in the event message is the corresponding internal account application, if known.
Unevaluated Properties: false
maskedNumber maskedAccountNumber (required)
A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber.
minLength: 2
maxLength: 5
pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$"
routingNumber accountRoutingNumber (required)
An account ABA routing and transit number.
minLength: 9
maxLength: 9
pattern: "^[0-9]{9}$"
verificationMethod externalAccountVerificationMethod (required)

The method used to verify the customer has access to the external account.

externalAccountVerificationMethod strings may have one of the following enumerated values:

ValueDescription
instantInstant Account Verification:

Access to the external account is verified via integration with an account verification service provider.
microDepositsMicro-Deposits:

Access to the external account is verified via verifying a set of micro-deposits.
manualManual:

Access to the external account is verified manually by the financial institution.

enum values: instant, microDeposits, manual
institutionName string(text)
The financial institution's name.
format: text
maxLength: 35
type productType (required)

The type (or category) of banking product.

productType strings may have one of the following enumerated values:

ValueDescription
savingsSavings:

Savings Account
checkingChecking:

Checking Account
cdCD:

Certificate of Deposit Account
iraIRA:

Individual Retirement Account
loanLoan:

Loan Account
creditCardCredit Card:

Credit Card Account

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

externalAccountRemovedEventSchema

{
  "maskedNumber": "*6789",
  "routingNumber": "123123123",
  "institutionName": "Third Party Bank"
}

External Account Removed Event Schema (v0.1.1)

Payload for event messages triggered when a customer has removed (unlinked) an external account. This schema defines the data object for event messages with category externalAccounts and event message type of externalAccountRemoved. The primaryId in the event message is the external account resource. The secondaryId in the event message is the corresponding internal account application, if known.

Properties

NameDescription
External Account Removed Event Schema (v0.1.1) object
Payload for event messages triggered when a customer has removed (unlinked) an external account. This schema defines the data object for event messages with category externalAccounts and event message type of externalAccountRemoved. The primaryId in the event message is the external account resource. The secondaryId in the event message is the corresponding internal account application, if known.
Unevaluated Properties: false
maskedNumber maskedAccountNumber (required)
A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber.
minLength: 2
maxLength: 5
pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$"
routingNumber accountRoutingNumber (required)
An account ABA routing and transit number.
minLength: 9
maxLength: 9
pattern: "^[0-9]{9}$"
institutionName string(text) (required)
The financial institution's name.
format: text
maxLength: 35

externalAccountRequestedEventSchema

{
  "maskedNumber": "*6789",
  "routingNumber": "123123123",
  "verificationMethod": "microDeposits"
}

External Account Requested Event Schema (v0.3.0)

Payload for event messages triggered when a banking customer has requested linking an external ACH banking account so that they may transfer funds between this financial institution and that external account. This schema defines the data object for event messages with category externalAccounts and event message type of externalAccountRequested. The primaryId in the event message is the external account resource. The secondaryId in the event message is the corresponding internal account application, if known.

Properties

NameDescription
External Account Requested Event Schema (v0.3.0) object
Payload for event messages triggered when a banking customer has requested linking an external ACH banking account so that they may transfer funds between this financial institution and that external account. This schema defines the data object for event messages with category externalAccounts and event message type of externalAccountRequested. The primaryId in the event message is the external account resource. The secondaryId in the event message is the corresponding internal account application, if known.
Unevaluated Properties: false
maskedNumber maskedAccountNumber (required)
A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber.
minLength: 2
maxLength: 5
pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$"
routingNumber accountRoutingNumber (required)
An account ABA routing and transit number.
minLength: 9
maxLength: 9
pattern: "^[0-9]{9}$"
verificationMethod externalAccountVerificationMethod (required)

The method used to verify the customer has access to the external account.

externalAccountVerificationMethod strings may have one of the following enumerated values:

ValueDescription
instantInstant Account Verification:

Access to the external account is verified via integration with an account verification service provider.
microDepositsMicro-Deposits:

Access to the external account is verified via verifying a set of micro-deposits.
manualManual:

Access to the external account is verified manually by the financial institution.

enum values: instant, microDeposits, manual
institutionName string(text)
The financial institution's name.
format: text
maxLength: 35

externalAccountVerificationBlockedEventSchema

{
  "maskedNumber": "*6789",
  "routingNumber": "123123123",
  "verificationMethod": "microDeposits"
}

External Account Verification Blocked Event Schema (v0.3.0)

Payload for event messages triggered when micro-deposit account verification is blocked. Micro-deposits are blocked when waiting for the micro-deposit transactions to be recorded against the external account and for the banking customer to enter the micro-deposit values to verify account ownership. This schema defines the data object for event messages with category externalAccounts and event message type of externalAccountVerificationBlocked. The primaryId in the event message is the external banking account, if known. The secondaryId in the event message is the corresponding internal account application, if known.

Properties

NameDescription
External Account Verification Blocked Event Schema (v0.3.0) object
Payload for event messages triggered when micro-deposit account verification is blocked. Micro-deposits are blocked when waiting for the micro-deposit transactions to be recorded against the external account and for the banking customer to enter the micro-deposit values to verify account ownership. This schema defines the data object for event messages with category externalAccounts and event message type of externalAccountVerificationBlocked. The primaryId in the event message is the external banking account, if known. The secondaryId in the event message is the corresponding internal account application, if known.
Unevaluated Properties: false
maskedNumber maskedAccountNumber (required)
A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber.
minLength: 2
maxLength: 5
pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$"
routingNumber accountRoutingNumber (required)
An account ABA routing and transit number.
minLength: 9
maxLength: 9
pattern: "^[0-9]{9}$"
verificationMethod externalAccountVerificationMethod (required)

The method used to verify the customer has access to the external account.

externalAccountVerificationMethod strings may have one of the following enumerated values:

ValueDescription
instantInstant Account Verification:

Access to the external account is verified via integration with an account verification service provider.
microDepositsMicro-Deposits:

Access to the external account is verified via verifying a set of micro-deposits.
manualManual:

Access to the external account is verified manually by the financial institution.

enum values: instant, microDeposits, manual
institutionName string(text)
The financial institution's name.
format: text
maxLength: 35

externalAccountVerificationFailedEventSchema

{
  "maskedNumber": "*6789",
  "routingNumber": "123123123",
  "verificationMethod": "microDeposits",
  "reason": "microDepositsAccountMismatched",
  "failureCount": 1
}

External Account Verification Failed Event Schema (v0.4.0)

Payload for event messages triggered when a user has failed to verify ownership of an external account while trying to add access to an external account. This schema defines the data object for event messages with category externalAccounts and event message type of externalAccountVerificationFailed. The primaryId in the event message is the external account resource. The secondaryId in the event message is the corresponding internal account application, if known.

Properties

NameDescription
External Account Verification Failed Event Schema (v0.4.0) object
Payload for event messages triggered when a user has failed to verify ownership of an external account while trying to add access to an external account. This schema defines the data object for event messages with category externalAccounts and event message type of externalAccountVerificationFailed. The primaryId in the event message is the external account resource. The secondaryId in the event message is the corresponding internal account application, if known.
Unevaluated Properties: false
maskedNumber maskedAccountNumber (required)
A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber.
minLength: 2
maxLength: 5
pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$"
routingNumber accountRoutingNumber (required)
An account ABA routing and transit number.
minLength: 9
maxLength: 9
pattern: "^[0-9]{9}$"
verificationMethod externalAccountVerificationMethod (required)

The method used to verify the customer has access to the external account.

externalAccountVerificationMethod strings may have one of the following enumerated values:

ValueDescription
instantInstant Account Verification:

Access to the external account is verified via integration with an account verification service provider.
microDepositsMicro-Deposits:

Access to the external account is verified via verifying a set of micro-deposits.
manualManual:

Access to the external account is verified manually by the financial institution.

enum values: instant, microDeposits, manual
institutionName string(text)
The financial institution's name.
format: text
maxLength: 35
reason externalAccountVerificationFailureEventReason (required)
Indicates why the verification failed.
enum values: microDepositsAccountMismatched, microDepositsAmountsMismatched, other, unknown
failureCount integer(int32)
The number of times a external account verification attempt failed. Omitted if unknown.
format: int32
minimum: 1
maximum: 20

externalAccountVerificationFailureEventReason

"microDepositsAccountMismatched"

External Account Verification Failure Event Reason (v1.0.0)

Indicates the reason that external account verification failed.

externalAccountVerificationFailureEventReason strings may have one of the following enumerated values:

ValueDescription
microDepositsAccountMismatchedMicro-Deposits Account Number Mismatched:

When verifying micro-deposits, the account number did not match the external account being verified
microDepositsAmountsMismatchedMicro-Deposits Amounts Mismatched:

When verifying micro-deposits, the amounts did not match the actual transactions
otherOther:

Account verification failed for some other reason
unknownUnknown:

Account verification failed for an unknown reason

type: string


enum values: microDepositsAccountMismatched, microDepositsAmountsMismatched, other, unknown

externalAccountVerificationMethod

"instant"

External Account Verification Method (v1.1.0)

The method used to verify the customer has access to the external account.

externalAccountVerificationMethod strings may have one of the following enumerated values:

ValueDescription
instantInstant Account Verification:

Access to the external account is verified via integration with an account verification service provider.
microDepositsMicro-Deposits:

Access to the external account is verified via verifying a set of micro-deposits.
manualManual:

Access to the external account is verified manually by the financial institution.

type: string


enum values: instant, microDeposits, manual

externalAccountVerificationRemovedEventSchema

{
  "maskedNumber": "*6789",
  "routingNumber": "123123123",
  "verificationMethod": "microDeposits"
}

External Account Verification Blocked Event Schema (v0.3.0)

Payload for event messages triggered when a customer removes a micro-deposit account verification. Micro-deposit verifications may be blocked waiting for the remote transactions to complete, and the user may cancel (remove) the verification. This schema defines the data object for event messages with category externalAccounts and event message type of externalAccountVerificationRemoved. The primaryId in the event message is the external banking account, if known. The secondaryId in the event message is the corresponding internal account application, if known.

Properties

NameDescription
External Account Verification Blocked Event Schema (v0.3.0) object
Payload for event messages triggered when a customer removes a micro-deposit account verification. Micro-deposit verifications may be blocked waiting for the remote transactions to complete, and the user may cancel (remove) the verification. This schema defines the data object for event messages with category externalAccounts and event message type of externalAccountVerificationRemoved. The primaryId in the event message is the external banking account, if known. The secondaryId in the event message is the corresponding internal account application, if known.
Unevaluated Properties: false
maskedNumber maskedAccountNumber (required)
A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber.
minLength: 2
maxLength: 5
pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$"
routingNumber accountRoutingNumber (required)
An account ABA routing and transit number.
minLength: 9
maxLength: 9
pattern: "^[0-9]{9}$"
verificationMethod externalAccountVerificationMethod (required)

The method used to verify the customer has access to the external account.

externalAccountVerificationMethod strings may have one of the following enumerated values:

ValueDescription
instantInstant Account Verification:

Access to the external account is verified via integration with an account verification service provider.
microDepositsMicro-Deposits:

Access to the external account is verified via verifying a set of micro-deposits.
manualManual:

Access to the external account is verified manually by the financial institution.

enum values: instant, microDeposits, manual
institutionName string(text)
The financial institution's name.
format: text
maxLength: 35

externalAccountVerifiedEventSchema

{
  "maskedNumber": "*6789",
  "routingNumber": "123123123",
  "verificationMethod": "microDeposits"
}

External Account Verified Event Schema (v0.2.0)

Payload for event messages triggered when a customer has successfully verified ownership of an external account. This schema defines the data object for event messages with category externalAccounts and event message type of externalAccountVerified. The primaryId in the event message is the external account resource. The secondaryId in the event message is the corresponding internal account application, if known.

Properties

NameDescription
External Account Verified Event Schema (v0.2.0) object
Payload for event messages triggered when a customer has successfully verified ownership of an external account. This schema defines the data object for event messages with category externalAccounts and event message type of externalAccountVerified. The primaryId in the event message is the external account resource. The secondaryId in the event message is the corresponding internal account application, if known.
Unevaluated Properties: false
maskedNumber maskedAccountNumber (required)
A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber.
minLength: 2
maxLength: 5
pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$"
routingNumber accountRoutingNumber (required)
An account ABA routing and transit number.
minLength: 9
maxLength: 9
pattern: "^[0-9]{9}$"
verificationMethod externalAccountVerificationMethod (required)

The method used to verify the customer has access to the external account.

externalAccountVerificationMethod strings may have one of the following enumerated values:

ValueDescription
instantInstant Account Verification:

Access to the external account is verified via integration with an account verification service provider.
microDepositsMicro-Deposits:

Access to the external account is verified via verifying a set of micro-deposits.
manualManual:

Access to the external account is verified manually by the financial institution.

enum values: instant, microDeposits, manual
institutionName string(text)
The financial institution's name.
format: text
maxLength: 35

fullAccountNumberAccessedEventSchema

{
  "maskedNumber": "*3210",
  "routingNumber": "021000021"
}

Full Account Number Accessed Events Schema (v0.1.1)

Payload for event messages triggered when a user has accessed a full unmasked account number for an internal account at the financial institution. This schema defines the data object for event messages with category accounts and event message type of fullAccountNumberAccessed. The primaryId in the event message is the account resource.

Properties

NameDescription
Full Account Number Accessed Events Schema (v0.1.1) object
Payload for event messages triggered when a user has accessed a full unmasked account number for an internal account at the financial institution. This schema defines the data object for event messages with category accounts and event message type of fullAccountNumberAccessed. The primaryId in the event message is the account resource.
Unevaluated Properties: false
maskedNumber maskedAccountNumber (required)
A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber.
minLength: 2
maxLength: 5
pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$"
routingNumber accountRoutingNumber (required)
The account's routing and transit number.
minLength: 9
maxLength: 9
pattern: "^[0-9]{9}$"

fullExternalAccountNumberAccessedEventSchema

{
  "maskedNumber": "*3210",
  "routingNumber": "021000021"
}

Full External Account Number Accessed Event Schema (v0.1.1)

Payload for event messages triggered when a user has accessed a full (unmasked) account number for an external account. This schema defines the data object for event messages with category externalAccounts and event message type of fullExternalAccountNumberAccessed. The primaryId in the event message is the external account resource.

Properties

NameDescription
Full External Account Number Accessed Event Schema (v0.1.1) object
Payload for event messages triggered when a user has accessed a full (unmasked) account number for an external account. This schema defines the data object for event messages with category externalAccounts and event message type of fullExternalAccountNumberAccessed. The primaryId in the event message is the external account resource.
maskedNumber maskedAccountNumber (required)
A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber.
minLength: 2
maxLength: 5
pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$"
routingNumber accountRoutingNumber (required)
The account's routing and transit number.
minLength: 9
maxLength: 9
pattern: "^[0-9]{9}$"

identityChallengeCreatedEventSchema

{
  "factors": [
    "sms",
    "email",
    "voice"
  ]
}

Identity Challenge Created Event Schema (v0.2.1)

Payload for event messages triggered when system creates a new identity challenge when it requires the user to complete an identity challenge. This schema defines the data object for event messages with category authentication and event message type of identityChallengeCreated. The primaryId in the event message is the identity challenge resource, if known. The secondaryId in the event message is the operationId of the challenge, if known.

Properties

NameDescription
Identity Challenge Created Event Schema (v0.2.1) object
Payload for event messages triggered when system creates a new identity challenge when it requires the user to complete an identity challenge. This schema defines the data object for event messages with category authentication and event message type of identityChallengeCreated. The primaryId in the event message is the identity challenge resource, if known. The secondaryId in the event message is the operationId of the challenge, if known.
Unevaluated Properties: false
factors array: [challengeFactorType]
A list of challenge factors offered to the customer.
minItems: 1
maxItems: 8
items: string
» enum values: sms, email, voice, securityQuestions, authenticatorToken

identityChallengeFailedEventSchema

{
  "factor": "sms",
  "channels": [
    "5555"
  ],
  "failureCount": 1
}

Identity Challenge Failed Event Schema (v0.2.1)

Payload for event messages triggered when a user has failed an identity challenge. This schema defines the data object for event messages with category authentication and event message type of identityChallengeFailed. The primaryId in the event message is the identity challenge resource, if known. The secondaryId in the event message is the operationId of the challenge, if known.

Properties

NameDescription
Identity Challenge Failed Event Schema (v0.2.1) object
Payload for event messages triggered when a user has failed an identity challenge. This schema defines the data object for event messages with category authentication and event message type of identityChallengeFailed. The primaryId in the event message is the identity challenge resource, if known. The secondaryId in the event message is the operationId of the challenge, if known.
Unevaluated Properties: false
factor eventAuthenticationChallengeFactor (required)
The factor or delivery method that the user selected to complete the identity challenge.
enum values: sms, email, voice, hardwareToken, softwareToken, authenticatorToken, securityQuestions, twoWaySms
channels array: [string]
An optional list of channels through which the identity challenge one-time passcode is delivered to the user according to the selected identity challenge factor. A user can select one or two email channels for the email factor. The voice, sms and twoWaySms factors allow only one channel. Omitted if the factor does not have identity challenge delivery channels.
minItems: 1
maxItems: 2
items: string(text)
» format: text
» maxLength: 72
failureCount integer(int32) (required)
The number of times the user submitted an invalid identity Challenge response, such as the wrong one-time passcode or incorrect security questions.
format: int32
minimum: 0
maximum: 20

identityChallengeInitiatedEventSchema

{
  "factor": "sms",
  "channels": [
    "5555"
  ]
}

Identity Challenge Initiated Event Schema (v0.1.1)

Payload for event messages triggered when a user has initiated an identity challenge for an operation that requires proof of identity. This schema defines the data object for event messages with category authentication and event message type of identityChallengeInitiated. The primaryId in the event message is the identity challenge resource, if known. The secondaryId in the event message is the operationId of the challenge, if known.

Properties

NameDescription
Identity Challenge Initiated Event Schema (v0.1.1) object
Payload for event messages triggered when a user has initiated an identity challenge for an operation that requires proof of identity. This schema defines the data object for event messages with category authentication and event message type of identityChallengeInitiated. The primaryId in the event message is the identity challenge resource, if known. The secondaryId in the event message is the operationId of the challenge, if known.
Unevaluated Properties: false
factor eventAuthenticationChallengeFactor (required)
The factor or delivery method that the user selected to complete the identity challenge.
enum values: sms, email, voice, hardwareToken, softwareToken, authenticatorToken, securityQuestions, twoWaySms
channels array: [string]
An optional list of channels through which the identity challenge one-time passcode is delivered to the user according to the selected identity challenge factor. A user can select one or two email channels for the email factor. The voice, sms and twoWaySms factors allow only one channel. Omitted if the factor does not have identity challenge delivery channels.
minItems: 1
maxItems: 2
items: string(text)
» format: text
» maxLength: 72

identityChallengeSucceededEventSchema

{
  "factor": "sms",
  "channels": [
    "5555"
  ],
  "failureCount": 1
}

Identity Challenge Succeeded Event Schema (v0.2.1)

Payload for event messages triggered when a user has successfully completed an identity challenge. This schema defines the data object for event messages with category authentication and event message type of identityChallengeSucceeded. The primaryId in the event message is the identity challenge resource, if known. The secondaryId in the event message is the operationId of the challenge, if known.

Properties

NameDescription
Identity Challenge Succeeded Event Schema (v0.2.1) object
Payload for event messages triggered when a user has successfully completed an identity challenge. This schema defines the data object for event messages with category authentication and event message type of identityChallengeSucceeded. The primaryId in the event message is the identity challenge resource, if known. The secondaryId in the event message is the operationId of the challenge, if known.
Unevaluated Properties: false
factor eventAuthenticationChallengeFactor (required)
The factor or delivery method that the user selected to complete the identity challenge.
enum values: sms, email, voice, hardwareToken, softwareToken, authenticatorToken, securityQuestions, twoWaySms
channels array: [string]
An optional list of channels through which the identity challenge one-time passcode is delivered to the user according to the selected identity challenge factor. A user can select one or two email channels for the email factor. The voice, sms and twoWaySms factors allow only one channel. Omitted if the factor does not have identity challenge delivery channels.
minItems: 1
maxItems: 2
items: string(text)
» format: text
» maxLength: 72
failureCount integer(int32) (required)
The number of times the user submitted an invalid identity Challenge response, such as the wrong one-time passcode or incorrect security questions.
format: int32
minimum: 0
maximum: 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}$"

institutionLocatorType

"abaRoutingNumber"

Institution Locator Type (v1.0.0)

Indicates the type of the institution locator.

institutionLocatorType strings may have one of the following enumerated values:

ValueDescription
abaRoutingNumberABA Routing Number:

The American Bankers Association routing number of a financial institution
swiftBicCodeswiftBicCode:

The SWIFT Business Identifier Code (BIC) code of a financial institution
ibanAccountNumberIBAN:

International Bank Account Number (IBAN)

type: string


enum values: abaRoutingNumber, swiftBicCode, ibanAccountNumber

jointOwnerApplicationApprovedEventSchema

{}

Joint Owner Application Approved Event Schema (v0.2.0)

Payload for event messages triggered when the system has approved a joint owner application for access to a banking account.
Warning: The schema jointOwnerApplicationApprovedEventSchema was deprecated on version v0.38.0 of the API. Use the accountApplicationApproved event with applicationType of jointOwner instead. jointOwnerApplicationApprovedEventSchema will be removed on version v0.42.0 of the API. This schema defines the data object for event messages with category accountApplications and event message type of jointOwnerApplicationApproved. The primaryId in the event message is the joint owner application. The secondaryId in the event message is the banking account.
deprecated

Properties

NameDescription
Joint Owner Application Approved Event Schema (v0.2.0) object
Payload for event messages triggered when the system has approved a joint owner application for access to a banking account.
Warning: The schema jointOwnerApplicationApprovedEventSchema was deprecated on version v0.38.0 of the API. Use the accountApplicationApproved event with applicationType of jointOwner instead. jointOwnerApplicationApprovedEventSchema will be removed on version v0.42.0 of the API. This schema defines the data object for event messages with category accountApplications and event message type of jointOwnerApplicationApproved. The primaryId in the event message is the joint owner application. The secondaryId in the event message is the banking account.
deprecated: true
Unevaluated Properties: false

maskedAccountNumber

"*1008"

Masked Account Number (v1.0.1)

A masked account number: an asterisk * followed by one to four characters of the fullAccountNumber.

type: string


minLength: 2
maxLength: 5
pattern: "^\*[- _a-zA-Z0-9.]{1,4}$"

mfaFailedEventSchema

{
  "factor": "sms",
  "channels": [
    "5555"
  ],
  "failureCount": 1
}

MFA Failed Event Schema (v0.2.1)

Payload for event messages triggered each time a user has failed a multi-factor authentication (MFA) challenge after logging in, such an entering an incorrect one-time passcode. This may be followed by a mfaSucceeded event upon a retry, or the user may reach their failure limit and then entire MFA flow fails. This schema defines the data object for event messages with category authentication and event message type of mfaFailed.

Properties

NameDescription
MFA Failed Event Schema (v0.2.1) object
Payload for event messages triggered each time a user has failed a multi-factor authentication (MFA) challenge after logging in, such an entering an incorrect one-time passcode. This may be followed by a mfaSucceeded event upon a retry, or the user may reach their failure limit and then entire MFA flow fails. This schema defines the data object for event messages with category authentication and event message type of mfaFailed.
Unevaluated Properties: false
factor eventAuthenticationChallengeFactor (required)
The factor or delivery method that the user selected to complete the MFA.
enum values: sms, email, voice, hardwareToken, softwareToken, authenticatorToken, securityQuestions, twoWaySms
channels array: [string]
An optional list of channels through which the MFA one-time passcode is delivered to the user according to the selected MFA factor. A user can select one or two email channels for the email factor. The voice, sms and twoWaySms factors allow only one channel. Omitted if the factor does not have MFA delivery channels.
minItems: 1
maxItems: 2
items: string(text)
» format: text
» maxLength: 72
failureCount integer(int32)
The number of times the user submitted an invalid MFA response, such as the wrong one-time passcode or incorrect security questions.
format: int32
minimum: 0
maximum: 20

mfaInitiatedEventSchema

{
  "factor": "sms",
  "channels": [
    "5555"
  ]
}

MFA Initiated Event Schema (v0.1.2)

Payload for event messages triggered when the system has initiated multi-factor authentication (MFA) after a user logs in. This schema defines the data object for event messages with category authentication and event message type of mfaInitiated.

Properties

NameDescription
MFA Initiated Event Schema (v0.1.2) object
Payload for event messages triggered when the system has initiated multi-factor authentication (MFA) after a user logs in. This schema defines the data object for event messages with category authentication and event message type of mfaInitiated.
Unevaluated Properties: false
factor eventAuthenticationChallengeFactor (required)
The factor or delivery method that the user selected to complete the MFA.
enum values: sms, email, voice, hardwareToken, softwareToken, authenticatorToken, securityQuestions, twoWaySms
channels array: [string]
An optional list of channels through which the MFA one-time passcode is delivered to the user according to the selected MFA factor. A user can select one or two email channels for the email factor. The voice, sms and twoWaySms factors allow only one channel. Omitted if the factor does not have MFA delivery channels.
minItems: 1
maxItems: 2
items: string(text)
» format: text
» maxLength: 72

mfaSucceededEventSchema

{
  "factor": "sms",
  "channels": [
    "5555"
  ],
  "failureCount": 1
}

MFA Succeeded Event Schema (v0.2.1)

Payload for event messages triggered when a user has successfully completed multi-factor authentication (MFA) after logging in. This may be preceded my one or more mfaFailed events if the user had intermediate failures, as indicated by the failureCount property. This schema defines the data object for event messages with category authentication and event message type of mfaSucceeded.

Properties

NameDescription
MFA Succeeded Event Schema (v0.2.1) object
Payload for event messages triggered when a user has successfully completed multi-factor authentication (MFA) after logging in. This may be preceded my one or more mfaFailed events if the user had intermediate failures, as indicated by the failureCount property. This schema defines the data object for event messages with category authentication and event message type of mfaSucceeded.
Unevaluated Properties: false
factor eventAuthenticationChallengeFactor (required)
The factor or delivery method that the user selected to complete the MFA.
enum values: sms, email, voice, hardwareToken, softwareToken, authenticatorToken, securityQuestions, twoWaySms
channels array: [string]
An optional list of channels through which the MFA one-time passcode is delivered to the user according to the selected MFA factor. A user can select one or two email channels for the email factor. The voice, sms and twoWaySms factors allow only one channel. Omitted if the factor does not have MFA delivery channels.
minItems: 1
maxItems: 2
items: string(text)
» format: text
» maxLength: 72
failureCount integer(int32)
The number of times the user submitted an invalid MFA response, such as the wrong one-time passcode or incorrect security questions.
format: int32
minimum: 0
maximum: 20

mobileDeviceRegistrationDeletedEventSchema

{
  "deviceId": "c6b79477550d0ebd16f7"
}

Mobile Device Registration Deleted Event Schema (v0.1.1)

Payload for event messages triggered when a user has deleted a device registration. This schema defines the data object for event messages with category profile and event message type of mobileDeviceRegistrationDeleted.

Properties

NameDescription
Mobile Device Registration Deleted Event Schema (v0.1.1) object
Payload for event messages triggered when a user has deleted a device registration. This schema defines the data object for event messages with category profile and event message type of mobileDeviceRegistrationDeleted.
Unevaluated Properties: false
deviceId string(text)
The unique ID of the device the user removed.
format: text
maxLength: 256

monetaryValue

"3456.78"

Monetary Value (v1.1.0)

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


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

nullableReadOnlyResourceId

"string"

Nullable Read-only Resource Identifier (v1.0.0)

The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is used in properties that reference a resource by ID rather than URL. This can be used in patch operations to detach a resource. Resource IDs are immutable.

type: string | null


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

nullableResourceId

"string"

Nullable Resource Identifier (v1.0.0)

The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is used in properties that reference a resource by ID rather than URL. This can be used in patch operations to detach a resource.

type: string | null


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

passwordUpdateFailedEventSchema

{
  "browser": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36",
  "operatingSystem": "macos",
  "platform": "web",
  "application": "apitureDigitalBanking",
  "deviceId": "9ba299c8aed474403707",
  "temporaryPassword": true
}

Password Update Failed Event Schema (v0.2.0)

Payload for event messages triggered when a user has failed to change a password. This schema defines the data object for event messages with category authentication and event message type of passwordUpdateFailed.

Properties

NameDescription
Password Update Failed Event Schema (v0.2.0) object
Payload for event messages triggered when a user has failed to change a password. This schema defines the data object for event messages with category authentication and event message type of passwordUpdateFailed.
Unevaluated Properties: false
browser string(text)
The browser or user agent associated with the client request, if known.
format: text
maxLength: 512
operatingSystem string(text)
The name of operating system of the device associated with the client request, if known.
format: text
maxLength: 32
platform string
The application platform of user's client application associated with the client request, if known.
enum values: web, mobile, voice, sms, other, unknown
application string(text)
The application into which the user logged in. The reserved names apitureDigitalBanking and apitureMobile represent Apiture's web and mobile applications. unknown if the application is not known.
format: text
maxLength: 32
deviceId string(text)
Text which identifies the client device the end user agent was using when their activity triggered the event. This property is omitted if the device ID is unknown.
format: text
maxLength: 64
temporaryPassword boolean
If true, the user failed to update a temporary password that was assigned for forgotten password flows or first-time login. If false or omitted, the failure applied to the user's normal password.

passwordUpdatedEventSchema

{
  "browser": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36",
  "operatingSystem": "macos",
  "platform": "web",
  "application": "apitureDigitalBanking",
  "deviceId": "9ba299c8aed474403707"
}

Password Updated Event Schema (v0.3.0)

Payload for event messages triggered when a user has changed their password. This schema defines the data object for event messages with category authentication and event message type of passwordUpdated.

Properties

NameDescription
Password Updated Event Schema (v0.3.0) object
Payload for event messages triggered when a user has changed their password. This schema defines the data object for event messages with category authentication and event message type of passwordUpdated.
Unevaluated Properties: false
browser string(text)
The browser or user agent associated with the client request, if known.
format: text
maxLength: 512
operatingSystem string(text)
The name of operating system of the device associated with the client request, if known.
format: text
maxLength: 32
platform string
The application platform of user's client application associated with the client request, if known.
enum values: web, mobile, voice, sms, other, unknown
application string(text)
The application into which the user logged in. The reserved names apitureDigitalBanking and apitureMobile represent Apiture's web and mobile applications. unknown if the application is not known.
format: text
maxLength: 32
deviceId string(text)
Text which identifies the client device the end user agent was using when their activity triggered the event. This property is omitted if the device ID is unknown.
format: text
maxLength: 64
temporaryPassword boolean
If true, the user replaced a temporary password that was assigned for forgotten password flows or first-time login. If false or omitted, the user changed their normal password.

paymentBatchAchSecCode

"arc"

ACH Payment (v1.0.1)

The Standard Entry Class (SEC) code that denotes the ACH payment authorization type.

type: string


enum values: arc, boc, ccd, cie, ctx, pop, ppd, rck, tel, web

paymentBatchDirection

"none"

Batch Payment Direction (v1.0.0)

Indicates the direction of money flow for a payment batch.

paymentBatchDirection strings may have one of the following enumerated values:

ValueDescription
noneNone:

No payment instructions to determine direction
creditcredit:

Payments are credit in the external accounts, debit to the settlement account
debitdebit:

Payments are debits in the external accounts, credit to the settlement account
bothboth:

Payment instructions include both debits and credits

type: string


enum values: none, credit, debit, both

paymentBatchSchedule

{
  "recurrenceType": "fixed",
  "scheduledOn": "2021-10-30",
  "frequency": "once",
  "endsOn": "2021-10-30",
  "effectiveOn": "2021-10-30"
}

Payment Batch Schedule (v1.3.2)

The scheduled date when the payment should be completed, the recurrence, if any, and other derived dates based on the scheduled date.

If the payment is a NACHA pass-through, the schedule is read-only and reflects the earliest scheduledOn and effectiveOn dates from the NACHA file with a recurrenceType of once.

Properties

NameDescription
Payment Batch Schedule (v1.3.2) object
The scheduled date when the payment should be completed, the recurrence, if any, and other derived dates based on the scheduled date.

If the payment is a NACHA pass-through, the schedule is read-only and reflects the earliest scheduledOn and effectiveOn dates from the NACHA file with a recurrenceType of once.

recurrenceType paymentRecurrenceType

Describes whether the payment instruction amounts in the batch vary or are fixed when the payment recurs. This is ignored if the payment frequency is once.

paymentRecurrenceType strings may have one of the following enumerated values:

ValueDescription
fixedFixed:

The payment amounts are the same each time a payment recurs
variableVariable:

The payment amounts vary and must be entered/verified each time a payment recurs
automaticallyRecurAutomatically Recur:

The payment batch will automatically recur after processing (but with no scheduled date)

enum values: fixed, variable, automaticallyRecur
scheduledOn date(date)
The payment's target completion date, in YYYY-MM-DD RFC 3339 date format. For recurring batches, this date get recalculated after each recurrence is processed.
format: date
minLength: 10
maxLength: 10
frequency paymentFrequency
For recurring payments and drafts, the interval at which the money movement recurs.
enum values: once, occasional, daily, weekly, biweekly, semimonthly, monthly, monthlyFirstDay, monthlyLastDay, bimonthly, quarterly, semiyearly, yearly
endsOn date(date)
The optional date when the recurring batch schedule ends, in YYYY-MM-DD RFC 3339 date format. Subsequent recurring payments may be scheduled up to and including this date, but not after. This property is omitted if frequency is once.
format: date
minLength: 10
maxLength: 10
effectiveOn date(date)
The target date when the batch payment or draft should be processed, in YYYY-MM-DD RFC 3339 date format. This is derived from the scheduledOn date. For recurring batches, this date get recalculated after each recurrence is processed.
format: date
minLength: 10
maxLength: 10

paymentBatchTrackingNumber

"15474162"

Payment Batch Tracking Number (v1.0.0)

A unique tracking number for this batch. Unlike the id, this numeric value is visible to the customer, and can be used to lookup a batch by this ID.

type: string


read-only
minLength: 6
maxLength: 9
pattern: "^[0-9]+$"

paymentFrequency

"once"

Payment Frequency (v1.1.1)

For recurring payments and drafts, the interval at which the money movement recurs.

type: string


enum values: once, occasional, daily, weekly, biweekly, semimonthly, monthly, monthlyFirstDay, monthlyLastDay, bimonthly, quarterly, semiyearly, yearly

paymentRecurrenceType

"fixed"

Payment Recurrence Type (v1.1.0)

Describes whether the payment instruction amounts in the batch vary or are fixed when the payment recurs. This is ignored if the payment frequency is once.

paymentRecurrenceType strings may have one of the following enumerated values:

ValueDescription
fixedFixed:

The payment amounts are the same each time a payment recurs
variableVariable:

The payment amounts vary and must be entered/verified each time a payment recurs
automaticallyRecurAutomatically Recur:

The payment batch will automatically recur after processing (but with no scheduled date)

type: string


enum values: fixed, variable, automaticallyRecur

phoneNumberType

"primary"

Phone Number Type (v1.0.0)

Describes the type of a banking customer's phone number.

phoneNumberType strings may have one of the following enumerated values:

ValueDescription
primaryPrimary:

The user's primary phone number
secondarySecondary:

The user's secondary phone number
mobileMobile:

The user's mobile phone number
faxfax:

The user's fax phone number
alternateAlternate:

The user's alternate phone number

type: string


enum values: primary, secondary, mobile, fax, alternate

phoneNumberUpdatedEventSchema

{
  "previousPhoneNumber": "910-555-1234",
  "newPhoneNumber": "910-555-5678",
  "type": "mobile"
}

Phone Number Updated Event Schema (v0.1.2)

Payload for event messages triggered when a user has updated a phone number associated with their profile. This schema defines the data object for event messages with category profile and event message type of phoneNumberUpdated.

Properties

NameDescription
Phone Number Updated Event Schema (v0.1.2) object
Payload for event messages triggered when a user has updated a phone number associated with their profile. This schema defines the data object for event messages with category profile and event message type of phoneNumberUpdated.
Unevaluated Properties: false
previousPhoneNumber string(text)
The previous phone number. If omitted, the user did not have a previous number of this type.
format: text
maxLength: 20
newPhoneNumber string(text)
The new phone number. If omitted, the user has removed the number of this type.
format: text
maxLength: 20
type phoneNumberType (required)

Describes the type of a banking customer's phone number.

phoneNumberType strings may have one of the following enumerated values:

ValueDescription
primaryPrimary:

The user's primary phone number
secondarySecondary:

The user's secondary phone number
mobileMobile:

The user's mobile phone number
faxfax:

The user's fax phone number
alternateAlternate:

The user's alternate phone number

enum values: primary, secondary, mobile, fax, alternate

primaryEmailUpdatedEventSchema

{
  "previousEmail": "fribble-fin@example.com",
  "newEmail": "fribble-cfo@example.com"
}

Primary Email Updated Event Schema (v0.2.2)

Payload for event messages triggered when a user has changed their primary email address. This schema defines the data object for event messages with category profile and event message type of primaryEmailUpdated.

Properties

NameDescription
Primary Email Updated Event Schema (v0.2.2) object
Payload for event messages triggered when a user has changed their primary email address. This schema defines the data object for event messages with category profile and event message type of primaryEmailUpdated.
Unevaluated Properties: false
previousEmail string(email)
The previous original value of the email address before the update.
format: email
maxLength: 120
newEmail string(email)
The new value of the email address after the update.
format: email
maxLength: 120

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

NameDescription
Problem Response (v0.4.1) object
API problem or error response, as per RFC 9457 application/problem+json.
type string(uri-reference)
A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
format: uri-reference
maxLength: 2048
title string(text)
A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type.
format: text
maxLength: 120
status integer(int32)
The HTTP status code for this occurrence of the problem.
format: int32
minimum: 100
maximum: 599
detail string(text)
A human-readable explanation specific to this occurrence of the problem.
format: text
maxLength: 256
instance string(uri-reference)
A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
format: uri-reference
maxLength: 2048
id readOnlyResourceId
The unique identifier for this problem. This is an immutable opaque string.
read-only
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
occurredAt readOnlyTimestamp(date-time)
The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC.
read-only
format: date-time
minLength: 20
maxLength: 30
problems array: [apiProblem]
Optional root-causes if there are multiple problems in the request or API call processing.
maxItems: 128
items: object
attributes object
Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

productType

"savings"

Product Type (v2.0.0)

The type (or category) of banking product.

productType strings may have one of the following enumerated values:

ValueDescription
savingsSavings:

Savings Account
checkingChecking:

Checking Account
cdCD:

Certificate of Deposit Account
iraIRA:

Individual Retirement Account
loanLoan:

Loan Account
creditCardCredit Card:

Credit Card Account

type: string


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

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

recentEventHistory

{
  "version": "0.2.0",
  "watermark": "VGhpcyBpcyBhIHNhbXBsZSBlbmNvZGVkL29wYXF1ZSBldmVudCBoaXN0b3J5IHdhdGVybWFyaw==",
  "limit": 1000,
  "hasMore": true,
  "startsAt": "2022-12-02T11:00:00.000",
  "endsAt": "2022-12-02T11:10:00.000Z",
  "items": [
    {
      "id": "b844b2d641da",
      "institutionId": "TIBURON",
      "category": "authentication",
      "type": "userLoggedIn",
      "occurredAt": "2022-12-02T11:08:00.375Z",
      "correlationId": "0730fd7ac6bfe5a87b0a",
      "sessionId": "2ded0203a8a2b6e7befa",
      "agentId": "4f3ec1daab02eed9de64",
      "coreCustomerId": "12299292",
      "agentType": "customer",
      "host": "13.226.38.34",
      "primaryId": "b844b2d6d9ca818df3c8",
      "data": {
        "browser": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36",
        "operatingSystem": "macos",
        "platform": "web",
        "application": "apitureDigitalBanking",
        "score": 2500
      }
    },
    {
      "id": "0399abed30f38b8a365c",
      "institutionId": "TIBURON",
      "category": "transfers",
      "type": "singleTransferScheduled",
      "occurredAt": "2022-12-02T11:08:00.375Z",
      "correlationId": "2266452a0bfd8150cf64",
      "sessionId": "2ded0203a8a2b6e7befa",
      "agentId": "4f3ec1daab02eed9de64",
      "coreCustomerId": "12299292",
      "agentType": "customer",
      "host": "13.226.38.34",
      "primaryId": "a727ff2aedea60646819",
      "data": {
        "sourceAccount": {
          "id": "a212d3c119148960683d",
          "maskedNumber": "*3210",
          "routingNumber": "021000021"
        },
        "targetAccount": {
          "id": "0c8ad50ab6cf0eb48c25",
          "maskedNumber": "*3219",
          "routingNumber": "021000021"
        }
      }
    }
  ]
}

Recent Event History (v1.6.3)

Representation of the recent event history resource.

Properties

NameDescription
Recent Event History (v1.6.3) object
Representation of the recent event history resource.
Unevaluated Properties: false
version string(semver)
The semantic version number of the event metadata structure.
format: semver
minLength: 5
maxLength: 12
enum values: 0.1.0, 0.2.0
startsAt timestamp(date-time)
The beginning date-time for the events in this page of event messages. This is an RFC 3339 UTC date-time string. This is omitted if the items array is empty.
format: date-time
minLength: 20
maxLength: 30
endsAt timestamp(date-time)
The ending date-time for the events in this page of event messages. This is an RFC 3339 UTC date-time string. This is omitted if the items array is empty.
format: date-time
minLength: 20
maxLength: 30
items array: [eventMessageItem]
An array of event items.
maxItems: 10000
items: object
» Unevaluated Properties: false
watermark string (required)
An opaque string which represents this response's watermark marker in the event history. The client should save this value and pass it as the watermark query parameter the next time it requests new events to fetch the next event history records above this watermark.
maxLength: 256
pattern: "^[-a-zA-Z0-9.,-~=_+:;@$]{1,256}$"
limit integer(int32)
The number of items requested for this page response. The length of the items array may be less that limit.
format: int32
minimum: 0
maximum: 10000
default: 1000
hasMore boolean (required)
true if there are unread events in the history above the watermark. This happens when there were more than limit recent items in the history.

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

singleTransferCanceledEventSchema

{
  "sourceAccount": {
    "id": "d8f6fabcc1085a2022ae",
    "maskedNumber": "*3210",
    "routingNumber": "021000021"
  },
  "targetAccount": {
    "id": "dc09216a9d32f1952259",
    "maskedNumber": "*3219",
    "routingNumber": "021000021"
  },
  "amount": "345.70"
}

Event Schema (v0.2.0)

Payload for event messages triggered when a customer or the system has canceled a transfer. This schema defines the data object for event messages with category transfers and event message type of singleTransferCanceled. The primaryId in the event message is the transfer resource.

Properties

NameDescription
Event Schema (v0.2.0) object
Payload for event messages triggered when a customer or the system has canceled a transfer. This schema defines the data object for event messages with category transfers and event message type of singleTransferCanceled. The primaryId in the event message is the transfer resource.
Unevaluated Properties: false
sourceAccount eventAccountReference (required)
The source account from which the funds are debited.
Additional Properties: false
targetAccount eventAccountReference (required)
The account where the funds are credited.
Additional Properties: false
amount monetaryValue
The amount of money to transfer between accounts.
maxLength: 16
pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"

singleTransferCreatedEventSchema

{
  "sourceAccount": {
    "id": "370c93621e94f0f088bc",
    "maskedNumber": "*3210",
    "routingNumber": "021000021"
  },
  "targetAccount": {
    "id": "8fdca899061880daf280",
    "maskedNumber": "*3219",
    "routingNumber": "021000021"
  },
  "amount": "345.70",
  "availableBalance": "2960.10"
}

Single Transfer Created Event Schema (v0.2.1)

Payload for event messages triggered when a user has created a single account-to-account transfer. This schema defines the data object for event messages with category transfers and event message type of singleTransferCreated. The primaryId in the event message is the transfer resource.

Properties

NameDescription
Single Transfer Created Event Schema (v0.2.1) object
Payload for event messages triggered when a user has created a single account-to-account transfer. This schema defines the data object for event messages with category transfers and event message type of singleTransferCreated. The primaryId in the event message is the transfer resource.
Unevaluated Properties: false
sourceAccount eventAccountReference (required)
The source account from which the funds are debited.
Additional Properties: false
targetAccount eventAccountReference (required)
The account where the funds are credited.
Additional Properties: false
amount monetaryValue
The amount of money to transfer between accounts.
maxLength: 16
pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"
availableBalance creditOrDebitValue
The available balance of the transfer's source account. This field is only available if the source account is internal (held at the financial institution) and if the balance is available from the banking core. This is the string representation of the exact decimal amount.
maxLength: 16
pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"

singleTransferEvent

{
  "sourceAccount": {
    "id": "3cfce6d07f4eb75185e9",
    "maskedNumber": "*3210",
    "routingNumber": "021000021"
  },
  "targetAccount": {
    "id": "777a2a2442ce020e63b1",
    "maskedNumber": "*3219",
    "routingNumber": "021000021"
  },
  "amount": "350.00",
  "frequency": "once"
}

Single Transfer Event (v1.1.0)

Describes the details of a single account-to-account transfer in an event payload.

Properties

NameDescription
Single Transfer Event (v1.1.0) object
Describes the details of a single account-to-account transfer in an event payload.
sourceAccount eventAccountReference
The source account from which the funds are debited.
Additional Properties: false
targetAccount eventAccountReference
The account where the funds are credited.
Additional Properties: false
amount monetaryValue
The amount of money to transfer between accounts.
maxLength: 16
pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"
frequency transferFrequency

For recurring transfers, the interval at which the money movement recurs.

transferFrequency strings may have one of the following enumerated values:

ValueDescription
onceOnce:

Transfer does not repeat
occasionalOccasional:

Transfer recurs but without a new scheduled date
dailyDaily:

Repeat daily on business days
weeklyWeekly:

Repeat weekly
biweeklybiweekly:

Repeat every two weeks (26 times a year)
semimonthlySemimonthly:

Repeat twice a month (24 times a year)
monthlyMonthly:

Repeat monthly
monthlyFirstDayMonthly First Day:

Repeat on the first business day of the month
monthlyLastDayMonthly Last Day:

Repeat on the last business day of the month
bimonthlyBimonthly:

Repeat every other month
quarterlyQuarterly:

Repeat quarterly (four times a year)
semiyearlySemiyearly:

Repeat every six months (twice a year)
yearlyYearly:

Repeat once every year

enum values: once, occasional, daily, weekly, biweekly, semimonthly, monthly, monthlyFirstDay, monthlyLastDay, bimonthly, quarterly, semiyearly, yearly

singleTransferFailedEventSchema

{
  "sourceAccount": {
    "id": "a212d3c119148960683d",
    "maskedNumber": "*3210",
    "routingNumber": "021000021"
  },
  "targetAccount": {
    "id": "0c8ad50ab6cf0eb48c25",
    "maskedNumber": "*3219",
    "routingNumber": "123123123"
  },
  "amount": "345.70",
  "reason": "nonSufficientFunds"
}

Single Transfer Failed Event Schema (v0.2.0)

Payload for event messages triggered when the system has failed to process a single account-to-account transfer. This schema defines the data object for event messages with category transfers and event message type of singleTransferFailed. The primaryId in the event message is the transfer resource.

Properties

NameDescription
Single Transfer Failed Event Schema (v0.2.0) object
Payload for event messages triggered when the system has failed to process a single account-to-account transfer. This schema defines the data object for event messages with category transfers and event message type of singleTransferFailed. The primaryId in the event message is the transfer resource.
Unevaluated Properties: false
sourceAccount eventAccountReference (required)
The source account from which the funds are debited.
Additional Properties: false
targetAccount eventAccountReference (required)
The account where the funds are credited.
Additional Properties: false
amount monetaryValue
The amount of money to transfer between accounts.
maxLength: 16
pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"
reason eventSingleTransferFailedReason (required)

Indicates why a single transfer failed.

eventSingleTransferFailedReason strings may have one of the following enumerated values:

ValueDescription
nonSufficientFundsNon Sufficient Funds:

Non Sufficient Funds (NSF) in the source account
sourceAccountClosedSource Account Closed:

The source (debit) account for the transfer is closed
targetAccountClosedTarget Account Closed:

The target (credit) account for the transfer is closed
otherOther:

Another unspecified reason

enum values: nonSufficientFunds, sourceAccountClosed, targetAccountClosed, other

singleTransferInitiatedEventSchema

{
  "sourceAccount": {
    "id": "b4f9dc1f07af757b0696",
    "maskedNumber": "*3210",
    "routingNumber": "021000021"
  },
  "targetAccount": {
    "id": "73bec47bcabaee4fca6c",
    "maskedNumber": "*3219",
    "routingNumber": "123123123"
  },
  "amount": "345.70",
  "availableBalance": "2960.10"
}

Message Schema (v0.2.1)

Payload for event messages triggered when the system has started processing a single scheduled account-to-account transfer. This schema defines the data object for event messages with category transfers and event message type of singleTransferInitiated. The primaryId in the event message is the transfer resource.

Properties

NameDescription
Message Schema (v0.2.1) object
Payload for event messages triggered when the system has started processing a single scheduled account-to-account transfer. This schema defines the data object for event messages with category transfers and event message type of singleTransferInitiated. The primaryId in the event message is the transfer resource.
Unevaluated Properties: false
sourceAccount eventAccountReference (required)
The source account from which the funds are debited.
Additional Properties: false
targetAccount eventAccountReference (required)
The account where the funds are credited.
Additional Properties: false
amount monetaryValue
The amount of money to transfer between accounts.
maxLength: 16
pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"
availableBalance creditOrDebitValue
The available balance of the transfer's source account. This field is only available if the source account is internal (held at the financial institution) and if the balance is available from the banking core. This is the string representation of the exact decimal amount.
maxLength: 16
pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"

singleTransferProcessedEventSchema

{
  "sourceAccount": {
    "id": "370c93621e94f0f088bc",
    "maskedNumber": "*3210",
    "routingNumber": "021000021"
  },
  "targetAccount": {
    "id": "8fdca899061880daf280",
    "maskedNumber": "*3219",
    "routingNumber": "021000021"
  },
  "amount": "345.70",
  "availableBalance": "2960.10"
}

Single Transfer Processed Event Schema (v0.2.1)

Payload for event messages triggered when a single account-to-account transfer has completed processing. This schema defines the data object for event messages with category transfers and event message type of singleTransferProcessed. The primaryId in the event message is the transfer resource.

Properties

NameDescription
Single Transfer Processed Event Schema (v0.2.1) object
Payload for event messages triggered when a single account-to-account transfer has completed processing. This schema defines the data object for event messages with category transfers and event message type of singleTransferProcessed. The primaryId in the event message is the transfer resource.
Unevaluated Properties: false
sourceAccount eventAccountReference (required)
The source account from which the funds are debited.
Additional Properties: false
targetAccount eventAccountReference (required)
The account where the funds are credited.
Additional Properties: false
amount monetaryValue
The amount of money to transfer between accounts.
maxLength: 16
pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"
availableBalance creditOrDebitValue
The available balance of the transfer's source account. This field is only available if the source account is internal (held at the financial institution) and if the balance is available from the banking core. This is the string representation of the exact decimal amount.
maxLength: 16
pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"

singleTransferScheduledEventSchema

{
  "sourceAccount": {
    "id": "a212d3c119148960683d",
    "maskedNumber": "*3210",
    "routingNumber": "021000021"
  },
  "targetAccount": {
    "id": "0c8ad50ab6cf0eb48c25",
    "maskedNumber": "*3219",
    "routingNumber": "021000021"
  },
  "amount": "345.70",
  "availableBalance": "2960.10"
}

Single Transfer Scheduled Event Schema (v0.2.1)

Payload for event messages triggered when a customer has scheduled a single account-to-account transfer. This schema defines the data object for event messages with category transfers and event message type of singleTransferScheduled. The primaryId in the event message is the transfer resource.

Properties

NameDescription
Single Transfer Scheduled Event Schema (v0.2.1) object
Payload for event messages triggered when a customer has scheduled a single account-to-account transfer. This schema defines the data object for event messages with category transfers and event message type of singleTransferScheduled. The primaryId in the event message is the transfer resource.
Unevaluated Properties: false
sourceAccount eventAccountReference (required)
The source account from which the funds are debited.
Additional Properties: false
targetAccount eventAccountReference (required)
The account where the funds are credited.
Additional Properties: false
amount monetaryValue
The amount of money to transfer between accounts.
maxLength: 16
pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"
availableBalance creditOrDebitValue
The available balance of the transfer's source account. This field is only available if the source account is internal (held at the financial institution) and if the balance is available from the banking core. This is the string representation of the exact decimal amount.
maxLength: 16
pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"

singleTransferUpdatedEventSchema

{
  "previousTransfer": {
    "sourceAccount": {
      "id": "a212d3c119148960683d",
      "maskedNumber": "*3210",
      "routingNumber": "021000021"
    },
    "targetAccount": {
      "id": "0c8ad50ab6cf0eb48c25",
      "maskedNumber": "*3219",
      "routingNumber": "021000021"
    },
    "amount": "350.00",
    "frequency": "once"
  },
  "newTransfer": {
    "sourceAccount": {
      "id": "a212d3c119148960683d",
      "maskedNumber": "*3210",
      "routingNumber": "021000021"
    },
    "targetAccount": {
      "id": "f901940ca3df8a40a238",
      "maskedNumber": "*8239",
      "routingNumber": "021000021"
    },
    "amount": "450.00",
    "frequency": "weekly"
  },
  "availableBalance": "4290.20"
}

Single Transfer Updated Event Schema (v0.3.0)

Payload for event messages triggered when a customer has scheduled a single account-to-account transfer. The transfer resource ID is captured in the event's primaryId. This schema defines the data object for event messages with category transfers and event message type of singleTransferUpdated. The primaryId in the event message is the transfer resource.

Properties

NameDescription
Single Transfer Updated Event Schema (v0.3.0) object
Payload for event messages triggered when a customer has scheduled a single account-to-account transfer. The transfer resource ID is captured in the event's primaryId. This schema defines the data object for event messages with category transfers and event message type of singleTransferUpdated. The primaryId in the event message is the transfer resource.
Unevaluated Properties: false
availableBalance creditOrDebitValue
The available balance of the transfer's source account. This field is only available if the source account is internal (held at the financial institution) and if the balance is available from the banking core. This is the string representation of the exact decimal amount.
maxLength: 16
pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
previousTransfer singleTransferEvent (required)
Describes the details of a single account-to-account transfer in an event payload.
newTransfer singleTransferEvent (required)
Describes the details of a single account-to-account transfer in an event payload.

smsConsentUpdatedEventSchema

{
  "consented": true
}

SMS Consent Updated Event Schema (v0.1.1)

Payload for event messages triggered when a user has changed their SMS notification consent. (i.e. when a user opts-in for or opt-out of SMS notifications.) This is also triggered if the user changes their mobile number. This schema defines the data object for event messages with category profile and event message type of smsConsentUpdated.

Properties

NameDescription
SMS Consent Updated Event Schema (v0.1.1) object
Payload for event messages triggered when a user has changed their SMS notification consent. (i.e. when a user opts-in for or opt-out of SMS notifications.) This is also triggered if the user changes their mobile number. This schema defines the data object for event messages with category profile and event message type of smsConsentUpdated.
Unevaluated Properties: false
consented boolean (required)
Indicates if the user has just consented to (true) removed consent (false) for SMS notifications.

timestamp

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

Timestamp (v1.0.0)

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

type: string(date-time)


format: date-time
minLength: 20
maxLength: 30

trackingId

"string"
  • (v1.1.0)*

A unique tracking ID string.

type: string(text)


format: text
minLength: 1
maxLength: 256
pattern: "^[-a-zA-Z0-9.,-~=_+:;@$]{1,256}$"

transferFrequency

"once"

Transfer Frequency (v1.0.0)

For recurring transfers, the interval at which the money movement recurs.

transferFrequency strings may have one of the following enumerated values:

ValueDescription
onceOnce:

Transfer does not repeat
occasionalOccasional:

Transfer recurs but without a new scheduled date
dailyDaily:

Repeat daily on business days
weeklyWeekly:

Repeat weekly
biweeklybiweekly:

Repeat every two weeks (26 times a year)
semimonthlySemimonthly:

Repeat twice a month (24 times a year)
monthlyMonthly:

Repeat monthly
monthlyFirstDayMonthly First Day:

Repeat on the first business day of the month
monthlyLastDayMonthly Last Day:

Repeat on the last business day of the month
bimonthlyBimonthly:

Repeat every other month
quarterlyQuarterly:

Repeat quarterly (four times a year)
semiyearlySemiyearly:

Repeat every six months (twice a year)
yearlyYearly:

Repeat once every year

type: string


enum values: once, occasional, daily, weekly, biweekly, semimonthly, monthly, monthlyFirstDay, monthlyLastDay, bimonthly, quarterly, semiyearly, yearly

userLoggedInEventSchema

{
  "browser": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36",
  "operatingSystem": "macos",
  "platform": "web",
  "application": "apitureDigitalBanking",
  "deviceId": "9ba299c8aed474403707",
  "userType": "retail",
  "score": 2500
}

User Logged In Event Schema (v0.3.0)

Payload for event messages triggered when a user has logged in. The authenticated user's resource ID is captured in the event's agentId. This schema defines the data object for event messages with category authentication and event message type of userLoggedIn.

Properties

NameDescription
User Logged In Event Schema (v0.3.0) object
Payload for event messages triggered when a user has logged in. The authenticated user's resource ID is captured in the event's agentId. This schema defines the data object for event messages with category authentication and event message type of userLoggedIn.
Unevaluated Properties: false
browser string(text)
The browser or user agent associated with the client request, if known.
format: text
maxLength: 512
operatingSystem string(text)
The name of operating system of the device associated with the client request, if known.
format: text
maxLength: 32
platform string
The application platform of user's client application associated with the client request, if known.
enum values: web, mobile, voice, sms, other, unknown
application string(text) (required)
The application into which the user logged in. The reserved names apitureDigitalBanking and apitureMobile represent Apiture's web and mobile applications. unknown if the application is not known.
format: text
maxLength: 32
deviceId string(text)
Text which identifies the client device the end user agent was using when their activity triggered the event. This property is omitted if the device ID is unknown.
format: text
maxLength: 64
userType userType
Indicates the type of digital banking customer/member. Omitted if not a digital banking customer.
enum values: commercial, retail
score number
A score that indicates the risk level of the user.
minimum: 0
maximum: 10000

userLoginFailedEventSchema

{
  "browser": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36",
  "operatingSystem": "macos",
  "platform": "web",
  "application": "apitureDigitalBanking",
  "deviceId": "9ba299c8aed474403707",
  "reason": "disabled",
  "userType": "retail"
}

User Login Failed Event Schema (v0.3.0)

Payload for event messages triggered when a user has failed a login attempt. This schema defines the data object for event messages with category authentication and event message type of userLoginFailed.

Properties

NameDescription
User Login Failed Event Schema (v0.3.0) object
Payload for event messages triggered when a user has failed a login attempt. This schema defines the data object for event messages with category authentication and event message type of userLoginFailed.
Unevaluated Properties: false
browser string(text)
The browser or user agent associated with the client request, if known.
format: text
maxLength: 512
operatingSystem string(text)
The name of operating system of the device associated with the client request, if known.
format: text
maxLength: 32
platform string
The application platform of user's client application associated with the client request, if known.
enum values: web, mobile, voice, sms, other, unknown
application string(text)
The application into which the user logged in. The reserved names apitureDigitalBanking and apitureMobile represent Apiture's web and mobile applications. unknown if the application is not known.
format: text
maxLength: 32
deviceId string(text)
Text which identifies the client device the end user agent was using when their activity triggered the event. This property is omitted if the device ID is unknown.
format: text
maxLength: 64
reason string(text) (required)
Indicates why the user was unable to login. Some possible values are

  • disabled
  • invalidCredentials
  • ipRestriction
  • other
  • unknown

Other values are possible.
format: text
maxLength: 80

userType userType
Indicates the type of digital banking customer/member. Omitted if not a digital banking customer.
enum values: commercial, retail

userType

"commercial"

User Type (v1.0.0)

Indicates the type of digital banking customer/member.

type: string


enum values: commercial, retail

usernameUpdatedEventSchema

{
  "browser": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36",
  "operatingSystem": "macos",
  "platform": "web",
  "application": "apitureDigitalBanking",
  "deviceId": "9ba299c8aed474403707"
}

Username Updated Event Schema (v0.3.0)

Payload for event messages triggered when a user has updated their username (access ID). This schema defines the data object for event messages with category authentication and event message type of usernameUpdated.

Properties

NameDescription
Username Updated Event Schema (v0.3.0) object
Payload for event messages triggered when a user has updated their username (access ID). This schema defines the data object for event messages with category authentication and event message type of usernameUpdated.
Unevaluated Properties: false
browser string(text)
The browser or user agent associated with the client request, if known.
format: text
maxLength: 512
operatingSystem string(text)
The name of operating system of the device associated with the client request, if known.
format: text
maxLength: 32
platform string
The application platform of user's client application associated with the client request, if known.
enum values: web, mobile, voice, sms, other, unknown
application string(text)
The application into which the user logged in. The reserved names apitureDigitalBanking and apitureMobile represent Apiture's web and mobile applications. unknown if the application is not known.
format: text
maxLength: 32
deviceId string(text)
Text which identifies the client device the end user agent was using when their activity triggered the event. This property is omitted if the device ID is unknown.
format: text
maxLength: 64

wireTransferApprovedEventSchema

{
  "approvalCount": 1,
  "remainingApprovalsCount": 1,
  "factor": "email"
}

Wire Transfer Approved Event Schema (v0.2.1)

Payload for event messages triggered when a banking user has approved a wire transfer. The wire transfer requires additional transfers if remainingApprovalsCount is greater than 0. If remainingApprovalsCount is 0, the system will schedule the wire to process on its scheduled date. This schema defines the data object for event messages with category wireTransfers and event message type of wireTransferApproved. The primaryId in the event message is the wire transfer resource.

Properties

NameDescription
Wire Transfer Approved Event Schema (v0.2.1) object
Payload for event messages triggered when a banking user has approved a wire transfer. The wire transfer requires additional transfers if remainingApprovalsCount is greater than 0. If remainingApprovalsCount is 0, the system will schedule the wire to process on its scheduled date. This schema defines the data object for event messages with category wireTransfers and event message type of wireTransferApproved. The primaryId in the event message is the wire transfer resource.
Unevaluated Properties: false
approvalCount integer(int32) (required)
The number of approvals already given for the wire transfer, including the approval corresponding to this event.
format: int32
minimum: 0
maximum: 3
remainingApprovalsCount integer(int32) (required)
The number of the remaining approvals that are required before the wire payment can be scheduled and processed.
format: int32
minimum: 0
maximum: 3
factor eventAuthenticationChallengeFactor
The authentication challenge factor the agent used to verify their identity when approving a wire transfer, if known.
enum values: sms, email, voice, hardwareToken, softwareToken, authenticatorToken, securityQuestions, twoWaySms

wireTransferBeneficiaryUpdatedEventSchema

{
  "previousBeneficiary": {
    "name": "Fribble Inc.",
    "address": {
      "address1": "1805 Tiburon Dr.",
      "address2": "Building 14, Suite 1500",
      "locality": "Wilmington",
      "regionName": "NC",
      "countryCode": "US",
      "postalCode": "28412"
    }
  },
  "newBeneficiary": {
    "name": "Fribble LLC",
    "address": {
      "address1": "1810 Tiburon Dr.",
      "address2": "Building 6, Suite 100",
      "locality": "Vancouver",
      "regionName": "British Columbia",
      "countryCode": "CA",
      "postalCode": "V5K 0A1"
    }
  }
}

Wire Transfer Beneficiary Updated Event Schema (v0.3.0)

Payload for event messages triggered when a user has changed a wire transfer beneficiary. This schema defines the data object for event messages with category wireTransfers and event message type of wireTransferBeneficiaryUpdated. The primaryId in the event message is the wire transfer resource.

Properties

NameDescription
Wire Transfer Beneficiary Updated Event Schema (v0.3.0) object
Payload for event messages triggered when a user has changed a wire transfer beneficiary. This schema defines the data object for event messages with category wireTransfers and event message type of wireTransferBeneficiaryUpdated. The primaryId in the event message is the wire transfer resource.
Unevaluated Properties: false
previousBeneficiary eventWireBeneficiary (required)
The name and address of a wire transfer beneficiary.
newBeneficiary eventWireBeneficiary (required)
The name and address of a wire transfer beneficiary.

wireTransferCreatedEventSchema

{
  "scope": "domestic",
  "sourceAccount": {
    "id": "c2f333cc-9cef-4bfc-af8e-fca63cd50b1b",
    "maskedNumber": "*6789",
    "routingNumber": "123123123"
  },
  "targetAccount": {
    "maskedNumber": "*8911",
    "locatorType": "abaRoutingNumber",
    "locator": "321321321"
  },
  "amount": "345.70",
  "availableBalance": "2960.10"
}

Wire Transfer Created Event Schema (v0.2.1)

Payload for event messages triggered when a user has created a wire transfer. This schema defines the data object for event messages with category wireTransfers and event message type of wireTransferCreated. The primaryId in the event message is the wire transfer resource.

Properties

NameDescription
Wire Transfer Created Event Schema (v0.2.1) object
Payload for event messages triggered when a user has created a wire transfer. This schema defines the data object for event messages with category wireTransfers and event message type of wireTransferCreated. The primaryId in the event message is the wire transfer resource.
Unevaluated Properties: false
sourceAccount eventAccountReference (required)
A reference to a banking account.
Additional Properties: false
targetAccount wireTransferEventTargetAccount (required)
Identifies a target account for a domestic or international wire transfer.
scope wireTransferPaymentScope (required)

Indicates if the wire transfer is a domestic wire or an international wire.

wireTransferPaymentScope strings may have one of the following enumerated values:

ValueDescription
domesticDomestic:

A wire transfer in which both the sender and beneficiary (recipient) financial institutions are in the US.
internationalInternational:

A wire transfer in which the beneficiary (recipient) financial institution is not in the US.

enum values: domestic, international
amount monetaryValue
The amount of money to wire from the source account to the target account.
maxLength: 16
pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"
availableBalance creditOrDebitValue
The available balance of the source account, if known. This is the string representation of the exact decimal amount. This value may be omitted if the system is unable to obtain it.
maxLength: 16
pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"

wireTransferEventTargetAccount

{
  "maskedNumber": "*6789",
  "locatorType": "abaRoutingNumber",
  "locator": "123123123"
}

Wire Transfer Target Account (v0.1.0)

Identifies a target account for a domestic or international wire transfer.

Properties

NameDescription
Wire Transfer Target Account (v0.1.0) object
Identifies a target account for a domestic or international wire transfer.
maskedNumber maskedAccountNumber (required)
The masked account number for the beneficiary. For domestic wire transfers, this is the US Bank Account number. For international wire transfers, this is the International Bank Account Number (IBAN). A masked account number consists of * followed by one to four characters of the full account number.
minLength: 2
maxLength: 5
pattern: "^\\*[- _a-zA-Z0-9.]{1,4}$"
locator string(text) (required)
The American Bankers Association routing number, SWIFT Business Identifier Code (BIC) code, or IBAN account number of the institution. The form of this institution locator string is set with the locatorType property.
format: text
maxLength: 36
locatorType institutionLocatorType (required)
Indicates the type of this institution's locator.
enum values: abaRoutingNumber, swiftBicCode, ibanAccountNumber

wireTransferInitiatedEventSchema

{
  "scope": "domestic",
  "sourceAccount": {
    "id": "65d2467fe82b5858e9fb",
    "maskedNumber": "*6789",
    "routingNumber": "123123123"
  },
  "targetAccount": {
    "maskedNumber": "*8911",
    "locatorType": "abaRoutingNumber",
    "locator": "321321321"
  },
  "amount": "345.70",
  "availableBalance": "2960.10"
}

Wire Transfer Initiated Event Schema (v0.2.1)

Payload for event messages triggered when the financial institution has initiate (started processing) a wire transfer with the FED wire network. This schema defines the data object for event messages with category wireTransfers and event message type of wireTransferInitiated. The primaryId in the event message is the wire transfer resource.

Properties

NameDescription
Wire Transfer Initiated Event Schema (v0.2.1) object
Payload for event messages triggered when the financial institution has initiate (started processing) a wire transfer with the FED wire network. This schema defines the data object for event messages with category wireTransfers and event message type of wireTransferInitiated. The primaryId in the event message is the wire transfer resource.
Unevaluated Properties: false
sourceAccount eventAccountReference (required)
A reference to a banking account.
Additional Properties: false
targetAccount wireTransferEventTargetAccount (required)
Identifies a target account for a domestic or international wire transfer.
scope wireTransferPaymentScope (required)

Indicates if the wire transfer is a domestic wire or an international wire.

wireTransferPaymentScope strings may have one of the following enumerated values:

ValueDescription
domesticDomestic:

A wire transfer in which both the sender and beneficiary (recipient) financial institutions are in the US.
internationalInternational:

A wire transfer in which the beneficiary (recipient) financial institution is not in the US.

enum values: domestic, international
amount monetaryValue
The amount of money to wire from the source account to the target account.
maxLength: 16
pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"
availableBalance creditOrDebitValue
The available balance of the source account, if known. This is the string representation of the exact decimal amount. This value may be omitted if the system is unable to obtain it.
maxLength: 16
pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"

wireTransferPaymentScope

"domestic"

Wire Transfer Payment Scope (v1.0.0)

Indicates if the wire transfer is a domestic wire or an international wire.

wireTransferPaymentScope strings may have one of the following enumerated values:

ValueDescription
domesticDomestic:

A wire transfer in which both the sender and beneficiary (recipient) financial institutions are in the US.
internationalInternational:

A wire transfer in which the beneficiary (recipient) financial institution is not in the US.

type: string


enum values: domestic, international

wireTransferScheduledEventSchema

{
  "scope": "domestic",
  "sourceAccount": {
    "id": "c2f333cc-9cef-4bfc-af8e-fca63cd50b1b",
    "maskedNumber": "*6789",
    "routingNumber": "123123123"
  },
  "targetAccount": {
    "maskedNumber": "*8911",
    "locatorType": "abaRoutingNumber",
    "locator": "321321321"
  },
  "amount": "345.70",
  "availableBalance": "2960.10"
}

Wire Transfer Scheduled Event Schema (v0.2.1)

Payload for event messages triggered when a customer has submitted and approved a wire transfer and it is queued for processing on its scheduled date. This schema defines the data object for event messages with category wireTransfers and event message type of wireTransferScheduled. The primaryId in the event message is the wire transfer resource.

Properties

NameDescription
Wire Transfer Scheduled Event Schema (v0.2.1) object
Payload for event messages triggered when a customer has submitted and approved a wire transfer and it is queued for processing on its scheduled date. This schema defines the data object for event messages with category wireTransfers and event message type of wireTransferScheduled. The primaryId in the event message is the wire transfer resource.
Unevaluated Properties: false
sourceAccount eventAccountReference (required)
A reference to a banking account.
Additional Properties: false
targetAccount wireTransferEventTargetAccount (required)
Identifies a target account for a domestic or international wire transfer.
scope wireTransferPaymentScope (required)

Indicates if the wire transfer is a domestic wire or an international wire.

wireTransferPaymentScope strings may have one of the following enumerated values:

ValueDescription
domesticDomestic:

A wire transfer in which both the sender and beneficiary (recipient) financial institutions are in the US.
internationalInternational:

A wire transfer in which the beneficiary (recipient) financial institution is not in the US.

enum values: domestic, international
amount monetaryValue
The amount of money to wire from the source account to the target account.
maxLength: 16
pattern: "^(0|[1-9][0-9]*)\\.[0-9][0-9]$"
availableBalance creditOrDebitValue
The available balance of the source account, if known. This is the string representation of the exact decimal amount. This value may be omitted if the system is unable to obtain it.
maxLength: 16
pattern: "^(-|\\+)?(0|[1-9][0-9]*)\\.[0-9][0-9]$"
Generated by @apiture/api-doc 3.2.1 on Wed Apr 10 2024 15:36:14 GMT+0000 (Coordinated Universal Time).
Shell HTTP Node.JS JavaScript Ruby Python Java Go