Events v0.19.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
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
entitlements	entitlementUpdated	entitlementUpdatedEventSchema
externalAccounts	externalAccountActivated	externalAccountActivatedEventSchema
externalAccounts	externalAccountRemoved	externalAccountRemovedEventSchema
externalAccounts	externalAccountRequested	externalAccountRequestedEventSchema
externalAccounts	externalAccountVerificationFailed	externalAccountVerificationFailedEventSchema
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:

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

Terms of service

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

• OAuth2 authentication (clientCredentials)
  • Client Credentials OAuth2 flow that allows a secure service application to access resources. (This access is not used with insecure clients such as web or mobile applications.) See details at Secure Access.
  • Flow: clientCredentials
  • Token URL = https://dev-oidc.apiture-comm-nonprod.com/oidc/token

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.

Event History

Event History

listRecentEventHistory

Code samples

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

GET https://api.apiture.com/banking/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/banking/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/banking/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/banking/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/banking/recentEventHistory', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/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/banking/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/banking/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

Parameter	Description
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. default: "" maxLength: 256 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 default: 1000 minimum: 0 maximum: 10000
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.1.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

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, 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". 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	[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 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". 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	[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 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". 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	[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 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". 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	[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 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". 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	[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 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". 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	[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/banking/eventHistory \
  -H 'Accept: application/restful+json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/banking/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/banking/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/banking/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/banking/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/banking/eventHistory', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/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/banking/eventHistory", data)
    req.Header = headers

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

Fetch event history

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

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

Parameters

Parameter	Description
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. default: "" maxLength: 256 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 default: 1000 minimum: 0 maximum: 10000
occurredAt in: query	string(text) 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 [start,end] 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": "1922a8531e8384cfa71b",
  "limit": 100,
  "nextPage_url": "https://production.api.apiture.com/banking/resources?start=8b76b4a97dccad88890e&limit=100",
  "version": "0.1.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

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, 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". 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	[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 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". 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	[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 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". 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	[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 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". 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	[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 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". 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	[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 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". 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	[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/banking/eventTypes \
  -H 'Accept: application/restful+json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/banking/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/banking/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/banking/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/banking/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/banking/eventTypes', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/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/banking/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/banking/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

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, 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". 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	[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 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". 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	[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 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". 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	[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 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". 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	[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 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". 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	[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/banking/eventTypesJsonSchema \
  -H 'Accept: application/schema+json' \
  -H 'If-None-Match: string' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/banking/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/banking/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/banking/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/banking/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/banking/eventTypesJsonSchema', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/banking/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/banking/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/banking/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

Parameter	Description
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

Response Schema

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, 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". 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	[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 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". 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	[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 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". 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	[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 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". 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	[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 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". 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	[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

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

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

address

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

Address (v1.3.0)

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

Properties

Name	Description
Address (v1.3.0)	object A postal address that can hold a US address or an international (non-US) postal addresses.
address1	string(text) (required) 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) (required) The city/town/municipality of the address. format: text maxLength: 20
countryCode	string (required) 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 (required) 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: 12 pattern: [0-9A-Za-z][- 0-9A-Za-z]{0,10}[0-9A-Za-z]

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

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

Name	Description
Address Updated Event Schema (v0.1.1)	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.
previousAddress	usAddress (required) The value of the address prior to the update.
newAddress	usAddress (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

Name	Description
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

challengeFactor

{
  "type": "sms",
  "labels": [
    "9876"
  ]
}

Challenge Factor (v1.2.0)

An challenge factor. See requiredIdentityChallenge for multiple examples.

Properties

Name	Description
Challenge Factor (v1.2.0)	object An challenge factor. See requiredIdentityChallenge for multiple examples.
id	challengeFactorId The ID of an a challenge factor. This ID is unique within the challenge factors associated with a challenge. The client should pass this id value as the factorId when starting or verifying a challenge factor. Note: The id will become required in a future update to this schema. minLength: 3 maxLength: 48 pattern: ^[-a-zA-Z0-9$_]{3,48}$
type	challengeFactorType (required) The name of challenge factor. challengeFactorType strings may have one of the following enumerated values: Value Description sms SMS: One-time passcode sent to the primary mobile phone number email Email: One-time passcode sent to the primary email address voice Voice: One-time passcode communicated via automated voice phone call authenticatorToken authenticator Token: One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app securityQuestions Security Questions: Prompt with the user's security questions registered with their security profile enum values: sms, email, voice, securityQuestions, authenticatorToken
labels	array: [string] A list of text label which identifies the channel(s) through which the user completes the challenge. For an sms or voice challenge, the only label item is the last four digits of the corresponding phone number. For an email challenge, each label is the masked email address. minItems: 1 maxItems: 4 items: string(text) » format: text » maxLength: 300
securityQuestions	challengeSecurityQuestions Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.

challengeFactorId

"string"

Challenge Factor ID (v1.0.0)

The ID of an a challenge factor. This ID is unique within the factors offered with a challenge.

type: string

minLength: 3
maxLength: 48
pattern: ^[-a-zA-Z0-9$_]{3,48}$

challengeFactorType

"sms"

Challenge Factor Type (v1.0.0)

The name of challenge factor.

challengeFactorType strings may have one of the following enumerated values:

Value	Description
sms	SMS: One-time passcode sent to the primary mobile phone number
email	Email: One-time passcode sent to the primary email address
voice	Voice: One-time passcode communicated via automated voice phone call
authenticatorToken	authenticator Token: One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app
securityQuestions	Security Questions: Prompt with the user's security questions registered with their security profile

type: string

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

challengeOperationId

"string"

Challenge Operation ID (v1.0.1)

The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses.

type: string

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

challengePromptId

"string"

Challenge Prompt ID (v1.0.0)

The unique ID of a prompt (such as a security question) in a challenge factor.

type: string

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

challengeSecurityQuestion

{
  "id": "74699fa628911e762ea5",
  "prompt": "What is your mother's maiden name?"
}

Challenge Security Question (v1.0.0)

A single security question within the questions array of the challengeSecurityQuestions

Properties

Name	Description
Challenge Security Question (v1.0.0)	object A single security question within the questions array of the challengeSecurityQuestions
id	challengePromptId (required) The unique ID of security question prompt. This should be included in the challengeVerification response as the promptId. minLength: 1 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]+$
prompt	string(text) (required) The text prompt of this security question. format: text maxLength: 50

challengeSecurityQuestions

{
  "questions": [
    {
      "id": "q1",
      "prompt": "What is your mother's maiden name?"
    },
    {
      "id": "q4",
      "prompt": "What is your high school's name?"
    },
    {
      "id": "q9",
      "prompt": "What is the name of your first pet?"
    }
  ]
}

Challenge Security Questions (v1.0.0)

Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.

Properties

Name	Description
Challenge Security Questions (v1.0.0)	object Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.
questions	array: [challengeSecurityQuestion] (required) The array of security questions. minItems: 1 maxItems: 8 items: object

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

Name	Description
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.
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: Value Description account Account: Entitlement is over a banking account customer Customer: 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

Name	Description
Account Reference (v0.1.0)	object A reference to a banking account.
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}$

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:

Value	Description
customer	Customer: A banking customer
operator	Operator: A financial institution operator or administrator
system	System: 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:

Value	Description
sms	SMS: One-time passcode sent to the primary mobile phone number
email	Email: One-time passcode sent to the primary email address
voice	Voice: One-time passcode communicated via automated voice phone call
softwareToken	Software Token: One-time passcode issued by a pre-registered software authenticator application
hardwareToken	Hardware Token: One-time passcode issued by a pre-registered hardware device such as a token key fob
authenticatorToken	Authenticator Token: One-time passcode issued by a pre-registered authenticator
securityQuestions	Security Questions: Prompt the user to answer their registered security questions
twoWaySms	Two-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:

Value	Description
account	Account: Entitlement is over a banking account
customer	Customer: Entitlement is over a banking customer

type: string

enum values: account, customer

eventHistory

{
  "start": "1922a8531e8384cfa71b",
  "limit": 100,
  "nextPage_url": "https://production.api.apiture.com/banking/resources?start=8b76b4a97dccad88890e&limit=100",
  "version": "0.1.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.3.0)

Representation of the event history resource.

Properties

Name	Description
Event History (v1.3.0)	object Representation of the event history resource.
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 default: 100 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) (required) The semantic version number of the event metadata structure. format: semver minLength: 5 maxLength: 12 enum values: 0.1.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

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

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

Name	Description
Event Item (v0.8.0)	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.
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	resourceId The unique ID of the customer in the banking core. This is only present if agentType is customer. minLength: 6 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.1.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.8.0)

A list of events within a time frame.

Properties

Name	Description
Event Messages (v0.8.0)	object A list of events within a time frame.
version	string(semver) (required) The semantic version number of the event metadata structure. format: semver minLength: 5 maxLength: 12 enum values: 0.1.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

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:

Value	Description
nonSufficientFunds	Non Sufficient Funds: Non Sufficient Funds (NSF) in the source account
sourceAccountClosed	Source Account Closed: The source (debit) account for the transfer is closed
targetAccountClosed	Target Account Closed: The target (credit) account for the transfer is closed
other	Other: 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

Name	Description
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

Name	Description
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.1.0)

The name and address of a wire transfer beneficiary.

Properties

Name	Description
Event Wire Beneficiary (v0.1.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	address (required) 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.

Properties

Name	Description
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.
account	eventAccountReference (required) The identifying properties of the external account.
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: Value Description instant Instant Account Verification: Access to the external account is verified via integration with an account verification service provider. microDeposits Micro-Deposits: Access to the external account is verified via verifying a set of micro-deposits. manual Manual: 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

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.

Properties

Name	Description
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.
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.2.1)

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.

Properties

Name	Description
External Account Requested Event Schema (v0.2.1)	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.
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: Value Description instant Instant Account Verification: Access to the external account is verified via integration with an account verification service provider. microDeposits Micro-Deposits: Access to the external account is verified via verifying a set of micro-deposits. manual Manual: Access to the external account is verified manually by the financial institution. enum values: instant, microDeposits, manual

externalAccountVerificationFailedEventSchema

{
  "maskedNumber": "*6789",
  "routingNumber": "123123123",
  "institutionName": "Third Party Bank",
  "verificationMethod": "microDeposits",
  "reason": "microDepositsMismatched",
  "failureCount": 1
}

External Account Verification Failed Event Schema (v0.3.1)

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.

Properties

Name	Description
External Account Verification Failed Event Schema (v0.3.1)	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.
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
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: Value Description instant Instant Account Verification: Access to the external account is verified via integration with an account verification service provider. microDeposits Micro-Deposits: Access to the external account is verified via verifying a set of micro-deposits. manual Manual: Access to the external account is verified manually by the financial institution. enum values: instant, microDeposits, manual
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:

Value	Description
microDepositsAccountMismatched	Micro-Deposits Account Number Mismatched: When verifying micro-deposits, the account number did not match the external account being verified
microDepositsAmountsMismatched	Micro-Deposits Amounts Mismatched: When verifying micro-deposits, the amounts did not match the actual transactions
other	Other: Account verification failed for some other reason
unknown	Unknown: 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:

Value	Description
instant	Instant Account Verification: Access to the external account is verified via integration with an account verification service provider.
microDeposits	Micro-Deposits: Access to the external account is verified via verifying a set of micro-deposits.
manual	Manual: Access to the external account is verified manually by the financial institution.

type: string

enum values: instant, microDeposits, manual

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

Name	Description
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.
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

Name	Description
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. The secondaryId in the event message is the operationId of the challenge.

Properties

Name	Description
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. The secondaryId in the event message is the operationId of the challenge.
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. The secondaryId in the event message is the operationId of the challenge.

Properties

Name	Description
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. The secondaryId in the event message is the operationId of the challenge.
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. The secondaryId in the event message is the operationId of the challenge.

Properties

Name	Description
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. The secondaryId in the event message is the operationId of the challenge.
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. The secondaryId in the event message is the operationId of the challenge.

Properties

Name	Description
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. The secondaryId in the event message is the operationId of the challenge.
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:

Value	Description
abaRoutingNumber	ABA Routing Number: The American Bankers Association routing number of a financial institution
swiftBicCode	swiftBicCode: The SWIFT Business Identifier Code (BIC) code of a financial institution
ibanAccountNumber	IBAN: International Bank Account Number (IBAN)

type: string

enum values: abaRoutingNumber, swiftBicCode, ibanAccountNumber

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

Name	Description
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.
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

Name	Description
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.
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

Name	Description
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.
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

Name	Description
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.
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]$

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",
  "temporaryPassword": true
}

Password Update Failed Event Schema (v0.1.2)

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

Name	Description
Password Update Failed Event Schema (v0.1.2)	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.
browser	string(text) The browser or user agent associated with the client request, if known. format: text maxLength: 160
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
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"
}

Password Updated Event Schema (v0.2.1)

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

Name	Description
Password Updated Event Schema (v0.2.1)	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.
browser	string(text) The browser or user agent associated with the client request, if known. format: text maxLength: 160
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
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.

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:

Value	Description
primary	Primary: The user's primary phone number
secondary	Secondary: The user's secondary phone number
mobile	Mobile: The user's mobile phone number
fax	fax: The user's fax phone number
alternate	Alternate: 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

Name	Description
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.
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: Value Description primary Primary: The user's primary phone number secondary Secondary: The user's secondary phone number mobile Mobile: The user's mobile phone number fax fax: The user's fax phone number alternate Alternate: 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

Name	Description
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.
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 7807 application/problem+json.

Properties

Name	Description
Problem Response (v0.4.1)	object API problem or error response, 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
attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

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.1.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"
        }
      }
    }
  ]
}

Recent Event History (v1.4.0)

Representation of the recent event history resource.

Properties

Name	Description
Recent Event History (v1.4.0)	object Representation of the recent event history resource.
version	string(semver) (required) The semantic version number of the event metadata structure. format: semver minLength: 5 maxLength: 12 enum values: 0.1.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
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 waterline. maxLength: 256 pattern: ^[-a-zA-Z0-9.,-~=_+:;@$]{1,256}$
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.

requiredIdentityChallenge

{
  "operationId": "createTransfer",
  "challengeId": "0504076c566a3cf7009c",
  "factors": [
    {
      "type": "sms",
      "labels": [
        "9876"
      ],
      "id": "85c0ee5753fcd0b0953f"
    },
    {
      "type": "voice",
      "labels": [
        "9876"
      ],
      "id": "d089e10a80a8627df37b"
    },
    {
      "type": "voice",
      "labels": [
        "6754"
      ],
      "id": "10506ecf9d1c2ee00403"
    },
    {
      "type": "email",
      "labels": [
        "an****nk@example.com",
        "an****98@example.com"
      ],
      "id": "e917d671cb2f030b56f1"
    },
    {
      "type": "authenticatorToken",
      "labels": [
        "Acme fob"
      ],
      "id": "fe6c452d7da0bbb4e407"
    },
    {
      "type": "securityQuestions",
      "securityQuestions": {
        "questions": [
          {
            "id": "q1",
            "prompt": "What is your mother's maiden name?"
          },
          {
            "id": "q4",
            "prompt": "What is your high school's name?"
          },
          {
            "id": "q9",
            "prompt": "What is the name of your first pet?"
          }
        ]
      },
      "id": "df33c6f88a37d6b3f0a6"
    }
  ]
}

Required Challenge (v1.2.2)

A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 Unauthorized problem response when the 401 problem type name is challengeRequired. See the "Challenge API" for details.

Properties

Name	Description
Required Challenge (v1.2.2)	object A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 Unauthorized problem response when the 401 problem type name is challengeRequired. See the "Challenge API" for details.
operationId	challengeOperationId (required) The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses. minLength: 6 maxLength: 48 pattern: ^[-a-zA-Z0-9$_]{6,48}$
challengeId	readOnlyResourceId (required) The unique ID of this challenge instance. This is an opaque string. This is passed when starting a challenge factor or when validating the identity challenge responses. read-only minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
factors	array: [challengeFactor] (required) A list of challenge factors. The user must complete one of these challenge factors. The labels in each factor identify one or more channels the user may use, such as a list of email addresses the system may use to send a one-time passcode to the user. *Note: The same channel may be used by multiple factors in the array of factors. For example, the user's primary mobile phone number may be used for both an sms factor and a voice factor. minItems: 1 maxItems: 8 items: object

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

Event Schema (v0.1.1)

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

Name	Description
Event Schema (v0.1.1)	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.
sourceAccount	eventAccountReference (required) The source account from which the funds are debited.
targetAccount	eventAccountReference (required) The account where the funds are credited.

singleTransferCreatedEventSchema

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

Single Transfer createdEvent Schema (v0.1.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

Name	Description
Single Transfer createdEvent Schema (v0.1.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.
sourceAccount	eventAccountReference (required) The source account from which the funds are debited.
targetAccount	eventAccountReference (required) The account where the funds are credited.

singleTransferEvent

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

Single Transfer Event (v1.0.0)

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

Properties

Name	Description
Single Transfer Event (v1.0.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.
targetAccount	eventAccountReference The account where the funds are credited.
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: Value Description once Once: Transfer does not repeat occasional Occasional: Transfer recurs but without a new scheduled date daily Daily: Repeat daily on business days weekly Weekly: Repeat weekly biweekly biweekly: Repeat every two weeks (26 times a year) semimonthly Semimonthly: Repeat twice a month (24 times a year) monthly Monthly: Repeat monthly monthlyFirstDay Monthly First Day: Repeat on the first business day of the month monthlyLastDay Monthly Last Day: Repeat on the last business day of the month bimonthly Bimonthly: Repeat every other month quarterly Quarterly: Repeat quarterly (four times a year) semiyearly Semiyearly: Repeat every six months (twice a year) yearly Yearly: Repeat once every year enum values: once, occasional, daily, weekly, biweekly, semimonthly, monthly, monthlyFirstDay, monthlyLastDay, bimonthly, quarterly, semiyearly, yearly

singleTransferFailedEventSchema

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

Single Transfer Failed Event Schema (v0.1.1)

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

Name	Description
Single Transfer Failed Event Schema (v0.1.1)	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.
reason	eventSingleTransferFailedReason (required) Indicates why a single transfer failed. eventSingleTransferFailedReason strings may have one of the following enumerated values: Value Description nonSufficientFunds Non Sufficient Funds: Non Sufficient Funds (NSF) in the source account sourceAccountClosed Source Account Closed: The source (debit) account for the transfer is closed targetAccountClosed Target Account Closed: The target (credit) account for the transfer is closed other Other: Another unspecified reason enum values: nonSufficientFunds, sourceAccountClosed, targetAccountClosed, other
sourceAccount	eventAccountReference (required) The source account from which the funds are debited.
targetAccount	eventAccountReference (required) The account where the funds are credited.

singleTransferInitiatedEventSchema

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

Message Schema (v0.1.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

Name	Description
Message Schema (v0.1.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.
sourceAccount	eventAccountReference (required) The source account from which the funds are debited.
targetAccount	eventAccountReference (required) The account where the funds are credited.

singleTransferProcessedEventSchema

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

Single Transfer Processed Event Schema (v0.1.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

Name	Description
Single Transfer Processed Event Schema (v0.1.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.
sourceAccount	eventAccountReference (required) The source account from which the funds are debited.
targetAccount	eventAccountReference (required) The account where the funds are credited.

singleTransferScheduledEventSchema

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

Single Transfer Scheduled Event Schema (v0.1.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

Name	Description
Single Transfer Scheduled Event Schema (v0.1.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.
sourceAccount	eventAccountReference (required) The source account from which the funds are debited.
targetAccount	eventAccountReference (required) The account where the funds are credited.

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

Single Transfer Updated Event Schema (v0.1.1)

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

Name	Description
Single Transfer Updated Event Schema (v0.1.1)	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.
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

Name	Description
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.
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

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:

Value	Description
once	Once: Transfer does not repeat
occasional	Occasional: Transfer recurs but without a new scheduled date
daily	Daily: Repeat daily on business days
weekly	Weekly: Repeat weekly
biweekly	biweekly: Repeat every two weeks (26 times a year)
semimonthly	Semimonthly: Repeat twice a month (24 times a year)
monthly	Monthly: Repeat monthly
monthlyFirstDay	Monthly First Day: Repeat on the first business day of the month
monthlyLastDay	Monthly Last Day: Repeat on the last business day of the month
bimonthly	Bimonthly: Repeat every other month
quarterly	Quarterly: Repeat quarterly (four times a year)
semiyearly	Semiyearly: Repeat every six months (twice a year)
yearly	Yearly: Repeat once every year

type: string

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

usAddress

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

Address (United States) (v1.4.0)

A postal address within the United States or US territories.

Properties

Name	Description
Address (United States) (v1.4.0)	object A postal address within the United States or US territories.
address1	string(text) (required) 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) (required) The city/town/municipality of the address. format: text maxLength: 20
countryCode	string (required) The ISO-3611 alpha-2 value for the country associated with the postal address. minLength: 2 maxLength: 2 const: US
regionCode	string (required) The state, district, or outlying area of the postal address. minLength: 2 maxLength: 2 pattern: ^[A-Za-z]{2}$
postalCode	string (required) A group of five or nine numbers that are added to a postal address to assist the sorting of mail. minLength: 5 maxLength: 10 pattern: ^\d{5}(?:[- ]?\d{4})?$

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",
  "userType": "retail",
  "score": 2500
}

User Logged In Event Schema (v0.2.2)

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

Name	Description
User Logged In Event Schema (v0.2.2)	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.
browser	string(text) The browser or user agent associated with the client request, if known. format: text maxLength: 160
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
userType	string 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",
  "reason": "disabled"
}

User Login Failed Event Schema (v0.1.2)

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

Name	Description
User Login Failed Event Schema (v0.1.2)	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.
browser	string(text) The browser or user agent associated with the client request, if known. format: text maxLength: 160
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
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

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

Username Updated Event Schema (v0.1.1)

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

Name	Description
Username Updated Event Schema (v0.1.1)	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.
browser	string(text) The browser or user agent associated with the client request, if known. format: text maxLength: 160
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

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

Name	Description
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.
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 (required) The authentication challenge factor the agent used to verify their identity when approving a wire transfer. 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.2.1)

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

Name	Description
Wire Transfer Beneficiary Updated Event Schema (v0.2.1)	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.
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"
  }
}

Wire Transfer Created Event Schema (v0.1.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

Name	Description
Wire Transfer Created Event Schema (v0.1.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.
sourceAccount	eventAccountReference (required) A reference to a banking account.
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: Value Description domestic Domestic: A wire transfer in which both the sender and beneficiary (recipient) financial institutions are in the US. international International: A wire transfer in which the beneficiary (recipient) financial institution is not in the US. enum values: domestic, international

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

Name	Description
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"
  }
}

Wire Transfer Initiated Event Schema (v0.1.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

Name	Description
Wire Transfer Initiated Event Schema (v0.1.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.
sourceAccount	eventAccountReference (required) A reference to a banking account.
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: Value Description domestic Domestic: A wire transfer in which both the sender and beneficiary (recipient) financial institutions are in the US. international International: A wire transfer in which the beneficiary (recipient) financial institution is not in the US. enum values: domestic, international

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:

Value	Description
domestic	Domestic: A wire transfer in which both the sender and beneficiary (recipient) financial institutions are in the US.
international	International: 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"
  }
}

Wire Transfer Scheduled Event Schema (v0.1.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

Name	Description
Wire Transfer Scheduled Event Schema (v0.1.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.
sourceAccount	eventAccountReference (required) A reference to a banking account.
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: Value Description domestic Domestic: A wire transfer in which both the sender and beneficiary (recipient) financial institutions are in the US. international International: A wire transfer in which the beneficiary (recipient) financial institution is not in the US. enum values: domestic, international

---