Events v0.11.1

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

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.

Event Types by Category

Events are organized into categories, as follows:

Event category	Event type	Event Message Schema
accounts	fullAccountNumberAccessed	fullAccountNumberAccessedEventSchema
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

Note: This document is not an API definition, but uses the OpenAPI document format to define the schemas of the event messages.

Download OpenAPI Definition (YAML)

Base URLs:

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

Terms of service

Email: Apiture Web: Apiture

License: Apiture API License

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",
  "regionName": "North Carolina",
  "countryCode": "US",
  "postalCode": "28412"
}

Address (v1.1.0)

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

Properties

Name	Description
address1	string (required) The first line of the postal address. In the US, this typically includes the building number and street name. maxLength: 35
address2	string 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. maxLength: 35
locality	string (required) The city/town/municipality of the address. maxLength: 20
countryCode	string (required) The ISO-3611 alpha-2 value for the country associated with the postal address. minLength: 2 maxLength: 2
regionName	string The state, district, or outlying area of the postal address. This is required if countryCode is not US. regionCode and regionName are mutually exclusive. 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
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: 5 maxLength: 10

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

Payload for event messages triggered when a user has updated their postal address.

This schema defines the data object for event messages with category profile and event message type of addressUpdated.

Properties

Name	Description
previousAddress	object: usAddress (required) The value of the address prior to the update.
newAddress	object: usAddress (required) The value of the address prior to the update.
type	string (required) Indicates which address associated with this banking customer's profile was updated. enum values: physical, mailing

entitlementUpdatedEventSchema

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

Event Schema (v0.1.1)

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.

Properties

Name	Description
type	string (required) The name of the enitlement setting. minLength: 4 maxLength: 64 pattern: ^[a-z][a-z0-9_]{3,63}$
category	string: 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	any (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
id	string: resourceId (required) The resource ID of the banking account. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]+$
maskedNumber	string: 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	string: 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

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

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
id	string: resourceId (required) The unique identifier for this event. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]+$
institutionId	string: institutionId The unique identifier of the financial institution, if applicable. minLength: 2 maxLength: 9 pattern: ^[A-Z0-9_]{2,8}$
correlationId	string: 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]+$
sessionId	string: resourceId The customer session ID, if known. User login starts a session. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]+$
type	string (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	number (required) An identifier for the category of the record type. Multiple record 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	string(date-time): timestamp (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. minLength: 20 maxLength: 30
agentId	string: 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]+$
agentType	string: eventAgentType (required) Indicates what type of agent or actor performed the operation that triggered this event. enum values: customer, operator, system
coreCustomerId	string: 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]+$
requesterId	string: 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]+$
host	string The host IP address of client which was used for this activity, if known. maxLength: 32
primaryId	string: 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]+$
secondaryId	string: 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]+$
data	object: abstractEventDataSchema Additional properties of the event, represented as a type-specific object.

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

A list of events within a time frame.

Properties

Name	Description
version	string(semver) (required) The semantic version number of the event metadata structure. enum values: 0.1.0
startsAt	string(date-time): timestamp The beginning date-time for the events in this page of event messages. This is an RFC 3339 UTC date-time string. minLength: 20 maxLength: 30
endsAt	string(date-time): timestamp The ending date-time for the events in this page of event messages. This is an RFC 3339 UTC date-time string. minLength: 20 maxLength: 30
items	array: [eventMessageItem] (required) An array of event items.

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

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
name	string (required) The name of the wire transfer beneficiary. maxLength: 35
address	object: 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.0)

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.

Properties

Name	Description
account	object: eventAccountReference (required) The identifying properties of the external account.
verificationMethod	string: 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 (required) The financial institution's name. maxLength: 35

externalAccountRemovedEventSchema

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

External Account Removed Event Schema (v0.1.0)

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.

Properties

Name	Description
maskedNumber	string: 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	string: accountRoutingNumber (required) An account ABA routing and transit number. minLength: 9 maxLength: 9 pattern: ^[0-9]{9}$
institutionName	string (required) The financial institution's name. maxLength: 35

externalAccountRequestedEventSchema

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

External Account Requested Event Schema (v0.2.0)

Payload for event messages triggered when a banking customer has requested linking an external ACH banking account so that they may transfer funds between this financial institution and that external account.

This schema defines the data object for event messages with category externalAccounts and event message type of externalAccountRequested.

Properties

Name	Description
maskedNumber	string: 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	string: accountRoutingNumber (required) An account ABA routing and transit number. minLength: 9 maxLength: 9 pattern: ^[0-9]{9}$
verificationMethod	string: 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.2.0)

Payload for event messages triggered when a user has failed to verify ownership of an external account while trying to add access to an external account.

This schema defines the data object for event messages with category externalAccounts and event message type of externalAccountVerificationFailed.

Properties

Name	Description
maskedNumber	string: 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	string: accountRoutingNumber (required) An account ABA routing and transit number. minLength: 9 maxLength: 9 pattern: ^[0-9]{9}$
institutionName	string (required) The financial institution's name. maxLength: 35
verificationMethod	string: 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	string: externalAccountVerificationFailureEventReason (required) Indicates why the verification failed. enum values: microDepositsAccountMismatched, microDepositsAmountsMismatched, other, unknown
failureCount	integer The number of times a external account verification attempt failed. Omitted if unknown. minimum: 1

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

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.

Properties

Name	Description
maskedNumber	string: 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	string: 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.0)

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.

Properties

Name	Description
maskedNumber	string: 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	string: accountRoutingNumber (required) The account's routing and transit number. minLength: 9 maxLength: 9 pattern: ^[0-9]{9}$

identityChallengeFailedEventSchema

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

Identity Challenge Failed Event Schema (v0.1.0)

Payload for event messages triggered when a user has failed an identity challenge.

Properties

Name	Description
factor	string: 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: » maxLength: 72
failureCount	integer (required) The number of times the user submitted an invalid identity Challenge response, such as the wrong one-time passcode or incorrect security questions. minimum: 0

identityChallengeInitiatedEventSchema

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

identity Challenge Initiated Event Schema (v0.1.0)

Payload for event messages triggered when a user has initiated and identity challenge for an operation that requires proof of identity.

Properties

Name	Description
factor	string: 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: » maxLength: 72

identityChallengeSucceededEventSchema

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

Identity Challenge Succeeded Event Schema (v0.1.0)

Payload for event messages triggered when a user has successfully completed an identity challenge.

Properties

Name	Description
factor	string: 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: » maxLength: 72
failureCount	integer (required) The number of times the user submitted an invalid identity Challenge response, such as the wrong one-time passcode or incorrect security questions. minimum: 0

institutionId

"TIBURON"

Institution ID (v1.0.0)

The unique immutable identifier of a financial institution.

Type: string
minLength: 2
maxLength: 9
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.1.0)

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
factor	string: 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: » maxLength: 72
failureCount	integer The number of times the user submitted an invalid MFA response, such as the wrong one-time passcode or incorrect security questions. minimum: 0

mfaInitiatedEventSchema

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

MFA Initiated Event Schema (v0.1.1)

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
factor	string: 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: » maxLength: 72

mfaSucceededEventSchema

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

MFA Succeeded Event Schema (v0.1.0)

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
factor	string: 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: » maxLength: 72
failureCount	integer The number of times the user submitted an invalid MFA response, such as the wrong one-time passcode or incorrect security questions. minimum: 0

mobileDeviceRegistrationDeletedEventSchema

{
  "deviceId": "c6b79477550d0ebd16f7"
}

Mobile Device Registration Deleted Event Schema (v0.1.0)

Payload for event messages triggered when a user has deleted a device registration.

This schema defines the data object for event messages with category authentication and event message type of mobileDeviceRegistrationDeleted.

Properties

Name	Description
deviceId	string The unique ID of the device the user removed. maxLength: 256

monetaryValue

"3456.78"

Monetary Value (v1.0.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.
The schema monetaryValue was added on version 0.4.0 of the API.

Type: string
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.1)

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
browser	string The browser or user agent associated with the client request, if known. maxLength: 160
operatingSystem	string The name of operating system of the device associated with the client request, if known. 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 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. 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.0)

Payload for event messages triggered when a user has changed their password.

This schema defines the data object for event messages with category authentication and event message type of passwordUpdated.

Properties

Name	Description
browser	string The browser or user agent associated with the client request, if known. maxLength: 160
operatingSystem	string The name of operating system of the device associated with the client request, if known. 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 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. 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.0)

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
previousPhoneNumber	string The previous phone number. If omitted, the user did not have a previous number of this type. maxLength: 20
newPhoneNumber	string The previous phone number. If omitted, the user has removed the number of this type. maxLength: 20
type	string: 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.1.0)

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
previousEmail	string(email) The previous original value of the email address before the update.
newEmail	string(email) The previous original value of the email address before the update.

resourceId

"string"

Resource Identifier (v1.0.0)

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]+$

singleTransferCanceledEventSchema

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

Event Schema (v0.1.0)

Payload for event messages triggered when a customer or the system has canceled a transfer.

Properties

Name	Description
sourceAccount	object: eventAccountReference (required) The source account from which the funds are debited.
targetAccount	object: 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.0)

Payload for event messages triggered when a user has created a single account-to-account transfer.

Properties

Name	Description
sourceAccount	object: eventAccountReference (required) The source account from which the funds are debited.
targetAccount	object: 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
sourceAccount	object: eventAccountReference The source account from which the funds are debited.
targetAccount	object: eventAccountReference The account where the funds are credited.
amount	string: monetaryValue The amount of money to transfer between accounts. pattern: ^(0|[1-9][0-9]*)\.[0-9][0-9]$
frequency	string: 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 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 monthlyFirstDay: Repeat on the first business day of the month monthlyLastDay monthlyLastDay: 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, 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.0)

Payload for event messages triggered when the system has failed to process a single account-to-account transfer.

Properties

Name	Description
reason	string: 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	object: eventAccountReference (required) The source account from which the funds are debited.
targetAccount	object: 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.0)

Payload for event messages triggered when the system has started processing a single scheduled account-to-account transfer.

Properties

Name	Description
sourceAccount	object: eventAccountReference (required) The source account from which the funds are debited.
targetAccount	object: 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.0)

Payload for event messages triggered when a single account-to-account transfer has completed processing.

Properties

Name	Description
sourceAccount	object: eventAccountReference (required) The source account from which the funds are debited.
targetAccount	object: 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.0)

Payload for event messages triggered when a customer has scheduled a single account-to-account transfer. The transfer resource ID is captured in the event's primaryId.

This schema defines the data object for event messages with category transfers and event message type of singleTransferScheduled.

Properties

Name	Description
sourceAccount	object: eventAccountReference (required) The source account from which the funds are debited.
targetAccount	object: 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.0)

Payload for event messages triggered when a customer has scheduled a single account-to-account transfer. The transfer resource ID is captured in the event's primaryId.

This schema defines the data object for event messages with category transfers and event message type of singleTransferScheduled.

Properties

Name	Description
previousTransfer	object: singleTransferEvent (required) Describes the details of a single account-to-account transfer in an event payload.
newTransfer	object: 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.0)

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
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.
The schema timestamp was added on version 0.4.0 of the API.

Type: string(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
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	monthlyFirstDay: Repeat on the first business day of the month
monthlyLastDay	monthlyLastDay: 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, 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.2.0)

A postal address within the United States or US territories.
The schema usAddress was added on version 0.5.0 of the API.

Properties

Name	Description
address1	string (required) The first line of the postal address. In the US, this typically includes the building number and street name. maxLength: 35
address2	string 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. maxLength: 35
locality	string (required) The city/town/municipality of the address. maxLength: 20
countryCode	string (required) The ISO-3611 alpha-2 value for the country associated with the postal address. minLength: 2 maxLength: 2
regionCode	string (required) The state, district, or outlying area of the postal address. minLength: 2 maxLength: 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.1)

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 userLoggedInEvent.

Properties

Name	Description
browser	string The browser or user agent associated with the client request, if known. maxLength: 160
operatingSystem	string The name of operating system of the device associated with the client request, if known. 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 (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. 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.1)

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
browser	string The browser or user agent associated with the client request, if known. maxLength: 160
operatingSystem	string The name of operating system of the device associated with the client request, if known. 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 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. maxLength: 32
reason	string (required) Indicates why the user was unable to login. Some possible values are disabled invalidCredentials ipRestriction other unknown Other values are possible.

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

Payload for event messages triggered when a user has updated their username (access ID).

This schema defines the data object for event messages with category authentication and event message type of usernameUpdated.

Properties

Name	Description
browser	string The browser or user agent associated with the client request, if known. maxLength: 160
operatingSystem	string The name of operating system of the device associated with the client request, if known. 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 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. maxLength: 32

wireTransferApprovedEventSchema

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

Wire Transfer Approved Event Schema (v0.1.0)

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.

Properties

Name	Description
approvalCount	integer (required) The number of approvals already given for the wire transfer, including the approval corresponding to this event. minimum: 0 maximum: 3
remainingApprovalsCount	integer (required) The number of the remaining approvals that are required before the wire payment can be scheduled and processed. minimum: 0 maximum: 3
factor	string: 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.0)

Payload for event messages triggered when a user has changed a wire transfer beneficiary.

This schema defines the data object for event messages with category wireTransfers and event message type of wireTransferBeneficiaryUpdated.

Properties

Name	Description
previousBeneficiary	object: eventWireBeneficiary (required) The name and address of a wire transfer beneficiary.
newBeneficiary	object: 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.0)

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.

Properties

Name	Description
sourceAccount	object: eventAccountReference (required) A reference to a banking account.
targetAccount	object: wireTransferEventTargetAccount (required) Identifies a target account for a domestic or international wire transfer.
scope	string: 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
maskedNumber	string: 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 (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. maxLength: 36
locatorType	string: 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.0)

Payload for event messages triggered when the financial institution has initiate (started processing) a wire transfer with the FED wire network.

Properties

Name	Description
sourceAccount	object: eventAccountReference (required) A reference to a banking account.
targetAccount	object: wireTransferEventTargetAccount (required) Identifies a target account for a domestic or international wire transfer.
scope	string: 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.0)

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.

Properties

Name	Description
sourceAccount	object: eventAccountReference (required) A reference to a banking account.
targetAccount	object: wireTransferEventTargetAccount (required) Identifies a target account for a domestic or international wire transfer.
scope	string: 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