Describes the event channels and event messages that the Apiture Open digital banking platform publishes for client subscription/consumption.
The DevBank public DevPortal sandbox environment
A user has changed their preferred phone number.
User Preferred Phone Number Changed
Fired after a customer changes their preferred phone number and it is reviewed and accepted.
Accepts the following message:
User (banking customer) changed their preferred phone number.
User (banking customer) changed their preferred phone number.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The phone number, as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is +1. Phone numbers are in E.164 format with a leading +, country code (up to 3 digits) and subscriber number.
An abstract schema used to define messages related to user profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "userPreferredPhoneChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"phoneNumber": "+19105550155"
}
A user has changed their preferred email address.
User Preferred Email Address Changed
Fired after a customer changes their preferred email address and it is reviewed and accepted.
Accepts the following message:
User (banking customer) changed their preferred email address.
User (banking customer) changed their preferred email address.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The user's new preferred email address, as a string.
An abstract schema used to define messages related to user profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "userPreferredEmailAddressChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"emailAddress": "JohnBankCustomer@example.com"
}
A user has changed their tax address.
User Preferred Tax Address Changed
Fired after a customer changes their tax address and it is reviewed and accepted.
Accepts the following message:
User (banking customer) changed their tax address.
User (banking customer) changed their preferred email address.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The user's new preferred email address.
The first street address line of the address, normally a house number and street name.
The optional second street address line of the address.
The name of the city or municipality.
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define messages related to user profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "userTaxAddressChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"address": {
"_id": "ha5",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
}
}
A user has changed their preferred mailing address.
User Preferred Mailing Address Address Changed
Fired after a customer changes their preferred mailing address and it is reviewed and accepted.
Accepts the following message:
User (banking customer) changed their preferred mailing address.
User (banking customer) changed their preferred email address.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The user's new preferred mailing address.
A postal address with the address type and an identifier.
This schema was resolved from contacts/address.
The first street address line of the address, normally a house number and street name.
The optional second street address line of the address.
The name of the city or municipality.
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.
The type of this address.
The type of a postal address.
Warning: The enum list will be removed in a future release.
The allowed values for this property are defined at runtime in the
label group named addressType
in the response from the getLabels operation.
This schema was resolved from contacts/addressType.
A text label, suitable for presentation to the end user. This is derived from type or from otherType if type is other
The actual address type if type is other.
An identifier for this address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all addresses within the addresses array.
The first street address line of the address, normally a house number and street name.
The optional second street address line of the address.
The name of the city or municipality.
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define messages related to user profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "userPreferredMailingAddressChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"address": {
"_id": "ha5",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
}
}
A user has created a new address.
Additional User Address Created
Fired after a customer creates a new user postal address to their profile.
Accepts the following message:
User (banking customer) added a new postal address to their profile.
The user created a new address in additional their preferred mailing address.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The user's new address.
The first street address line of the address, normally a house number and street name.
The optional second street address line of the address.
The name of the city or municipality.
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define messages related to user profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "additionalUserAddressCreated",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"address": {
"_id": "ha5",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
}
}
A user has changed their W-9 tax withholding status.
User W-9 Tax Withholding Created
Fired after a customer changes their W-9 tax withholding status.
Accepts the following message:
User (banking customer) changed their W-9 tax withholding status.
A user changed their W-9 tax withholdings status. true indicates the user is subject to backup W-9 tax withholdings.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The user's new withholding setting.
An abstract schema used to define messages related to user profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "userW9TaxWithholdingsStatusChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"w9Withholdings": false
}
The user changed their SMS notification opt-in/opt-out setting.
User SMS Opt-In Setting Changed
The user changed their SMS notification opt-in/opt-out setting.
Accepts the following message:
The current user and their SMS notification setting.
Message conveying a user changed their SMS communication option.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
false if the user has explicitly opted out of receiving SMS text messages from the financial institution for notification of banking or related activity. This value reflects the user's most recent opt in/opt out selection.
An abstract schema used to define messages related to user profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "userSmsOptInChanged",
"version": "1.0.0",
"userId": "af2cadf2-8ac9-43f3-b639-06cb6bfa01bb",
"userUri": "https://api.devbank.apiture.com/users/users/af2cadf2-8ac9-43f3-b639-06cb6bfa01bb",
"trackingId": "X47-aaapeye",
"smsNotifications": false
}
A user has changed the organization's preferred phone number.
Organization Preferred Phone Number Changed
Fired after a customer changes the organization's preferred phone number and it is reviewed and accepted.
Accepts the following message:
User (banking customer) changed the organization's preferred phone number.
User (banking customer) changed the organization's preferred phone number.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The phone number, as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is +1. Phone numbers are in E.164 format with a leading +, country code (up to 3 digits) and subscriber number.
An abstract schema used to define messages related to organization profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "organizationPreferredPhoneChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"organizationId": "126d24d0-fcdb",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/126d24d0-fcdb",
"phoneNumber": "+19105550155"
}
A user has changed the organization's preferred email address.
Organization Preferred Email Address Changed
Fired after a customer changes the organization's preferred email address and it is reviewed and accepted.
Accepts the following message:
User (banking customer) changed the organization's preferred email address.
User (banking customer) changed the organization's preferred email address.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The organization's new preferred email address, as a string.
An abstract schema used to define messages related to organization profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "organizationPreferredEmailAddressChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"organizationId": "126d24d0-fcdb",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/126d24d0-fcdb",
"emailAddress": "JohnBankCustomer@example.com"
}
A user has changed the organization's tax address.
Organization Preferred Tax Address Changed
Fired after a customer changes the organization's tax address and it is reviewed and accepted.
Accepts the following message:
User (banking customer) changed the organization's tax address.
User (banking customer) changed the organization's preferred email address.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The organization's new preferred email address.
The first street address line of the address, normally a house number and street name.
The optional second street address line of the address.
The name of the city or municipality.
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define messages related to organization profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "organizationTaxAddressChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"organizationId": "126d24d0-fcdb",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/126d24d0-fcdb",
"address": {
"_id": "wa1",
"type": "work",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
}
}
A user has changed the organization's preferred mailing address.
Organization Preferred Mailing Address Address Changed
Fired after a customer changes the organization's preferred mailing address and it is reviewed and accepted.
Accepts the following message:
User (banking customer) changed the organization's preferred mailing address.
User (banking customer) changed the organization's preferred email address.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The organization's new preferred mailing address.
A postal address with the address type and an identifier.
This schema was resolved from contacts/address.
The first street address line of the address, normally a house number and street name.
The optional second street address line of the address.
The name of the city or municipality.
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.
The type of this address.
The type of a postal address.
Warning: The enum list will be removed in a future release.
The allowed values for this property are defined at runtime in the
label group named addressType
in the response from the getLabels operation.
This schema was resolved from contacts/addressType.
A text label, suitable for presentation to the end user. This is derived from type or from otherType if type is other
The actual address type if type is other.
An identifier for this address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all addresses within the addresses array.
The first street address line of the address, normally a house number and street name.
The optional second street address line of the address.
The name of the city or municipality.
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define messages related to organization profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "organizationPreferredMailingAddressChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"organizationId": "126d24d0-fcdb",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/126d24d0-fcdb",
"address": {
"_id": "ha5",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
}
}
A user has created a new address.
Additional Organization Address Created
Fired after a customer creates a new user postal address to their profile.
Accepts the following message:
User (banking customer) added a new postal address to their profile.
The user created a new address in additional the organization's preferred mailing address.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The organization's new address.
The first street address line of the address, normally a house number and street name.
The optional second street address line of the address.
The name of the city or municipality.
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define messages related to organization profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "additionalOrganizationAddressCreated",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"organizationId": "126d24d0-fcdb",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/126d24d0-fcdb",
"address": {
"_id": "ba1",
"type": "business",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
}
}
A user has changed the W-9 tax withholding status of an organization.
Organization W-9 Tax Withholdings Status Changed
Fired after a customer changes the W-9 tax withholding status of an organization
Accepts the following message:
User (banking customer) changed the W-9 tax withholding status of an organization
A user changed the organization's W-9 tax withholdings status. true indicates the organization is subject to backup W-9 tax withholdings.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The organization's new withholding setting.
An abstract schema used to define messages related to organization profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "organizationW9TaxWithholdingsStatusChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"organizationId": "126d24d0-fcdb",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/126d24d0-fcdb",
"w9Withholdings": false
}
A user has changed the home website URL of an organization.
Organization Website URL Changed
Fired after a customer changes the home website URL of an organization
Accepts the following message:
User (banking customer) changed the home website URL of an organization
A user changed the organization's home website URL.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The organization's new business website URL.
An abstract schema used to define messages related to organization profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "organizationWebsiteUrlChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"organizationId": "126d24d0-fcdb",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/126d24d0-fcdb",
"homeUrl": "https://www.smitties-detailing.com"
}
New digital account opening account application started.
Account Application Started
Fired after a customer starts a new account application for review/approval.
Accepts the following message:
User (banking customer) started an account application to open a new account.
A user (banking customer) has started an account application for review/approval.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
An abstract schema used to define other message schemas related to account applications.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "accountApplicationStarted",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"applicationUri": "https://api.devbank.apiture.com/accountApplications/applications/491a1529-feba-47f2-a118-1632d5d8675a",
"applicationId": "491a1529-feba-47f2-a118-1632d5d8675a",
"products": {
"0": {
"accountType": "DDA",
"productId": "6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"uri": "https://api.devbank.apiture.com/products/products/6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"name": "Premiere Checking"
}
},
"organizationId": "b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0"
}
New digital account opening account application was approved, either automatically or by the financial institution.
Account Application Approved
Fired after a completed account application was approved.
Accepts the following message:
A completed account application was approved.
An account application has been approved, either automatically or by the financial institution.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
The URI of the Approval resource which the financial institution reviewed and approved. May not exist if the application was auto-approved.
An abstract schema used to define other message schemas related to account applications.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "accountApplicationApproved",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"applicationUri": "https://api.devbank.apiture.com/accountApplications/applications/491a1529-feba-47f2-a118-1632d5d8675a",
"applicationId": "491a1529-feba-47f2-a118-1632d5d8675a",
"products": {
"0": {
"accountType": "DDA",
"productId": "6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"uri": "https://api.devbank.apiture.com/products/products/6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"name": "Premiere Checking"
}
},
"organizationId": "b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0"
}
New digital account opening account application has become blocked.
Account Application Blocked
Fired after a customer's account application has become blocked.
Accepts the following message:
User (banking customer) account application has become blocked.
An account application has become blocked.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
An abstract schema used to define other message schemas related to account applications.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "accountApplicationBlocked",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"applicationUri": "https://api.devbank.apiture.com/accountApplications/applications/491a1529-feba-47f2-a118-1632d5d8675a",
"applicationId": "491a1529-feba-47f2-a118-1632d5d8675a",
"products": {
"0": {
"accountType": "DDA",
"productId": "6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"uri": "https://api.devbank.apiture.com/products/products/6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"name": "Premiere Checking"
}
},
"organizationId": "b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0"
}
New digital account opening account application has expired.
Account Application Expired
Fired after a customer's account application has expired.
Accepts the following message:
User (banking customer) account application has expired.
A user's account application has expired
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
Date-time when the application was created
The expiration date/time of the application
An abstract schema used to define other message schemas related to account applications.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "accountApplicationExpired",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"applicationUri": "https://api.devbank.apiture.com/accountApplications/applications/491a1529-feba-47f2-a118-1632d5d8675a",
"applicationId": "491a1529-feba-47f2-a118-1632d5d8675a",
"products": {
"0": {
"accountType": "DDA",
"productId": "6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"uri": "https://api.devbank.apiture.com/products/products/6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"name": "Premiere Checking"
}
},
"organizationId": "b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"createdAt": "2021-07-08T11:44:01.375Z",
"expiredAt": "2021-08-19T05:57:38.375Z"
}
A user has canceled a digital account opening account application.
Account Application Canceled
Fired after a customer has canceled an account application.
Accepts the following message:
User (banking customer) has canceled an account application.
A user (banking customer) has canceled an account application.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
An abstract schema used to define other message schemas related to account applications.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "accountApplicationCanceled",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"applicationUri": "https://api.devbank.apiture.com/accountApplications/applications/491a1529-feba-47f2-a118-1632d5d8675a",
"applicationId": "491a1529-feba-47f2-a118-1632d5d8675a",
"products": {
"0": {
"accountType": "DDA",
"productId": "6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"uri": "https://api.devbank.apiture.com/products/products/6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"name": "Premiere Checking"
}
},
"organizationId": "b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0"
}
Enrollment as a joint owner or authorized signer on an account has expired.
Enrollment Expired
Fired after a customer's account application has expired.
Accepts the following message:
User (banking customer) account application has expired.
A user's enrollment as an account joint owner or authorized signer has expired,
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account enrollment resource.
The URI of the Apiture account enrollment resource.
The account(s) the user is joining as joint owner or authorized signer.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
Date-time when the application was created.
The expiration date/time of the enrollment.
An abstract schema used to define other message schemas related to joint owner or authorized signer enrollments.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account enrollment resource.
The URI of the Apiture account enrollment resource.
The account(s) the user is joining as joint owner or authorized signer.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "enrollmentExpired",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"enrollmentUri": "https://api.devbank.apiture.com/accountApplications/enrollments/491a1529-feba-47f2-a118-1632d5d8675a",
"enrollmentId": "491a1529-feba-47f2-a118-1632d5d8675a",
"accounts": {
"0": {
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210",
"accountType": "DDA"
}
},
"organizationId": "b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"applicationDaysToExpire": 45,
"createdAt": "2021-07-08T11:44:01.375Z",
"expiredAt": "2021-08-23T06:04:09.375Z"
}
A user has canceled their enrollment as a joint owner or authorized signer on an account.
Enrollment Canceled
Fired after a customer has canceled an account application.
Accepts the following message:
User (banking customer) has canceled an account application.
A user (banking customer) has canceled their enrollment as an account joint owner or authorized signer.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account enrollment resource.
The URI of the Apiture account enrollment resource.
The account(s) the user is joining as joint owner or authorized signer.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
An abstract schema used to define other message schemas related to joint owner or authorized signer enrollments.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account enrollment resource.
The URI of the Apiture account enrollment resource.
The account(s) the user is joining as joint owner or authorized signer.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "enrollmentCanceled",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"enrollmentUri": "https://api.devbank.apiture.com/accountApplications/enrollments/491a1529-feba-47f2-a118-1632d5d8675a",
"enrollmentId": "491a1529-feba-47f2-a118-1632d5d8675a",
"accounts": {
"0": {
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210",
"accountType": "DDA"
}
},
"organizationId": "b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0"
}
A user's digital account opening account application was flagged for review by the financial institution.
Account Application Flagged For Review
Fired after an account application was flagged for review.
Accepts the following message:
An account application was flagged for review.
An account application was flagged for review by the financial institution.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
An abstract schema used to define other message schemas related to account applications.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "accountApplicationFlaggedForReview",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"applicationUri": "https://api.devbank.apiture.com/accountApplications/applications/491a1529-feba-47f2-a118-1632d5d8675a",
"applicationId": "491a1529-feba-47f2-a118-1632d5d8675a",
"products": {
"0": {
"accountType": "DDA",
"productId": "6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"uri": "https://api.devbank.apiture.com/products/products/6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"name": "Premiere Checking"
}
},
"organizationId": "b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0"
}
User has completed an invitation to become a joint account owner
Joint Owner Invitation Completed
Fired after a user has completed an invitation to become a joint account owner.
Accepts the following message:
User (banking customer) completed an invitation to become a joint account owner.
User (banking customer) completed an invitation to become a joint owner on a personal account.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
An abstract schema used to define other account owner invitation-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "jointOwnerInvitationCompleted",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"accountType": "DDA",
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/b13d0bd2-b238-4f12-a6de-0924abc6edd9",
"invitationUri": "https://api.devbank.apiture.com/invitations/invitations/48c5ab04-73a6-4a9d-a782-ff9e9a9ccb3d",
"inviterFullName": "Maxine Peck",
"inviteeFullName": "John B. Customer",
"inviteeEmailAddress": "JohnBankCustomer@example.com"
}
User has completed an invitation to become an authorized signer on a business account
Authorized Signer Invitation Completed
Fired after a user has completed an invitation to become an authorized signer on a business account.
Accepts the following message:
User (banking customer) completed an invitation to become an authorized signer on a business account
User (banking customer) completed an invitation to become an authorized signer on a business account.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
An abstract schema used to define other account owner invitation-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "authSignerInvitationCompleted",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"accountType": "DDA",
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/b13d0bd2-b238-4f12-a6de-0924abc6edd9",
"invitationUri": "https://api.devbank.apiture.com/invitations/invitations/48c5ab04-73a6-4a9d-a782-ff9e9a9ccb3d",
"inviterFullName": "Maxine Peck",
"inviteeFullName": "John B. Customer",
"inviteeEmailAddress": "JohnBankCustomer@example.com",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0"
}
Account Created events.
Accounts
Fired after a customer creates (opens) a banking account
Accepts the following message:
User (banking customer) successfully created (opened) an account
A banking customer successfully opened a new account.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource, if the event is for a business account context. Omitted if the account is a personal account.
An abstract schema used to define other account-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource, if the event is for a business account context. Omitted if the account is a personal account.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "accountCreated",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"accountType": "DDA",
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210",
"accountUri": "https://api.devbank.apiture.com/accounts/externalAccounts/0d34247b-8b74-40cc-b7f1-0ec5c97340e1"
}
Account Closed events.
Accounts
Fired after an account is closed by the customer or the financial institution.
Accepts the following message:
A banking account was closed
A banking account was closed.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource, if the event is for a business account context. Omitted if the account is a personal account.
An abstract schema used to define other account-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource, if the event is for a business account context. Omitted if the account is a personal account.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "accountClosed",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"accountType": "DDA",
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210",
"accountUri": "https://api.devbank.apiture.com/accounts/externalAccounts/0d34247b-8b74-40cc-b7f1-0ec5c97340e1"
}
Account updated events.
Accounts
Fired after updating properties of an account. Note: CD maturity settings and CD interest disbursement settings are conveyed with other events.
Accepts the following message:
Properties of a bank account were updated
A banking account resource was updated.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource, if the event is for a business account context. Omitted if the account is a personal account.
An abstract schema used to define other account-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource, if the event is for a business account context. Omitted if the account is a personal account.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "accountUpdated",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"accountType": "DDA",
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210",
"accountUri": "https://api.devbank.apiture.com/accounts/externalAccounts/0d34247b-8b74-40cc-b7f1-0ec5c97340e1"
}
Account CD maturity updated events.
Accounts
Fired after a customer changes a CD account's maturity settings.
Accepts the following message:
CD Maturity settings of a bank account were updated
A banking account's CD Maturity Settings resource were updated.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource, if the event is for a business account context. Omitted if the account is a personal account.
If the account to transfer the account balance upon maturity has changed, this object is present and contains the target account details.
Is the transfer account internal or external.
The unique full account number of the account.
The account routing number which identifies the financial institution.
Additional properties are allowed.
An abstract schema used to define other account-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource, if the event is for a business account context. Omitted if the account is a personal account.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "cdMaturityUpdated",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"accountType": "CD",
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210",
"accountUri": "https://api.devbank.apiture.com/accounts/externalAccounts/0d34247b-8b74-40cc-b7f1-0ec5c97340e1",
"balanceTransferAccount": {
"location": "internal",
"accountNumber": "9876543210",
"routingNumber": "021000021"
}
}
Account interest disbursement Updated events.
Accounts
Fired after a customer changes a CD account's interest disbursement settings.
Accepts the following message:
CD Interest Disbursement settings of a bank account were updated
A banking account's CD Maturity Settings resource were updated.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource, if the event is for a business account context. Omitted if the account is a personal account.
If the account to disburse earned interest for a CD account has changed, this object is present and contains the target account details.
Is the interest disbursement account internal or external.
The unique full account number of the account.
The account routing number which identifies the financial institution.
Additional properties are allowed.
An abstract schema used to define other account-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource, if the event is for a business account context. Omitted if the account is a personal account.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "cdInterestDisbursementUpdated",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"accountType": "CD",
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210",
"accountUri": "https://api.devbank.apiture.com/accounts/externalAccounts/0d34247b-8b74-40cc-b7f1-0ec5c97340e1",
"disbursementAccount": {
"location": "internal",
"accountNumber": "9876543210",
"routingNumber": "021000021"
}
}
External account verification submitted events.
Account Verifications
Fired after the customer submitted a new external account for verification.
Accepts the following message:
User (banking customer) submitted external account details for verification
Message body sent when a user's attempt to link an external account triggered review.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The URI of the Approval resource which the operator must approve/reject.
The type of account verification that triggered review.
An abstract schema used to define other account verification schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The URI of the Approval resource which the operator must approve/reject.
The type of account verification that triggered review.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "accountVerificationSubmitted",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"accountType": "DDA",
"verificationType": "verificationProviderWidget",
"approvalUri": "https://api.devbank.apiture.com/approvals/approvals/3a890436-55de-4560-9632-9dd9f26efb72"
}
External account verification approved events.
Account Verifications
Fired after the system or an operator approved an external account that was under review.
Accepts the following message:
The system or an operator approved an external account that was under review
Message body sent when an operator approved an external account that was under review.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The URI of the Approval resource which the operator must approve/reject.
The type of account verification that triggered review.
An abstract schema used to define other account verification schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The URI of the Approval resource which the operator must approve/reject.
The type of account verification that triggered review.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "accountVerificationApproved",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"accountType": "DDA",
"verificationType": "verificationProviderWidget",
"approvalUri": "https://api.devbank.apiture.com/approvals/approvals/3a890436-55de-4560-9632-9dd9f26efb72"
}
Account verification rejected events.
Account Verifications
Fired after external account verification rejected events.
Accepts the following message:
The system or an operator rejected an external account that was under review
Message body sent when an operator rejected an external account that was under review.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The URI of the Approval resource which the operator must approve/reject.
The type of account verification that triggered review.
An abstract schema used to define other account verification schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The URI of the Approval resource which the operator must approve/reject.
The type of account verification that triggered review.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "accountVerificationRejected",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"accountType": "DDA",
"verificationType": "verificationProviderWidget",
"approvalUri": "https://api.devbank.apiture.com/approvals/approvals/3a890436-55de-4560-9632-9dd9f26efb72"
}
External Account Activated
External Account Activated
Fired after a user activated a verified external account.
Accepts the following message:
A user activated a verified external account.
Message body sent when a user activates a verified external account.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The account routing number which identifies the financial institution.
The user-assigned name of this external account.
Optional account verification method that was used for linking a new external account.
An abstract schema used to define other external account-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The account routing number which identifies the financial institution.
The user-assigned name of this external account.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "externalAccountActivated",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"accountType": "DDA",
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"routingNumber": "021000021",
"name": "My 3rd Party Bank Savings",
"verificationMethod": "instant"
}
Micro-Deposit Verification Started
Micro-Deposit Verification Started
Fired after user user has initiated micro-deposits verification of an external account.
Accepts the following message:
The user has initiated micro-deposits verification of an external account.
Message body sent when a user has initiated micro-deposits verification of an external account.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The account routing number which identifies the financial institution.
The user-assigned name of this external account.
An abstract schema used to define other external account-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The account routing number which identifies the financial institution.
The user-assigned name of this external account.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "microDepositVerificationStarted",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"accountType": "DDA",
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"routingNumber": "021000021",
"name": "My 3rd Party Bank Savings"
}
Micro-Deposit Deposited
Micro-Deposit Deposited
Fired after the financial institution has completed micro-deposits transaction.
Accepts the following message:
The financial institution has completed micro-deposits transaction
Message body sent when the financial institution has completed micro-deposits transaction.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The account routing number which identifies the financial institution.
The user-assigned name of this external account.
An abstract schema used to define other external account-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The account routing number which identifies the financial institution.
The user-assigned name of this external account.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "microDepositDeposited",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"accountType": "DDA",
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"routingNumber": "021000021",
"name": "My 3rd Party Bank Savings"
}
User (banking customer) successfully authenticated.
User Authentication
Fired after a user successfully authenticates.
Accepts the following message:
User (banking customer) successfully authenticated message
Message body sent when a user (banking customer) has successfully authenticated.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The login username the customer entered when attempting to authenticate.
Abstract message body used to construct other message schemas related to user authentication.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The login username the customer entered when attempting to authenticate.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "userAuthenticated",
"version": "1.2.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"username": "merkin.muffley"
}
User (banking customer) failed to authenticate.
User Authentication Failed
Fired after a user failed to authenticate.
Accepts the following message:
User (banking customer) failed to authenticate message
Message body sent when a user (banking customer) failed an authentication attempt.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The login username the customer entered when attempting to authenticate.
Abstract message body used to construct other message schemas related to user authentication.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The login username the customer entered when attempting to authenticate.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "userAuthenticationFailed",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"username": "merkin.muffley"
}
User (banking customer) attempted to authenticate (logon).
User Authentication Attempted
User (banking customer) attempted to authenticate (logon).
Accepts the following message:
User (banking customer) attempted to authenticate (logon).
User (banking customer) attempted to authenticate (logon).
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The login username the customer entered when attempting to authenticate.
Identifies what type of client platform the user was using when attempting to authenticate.
Abstract message body used to construct other message schemas related to user authentication.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The login username the customer entered when attempting to authenticate.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "userAuthenticationAttempted",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"username": "merkin.muffley",
"clientDeviceType": "mobile"
}
User (banking customer) submitted a remote check for verification and processing and depositing.
Check Submitted
User (banking customer) submitted a remote check for verification and processing and depositing.
Accepts the following message:
Customer submitted a remote check for deposit
Message body sent when a user has submitted a remote check for verification, processing and depositing.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
An abstract schema used to define other check event schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "checkSubmitted",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"checkUri": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/43d09006-a112/checks/6c87c44b-b96f",
"depositAccount": {
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"organizationId": "b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"accountType": "DDA"
},
"amount": "3456.78",
"currency": "USD",
"confirmationId": "3019489393-x7b"
}
The processor and/or financial institution has processed, validated, and accepted a remote check for deposit.
Check Accepted
The processor and/or financial institution has processed, validated, and accepted a remote check for deposit.
Accepts the following message:
The processor and/or financial institution has processed, validated, and accepted a remote check for deposit
Message body sent when the check processor has processed, validated, and accepted a remote check.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Identifies the financial institution operator or administrative user involved with the banking activity
Identifies the financial institution operator or administrative user involved with the banking activity
The operator's unique ID.
The operator's first name (or given name).
The operator's last name (or surname).
Additional properties are allowed.
An abstract schema used to define other processed check event schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Identifies the financial institution operator or administrative user involved with the banking activity
Identifies the financial institution operator or administrative user involved with the banking activity
The operator's unique ID.
The operator's first name (or given name).
The operator's last name (or surname).
Additional properties are allowed.
An abstract schema used to define other check event schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "checkAccepted",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"checkUri": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/43d09006-a112/checks/6c87c44b-b96f",
"depositAccount": {
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"organizationId": "b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"accountType": "DDA"
},
"amount": "3456.78",
"currency": "USD",
"confirmationId": "3019489393-x7b",
"operator": {
"id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"firstName": "Casey",
"lastName": "Hargrove"
}
}
The check processor has processed, validated, and accepted a remote check but adjusted the deposit amount up.
Check Accepted, Adjusted Up
The check processor has processed, validated, and accepted a remote check but adjusted the deposit amount up.
Accepts the following message:
The check processor has processed, validated, and accepted a remote check but adjusted the deposit amount up.
Message body sent when the check processor has processed, validated, and accepted a remote check but adjusted the deposit amount up.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Identifies the financial institution operator or administrative user involved with the banking activity
Identifies the financial institution operator or administrative user involved with the banking activity
The operator's unique ID.
The operator's first name (or given name).
The operator's last name (or surname).
Additional properties are allowed.
An abstract schema used to define other processed check event schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Identifies the financial institution operator or administrative user involved with the banking activity
Identifies the financial institution operator or administrative user involved with the banking activity
The operator's unique ID.
The operator's first name (or given name).
The operator's last name (or surname).
Additional properties are allowed.
An abstract schema used to define other check event schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "checkAcceptedAdjustedUp",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"checkUri": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/43d09006-a112/checks/6c87c44b-b96f",
"depositAccount": {
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"organizationId": "b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"accountType": "DDA"
},
"amount": "3456.78",
"currency": "USD",
"confirmationId": "3019489393-x7b",
"operator": {
"id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"firstName": "Casey",
"lastName": "Hargrove"
}
}
The check processor has processed, validated, and accepted a remote check but adjusted the deposit amount down.
Check Accepted, Adjusted Down
The check processor has processed, validated, and accepted a remote check but adjusted the deposit amount down.
Accepts the following message:
The check processor has processed, validated, and accepted a remote check but adjusted the deposit amount down
Message body sent when the check processor has processed, validated, and accepted a remote check but adjusted the deposit amount down.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Identifies the financial institution operator or administrative user involved with the banking activity
Identifies the financial institution operator or administrative user involved with the banking activity
The operator's unique ID.
The operator's first name (or given name).
The operator's last name (or surname).
Additional properties are allowed.
An abstract schema used to define other processed check event schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Identifies the financial institution operator or administrative user involved with the banking activity
Identifies the financial institution operator or administrative user involved with the banking activity
The operator's unique ID.
The operator's first name (or given name).
The operator's last name (or surname).
Additional properties are allowed.
An abstract schema used to define other check event schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "checkAcceptedAdjustedDown",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"checkUri": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/43d09006-a112/checks/6c87c44b-b96f",
"depositAccount": {
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"organizationId": "b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"accountType": "DDA"
},
"amount": "3456.78",
"currency": "USD",
"confirmationId": "3019489393-x7b",
"operator": {
"id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"firstName": "Casey",
"lastName": "Hargrove"
}
}
The processor and/or financial institution has rejected a remote check.
Check Rejected
The processor and/or financial institution has rejected a remote check.
Accepts the following message:
The processor and/or financial institution has rejected a remote check
Message body sent when the check processor or the financial institution has rejected a remote check.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Identifies the financial institution operator or administrative user involved with the banking activity
Identifies the financial institution operator or administrative user involved with the banking activity
The operator's unique ID.
The operator's first name (or given name).
The operator's last name (or surname).
Additional properties are allowed.
The reason the check deposit provider ir financial institution gave for rejecting a check deposit.
An abstract schema used to define other processed check event schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Identifies the financial institution operator or administrative user involved with the banking activity
Identifies the financial institution operator or administrative user involved with the banking activity
The operator's unique ID.
The operator's first name (or given name).
The operator's last name (or surname).
Additional properties are allowed.
An abstract schema used to define other check event schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "checkRejected",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"checkUri": "https://api.devbank.apiture.com/checkDeposits/checkDeposits/43d09006-a112/checks/6c87c44b-b96f",
"depositAccount": {
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"organizationId": "b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"accountType": "DDA"
},
"amount": "3456.78",
"currency": "USD",
"confirmationId": "3019489393-x7b",
"operator": {
"id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
"firstName": "Casey",
"lastName": "Hargrove"
},
"rejectReason": "signatureMissing"
}
An account owner sent an invitation to add another owner to an account.
Invitation Sent
An account owner sent an invitation to add another owner to an account.
Accepts the following message:
An account owner sent an invitation to add another owner to an account.
Message payload when an owner has sent an invitation to ask another person to join the account.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
An abstract schema used to define other account owner invitation-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "invitationSent",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"accountType": "DDA",
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/b13d0bd2-b238-4f12-a6de-0924abc6edd9",
"invitationUri": "https://api.devbank.apiture.com/invitations/invitations/48c5ab04-73a6-4a9d-a782-ff9e9a9ccb3d",
"inviterFullName": "Maxine Peck",
"inviteeFullName": "John B. Customer",
"inviteeEmailAddress": "JohnBankCustomer@example.com"
}
An invitee has accepted an invitation to add another owner to an account.
Invitation Accepted
An invitee has accepted an invitation to add another owner to an account.
Accepts the following message:
An invitee has accepted an invitation to add another owner to an account.
Message payload when an invitee has accepted an invitation to join the account.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
An abstract schema used to define other account owner invitation-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "invitationAccepted",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"accountType": "DDA",
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/b13d0bd2-b238-4f12-a6de-0924abc6edd9",
"invitationUri": "https://api.devbank.apiture.com/invitations/invitations/48c5ab04-73a6-4a9d-a782-ff9e9a9ccb3d",
"inviterFullName": "Maxine Peck",
"inviteeFullName": "John B. Customer",
"inviteeEmailAddress": "JohnBankCustomer@example.com"
}
An account owner revoked an invitation to add another owner to an account.
Invitation Revoked
An account owner revoked an invitation to add another owner to an account.
Accepts the following message:
An account owner revoked an invitation to add another owner to an account.
Message payload when an owner has revoked an invitation to ask another person to join the account.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
An abstract schema used to define other account owner invitation-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "invitationRevoked",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"accountType": "DDA",
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/b13d0bd2-b238-4f12-a6de-0924abc6edd9",
"invitationUri": "https://api.devbank.apiture.com/invitations/invitations/48c5ab04-73a6-4a9d-a782-ff9e9a9ccb3d",
"inviterFullName": "Maxine Peck",
"inviteeFullName": "John B. Customer",
"inviteeEmailAddress": "JohnBankCustomer@example.com"
}
An invitation to add another owner to an account has expired.
Invitation Expired
An invitation to add another owner to an account has expired.
Accepts the following message:
An invitation to add another owner to an account has expired.
Message payload when an invitation to ask another person to join the account has expired.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
Date-time when the application was created.
The expiration date/time of the application
An abstract schema used to define other account owner invitation-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "invitationExpired",
"version": "1.2.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"accountType": "DDA",
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/b13d0bd2-b238-4f12-a6de-0924abc6edd9",
"invitationUri": "https://api.devbank.apiture.com/invitations/invitations/48c5ab04-73a6-4a9d-a782-ff9e9a9ccb3d",
"inviterFullName": "Maxine Peck",
"inviteeFullName": "John B. Customer",
"inviteeEmailAddress": "JohnBankCustomer@example.com",
"expiredAt": "2021-08-19T06:02:12.375Z"
}
The user added a secondary account to a card.
Secondary Account Added to Card
The user added a secondary account to a card.
Accepts the following message:
The user added a secondary account to a card
The user added a secondary account to a card.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
The secondary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define other message schemas related to secondary accounts linked to a card (which allows checking account balances or making withdrawals/deposits against the secondary accounts).
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
The secondary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define other card-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "secondaryAccountAddedToCard",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"primary": {
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210"
},
"lastFour": "9999",
"cardUri": "https://api.devbank.apiture.com/cards/cards/a8d50e9f-af59-468f-ad15-ea2d4038670c",
"secondary": {
"accountId": "5705ffd9-b6d2-4dee-8264-24202f84183c",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/5705ffd9-b6d2-4dee-8264-24202f84183c",
"accountNumber": "9087654321"
}
}
The user removed a secondary account from a card.
Secondary Account Removed from Card
The user removed a secondary account from a card.
Accepts the following message:
The user removed a secondary account from a card
The user removed a secondary account from a card.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
The secondary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define other message schemas related to secondary accounts linked to a card (which allows checking account balances or making withdrawals/deposits against the secondary accounts).
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
The secondary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define other card-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "secondaryAccountRemovedFromCard",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"primary": {
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210"
},
"lastFour": "9999",
"cardUri": "https://api.devbank.apiture.com/cards/cards/a8d50e9f-af59-468f-ad15-ea2d4038670c",
"secondary": {
"accountId": "5705ffd9-b6d2-4dee-8264-24202f84183c",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/5705ffd9-b6d2-4dee-8264-24202f84183c",
"accountNumber": "9087654321"
}
}
Card Request Submitted
Card Request Submitted
Fired when an account holder requested a new or replacement debit card for an account.
Accepts the following message:
An account holder requested a new or replacement debit card for an account.
An account holder requested a new or replacement debit card for an account.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes. Present for requests to replace existing cards.
The URI of the card resource from the Cards API. Present for requests to replace existing cards.
The URI of the debit card request resource.
The reason the user is requesting a replacement card.
cardRequestReason strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
initial | Initial Card Request |
lost | Lost Card |
stolen | Stolen Card |
damaged | Damaged Card |
neverReceived | Never Received: The card holder is requesting a replacement of card that was shipped but never received. |
reorder | Reorder Closed Card: The card holder is requesting a replacement of a previously closed card. |
These enumeration values are further described by the label group
named cardRequestReason in the response from the getLabels operation.
This schema was resolved from cards/cardRequestReason.
The unique Apiture URI of the organization resource, if the corresponding account is a business account.
The name of the card issuer associated with the parameters.
An abstract schema used to define other messages event schemas related debit card requests.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes. Present for requests to replace existing cards.
The URI of the card resource from the Cards API. Present for requests to replace existing cards.
The URI of the debit card request resource.
The reason the user is requesting a replacement card.
cardRequestReason strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
initial | Initial Card Request |
lost | Lost Card |
stolen | Stolen Card |
damaged | Damaged Card |
neverReceived | Never Received: The card holder is requesting a replacement of card that was shipped but never received. |
reorder | Reorder Closed Card: The card holder is requesting a replacement of a previously closed card. |
These enumeration values are further described by the label group
named cardRequestReason in the response from the getLabels operation.
This schema was resolved from cards/cardRequestReason.
The unique Apiture URI of the organization resource, if the corresponding account is a business account.
The name of the card issuer associated with the parameters.
An abstract schema used to define other card-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "cardRequestSubmitted",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"primary": {
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210"
},
"lastFour": "9999",
"cardUri": "https://api.devbank.apiture.com/cards/cards/a8d50e9f-af59-468f-ad15-ea2d4038670c",
"cardRequestUri": "https://api.devbank.apiture.com/cards/cardRequests/1e771eae-dde8-4274-b78a-dbb9d9fa84e5",
"reason": "stolen",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"issuer": "marqeta"
}
The financial institution or card provider rejected a request for a new or replacement debit card.
Card Request Rejected
The financial institution or card provider rejected a request for a new or replacement debit card.
Accepts the following message:
The financial institution or card provider rejected a request for a new or replacement debit card.
The financial institution or card provider rejected a request for a new or replacement debit card.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes. Present for requests to replace existing cards.
The URI of the card resource from the Cards API. Present for requests to replace existing cards.
The URI of the debit card request resource.
The reason the user is requesting a replacement card.
cardRequestReason strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
initial | Initial Card Request |
lost | Lost Card |
stolen | Stolen Card |
damaged | Damaged Card |
neverReceived | Never Received: The card holder is requesting a replacement of card that was shipped but never received. |
reorder | Reorder Closed Card: The card holder is requesting a replacement of a previously closed card. |
These enumeration values are further described by the label group
named cardRequestReason in the response from the getLabels operation.
This schema was resolved from cards/cardRequestReason.
The unique Apiture URI of the organization resource, if the corresponding account is a business account.
The name of the card issuer associated with the parameters.
Text describing why the financial institution or issuer rejected the card request. This may may be an empty string.
An abstract schema used to define other messages event schemas related debit card requests.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes. Present for requests to replace existing cards.
The URI of the card resource from the Cards API. Present for requests to replace existing cards.
The URI of the debit card request resource.
The reason the user is requesting a replacement card.
cardRequestReason strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
initial | Initial Card Request |
lost | Lost Card |
stolen | Stolen Card |
damaged | Damaged Card |
neverReceived | Never Received: The card holder is requesting a replacement of card that was shipped but never received. |
reorder | Reorder Closed Card: The card holder is requesting a replacement of a previously closed card. |
These enumeration values are further described by the label group
named cardRequestReason in the response from the getLabels operation.
This schema was resolved from cards/cardRequestReason.
The unique Apiture URI of the organization resource, if the corresponding account is a business account.
The name of the card issuer associated with the parameters.
An abstract schema used to define other card-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "cardRequestRejected",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"primary": {
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210"
},
"lastFour": "9999",
"cardUri": "https://api.devbank.apiture.com/cards/cards/a8d50e9f-af59-468f-ad15-ea2d4038670c",
"cardRequestUri": "https://api.devbank.apiture.com/cards/cardRequests/1e771eae-dde8-4274-b78a-dbb9d9fa84e5",
"reason": "stolen",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"issuer": "marqeta",
"rejectionReason": "Customer changed key profile data in the last 45 days."
}
Card Ordered
Card Ordered
Fired when a card order has been accepted and approved and sent to the card issuer.
Accepts the following message:
A card order has been accepted and approved and sent to the card issuer.
An account holder requested a new or replacement debit card for an account.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes. Present for requests to replace existing cards.
The URI of the card resource from the Cards API. Present for requests to replace existing cards.
The URI of the debit card request resource.
The reason the user is requesting a replacement card.
cardRequestReason strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
initial | Initial Card Request |
lost | Lost Card |
stolen | Stolen Card |
damaged | Damaged Card |
neverReceived | Never Received: The card holder is requesting a replacement of card that was shipped but never received. |
reorder | Reorder Closed Card: The card holder is requesting a replacement of a previously closed card. |
These enumeration values are further described by the label group
named cardRequestReason in the response from the getLabels operation.
This schema was resolved from cards/cardRequestReason.
The unique Apiture URI of the organization resource, if the corresponding account is a business account.
The name of the card issuer associated with the parameters.
An abstract schema used to define other messages event schemas related debit card requests.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes. Present for requests to replace existing cards.
The URI of the card resource from the Cards API. Present for requests to replace existing cards.
The URI of the debit card request resource.
The reason the user is requesting a replacement card.
cardRequestReason strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
initial | Initial Card Request |
lost | Lost Card |
stolen | Stolen Card |
damaged | Damaged Card |
neverReceived | Never Received: The card holder is requesting a replacement of card that was shipped but never received. |
reorder | Reorder Closed Card: The card holder is requesting a replacement of a previously closed card. |
These enumeration values are further described by the label group
named cardRequestReason in the response from the getLabels operation.
This schema was resolved from cards/cardRequestReason.
The unique Apiture URI of the organization resource, if the corresponding account is a business account.
The name of the card issuer associated with the parameters.
An abstract schema used to define other card-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "cardOrdered",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"primary": {
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210"
},
"lastFour": "9999",
"cardUri": "https://api.devbank.apiture.com/cards/cards/a8d50e9f-af59-468f-ad15-ea2d4038670c",
"cardRequestUri": "https://api.devbank.apiture.com/cards/cardRequests/1e771eae-dde8-4274-b78a-dbb9d9fa84e5",
"reason": "stolen",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"issuer": "marqeta"
}
Card Closed
Card Closed
Fired when a debit card holder closed a debit card for an account.
Accepts the following message:
Card Closed
A card holder has closed their debit card to prevent use.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
An abstract schema used to define other card-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "cardClosed",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"primary": {
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210"
},
"lastFour": "9999",
"cardUri": "https://api.devbank.apiture.com/cards/cards/a8d50e9f-af59-468f-ad15-ea2d4038670c"
}
Card Locked
Card Locked
Fired when a debit card holder locked a debit card for an account to prevent use.
Accepts the following message:
Card Locked
A card holder has locked their debit card to prevent use.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
An abstract schema used to define other card-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "cardLocked",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"primary": {
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210"
},
"lastFour": "9999",
"cardUri": "https://api.devbank.apiture.com/cards/cards/a8d50e9f-af59-468f-ad15-ea2d4038670c"
}
Card Unlocked
Card Unlocked
Fired when a debit card holder unlocked a previously locked debit card for an account to allow use again.
Accepts the following message:
Card Unlocked
A card holder has unlocked their debit card to allow use.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
An abstract schema used to define other card-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "cardUnlocked",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"primary": {
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210"
},
"lastFour": "9999",
"cardUri": "https://api.devbank.apiture.com/cards/cards/a8d50e9f-af59-468f-ad15-ea2d4038670c"
}
Card Activated
Card Activated
Fired when a debit card holder activated a debit card for an account
Accepts the following message:
Card Activated
A card holder has activated their debit card.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
An abstract schema used to define other card-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "cardActivated",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"primary": {
"accountId": "d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountUri": "https://api.devbank.apiture.com/accounts/accounts/d099a4f0-7a21-44d2-90f7-b0ccb798991a",
"accountNumber": "9876543210"
},
"lastFour": "9999",
"cardUri": "https://api.devbank.apiture.com/cards/cards/a8d50e9f-af59-468f-ad15-ea2d4038670c"
}
A financial institution operator returned an account application document to the applicant so that the applicant can replace the document with a new upload.
Document Requirement Returned for Account Application
The financial institution operator returned a document to the uer for replacement.
Accepts the following message:
Document Requirement Returned for Account Application
A financial institution operator returned an account application document to the applicant so that the applicant can replace the document with a new upload.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The URI of the document.
The document type as determined by the business use case. Unlike the contentType, this indicates what the document content represents (such as a driversLicense, utilityBill, etc.).
The unique _id of the Apiture approval resource.
The URI of the approval resource from the Approvals API
The unique _id of the Apiture workflow resource that is orchestrating the document upload/approval, if it exists. The workflow may be associated with an account application or a user enrollment.
The URI of the workflow resource that is orchestrating the document upload/approval, if it exists. The workflow may be associated with an account application or a user enrollment.
Abstract schema used to construct message schemas related to account application documents.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The URI of the document.
The document type as determined by the business use case. Unlike the contentType, this indicates what the document content represents (such as a driversLicense, utilityBill, etc.).
The unique _id of the Apiture approval resource.
The URI of the approval resource from the Approvals API
The unique _id of the Apiture workflow resource that is orchestrating the document upload/approval, if it exists. The workflow may be associated with an account application or a user enrollment.
The URI of the workflow resource that is orchestrating the document upload/approval, if it exists. The workflow may be associated with an account application or a user enrollment.
An abstract schema used to define messages related to user profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "documentRequirementReturned",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"approvalId": "20544716-2fed-48da-8100-d44e5130c24d",
"approvalUri": "https://api.devbank.apiture.com/approvals/approvals/20544716-2fed-48da-8100-d44e5130c24d",
"documentUri": "https://api.devbank.apiture.com/vault/files/1fef4395-9dd3-4009-86b9-aa408f8523e7",
"documentType": "driversLicense",
"workflowId": "872af54a-abd9-42bd-a196-31e9ee889662",
"workflowUri": "https://api.devbank.apiture.com/workflow/workflows/872af54a-abd9-42bd-a196-31e9ee889662"
}
The user has uploaded a replacement document for a document that the financial institution returned.
Document Replacement Updated
The user uploaded a replacement document.
Accepts the following message:
Document Replacement Updated
A user uploaded a replacement for a document that the financial institution returned after review.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The URI of the document.
The document type as determined by the business use case. Unlike the contentType, this indicates what the document content represents (such as a driversLicense, utilityBill, etc.).
The unique _id of the Apiture approval resource.
The URI of the approval resource from the Approvals API
The unique _id of the Apiture workflow resource that is orchestrating the document upload/approval, if it exists. The workflow may be associated with an account application or a user enrollment.
The URI of the workflow resource that is orchestrating the document upload/approval, if it exists. The workflow may be associated with an account application or a user enrollment.
Abstract schema used to construct message schemas related to account application documents.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The URI of the document.
The document type as determined by the business use case. Unlike the contentType, this indicates what the document content represents (such as a driversLicense, utilityBill, etc.).
The unique _id of the Apiture approval resource.
The URI of the approval resource from the Approvals API
The unique _id of the Apiture workflow resource that is orchestrating the document upload/approval, if it exists. The workflow may be associated with an account application or a user enrollment.
The URI of the workflow resource that is orchestrating the document upload/approval, if it exists. The workflow may be associated with an account application or a user enrollment.
An abstract schema used to define messages related to user profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "documentReplacementUploaded",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"approvalId": "20544716-2fed-48da-8100-d44e5130c24d",
"approvalUri": "https://api.devbank.apiture.com/approvals/approvals/20544716-2fed-48da-8100-d44e5130c24d",
"documentUri": "https://api.devbank.apiture.com/vault/files/1fef4395-9dd3-4009-86b9-aa408f8523e7",
"documentType": "driversLicense",
"workflowId": "872af54a-abd9-42bd-a196-31e9ee889662",
"workflowUri": "https://api.devbank.apiture.com/workflow/workflows/872af54a-abd9-42bd-a196-31e9ee889662"
}
A new financial institution operator case was created
Case Created
A new financial institution operator case was created.
Accepts the following message:
Case Created
Event message describing a newly created case.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator actions.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "caseCreated",
"version": "1.0.0",
"operator": {
"id": "4b18c6ea-77ee-489032",
"uri": "https://api.devbank.apiture.com/operators/operators/4b18c6ea-77ee-489032",
"ipAddress": "18.234.18.250"
},
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"case": {
"id": "9e37266e-1982-45db-8a15-cb8f878c6c51",
"uri": "https://api.devbank.apiture.com/cases/cases/9e37266e-1982-45db-8a15-cb8f878c6c51",
"number": 76908,
"type": "accountApplicationReview",
"businessObjectUri": "https://api.banking.apiture.com/accountApplications/applications/95dde7bc-a545-405e-8769-d8207d732630"
}
}
A new financial institution operator case was closed
Case Closed
A new financial institution operator case was closed.
Accepts the following message:
Case Closed
Event message describing a recently closed case.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
The ID of the operator the case is assigned to.
Abstract schema used to construct message schemas related to assigned financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
The ID of the operator the case is assigned to.
Abstract schema used to construct message schemas related to financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator actions.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "caseClosed",
"version": "1.0.0",
"operator": {
"id": "4b18c6ea-77ee-489032",
"uri": "https://api.devbank.apiture.com/operators/operators/4b18c6ea-77ee-489032",
"ipAddress": "18.234.18.250"
},
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"case": {
"id": "9e37266e-1982-45db-8a15-cb8f878c6c51",
"uri": "https://api.devbank.apiture.com/cases/cases/9e37266e-1982-45db-8a15-cb8f878c6c51",
"number": 76908,
"type": "accountApplicationReview",
"businessObjectUri": "https://api.banking.apiture.com/accountApplications/applications/95dde7bc-a545-405e-8769-d8207d732630"
},
"assigneeId": "9e37266e-1982-45db-8a15-cb8f878c6c51"
}
A financial institution operator case was canceled.
Case Canceled
A financial institution operator case was canceled.
Accepts the following message:
A financial institution operator case was canceled.
A financial institution operator case was canceled.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
The ID of the operator the case is assigned to.
Abstract schema used to construct message schemas related to assigned financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
The ID of the operator the case is assigned to.
Abstract schema used to construct message schemas related to financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator actions.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "caseCanceled",
"version": "1.0.0",
"operator": {
"id": "4b18c6ea-77ee-489032",
"uri": "https://api.devbank.apiture.com/operators/operators/4b18c6ea-77ee-489032",
"ipAddress": "18.234.18.250"
},
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"case": {
"id": "9e37266e-1982-45db-8a15-cb8f878c6c51",
"uri": "https://api.devbank.apiture.com/cases/cases/9e37266e-1982-45db-8a15-cb8f878c6c51",
"number": 76908,
"type": "accountApplicationReview",
"businessObjectUri": "https://api.banking.apiture.com/accountApplications/applications/95dde7bc-a545-405e-8769-d8207d732630"
},
"assigneeId": "9e37266e-1982-45db-8a15-cb8f878c6c51"
}
A financial institution operator case expired.
Case Expired
A financial institution operator case expired.
Accepts the following message:
A financial institution operator case expired.
A financial institution operator case expired.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
The ID of the operator the case is assigned to.
Abstract schema used to construct message schemas related to assigned financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
The ID of the operator the case is assigned to.
Abstract schema used to construct message schemas related to financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator actions.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "caseExpired",
"version": "1.0.0",
"operator": {
"id": "4b18c6ea-77ee-489032",
"uri": "https://api.devbank.apiture.com/operators/operators/4b18c6ea-77ee-489032",
"ipAddress": "18.234.18.250"
},
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"case": {
"id": "9e37266e-1982-45db-8a15-cb8f878c6c51",
"uri": "https://api.devbank.apiture.com/cases/cases/9e37266e-1982-45db-8a15-cb8f878c6c51",
"number": 76908,
"type": "accountApplicationReview",
"businessObjectUri": "https://api.banking.apiture.com/accountApplications/applications/95dde7bc-a545-405e-8769-d8207d732630"
},
"assigneeId": "9e37266e-1982-45db-8a15-cb8f878c6c51"
}
A financial institution operator case was assigned to an operator.
Case Assigned
A financial institution operator case was assigned to an operator.
Accepts the following message:
A financial institution operator case was assigned to an operator.
A financial institution operator case was assigned to an operator.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
The ID of the operator the case is assigned to.
Abstract schema used to construct message schemas related to assigned financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
The ID of the operator the case is assigned to.
Abstract schema used to construct message schemas related to financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator actions.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "caseAssigned",
"version": "1.0.0",
"operator": {
"id": "4b18c6ea-77ee-489032",
"uri": "https://api.devbank.apiture.com/operators/operators/4b18c6ea-77ee-489032",
"ipAddress": "18.234.18.250"
},
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"case": {
"id": "9e37266e-1982-45db-8a15-cb8f878c6c51",
"uri": "https://api.devbank.apiture.com/cases/cases/9e37266e-1982-45db-8a15-cb8f878c6c51",
"number": 76908,
"type": "accountApplicationReview",
"businessObjectUri": "https://api.banking.apiture.com/accountApplications/applications/95dde7bc-a545-405e-8769-d8207d732630"
},
"assigneeId": "9e37266e-1982-45db-8a15-cb8f878c6c51"
}
A financial institution operator case was unassigned.
Case Unassigned
A financial institution operator case was unassigned.
Accepts the following message:
A financial institution operator case was unassigned.
A financial institution operator case was unassigned.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator actions.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "caseUnassigned",
"version": "1.0.0",
"operator": {
"id": "4b18c6ea-77ee-489032",
"uri": "https://api.devbank.apiture.com/operators/operators/4b18c6ea-77ee-489032",
"ipAddress": "18.234.18.250"
},
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"case": {
"id": "9e37266e-1982-45db-8a15-cb8f878c6c51",
"uri": "https://api.devbank.apiture.com/cases/cases/9e37266e-1982-45db-8a15-cb8f878c6c51",
"number": 76908,
"type": "accountApplicationReview",
"businessObjectUri": "https://api.banking.apiture.com/accountApplications/applications/95dde7bc-a545-405e-8769-d8207d732630"
}
}
A message was sent for a financial institution operator case.
Case Message Sent
A message was sent for a financial institution operator case.
Accepts the following message:
A message was sent for a financial institution operator case.
A message was sent for a financial institution operator case.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Identifies a message associated with a financial institution operator case.
The _id of the message resource from the Messages API.
The URI of the case message.
Indicates the type of user who created the message, and by inference, who the message recipient is. If the author is customer, then the recipient is the operator; if the author is operator, then the recipient is the customer.
messageAuthorType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
customer | Customer: This message was written by the customer |
operator | Operator: This message was written by a financial institution operator. |
This schema was resolved from messages/messageAuthorType.
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator actions.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "caseMessageSent",
"version": "1.0.0",
"operator": {
"id": "4b18c6ea-77ee-489032",
"uri": "https://api.devbank.apiture.com/operators/operators/4b18c6ea-77ee-489032",
"ipAddress": "18.234.18.250"
},
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"case": {
"id": "9e37266e-1982-45db-8a15-cb8f878c6c51",
"uri": "https://api.devbank.apiture.com/cases/cases/9e37266e-1982-45db-8a15-cb8f878c6c51",
"number": 76908,
"type": "accountApplicationReview",
"businessObjectUri": "https://api.banking.apiture.com/accountApplications/applications/95dde7bc-a545-405e-8769-d8207d732630"
},
"message": {
"id": "6df3a1c1-4290-43e1-90ff-bfca3f353e15",
"uri": "https://api.devbank.apiture.com/messages/messages/6df3a1c1-4290-43e1-90ff-bfca3f353e15",
"authorType": "operator"
}
}
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define messages related to user profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
User (banking customer) changed their preferred phone number.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The phone number, as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is +1. Phone numbers are in E.164 format with a leading +, country code (up to 3 digits) and subscriber number.
An abstract schema used to define messages related to user profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
User (banking customer) changed their preferred email address.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The user's new preferred email address, as a string.
An abstract schema used to define messages related to user profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
User (banking customer) changed their preferred email address.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The user's new preferred mailing address.
A postal address with the address type and an identifier.
This schema was resolved from contacts/address.
The first street address line of the address, normally a house number and street name.
The optional second street address line of the address.
The name of the city or municipality.
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.
The type of this address.
The type of a postal address.
Warning: The enum list will be removed in a future release.
The allowed values for this property are defined at runtime in the
label group named addressType
in the response from the getLabels operation.
This schema was resolved from contacts/addressType.
A text label, suitable for presentation to the end user. This is derived from type or from otherType if type is other
The actual address type if type is other.
An identifier for this address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all addresses within the addresses array.
The first street address line of the address, normally a house number and street name.
The optional second street address line of the address.
The name of the city or municipality.
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define messages related to user profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
User (banking customer) changed their preferred email address.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The user's new preferred email address.
The first street address line of the address, normally a house number and street name.
The optional second street address line of the address.
The name of the city or municipality.
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define messages related to user profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The user created a new address in additional their preferred mailing address.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The user's new address.
The first street address line of the address, normally a house number and street name.
The optional second street address line of the address.
The name of the city or municipality.
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define messages related to user profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A user changed their W-9 tax withholdings status. true indicates the user is subject to backup W-9 tax withholdings.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The user's new withholding setting.
An abstract schema used to define messages related to user profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define other message schemas related to account applications.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
A user (banking customer) has started an account application for review/approval.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
An abstract schema used to define other message schemas related to account applications.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An account application has been approved, either automatically or by the financial institution.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
The URI of the Approval resource which the financial institution reviewed and approved. May not exist if the application was auto-approved.
An abstract schema used to define other message schemas related to account applications.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An account application has become blocked.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
An abstract schema used to define other message schemas related to account applications.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A user (banking customer) has canceled an account application.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
An abstract schema used to define other message schemas related to account applications.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A user's account application has expired
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
Date-time when the application was created
The expiration date/time of the application
An abstract schema used to define other message schemas related to account applications.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An account application was flagged for review by the financial institution.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
An abstract schema used to define other message schemas related to account applications.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account application resource.
The URI of the Apiture account application resource.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define other message schemas related to joint owner or authorized signer enrollments.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account enrollment resource.
The URI of the Apiture account enrollment resource.
The account(s) the user is joining as joint owner or authorized signer.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
A user (banking customer) has canceled their enrollment as an account joint owner or authorized signer.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account enrollment resource.
The URI of the Apiture account enrollment resource.
The account(s) the user is joining as joint owner or authorized signer.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
An abstract schema used to define other message schemas related to joint owner or authorized signer enrollments.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account enrollment resource.
The URI of the Apiture account enrollment resource.
The account(s) the user is joining as joint owner or authorized signer.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A user's enrollment as an account joint owner or authorized signer has expired,
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account enrollment resource.
The URI of the Apiture account enrollment resource.
The account(s) the user is joining as joint owner or authorized signer.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
Date-time when the application was created.
The expiration date/time of the enrollment.
An abstract schema used to define other message schemas related to joint owner or authorized signer enrollments.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique resource _id of the Apiture account enrollment resource.
The URI of the Apiture account enrollment resource.
The account(s) the user is joining as joint owner or authorized signer.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Properties of messages referencing a banking product by IFX type.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique _id of the Apiture banking product resource.
The URI of the Apiture banking product resource.
The name of the banking product.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define other account-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource, if the event is for a business account context. Omitted if the account is a personal account.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define other external account-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The account routing number which identifies the financial institution.
The user-assigned name of this external account.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A banking customer successfully opened a new account.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource, if the event is for a business account context. Omitted if the account is a personal account.
An abstract schema used to define other account-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource, if the event is for a business account context. Omitted if the account is a personal account.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A banking account was closed.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource, if the event is for a business account context. Omitted if the account is a personal account.
An abstract schema used to define other account-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource, if the event is for a business account context. Omitted if the account is a personal account.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A banking account resource was updated.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource, if the event is for a business account context. Omitted if the account is a personal account.
An abstract schema used to define other account-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource, if the event is for a business account context. Omitted if the account is a personal account.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A banking account's CD Maturity Settings resource were updated.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource, if the event is for a business account context. Omitted if the account is a personal account.
If the account to transfer the account balance upon maturity has changed, this object is present and contains the target account details.
Is the transfer account internal or external.
The unique full account number of the account.
The account routing number which identifies the financial institution.
Additional properties are allowed.
An abstract schema used to define other account-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource, if the event is for a business account context. Omitted if the account is a personal account.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A banking account's CD Maturity Settings resource were updated.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource, if the event is for a business account context. Omitted if the account is a personal account.
If the account to disburse earned interest for a CD account has changed, this object is present and contains the target account details.
Is the interest disbursement account internal or external.
The unique full account number of the account.
The account routing number which identifies the financial institution.
Additional properties are allowed.
An abstract schema used to define other account-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource, if the event is for a business account context. Omitted if the account is a personal account.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define other account verification schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The URI of the Approval resource which the operator must approve/reject.
The type of account verification that triggered review.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Message body sent when a user's attempt to link an external account triggered review.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The URI of the Approval resource which the operator must approve/reject.
The type of account verification that triggered review.
An abstract schema used to define other account verification schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The URI of the Approval resource which the operator must approve/reject.
The type of account verification that triggered review.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Message body sent when an operator approved an external account that was under review.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The URI of the Approval resource which the operator must approve/reject.
The type of account verification that triggered review.
An abstract schema used to define other account verification schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The URI of the Approval resource which the operator must approve/reject.
The type of account verification that triggered review.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Message body sent when an operator rejected an external account that was under review.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The URI of the Approval resource which the operator must approve/reject.
The type of account verification that triggered review.
An abstract schema used to define other account verification schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The URI of the Approval resource which the operator must approve/reject.
The type of account verification that triggered review.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Message body sent when a user activates a verified external account.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The account routing number which identifies the financial institution.
The user-assigned name of this external account.
Optional account verification method that was used for linking a new external account.
An abstract schema used to define other external account-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The account routing number which identifies the financial institution.
The user-assigned name of this external account.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Message body sent when a user has initiated micro-deposits verification of an external account.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The account routing number which identifies the financial institution.
The user-assigned name of this external account.
An abstract schema used to define other external account-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The account routing number which identifies the financial institution.
The user-assigned name of this external account.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Message body sent when the financial institution has completed micro-deposits transaction.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The account routing number which identifies the financial institution.
The user-assigned name of this external account.
An abstract schema used to define other external account-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The account routing number which identifies the financial institution.
The user-assigned name of this external account.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
User (banking customer) completed an invitation to become a joint owner on a personal account.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
An abstract schema used to define other account owner invitation-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
User (banking customer) completed an invitation to become an authorized signer on a business account.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
An abstract schema used to define other account owner invitation-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Abstract message body used to construct other message schemas related to user authentication.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The login username the customer entered when attempting to authenticate.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Message body sent when a user (banking customer) has successfully authenticated.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The login username the customer entered when attempting to authenticate.
Abstract message body used to construct other message schemas related to user authentication.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The login username the customer entered when attempting to authenticate.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Message body sent when a user (banking customer) failed an authentication attempt.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The login username the customer entered when attempting to authenticate.
Abstract message body used to construct other message schemas related to user authentication.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The login username the customer entered when attempting to authenticate.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
User (banking customer) attempted to authenticate (logon).
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The login username the customer entered when attempting to authenticate.
Identifies what type of client platform the user was using when attempting to authenticate.
Abstract message body used to construct other message schemas related to user authentication.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The login username the customer entered when attempting to authenticate.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define other check event schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Message body sent when a user has submitted a remote check for verification, processing and depositing.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
An abstract schema used to define other check event schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Identifies the financial institution operator or administrative user involved with the banking activity
The operator's unique ID.
The operator's first name (or given name).
The operator's last name (or surname).
Additional properties are allowed.
An abstract schema used to define other processed check event schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Identifies the financial institution operator or administrative user involved with the banking activity
Identifies the financial institution operator or administrative user involved with the banking activity
The operator's unique ID.
The operator's first name (or given name).
The operator's last name (or surname).
Additional properties are allowed.
An abstract schema used to define other check event schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Message body sent when the check processor has processed, validated, and accepted a remote check.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Identifies the financial institution operator or administrative user involved with the banking activity
Identifies the financial institution operator or administrative user involved with the banking activity
The operator's unique ID.
The operator's first name (or given name).
The operator's last name (or surname).
Additional properties are allowed.
An abstract schema used to define other processed check event schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Identifies the financial institution operator or administrative user involved with the banking activity
Identifies the financial institution operator or administrative user involved with the banking activity
The operator's unique ID.
The operator's first name (or given name).
The operator's last name (or surname).
Additional properties are allowed.
An abstract schema used to define other check event schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Message body sent when the check processor has processed, validated, and accepted a remote check but adjusted the deposit amount up.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Identifies the financial institution operator or administrative user involved with the banking activity
Identifies the financial institution operator or administrative user involved with the banking activity
The operator's unique ID.
The operator's first name (or given name).
The operator's last name (or surname).
Additional properties are allowed.
An abstract schema used to define other processed check event schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Identifies the financial institution operator or administrative user involved with the banking activity
Identifies the financial institution operator or administrative user involved with the banking activity
The operator's unique ID.
The operator's first name (or given name).
The operator's last name (or surname).
Additional properties are allowed.
An abstract schema used to define other check event schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Message body sent when the check processor has processed, validated, and accepted a remote check but adjusted the deposit amount down.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Identifies the financial institution operator or administrative user involved with the banking activity
Identifies the financial institution operator or administrative user involved with the banking activity
The operator's unique ID.
The operator's first name (or given name).
The operator's last name (or surname).
Additional properties are allowed.
An abstract schema used to define other processed check event schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Identifies the financial institution operator or administrative user involved with the banking activity
Identifies the financial institution operator or administrative user involved with the banking activity
The operator's unique ID.
The operator's first name (or given name).
The operator's last name (or surname).
Additional properties are allowed.
An abstract schema used to define other check event schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Message body sent when the check processor or the financial institution has rejected a remote check.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Identifies the financial institution operator or administrative user involved with the banking activity
Identifies the financial institution operator or administrative user involved with the banking activity
The operator's unique ID.
The operator's first name (or given name).
The operator's last name (or surname).
Additional properties are allowed.
The reason the check deposit provider ir financial institution gave for rejecting a check deposit.
An abstract schema used to define other processed check event schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Identifies the financial institution operator or administrative user involved with the banking activity
Identifies the financial institution operator or administrative user involved with the banking activity
The operator's unique ID.
The operator's first name (or given name).
The operator's last name (or surname).
Additional properties are allowed.
An abstract schema used to define other check event schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The account where the check is to be deposited.
The target account where a check or batch of checks are deposited.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
The monetary value of the check deposit. The numeric value is represented as a string so that it can be exact with no loss of precision.
The ISO 4217 currency code for this check deposit. This is always upper case ASCII.
An optional confirmation code returned by the check deposit processor.
The URI of the corresponding check resource from the Check Deposits API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define messages related to organization profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
User (banking customer) changed the organization's preferred phone number.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The phone number, as a string. The service strips all spaces, hyphens, periods and parentheses from input. The default country code prefix is +1. Phone numbers are in E.164 format with a leading +, country code (up to 3 digits) and subscriber number.
An abstract schema used to define messages related to organization profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
User (banking customer) changed the organization's preferred email address.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The organization's new preferred email address, as a string.
An abstract schema used to define messages related to organization profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
User (banking customer) changed the organization's preferred email address.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The organization's new preferred mailing address.
A postal address with the address type and an identifier.
This schema was resolved from contacts/address.
The first street address line of the address, normally a house number and street name.
The optional second street address line of the address.
The name of the city or municipality.
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.
The type of this address.
The type of a postal address.
Warning: The enum list will be removed in a future release.
The allowed values for this property are defined at runtime in the
label group named addressType
in the response from the getLabels operation.
This schema was resolved from contacts/addressType.
A text label, suitable for presentation to the end user. This is derived from type or from otherType if type is other
The actual address type if type is other.
An identifier for this address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all addresses within the addresses array.
The first street address line of the address, normally a house number and street name.
The optional second street address line of the address.
The name of the city or municipality.
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define messages related to organization profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
User (banking customer) changed the organization's preferred email address.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The organization's new preferred email address.
The first street address line of the address, normally a house number and street name.
The optional second street address line of the address.
The name of the city or municipality.
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define messages related to organization profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The user created a new address in additional the organization's preferred mailing address.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The organization's new address.
The first street address line of the address, normally a house number and street name.
The optional second street address line of the address.
The name of the city or municipality.
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define messages related to organization profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A user changed the organization's W-9 tax withholdings status. true indicates the organization is subject to backup W-9 tax withholdings.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The organization's new withholding setting.
An abstract schema used to define messages related to organization profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A user changed the organization's home website URL.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The organization's new business website URL.
An abstract schema used to define messages related to organization profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define other account owner invitation-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Message payload when an owner has sent an invitation to ask another person to join the account.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
An abstract schema used to define other account owner invitation-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Message payload when an invitee has accepted an invitation to join the account.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
An abstract schema used to define other account owner invitation-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Message payload when an owner has revoked an invitation to ask another person to join the account.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
An abstract schema used to define other account owner invitation-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Message payload when an invitation to ask another person to join the account has expired.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
Date-time when the application was created.
The expiration date/time of the application
An abstract schema used to define other account owner invitation-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
The unique Apiture URI of the invitation resource.
The full name of the user sending the invitation.
The full name of the invitee.
The email address of the invitee.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Properties which identify an organization in event messages possibly related to an organization.
The unique Apiture _id of the organization resource.
The unique Apiture URI of the organization resource.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define other card-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define other message schemas related to secondary accounts linked to a card (which allows checking account balances or making withdrawals/deposits against the secondary accounts).
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
The secondary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define other card-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The user added a secondary account to a card.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
The secondary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define other message schemas related to secondary accounts linked to a card (which allows checking account balances or making withdrawals/deposits against the secondary accounts).
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
The secondary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define other card-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The user removed a secondary account from a card.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
The secondary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define other message schemas related to secondary accounts linked to a card (which allows checking account balances or making withdrawals/deposits against the secondary accounts).
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
The secondary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define other card-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An abstract schema used to define other messages event schemas related debit card requests.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes. Present for requests to replace existing cards.
The URI of the card resource from the Cards API. Present for requests to replace existing cards.
The URI of the debit card request resource.
The reason the user is requesting a replacement card.
cardRequestReason strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
initial | Initial Card Request |
lost | Lost Card |
stolen | Stolen Card |
damaged | Damaged Card |
neverReceived | Never Received: The card holder is requesting a replacement of card that was shipped but never received. |
reorder | Reorder Closed Card: The card holder is requesting a replacement of a previously closed card. |
These enumeration values are further described by the label group
named cardRequestReason in the response from the getLabels operation.
This schema was resolved from cards/cardRequestReason.
The unique Apiture URI of the organization resource, if the corresponding account is a business account.
The name of the card issuer associated with the parameters.
An abstract schema used to define other card-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An account holder requested a new or replacement debit card for an account.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes. Present for requests to replace existing cards.
The URI of the card resource from the Cards API. Present for requests to replace existing cards.
The URI of the debit card request resource.
The reason the user is requesting a replacement card.
cardRequestReason strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
initial | Initial Card Request |
lost | Lost Card |
stolen | Stolen Card |
damaged | Damaged Card |
neverReceived | Never Received: The card holder is requesting a replacement of card that was shipped but never received. |
reorder | Reorder Closed Card: The card holder is requesting a replacement of a previously closed card. |
These enumeration values are further described by the label group
named cardRequestReason in the response from the getLabels operation.
This schema was resolved from cards/cardRequestReason.
The unique Apiture URI of the organization resource, if the corresponding account is a business account.
The name of the card issuer associated with the parameters.
An abstract schema used to define other messages event schemas related debit card requests.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes. Present for requests to replace existing cards.
The URI of the card resource from the Cards API. Present for requests to replace existing cards.
The URI of the debit card request resource.
The reason the user is requesting a replacement card.
cardRequestReason strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
initial | Initial Card Request |
lost | Lost Card |
stolen | Stolen Card |
damaged | Damaged Card |
neverReceived | Never Received: The card holder is requesting a replacement of card that was shipped but never received. |
reorder | Reorder Closed Card: The card holder is requesting a replacement of a previously closed card. |
These enumeration values are further described by the label group
named cardRequestReason in the response from the getLabels operation.
This schema was resolved from cards/cardRequestReason.
The unique Apiture URI of the organization resource, if the corresponding account is a business account.
The name of the card issuer associated with the parameters.
An abstract schema used to define other card-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The financial institution or card provider rejected a request for a new or replacement debit card.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes. Present for requests to replace existing cards.
The URI of the card resource from the Cards API. Present for requests to replace existing cards.
The URI of the debit card request resource.
The reason the user is requesting a replacement card.
cardRequestReason strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
initial | Initial Card Request |
lost | Lost Card |
stolen | Stolen Card |
damaged | Damaged Card |
neverReceived | Never Received: The card holder is requesting a replacement of card that was shipped but never received. |
reorder | Reorder Closed Card: The card holder is requesting a replacement of a previously closed card. |
These enumeration values are further described by the label group
named cardRequestReason in the response from the getLabels operation.
This schema was resolved from cards/cardRequestReason.
The unique Apiture URI of the organization resource, if the corresponding account is a business account.
The name of the card issuer associated with the parameters.
Text describing why the financial institution or issuer rejected the card request. This may may be an empty string.
An abstract schema used to define other messages event schemas related debit card requests.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes. Present for requests to replace existing cards.
The URI of the card resource from the Cards API. Present for requests to replace existing cards.
The URI of the debit card request resource.
The reason the user is requesting a replacement card.
cardRequestReason strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
initial | Initial Card Request |
lost | Lost Card |
stolen | Stolen Card |
damaged | Damaged Card |
neverReceived | Never Received: The card holder is requesting a replacement of card that was shipped but never received. |
reorder | Reorder Closed Card: The card holder is requesting a replacement of a previously closed card. |
These enumeration values are further described by the label group
named cardRequestReason in the response from the getLabels operation.
This schema was resolved from cards/cardRequestReason.
The unique Apiture URI of the organization resource, if the corresponding account is a business account.
The name of the card issuer associated with the parameters.
An abstract schema used to define other card-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
An account holder requested a new or replacement debit card for an account.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes. Present for requests to replace existing cards.
The URI of the card resource from the Cards API. Present for requests to replace existing cards.
The URI of the debit card request resource.
The reason the user is requesting a replacement card.
cardRequestReason strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
initial | Initial Card Request |
lost | Lost Card |
stolen | Stolen Card |
damaged | Damaged Card |
neverReceived | Never Received: The card holder is requesting a replacement of card that was shipped but never received. |
reorder | Reorder Closed Card: The card holder is requesting a replacement of a previously closed card. |
These enumeration values are further described by the label group
named cardRequestReason in the response from the getLabels operation.
This schema was resolved from cards/cardRequestReason.
The unique Apiture URI of the organization resource, if the corresponding account is a business account.
The name of the card issuer associated with the parameters.
An abstract schema used to define other messages event schemas related debit card requests.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes. Present for requests to replace existing cards.
The URI of the card resource from the Cards API. Present for requests to replace existing cards.
The URI of the debit card request resource.
The reason the user is requesting a replacement card.
cardRequestReason strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
initial | Initial Card Request |
lost | Lost Card |
stolen | Stolen Card |
damaged | Damaged Card |
neverReceived | Never Received: The card holder is requesting a replacement of card that was shipped but never received. |
reorder | Reorder Closed Card: The card holder is requesting a replacement of a previously closed card. |
These enumeration values are further described by the label group
named cardRequestReason in the response from the getLabels operation.
This schema was resolved from cards/cardRequestReason.
The unique Apiture URI of the organization resource, if the corresponding account is a business account.
The name of the card issuer associated with the parameters.
An abstract schema used to define other card-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A card holder has locked their debit card to prevent use.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
An abstract schema used to define other card-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A card holder has unlocked their debit card to allow use.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
An abstract schema used to define other card-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A card holder has closed their debit card to prevent use.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
An abstract schema used to define other card-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A card holder has activated their debit card.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
An abstract schema used to define other card-related message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The primary account the card is associated with.
Properties of messages referencing a banking account.
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The unique Apiture _id of the account resource.
The unique full account number of the account.
The URI of the Apiture account resource.
A property for an account type
A code which identifies the product/account type. This is one of the IFX AcctType values.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
The last four digits of the card number, for identification purposes.
The URI of the card resource from the Cards API.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Message conveying a user changed their SMS communication option.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
false if the user has explicitly opted out of receiving SMS text messages from the financial institution for notification of banking or related activity. This value reflects the user's most recent opt in/opt out selection.
An abstract schema used to define messages related to user profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Abstract schema used to construct message schemas related to account application documents.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The URI of the document.
The document type as determined by the business use case. Unlike the contentType, this indicates what the document content represents (such as a driversLicense, utilityBill, etc.).
The unique _id of the Apiture approval resource.
The URI of the approval resource from the Approvals API
The unique _id of the Apiture workflow resource that is orchestrating the document upload/approval, if it exists. The workflow may be associated with an account application or a user enrollment.
The URI of the workflow resource that is orchestrating the document upload/approval, if it exists. The workflow may be associated with an account application or a user enrollment.
An abstract schema used to define messages related to user profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A financial institution operator returned an account application document to the applicant so that the applicant can replace the document with a new upload.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The URI of the document.
The document type as determined by the business use case. Unlike the contentType, this indicates what the document content represents (such as a driversLicense, utilityBill, etc.).
The unique _id of the Apiture approval resource.
The URI of the approval resource from the Approvals API
The unique _id of the Apiture workflow resource that is orchestrating the document upload/approval, if it exists. The workflow may be associated with an account application or a user enrollment.
The URI of the workflow resource that is orchestrating the document upload/approval, if it exists. The workflow may be associated with an account application or a user enrollment.
Abstract schema used to construct message schemas related to account application documents.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The URI of the document.
The document type as determined by the business use case. Unlike the contentType, this indicates what the document content represents (such as a driversLicense, utilityBill, etc.).
The unique _id of the Apiture approval resource.
The URI of the approval resource from the Approvals API
The unique _id of the Apiture workflow resource that is orchestrating the document upload/approval, if it exists. The workflow may be associated with an account application or a user enrollment.
The URI of the workflow resource that is orchestrating the document upload/approval, if it exists. The workflow may be associated with an account application or a user enrollment.
An abstract schema used to define messages related to user profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A user uploaded a replacement for a document that the financial institution returned after review.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The URI of the document.
The document type as determined by the business use case. Unlike the contentType, this indicates what the document content represents (such as a driversLicense, utilityBill, etc.).
The unique _id of the Apiture approval resource.
The URI of the approval resource from the Approvals API
The unique _id of the Apiture workflow resource that is orchestrating the document upload/approval, if it exists. The workflow may be associated with an account application or a user enrollment.
The URI of the workflow resource that is orchestrating the document upload/approval, if it exists. The workflow may be associated with an account application or a user enrollment.
Abstract schema used to construct message schemas related to account application documents.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
The URI of the document.
The document type as determined by the business use case. Unlike the contentType, this indicates what the document content represents (such as a driversLicense, utilityBill, etc.).
The unique _id of the Apiture approval resource.
The URI of the approval resource from the Approvals API
The unique _id of the Apiture workflow resource that is orchestrating the document upload/approval, if it exists. The workflow may be associated with an account application or a user enrollment.
The URI of the workflow resource that is orchestrating the document upload/approval, if it exists. The workflow may be associated with an account application or a user enrollment.
An abstract schema used to define messages related to user profile changes.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator actions.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator actions.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Abstract schema used to construct message schemas related to assigned financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
The ID of the operator the case is assigned to.
Abstract schema used to construct message schemas related to financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator actions.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Event message describing a newly created case.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator actions.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Event message describing a recently closed case.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
The ID of the operator the case is assigned to.
Abstract schema used to construct message schemas related to assigned financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
The ID of the operator the case is assigned to.
Abstract schema used to construct message schemas related to financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator actions.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A financial institution operator case was canceled.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
The ID of the operator the case is assigned to.
Abstract schema used to construct message schemas related to assigned financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
The ID of the operator the case is assigned to.
Abstract schema used to construct message schemas related to financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator actions.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A financial institution operator case expired.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
The ID of the operator the case is assigned to.
Abstract schema used to construct message schemas related to assigned financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
The ID of the operator the case is assigned to.
Abstract schema used to construct message schemas related to financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator actions.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A financial institution operator case was assigned to an operator.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
The ID of the operator the case is assigned to.
Abstract schema used to construct message schemas related to assigned financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
The ID of the operator the case is assigned to.
Abstract schema used to construct message schemas related to financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator actions.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A financial institution operator case was unassigned.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator actions.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Identifies a message associated with a financial institution operator case.
The _id of the message resource from the Messages API.
The URI of the case message.
Indicates the type of user who created the message, and by inference, who the message recipient is. If the author is customer, then the recipient is the operator; if the author is operator, then the recipient is the customer.
messageAuthorType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
customer | Customer: This message was written by the customer |
operator | Operator: This message was written by a financial institution operator. |
This schema was resolved from messages/messageAuthorType.
Additional properties are allowed.
A message was sent for a financial institution operator case.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Identifies a message associated with a financial institution operator case.
The _id of the message resource from the Messages API.
The URI of the case message.
Indicates the type of user who created the message, and by inference, who the message recipient is. If the author is customer, then the recipient is the operator; if the author is operator, then the recipient is the customer.
messageAuthorType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
customer | Customer: This message was written by the customer |
operator | Operator: This message was written by a financial institution operator. |
This schema was resolved from messages/messageAuthorType.
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator cases.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Summary properties of a financial institution operator case.
The unique _id of the Apiture case resource.
The URI of the case.
This case's sequential number, for easy reference.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
The URI of a resource that this case pertains to. This must be a URI within the deployed Apiture system (the hostname must match the services' API host, such as https://api.thirdpartybank.apiture.com/).
Additional properties are allowed.
Abstract schema used to construct message schemas related to financial institution operator actions.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The financial institution operator who performed the action. Omitted if performed by the system instead of an operator.
Properties of a financial institution operator.
The unique Apiture _id of the operator who performed the action that triggered this event.
The URI of the Apiture operator resource.
The IP address of the device the operator was using when performing an action. This is omitted if not available or known.
Additional properties are allowed.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
The unique Apiture _id of the user who performed the action that triggered this event.
The URI of the Apiture user resource.
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.
Base abstract schema for all event message schemas.
The unique ID of this event. This is an opaque string.
The message type. This is the name of the message schema.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
A postal address with the address type and an identifier.
This schema was resolved from contacts/address.
The first street address line of the address, normally a house number and street name.
The optional second street address line of the address.
The name of the city or municipality.
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.
The type of this address.
The type of a postal address.
Warning: The enum list will be removed in a future release.
The allowed values for this property are defined at runtime in the
label group named addressType
in the response from the getLabels operation.
This schema was resolved from contacts/addressType.
A text label, suitable for presentation to the end user. This is derived from type or from otherType if type is other
The actual address type if type is other.
An identifier for this address, so that it can be referenced uniquely. The service will assign a unique _id if the client does not provide one. The _id must be unique across all addresses within the addresses array.
The first street address line of the address, normally a house number and street name.
The optional second street address line of the address.
The name of the city or municipality.
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.
Additional properties are allowed.
Additional properties are allowed.
The first street address line of the address, normally a house number and street name.
The optional second street address line of the address.
The name of the city or municipality.
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.
Additional properties are allowed.
A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.
ifxType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
CCA | Credit card account |
CDA | Certificate of deposit account (CD) |
CLA | Commercial loan account |
CMA | Cash management account |
DDA | Demand deposit account |
EQU | Home equity loan |
GLA | General ledger account |
ILA | Installment loan account |
INV | Investment account |
IRA | Individual retirement account |
IRL | Accounts held in Ireland |
LOC | Consumer line of credit |
MLA | Military Lending Account: Credit facility held by former US service member |
MMA | Money market account |
PBA | Packaged bank Account: Account with additional benefits that charges a fixed monthly fee. |
PPA | Private pension administrator |
RWD | Reward accounts |
SDA | Savings deposit account |
These enumeration values are further described by the label group
named ifxType in the response from the getLabels operation.
This schema was resolved from products/ifxType.
The reason the user is requesting a replacement card.
cardRequestReason strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
initial | Initial Card Request |
lost | Lost Card |
stolen | Stolen Card |
damaged | Damaged Card |
neverReceived | Never Received: The card holder is requesting a replacement of card that was shipped but never received. |
reorder | Reorder Closed Card: The card holder is requesting a replacement of a previously closed card. |
These enumeration values are further described by the label group
named cardRequestReason in the response from the getLabels operation.
This schema was resolved from cards/cardRequestReason.
Indicates what type of cases this is.
caseType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
accountApplicationReview | Account Application Review |
accountCoOwnerEnrollmentReview | Account Co-owner Enrollment Review |
authorizedSignerReview | Authorized Signer Review |
externalAccountReview | External Account Review |
transactionInquiry | Transaction Inquiry: Opened when a customer inquires about a transaction. This is not a dispute, although a financial institution operator may create a new transaction dispute case based on the inquiry. |
transactionDispute | Transaction Dispute: A customer has disputed a transaction. |
This schema was resolved from cases/caseType.
Indicates the type of user who created the message, and by inference, who the message recipient is. If the author is customer, then the recipient is the operator; if the author is operator, then the recipient is the customer.
messageAuthorType strings may have one of the following
enumerated values:
| Value | Description |
|---|---|
customer | Customer: This message was written by the customer |
operator | Operator: This message was written by a financial institution operator. |
This schema was resolved from messages/messageAuthorType.
The type of a postal address.
Warning: The enum list will be removed in a future release.
The allowed values for this property are defined at runtime in the
label group named addressType
in the response from the getLabels operation.
This schema was resolved from contacts/addressType.