Index

Apiture Public Events 0.14.1 documentation

Apiture Public Events 0.14.1

Apiture Open API License Agreement
Apiture
api@apiture.com
ID: https://production.api.apiture.com/apis/async-api-id/apiture-public-events

Describes the event channels and event messages that the Apiture Open digital banking platform publishes for client subscription/consumption.

#Authentication
#Accounts
#External Account Verifications
#External Accounts
#Remote Check Deposits
#Account Applications
#Enrollments
#Users
#Micro-Deposits
#Account Invitations
#Debit Cards
#Documents
#Cases

Servers

https://api.devbank.apiture.com/async-eventssqsdevbank
The DevBank public DevPortal sandbox environment

Operations

SUB userProfile/preferredPhoneChanged
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.

Operation IDuserPreferredPhoneChanged
Accepts the following message:
User Preferred Phone Number ChangeduserPreferredPhoneChanged
User (banking customer) changed their preferred phone number.
object
uid: userPreferredPhoneChanged
User (banking customer) changed their preferred phone number.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
required
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

phoneNumber
string
[ 8 .. 20 ] characters
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.

x-apiture-version
1.0.0
object
uid: abstractUserProfileMessage
An abstract schema used to define messages related to user profile changes.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
required
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractUserMessage
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractMessage
Base abstract schema for all event message schemas.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

x-apiture-fragment
true
x-apiture-version
1.1.0
x-apiture-flattened
true
Additional properties are allowed.
1 item:
userId
2 item:
userUri
3 item:
userIpAddress
4 item:
trackingId
x-apiture-flattened
true
Additional properties are allowed.
x-apiture-flattened
true
Additional properties are allowed.
1 item:
phoneNumber
x-apiture-flattened
true
Additional properties are allowed.
#Users
Examples
{ "_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" }

This example has been generated automatically.
SUB userProfile/preferredEmailAddressChanged
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.

Operation IDuserPreferredEmailAddressChanged
Accepts the following message:
User Preferred Email Address ChangeduserPreferredEmailAddressChanged
User (banking customer) changed their preferred email address.
object
uid: userPreferredEmailAddressChanged
User (banking customer) changed their preferred email address.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
required
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

emailAddress
string
format: email[ 8 .. 120 ] characters
The user's new preferred email address, as a string.

x-apiture-version
1.0.0
object
uid: abstractUserProfileMessage
An abstract schema used to define messages related to user profile changes.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
required
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractUserMessage
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractMessage
Base abstract schema for all event message schemas.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

x-apiture-fragment
true
x-apiture-version
1.1.0
x-apiture-flattened
true
Additional properties are allowed.
1 item:
userId
2 item:
userUri
3 item:
userIpAddress
4 item:
trackingId
x-apiture-flattened
true
Additional properties are allowed.
x-apiture-flattened
true
Additional properties are allowed.
1 item:
emailAddress
x-apiture-flattened
true
Additional properties are allowed.
#Users
Examples
{ "_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" }

This example has been generated automatically.
SUB userProfile/taxAddressChanged
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.

Operation IDuserTaxAddressChanged
Accepts the following message:
User Preferred Tax Address ChangeduserTaxAddressChanged
User (banking customer) changed their tax address.
object
uid: userTaxAddressChanged
User (banking customer) changed their preferred email address.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
required
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

object allOf
The user's new preferred email address.

object
uid: simpleAddress
A postal address.

This schema was resolved from contacts/simpleAddress.

addressLine1
string
[ 4 .. 128 ] characters
The first street address line of the address, normally a house number and street name.

addressLine2
string
<= 128 characters
The optional second street address line of the address.

city
string
[ 2 .. 128 ] characters
The name of the city or municipality.

regionCode
string
must match: ^[a-zA-Z]{2}$2 characters
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.

postalCode
string
must match: ^[0-9]{5}(?:-[0-9]{4})?$[ 5 .. 10 ] characters
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.

countryCode
string
must match: ^[a-zA-Z]{2}$2 characters
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.

x-apiture-version
1.0.0
x-apiture-resolved-from
https://production.api.apiture.com/schemas/contacts/simpleAddress/v1.0.0/model.json
x-apiture-namespace
contacts
x-apiture-flattened
true
Additional properties are allowed.
Additional properties are allowed.
x-apiture-version
1.0.0
object
uid: abstractUserProfileMessage
An abstract schema used to define messages related to user profile changes.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
required
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractUserMessage
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractMessage
Base abstract schema for all event message schemas.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

x-apiture-fragment
true
x-apiture-version
1.1.0
x-apiture-flattened
true
Additional properties are allowed.
1 item:
userId
2 item:
userUri
3 item:
userIpAddress
4 item:
trackingId
x-apiture-flattened
true
Additional properties are allowed.
x-apiture-flattened
true
Additional properties are allowed.
1 item:
address
x-apiture-flattened
true
Additional properties are allowed.
#Users
Examples
{ "_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" } }

This example has been generated automatically.
SUB userProfile/preferredMailingAddressChanged
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.

Operation IDuserPreferredMailingAddressChanged
Accepts the following message:
User Preferred Mailing Address Address ChangeduserPreferredMailingAddressChanged
User (banking customer) changed their preferred mailing address.
object
uid: userPreferredMailingAddressChanged
User (banking customer) changed their preferred email address.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
required
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

object allOf
The user's new preferred mailing address.

object
uid: address
A postal address with the address type and an identifier.

This schema was resolved from contacts/address.

addressLine1
string
[ 4 .. 128 ] characters
The first street address line of the address, normally a house number and street name.

addressLine2
string
<= 128 characters
The optional second street address line of the address.

city
string
[ 2 .. 128 ] characters
The name of the city or municipality.

regionCode
string
must match: ^[a-zA-Z]{2}$2 characters
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.

postalCode
string
must match: ^[0-9]{5}(?:-[0-9]{4})?$[ 5 .. 10 ] characters
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.

countryCode
string
must match: ^[a-zA-Z]{2}$2 characters
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.

required
allOf
The type of this address.

string
uid: addressType
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.

Allowed values:
"unknown"
"home"
"prior"
"work"
"school"
"mailing"
"vacation"
"shipping"
"billing"
"headquarters"
"commercial"
"site"
"property"
"other"
"notApplicable"
x-apiture-choice
addressType
x-apiture-version
1.0.0
x-apiture-resolved-from
https://production.api.apiture.com/schemas/contacts/addressType/v1.0.0/model.json
x-apiture-namespace
contacts
x-apiture-flattened
true
label
read-only
string
[ 4 .. 32 ] characters
A text label, suitable for presentation to the end user. This is derived from type or from otherType if type is other

otherType
string
[ 4 .. 32 ] characters
The actual address type if type is other.

_id
string
must match: ^[-a-zA-Z0-9_]{1,8}$[ 1 .. 8 ] characters
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.

x-apiture-version
1.0.0
x-apiture-resolved-from
https://production.api.apiture.com/schemas/contacts/address/v1.0.0/model.json
x-apiture-namespace
contacts
object
uid: simpleAddress
A postal address.

This schema was resolved from contacts/simpleAddress.

addressLine1
string
[ 4 .. 128 ] characters
The first street address line of the address, normally a house number and street name.

addressLine2
string
<= 128 characters
The optional second street address line of the address.

city
string
[ 2 .. 128 ] characters
The name of the city or municipality.

regionCode
string
must match: ^[a-zA-Z]{2}$2 characters
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.

postalCode
string
must match: ^[0-9]{5}(?:-[0-9]{4})?$[ 5 .. 10 ] characters
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.

countryCode
string
must match: ^[a-zA-Z]{2}$2 characters
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.

x-apiture-version
1.0.0
x-apiture-resolved-from
https://production.api.apiture.com/schemas/contacts/simpleAddress/v1.0.0/model.json
x-apiture-namespace
contacts
x-apiture-flattened
true
Additional properties are allowed.
1 item:
type
2 item:
label
3 item:
otherType
4 item:
_id
x-apiture-flattened
true
Additional properties are allowed.
Additional properties are allowed.
x-apiture-version
1.0.0
object
uid: abstractUserProfileMessage
An abstract schema used to define messages related to user profile changes.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
required
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractUserMessage
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractMessage
Base abstract schema for all event message schemas.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

x-apiture-fragment
true
x-apiture-version
1.1.0
x-apiture-flattened
true
Additional properties are allowed.
1 item:
userId
2 item:
userUri
3 item:
userIpAddress
4 item:
trackingId
x-apiture-flattened
true
Additional properties are allowed.
x-apiture-flattened
true
Additional properties are allowed.
1 item:
address
x-apiture-flattened
true
Additional properties are allowed.
#Users
Examples
{ "_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" } }

This example has been generated automatically.
SUB userProfile/additionalAddressCreated
A user has created a new address.

Additional User Address Created
Fired after a customer creates a new user postal address to their profile.

Operation IDadditionalUserAddressCreated
Accepts the following message:
Additional User Address CreatedadditionalUserAddressCreated
User (banking customer) added a new postal address to their profile.
object
uid: additionalUserAddressCreated
The user created a new address in additional their preferred mailing address.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
required
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

object allOf
The user's new address.

object
uid: simpleAddress
A postal address.

This schema was resolved from contacts/simpleAddress.

addressLine1
string
[ 4 .. 128 ] characters
The first street address line of the address, normally a house number and street name.

addressLine2
string
<= 128 characters
The optional second street address line of the address.

city
string
[ 2 .. 128 ] characters
The name of the city or municipality.

regionCode
string
must match: ^[a-zA-Z]{2}$2 characters
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.

postalCode
string
must match: ^[0-9]{5}(?:-[0-9]{4})?$[ 5 .. 10 ] characters
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.

countryCode
string
must match: ^[a-zA-Z]{2}$2 characters
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.

x-apiture-version
1.0.0
x-apiture-resolved-from
https://production.api.apiture.com/schemas/contacts/simpleAddress/v1.0.0/model.json
x-apiture-namespace
contacts
x-apiture-flattened
true
Additional properties are allowed.
Additional properties are allowed.
x-apiture-version
1.0.0
object
uid: abstractUserProfileMessage
An abstract schema used to define messages related to user profile changes.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
required
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractUserMessage
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractMessage
Base abstract schema for all event message schemas.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

x-apiture-fragment
true
x-apiture-version
1.1.0
x-apiture-flattened
true
Additional properties are allowed.
1 item:
userId
2 item:
userUri
3 item:
userIpAddress
4 item:
trackingId
x-apiture-flattened
true
Additional properties are allowed.
x-apiture-flattened
true
Additional properties are allowed.
1 item:
address
x-apiture-flattened
true
Additional properties are allowed.
#Users
Examples
{ "_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" } }

This example has been generated automatically.
SUB userProfile/w9TaxWithholdingsStatusChanged
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.

Operation IDuserW9TaxWithholdingsStatusChanged
Accepts the following message:
User W-9 Tax Withholding CreateduserW9TaxWithholdingsStatusChanged
User (banking customer) changed their W-9 tax withholding status.
object
uid: userW9TaxWithholdingsStatusChanged
A user changed their W-9 tax withholdings status. true indicates the user is subject to backup W-9 tax withholdings.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
required
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

w9Withholdings
boolean
The user's new withholding setting.

x-apiture-version
1.0.0
object
uid: abstractUserProfileMessage
An abstract schema used to define messages related to user profile changes.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
required
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractUserMessage
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractMessage
Base abstract schema for all event message schemas.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

x-apiture-fragment
true
x-apiture-version
1.1.0
x-apiture-flattened
true
Additional properties are allowed.
1 item:
userId
2 item:
userUri
3 item:
userIpAddress
4 item:
trackingId
x-apiture-flattened
true
Additional properties are allowed.
x-apiture-flattened
true
Additional properties are allowed.
1 item:
w9Withholdings
x-apiture-flattened
true
Additional properties are allowed.
#Users
Examples
{ "_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 }

This example has been generated automatically.
SUB userProfile/userSmsOptInChanged
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.

Operation IDuserSmsOptInChanged
Accepts the following message:
User SMS Opt-In Setting ChangeduserSmsOptInChanged
The current user and their SMS notification setting.
object
uid: userSmsOptInChanged
Message conveying a user changed their SMS communication option.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
required
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

smsNotifications
required
boolean
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.

x-apiture-version
1.0.0
object
uid: abstractUserProfileMessage
An abstract schema used to define messages related to user profile changes.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
required
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractUserMessage
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractMessage
Base abstract schema for all event message schemas.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

x-apiture-fragment
true
x-apiture-version
1.1.0
x-apiture-flattened
true
Additional properties are allowed.
1 item:
userId
2 item:
userUri
3 item:
userIpAddress
4 item:
trackingId
x-apiture-flattened
true
Additional properties are allowed.
x-apiture-flattened
true
Additional properties are allowed.
1 item:
smsNotifications
x-apiture-flattened
true
Additional properties are allowed.
#Users
Examples
{ "_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 }

This example has been generated automatically.
SUB organizationProfile/preferredPhoneChanged
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.

Operation IDorganizationPreferredPhoneChanged
Accepts the following message:
Organization Preferred Phone Number ChangedorganizationPreferredPhoneChanged
User (banking customer) changed the organization's preferred phone number.
object
uid: organizationPreferredPhoneChanged
User (banking customer) changed the organization's preferred phone number.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the organization resource.

organizationUri
required
string
[ 16 .. 2048 ] characters
The unique Apiture URI of the organization resource.

phoneNumber
string
[ 8 .. 20 ] characters
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.

x-apiture-version
1.0.0
object
uid: abstractOrganizationProfileMessage
An abstract schema used to define messages related to organization profile changes.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the organization resource.

organizationUri
required
string
[ 16 .. 2048 ] characters
The unique Apiture URI of the organization resource.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractUserMessage
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractMessage
Base abstract schema for all event message schemas.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

x-apiture-fragment
true
x-apiture-version
1.1.0
x-apiture-flattened
true
Additional properties are allowed.
1 item:
userId
2 item:
userUri
3 item:
userIpAddress
4 item:
trackingId
x-apiture-flattened
true
Additional properties are allowed.
object
uid: organizationProperties
Properties which identify an organization in event messages possibly related to an organization.

organizationId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the organization resource.

organizationUri
string
[ 16 .. 2048 ] characters
The unique Apiture URI of the organization resource.

x-apiture-fragment
true
x-apiture-version
1.0.0
x-apiture-flattened
true
Additional properties are allowed.
x-apiture-flattened
true
Additional properties are allowed.
1 item:
phoneNumber
x-apiture-flattened
true
Additional properties are allowed.
#Organizations
Examples
{ "_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" }

This example has been generated automatically.
SUB organizationProfile/preferredEmailAddressChanged
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.

Operation IDorganizationPreferredEmailAddressChanged
Accepts the following message:
Organization Preferred Email Address ChangedorganizationPreferredEmailAddressChanged
User (banking customer) changed the organization's preferred email address.
object
uid: organizationPreferredEmailAddressChanged
User (banking customer) changed the organization's preferred email address.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the organization resource.

organizationUri
required
string
[ 16 .. 2048 ] characters
The unique Apiture URI of the organization resource.

emailAddress
string
format: email[ 8 .. 120 ] characters
The organization's new preferred email address, as a string.

x-apiture-version
1.0.0
object
uid: abstractOrganizationProfileMessage
An abstract schema used to define messages related to organization profile changes.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the organization resource.

organizationUri
required
string
[ 16 .. 2048 ] characters
The unique Apiture URI of the organization resource.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractUserMessage
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractMessage
Base abstract schema for all event message schemas.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

x-apiture-fragment
true
x-apiture-version
1.1.0
x-apiture-flattened
true
Additional properties are allowed.
1 item:
userId
2 item:
userUri
3 item:
userIpAddress
4 item:
trackingId
x-apiture-flattened
true
Additional properties are allowed.
object
uid: organizationProperties
Properties which identify an organization in event messages possibly related to an organization.

organizationId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the organization resource.

organizationUri
string
[ 16 .. 2048 ] characters
The unique Apiture URI of the organization resource.

x-apiture-fragment
true
x-apiture-version
1.0.0
x-apiture-flattened
true
Additional properties are allowed.
x-apiture-flattened
true
Additional properties are allowed.
1 item:
emailAddress
x-apiture-flattened
true
Additional properties are allowed.
#Organizations
Examples
{ "_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" }

This example has been generated automatically.
SUB organizationProfile/taxAddressChanged
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.

Operation IDorganizationTaxAddressChanged
Accepts the following message:
Organization Preferred Tax Address ChangedorganizationTaxAddressChanged
User (banking customer) changed the organization's tax address.
object
uid: organizationTaxAddressChanged
User (banking customer) changed the organization's preferred email address.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the organization resource.

organizationUri
required
string
[ 16 .. 2048 ] characters
The unique Apiture URI of the organization resource.

object allOf
The organization's new preferred email address.

object
uid: simpleAddress
A postal address.

This schema was resolved from contacts/simpleAddress.

addressLine1
string
[ 4 .. 128 ] characters
The first street address line of the address, normally a house number and street name.

addressLine2
string
<= 128 characters
The optional second street address line of the address.

city
string
[ 2 .. 128 ] characters
The name of the city or municipality.

regionCode
string
must match: ^[a-zA-Z]{2}$2 characters
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.

postalCode
string
must match: ^[0-9]{5}(?:-[0-9]{4})?$[ 5 .. 10 ] characters
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.

countryCode
string
must match: ^[a-zA-Z]{2}$2 characters
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.

x-apiture-version
1.0.0
x-apiture-resolved-from
https://production.api.apiture.com/schemas/contacts/simpleAddress/v1.0.0/model.json
x-apiture-namespace
contacts
x-apiture-flattened
true
Additional properties are allowed.
Additional properties are allowed.
x-apiture-version
1.0.0
object
uid: abstractOrganizationProfileMessage
An abstract schema used to define messages related to organization profile changes.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the organization resource.

organizationUri
required
string
[ 16 .. 2048 ] characters
The unique Apiture URI of the organization resource.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractUserMessage
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractMessage
Base abstract schema for all event message schemas.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

x-apiture-fragment
true
x-apiture-version
1.1.0
x-apiture-flattened
true
Additional properties are allowed.
1 item:
userId
2 item:
userUri
3 item:
userIpAddress
4 item:
trackingId
x-apiture-flattened
true
Additional properties are allowed.
object
uid: organizationProperties
Properties which identify an organization in event messages possibly related to an organization.

organizationId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the organization resource.

organizationUri
string
[ 16 .. 2048 ] characters
The unique Apiture URI of the organization resource.

x-apiture-fragment
true
x-apiture-version
1.0.0
x-apiture-flattened
true
Additional properties are allowed.
x-apiture-flattened
true
Additional properties are allowed.
1 item:
address
x-apiture-flattened
true
Additional properties are allowed.
#Organizations
Examples
{ "_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" } }

This example has been generated automatically.
SUB organizationProfile/preferredMailingAddressChanged
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.

Operation IDorganizationPreferredMailingAddressChanged
Accepts the following message:
Organization Preferred Mailing Address Address ChangedorganizationPreferredMailingAddressChanged
User (banking customer) changed the organization's preferred mailing address.
object
uid: organizationPreferredMailingAddressChanged
User (banking customer) changed the organization's preferred email address.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the organization resource.

organizationUri
required
string
[ 16 .. 2048 ] characters
The unique Apiture URI of the organization resource.

object allOf
The organization's new preferred mailing address.

object
uid: address
A postal address with the address type and an identifier.

This schema was resolved from contacts/address.

addressLine1
string
[ 4 .. 128 ] characters
The first street address line of the address, normally a house number and street name.

addressLine2
string
<= 128 characters
The optional second street address line of the address.

city
string
[ 2 .. 128 ] characters
The name of the city or municipality.

regionCode
string
must match: ^[a-zA-Z]{2}$2 characters
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.

postalCode
string
must match: ^[0-9]{5}(?:-[0-9]{4})?$[ 5 .. 10 ] characters
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.

countryCode
string
must match: ^[a-zA-Z]{2}$2 characters
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.

required
allOf
The type of this address.

string
uid: addressType
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.

Allowed values:
"unknown"
"home"
"prior"
"work"
"school"
"mailing"
"vacation"
"shipping"
"billing"
"headquarters"
"commercial"
"site"
"property"
"other"
"notApplicable"
x-apiture-choice
addressType
x-apiture-version
1.0.0
x-apiture-resolved-from
https://production.api.apiture.com/schemas/contacts/addressType/v1.0.0/model.json
x-apiture-namespace
contacts
x-apiture-flattened
true
label
read-only
string
[ 4 .. 32 ] characters
A text label, suitable for presentation to the end user. This is derived from type or from otherType if type is other

otherType
string
[ 4 .. 32 ] characters
The actual address type if type is other.

_id
string
must match: ^[-a-zA-Z0-9_]{1,8}$[ 1 .. 8 ] characters
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.

x-apiture-version
1.0.0
x-apiture-resolved-from
https://production.api.apiture.com/schemas/contacts/address/v1.0.0/model.json
x-apiture-namespace
contacts
object
uid: simpleAddress
A postal address.

This schema was resolved from contacts/simpleAddress.

addressLine1
string
[ 4 .. 128 ] characters
The first street address line of the address, normally a house number and street name.

addressLine2
string
<= 128 characters
The optional second street address line of the address.

city
string
[ 2 .. 128 ] characters
The name of the city or municipality.

regionCode
string
must match: ^[a-zA-Z]{2}$2 characters
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.

postalCode
string
must match: ^[0-9]{5}(?:-[0-9]{4})?$[ 5 .. 10 ] characters
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.

countryCode
string
must match: ^[a-zA-Z]{2}$2 characters
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.

x-apiture-version
1.0.0
x-apiture-resolved-from
https://production.api.apiture.com/schemas/contacts/simpleAddress/v1.0.0/model.json
x-apiture-namespace
contacts
x-apiture-flattened
true
Additional properties are allowed.
1 item:
type
2 item:
label
3 item:
otherType
4 item:
_id
x-apiture-flattened
true
Additional properties are allowed.
Additional properties are allowed.
x-apiture-version
1.0.0
object
uid: abstractOrganizationProfileMessage
An abstract schema used to define messages related to organization profile changes.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the organization resource.

organizationUri
required
string
[ 16 .. 2048 ] characters
The unique Apiture URI of the organization resource.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractUserMessage
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractMessage
Base abstract schema for all event message schemas.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

x-apiture-fragment
true
x-apiture-version
1.1.0
x-apiture-flattened
true
Additional properties are allowed.
1 item:
userId
2 item:
userUri
3 item:
userIpAddress
4 item:
trackingId
x-apiture-flattened
true
Additional properties are allowed.
object
uid: organizationProperties
Properties which identify an organization in event messages possibly related to an organization.

organizationId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the organization resource.

organizationUri
string
[ 16 .. 2048 ] characters
The unique Apiture URI of the organization resource.

x-apiture-fragment
true
x-apiture-version
1.0.0
x-apiture-flattened
true
Additional properties are allowed.
x-apiture-flattened
true
Additional properties are allowed.
1 item:
address
x-apiture-flattened
true
Additional properties are allowed.
#Organizations
Examples
{ "_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" } }

This example has been generated automatically.
SUB organizationProfile/additionalAddressCreated
A user has created a new address.

Additional Organization Address Created
Fired after a customer creates a new user postal address to their profile.

Operation IDadditionalOrganizationAddressCreated
Accepts the following message:
Additional Organization Address CreatedadditionalOrganizationAddressCreated
User (banking customer) added a new postal address to their profile.
object
uid: additionalOrganizationAddressCreated
The user created a new address in additional the organization's preferred mailing address.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the organization resource.

organizationUri
required
string
[ 16 .. 2048 ] characters
The unique Apiture URI of the organization resource.

object allOf
The organization's new address.

object
uid: simpleAddress
A postal address.

This schema was resolved from contacts/simpleAddress.

addressLine1
string
[ 4 .. 128 ] characters
The first street address line of the address, normally a house number and street name.

addressLine2
string
<= 128 characters
The optional second street address line of the address.

city
string
[ 2 .. 128 ] characters
The name of the city or municipality.

regionCode
string
must match: ^[a-zA-Z]{2}$2 characters
The mailing address region code, such as state in the US, or a province in Canada. This is normalized to uppercase.

postalCode
string
must match: ^[0-9]{5}(?:-[0-9]{4})?$[ 5 .. 10 ] characters
The mailing address postal code, such as a US Zip or Zip+4 code, or a Canadian postal code.

countryCode
string
must match: ^[a-zA-Z]{2}$2 characters
The ISO 3166-1 alpha-2 country code. This is normalized to uppercase.

x-apiture-version
1.0.0
x-apiture-resolved-from
https://production.api.apiture.com/schemas/contacts/simpleAddress/v1.0.0/model.json
x-apiture-namespace
contacts
x-apiture-flattened
true
Additional properties are allowed.
Additional properties are allowed.
x-apiture-version
1.0.0
object
uid: abstractOrganizationProfileMessage
An abstract schema used to define messages related to organization profile changes.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the organization resource.

organizationUri
required
string
[ 16 .. 2048 ] characters
The unique Apiture URI of the organization resource.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractUserMessage
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractMessage
Base abstract schema for all event message schemas.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

x-apiture-fragment
true
x-apiture-version
1.1.0
x-apiture-flattened
true
Additional properties are allowed.
1 item:
userId
2 item:
userUri
3 item:
userIpAddress
4 item:
trackingId
x-apiture-flattened
true
Additional properties are allowed.
object
uid: organizationProperties
Properties which identify an organization in event messages possibly related to an organization.

organizationId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the organization resource.

organizationUri
string
[ 16 .. 2048 ] characters
The unique Apiture URI of the organization resource.

x-apiture-fragment
true
x-apiture-version
1.0.0
x-apiture-flattened
true
Additional properties are allowed.
x-apiture-flattened
true
Additional properties are allowed.
1 item:
address
x-apiture-flattened
true
Additional properties are allowed.
#Organizations
Examples
{ "_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" } }

This example has been generated automatically.
SUB organizationProfile/w9TaxWithholdingsStatusChanged
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

Operation IDorganizationW9TaxWithholdingsStatusChanged
Accepts the following message:
Organization W-9 Tax Withholdings Status ChangedorganizationW9TaxWithholdingsStatusChanged
User (banking customer) changed the W-9 tax withholding status of an organization
object
uid: organizationW9TaxWithholdingsStatusChanged
A user changed the organization's W-9 tax withholdings status. true indicates the organization is subject to backup W-9 tax withholdings.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the organization resource.

organizationUri
required
string
[ 16 .. 2048 ] characters
The unique Apiture URI of the organization resource.

w9Withholdings
boolean
The organization's new withholding setting.

x-apiture-version
1.0.0
object
uid: abstractOrganizationProfileMessage
An abstract schema used to define messages related to organization profile changes.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the organization resource.

organizationUri
required
string
[ 16 .. 2048 ] characters
The unique Apiture URI of the organization resource.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractUserMessage
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractMessage
Base abstract schema for all event message schemas.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

x-apiture-fragment
true
x-apiture-version
1.1.0
x-apiture-flattened
true
Additional properties are allowed.
1 item:
userId
2 item:
userUri
3 item:
userIpAddress
4 item:
trackingId
x-apiture-flattened
true
Additional properties are allowed.
object
uid: organizationProperties
Properties which identify an organization in event messages possibly related to an organization.

organizationId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the organization resource.

organizationUri
string
[ 16 .. 2048 ] characters
The unique Apiture URI of the organization resource.

x-apiture-fragment
true
x-apiture-version
1.0.0
x-apiture-flattened
true
Additional properties are allowed.
x-apiture-flattened
true
Additional properties are allowed.
1 item:
w9Withholdings
x-apiture-flattened
true
Additional properties are allowed.
#Organizations
Examples
{ "_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 }

This example has been generated automatically.
SUB organizationProfile/websiteUrlChanged
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

Operation IDorganizationWebsiteUrlChanged
Accepts the following message:
Organization Website URL ChangedorganizationWebsiteUrlChanged
User (banking customer) changed the home website URL of an organization
object
uid: organizationWebsiteUrlChanged
A user changed the organization's home website URL.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the organization resource.

organizationUri
required
string
[ 16 .. 2048 ] characters
The unique Apiture URI of the organization resource.

homeUrl
string
format: uri
The organization's new business website URL.

x-apiture-version
1.0.0
object
uid: abstractOrganizationProfileMessage
An abstract schema used to define messages related to organization profile changes.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId
required
string
[ 16 .. 48 ] characters
The unique Apiture _id of the organization resource.

organizationUri
required
string
[ 16 .. 2048 ] characters
The unique Apiture URI of the organization resource.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractUserMessage
Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

userId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the user who performed the action that triggered this event.

userUri
string
format: uri<= 2048 characters
The URI of the Apiture user resource.

userIpAddress
string
[ 8 .. 20 ] characters
The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId
string
must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters
If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

x-apiture-fragment
true
x-apiture-version
1.0.0
object
uid: abstractMessage
Base abstract schema for all event message schemas.

_id
required
string
[ 16 .. 48 ] characters
The unique ID of this event. This is an opaque string.

occurredAt
required
string
format: date-time
The RFC 3339 date-time (UTC) when the event occurred.

type
required
string
[ 6 .. 48 ] characters
The message type. This is the name of the message schema.

version
required
string
format: semantic-version
The semantic version number of this message's schema.

x-apiture-fragment
true
x-apiture-version
1.1.0
x-apiture-flattened
true
Additional properties are allowed.
1 item:
userId
2 item:
userUri
3 item:
userIpAddress
4 item:
trackingId
x-apiture-flattened
true
Additional properties are allowed.
object
uid: organizationProperties
Properties which identify an organization in event messages possibly related to an organization.

organizationId
string
[ 16 .. 48 ] characters
The unique Apiture _id of the organization resource.

organizationUri
string
[ 16 .. 2048 ] characters
The unique Apiture URI of the organization resource.

x-apiture-fragment
true
x-apiture-version
1.0.0
x-apiture-flattened
true
Additional properties are allowed.
x-apiture-flattened
true
Additional properties are allowed.
1 item:
homeUrl
x-apiture-flattened
true
Additional properties are allowed.
#Organizations
Examples
{ "_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" }

This example has been generated automatically.

SUB accountApplications/started

New digital account opening account application started.

Account Application Started

Fired after a customer starts a new account application for review/approval.

Operation IDaccountApplicationStarted

Accepts the following message:

Account Application StartedaccountApplicationStarted

User (banking customer) started an account application to open a new account.

object

uid: accountApplicationStarted

A user (banking customer) has started an account application for review/approval.

_id

required

string

[ 16 .. 48 ] characters

The unique ID of this event. This is an opaque string.

occurredAt

required

string

format: date-time

The RFC 3339 date-time (UTC) when the event occurred.

type

required

string

[ 6 .. 48 ] characters

The message type. This is the name of the message schema.

version

required

string

format: semantic-version

The semantic version number of this message's schema.

userId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the user who performed the action that triggered this event.

userUri

string

format: uri<= 2048 characters

The URI of the Apiture user resource.

userIpAddress

string

[ 8 .. 20 ] characters

The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId

string

must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters

If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the organization resource.

organizationUri

string

[ 16 .. 2048 ] characters

The unique Apiture URI of the organization resource.

applicationId

required

string

[ 16 .. 48 ] characters

The unique resource _id of the Apiture account application resource.

applicationUri

required

string

format: uri<= 2048 characters

The URI of the Apiture account application resource.

required

array<object>

uid: accountProductProperties

required

allOf

A code which identifies the product/account type. This is one of the IFX AcctType values.

string

uid: ifxType

A code which identifies the product type. This is one of the IFX AcctType values. Labels and descriptions for the enumeration values are in the ifxType key in the response of the getLabels operation.

ifxType strings may have one of the following enumerated values:

Value	Description
`CCA`	Credit card account
`CDA`	Certificate of deposit account (CD)
`CLA`	Commercial loan account
`CMA`	Cash management account
`DDA`	Demand deposit account
`EQU`	Home equity loan
`GLA`	General ledger account
`ILA`	Installment loan account
`INV`	Investment account
`IRA`	Individual retirement account
`IRL`	Accounts held in Ireland
`LOC`	Consumer line of credit
`MLA`	Military Lending Account: Credit facility held by former US service member
`MMA`	Money market account
`PBA`	Packaged bank Account: Account with additional benefits that charges a fixed monthly fee.
`PPA`	Private pension administrator
`RWD`	Reward accounts
`SDA`	Savings deposit account

These enumeration values are further described by the label group named ifxType in the response from the getLabels operation.

This schema was resolved from products/ifxType.

"CCA"
"CDA"
"CLA"
"CMA"
"DDA"
"EQU"
"GLA"
"ILA"
"INV"
"IRA"
"IRL"
"LOC"
"MLA"
"MMA"
"PBA"
"PPA"
"RWD"
"SDA"

productId

string

[ 16 .. 48 ] characters

The unique _id of the Apiture banking product resource.

uri

required

string

format: uri<= 2048 characters

The URI of the Apiture banking product resource.

name

required

string

The name of the banking product.

x-apiture-version

1.1.0

object

uid: abstractAccountApplicationMessage

An abstract schema used to define other message schemas related to account applications.

_id

required

string

[ 16 .. 48 ] characters

The unique ID of this event. This is an opaque string.

occurredAt

required

string

format: date-time

The RFC 3339 date-time (UTC) when the event occurred.

type

required

string

[ 6 .. 48 ] characters

The message type. This is the name of the message schema.

version

required

string

format: semantic-version

The semantic version number of this message's schema.

userId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the user who performed the action that triggered this event.

userUri

string

format: uri<= 2048 characters

The URI of the Apiture user resource.

userIpAddress

string

[ 8 .. 20 ] characters

The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId

string

must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters

If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the organization resource.

organizationUri

string

[ 16 .. 2048 ] characters

The unique Apiture URI of the organization resource.

applicationId

required

string

[ 16 .. 48 ] characters

The unique resource _id of the Apiture account application resource.

applicationUri

required

string

format: uri<= 2048 characters

The URI of the Apiture account application resource.

required

array<object>

uid: accountProductProperties

required

allOf

A code which identifies the product/account type. This is one of the IFX AcctType values.

string

uid: ifxType

ifxType strings may have one of the following enumerated values:

Value	Description
`CCA`	Credit card account
`CDA`	Certificate of deposit account (CD)
`CLA`	Commercial loan account
`CMA`	Cash management account
`DDA`	Demand deposit account
`EQU`	Home equity loan
`GLA`	General ledger account
`ILA`	Installment loan account
`INV`	Investment account
`IRA`	Individual retirement account
`IRL`	Accounts held in Ireland
`LOC`	Consumer line of credit
`MLA`	Military Lending Account: Credit facility held by former US service member
`MMA`	Money market account
`PBA`	Packaged bank Account: Account with additional benefits that charges a fixed monthly fee.
`PPA`	Private pension administrator
`RWD`	Reward accounts
`SDA`	Savings deposit account

These enumeration values are further described by the label group named ifxType in the response from the getLabels operation.

This schema was resolved from products/ifxType.

"CCA"
"CDA"
"CLA"
"CMA"
"DDA"
"EQU"
"GLA"
"ILA"
"INV"
"IRA"
"IRL"
"LOC"
"MLA"
"MMA"
"PBA"
"PPA"
"RWD"
"SDA"

productId

string

[ 16 .. 48 ] characters

The unique _id of the Apiture banking product resource.

uri

required

string

format: uri<= 2048 characters

The URI of the Apiture banking product resource.

name

required

string

The name of the banking product.

x-apiture-version

1.1.0

x-apiture-fragment

true

object

uid: abstractUserMessage

Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.

object

uid: organizationProperties

Properties which identify an organization in event messages possibly related to an organization.

x-apiture-flattened

true

Additional properties are allowed.

x-apiture-flattened

true

Additional properties are allowed.

#Account Applications

Examples

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

This example has been generated automatically.

SUB accountApplications/approved

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.

Operation IDaccountApplicationApproved

Accepts the following message:

Account Application ApprovedaccountApplicationApproved

A completed account application was approved.

object

uid: accountApplicationApproved

An account application has been approved, either automatically or by the financial institution.

_id

required

string

[ 16 .. 48 ] characters

The unique ID of this event. This is an opaque string.

occurredAt

required

string

format: date-time

The RFC 3339 date-time (UTC) when the event occurred.

type

required

string

[ 6 .. 48 ] characters

The message type. This is the name of the message schema.

version

required

string

format: semantic-version

The semantic version number of this message's schema.

userId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the user who performed the action that triggered this event.

userUri

string

format: uri<= 2048 characters

The URI of the Apiture user resource.

userIpAddress

string

[ 8 .. 20 ] characters

The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId

string

must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters

If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the organization resource.

organizationUri

string

[ 16 .. 2048 ] characters

The unique Apiture URI of the organization resource.

applicationId

required

string

[ 16 .. 48 ] characters

The unique resource _id of the Apiture account application resource.

applicationUri

required

string

format: uri<= 2048 characters

The URI of the Apiture account application resource.

required

array<object>

uid: accountProductProperties

required

allOf

A code which identifies the product/account type. This is one of the IFX AcctType values.

string

uid: ifxType

ifxType strings may have one of the following enumerated values:

Value	Description
`CCA`	Credit card account
`CDA`	Certificate of deposit account (CD)
`CLA`	Commercial loan account
`CMA`	Cash management account
`DDA`	Demand deposit account
`EQU`	Home equity loan
`GLA`	General ledger account
`ILA`	Installment loan account
`INV`	Investment account
`IRA`	Individual retirement account
`IRL`	Accounts held in Ireland
`LOC`	Consumer line of credit
`MLA`	Military Lending Account: Credit facility held by former US service member
`MMA`	Money market account
`PBA`	Packaged bank Account: Account with additional benefits that charges a fixed monthly fee.
`PPA`	Private pension administrator
`RWD`	Reward accounts
`SDA`	Savings deposit account

These enumeration values are further described by the label group named ifxType in the response from the getLabels operation.

This schema was resolved from products/ifxType.

"CCA"
"CDA"
"CLA"
"CMA"
"DDA"
"EQU"
"GLA"
"ILA"
"INV"
"IRA"
"IRL"
"LOC"
"MLA"
"MMA"
"PBA"
"PPA"
"RWD"
"SDA"

productId

string

[ 16 .. 48 ] characters

The unique _id of the Apiture banking product resource.

uri

required

string

format: uri<= 2048 characters

The URI of the Apiture banking product resource.

name

required

string

The name of the banking product.

approvalUri

string

format: uri

The URI of the Approval resource which the financial institution reviewed and approved. May not exist if the application was auto-approved.

x-apiture-version

1.0.0

object

uid: abstractAccountApplicationMessage

An abstract schema used to define other message schemas related to account applications.

_id

required

string

[ 16 .. 48 ] characters

The unique ID of this event. This is an opaque string.

occurredAt

required

string

format: date-time

The RFC 3339 date-time (UTC) when the event occurred.

type

required

string

[ 6 .. 48 ] characters

The message type. This is the name of the message schema.

version

required

string

format: semantic-version

The semantic version number of this message's schema.

userId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the user who performed the action that triggered this event.

userUri

string

format: uri<= 2048 characters

The URI of the Apiture user resource.

userIpAddress

string

[ 8 .. 20 ] characters

The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId

string

must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters

If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the organization resource.

organizationUri

string

[ 16 .. 2048 ] characters

The unique Apiture URI of the organization resource.

applicationId

required

string

[ 16 .. 48 ] characters

The unique resource _id of the Apiture account application resource.

applicationUri

required

string

format: uri<= 2048 characters

The URI of the Apiture account application resource.

required

array<object>

uid: accountProductProperties

required

allOf

A code which identifies the product/account type. This is one of the IFX AcctType values.

string

uid: ifxType

ifxType strings may have one of the following enumerated values:

Value	Description
`CCA`	Credit card account
`CDA`	Certificate of deposit account (CD)
`CLA`	Commercial loan account
`CMA`	Cash management account
`DDA`	Demand deposit account
`EQU`	Home equity loan
`GLA`	General ledger account
`ILA`	Installment loan account
`INV`	Investment account
`IRA`	Individual retirement account
`IRL`	Accounts held in Ireland
`LOC`	Consumer line of credit
`MLA`	Military Lending Account: Credit facility held by former US service member
`MMA`	Money market account
`PBA`	Packaged bank Account: Account with additional benefits that charges a fixed monthly fee.
`PPA`	Private pension administrator
`RWD`	Reward accounts
`SDA`	Savings deposit account

These enumeration values are further described by the label group named ifxType in the response from the getLabels operation.

This schema was resolved from products/ifxType.

"CCA"
"CDA"
"CLA"
"CMA"
"DDA"
"EQU"
"GLA"
"ILA"
"INV"
"IRA"
"IRL"
"LOC"
"MLA"
"MMA"
"PBA"
"PPA"
"RWD"
"SDA"

productId

string

[ 16 .. 48 ] characters

The unique _id of the Apiture banking product resource.

uri

required

string

format: uri<= 2048 characters

The URI of the Apiture banking product resource.

name

required

string

The name of the banking product.

x-apiture-version

1.1.0

x-apiture-fragment

true

object

uid: abstractUserMessage

Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.

object

uid: organizationProperties

Properties which identify an organization in event messages possibly related to an organization.

x-apiture-flattened

true

Additional properties are allowed.

x-apiture-flattened

true

Additional properties are allowed.

#Account Applications

Examples

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

This example has been generated automatically.

SUB accountApplications/blocked

New digital account opening account application has become blocked.

Account Application Blocked

Fired after a customer's account application has become blocked.

Operation IDaccountApplicationBlocked

Accepts the following message:

Account Application BlockedaccountApplicationBlocked

User (banking customer) account application has become blocked.

object

uid: accountApplicationBlocked

An account application has become blocked.

_id

required

string

[ 16 .. 48 ] characters

The unique ID of this event. This is an opaque string.

occurredAt

required

string

format: date-time

The RFC 3339 date-time (UTC) when the event occurred.

type

required

string

[ 6 .. 48 ] characters

The message type. This is the name of the message schema.

version

required

string

format: semantic-version

The semantic version number of this message's schema.

userId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the user who performed the action that triggered this event.

userUri

string

format: uri<= 2048 characters

The URI of the Apiture user resource.

userIpAddress

string

[ 8 .. 20 ] characters

The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId

string

must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters

If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the organization resource.

organizationUri

string

[ 16 .. 2048 ] characters

The unique Apiture URI of the organization resource.

applicationId

required

string

[ 16 .. 48 ] characters

The unique resource _id of the Apiture account application resource.

applicationUri

required

string

format: uri<= 2048 characters

The URI of the Apiture account application resource.

required

array<object>

uid: accountProductProperties

required

allOf

A code which identifies the product/account type. This is one of the IFX AcctType values.

string

uid: ifxType

ifxType strings may have one of the following enumerated values:

Value	Description
`CCA`	Credit card account
`CDA`	Certificate of deposit account (CD)
`CLA`	Commercial loan account
`CMA`	Cash management account
`DDA`	Demand deposit account
`EQU`	Home equity loan
`GLA`	General ledger account
`ILA`	Installment loan account
`INV`	Investment account
`IRA`	Individual retirement account
`IRL`	Accounts held in Ireland
`LOC`	Consumer line of credit
`MLA`	Military Lending Account: Credit facility held by former US service member
`MMA`	Money market account
`PBA`	Packaged bank Account: Account with additional benefits that charges a fixed monthly fee.
`PPA`	Private pension administrator
`RWD`	Reward accounts
`SDA`	Savings deposit account

These enumeration values are further described by the label group named ifxType in the response from the getLabels operation.

This schema was resolved from products/ifxType.

"CCA"
"CDA"
"CLA"
"CMA"
"DDA"
"EQU"
"GLA"
"ILA"
"INV"
"IRA"
"IRL"
"LOC"
"MLA"
"MMA"
"PBA"
"PPA"
"RWD"
"SDA"

productId

string

[ 16 .. 48 ] characters

The unique _id of the Apiture banking product resource.

uri

required

string

format: uri<= 2048 characters

The URI of the Apiture banking product resource.

name

required

string

The name of the banking product.

x-apiture-version

1.1.0

object

uid: abstractAccountApplicationMessage

An abstract schema used to define other message schemas related to account applications.

_id

required

string

[ 16 .. 48 ] characters

The unique ID of this event. This is an opaque string.

occurredAt

required

string

format: date-time

The RFC 3339 date-time (UTC) when the event occurred.

type

required

string

[ 6 .. 48 ] characters

The message type. This is the name of the message schema.

version

required

string

format: semantic-version

The semantic version number of this message's schema.

userId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the user who performed the action that triggered this event.

userUri

string

format: uri<= 2048 characters

The URI of the Apiture user resource.

userIpAddress

string

[ 8 .. 20 ] characters

The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId

string

must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters

If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the organization resource.

organizationUri

string

[ 16 .. 2048 ] characters

The unique Apiture URI of the organization resource.

applicationId

required

string

[ 16 .. 48 ] characters

The unique resource _id of the Apiture account application resource.

applicationUri

required

string

format: uri<= 2048 characters

The URI of the Apiture account application resource.

required

array<object>

uid: accountProductProperties

required

allOf

A code which identifies the product/account type. This is one of the IFX AcctType values.

string

uid: ifxType

ifxType strings may have one of the following enumerated values:

Value	Description
`CCA`	Credit card account
`CDA`	Certificate of deposit account (CD)
`CLA`	Commercial loan account
`CMA`	Cash management account
`DDA`	Demand deposit account
`EQU`	Home equity loan
`GLA`	General ledger account
`ILA`	Installment loan account
`INV`	Investment account
`IRA`	Individual retirement account
`IRL`	Accounts held in Ireland
`LOC`	Consumer line of credit
`MLA`	Military Lending Account: Credit facility held by former US service member
`MMA`	Money market account
`PBA`	Packaged bank Account: Account with additional benefits that charges a fixed monthly fee.
`PPA`	Private pension administrator
`RWD`	Reward accounts
`SDA`	Savings deposit account

These enumeration values are further described by the label group named ifxType in the response from the getLabels operation.

This schema was resolved from products/ifxType.

"CCA"
"CDA"
"CLA"
"CMA"
"DDA"
"EQU"
"GLA"
"ILA"
"INV"
"IRA"
"IRL"
"LOC"
"MLA"
"MMA"
"PBA"
"PPA"
"RWD"
"SDA"

productId

string

[ 16 .. 48 ] characters

The unique _id of the Apiture banking product resource.

uri

required

string

format: uri<= 2048 characters

The URI of the Apiture banking product resource.

name

required

string

The name of the banking product.

x-apiture-version

1.1.0

x-apiture-fragment

true

object

uid: abstractUserMessage

Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.

object

uid: organizationProperties

Properties which identify an organization in event messages possibly related to an organization.

x-apiture-flattened

true

Additional properties are allowed.

x-apiture-flattened

true

Additional properties are allowed.

#Account Applications

Examples

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

This example has been generated automatically.

SUB accountApplications/expired

New digital account opening account application has expired.

Account Application Expired

Fired after a customer's account application has expired.

Operation IDaccountApplicationExpired

Accepts the following message:

Account Application ExpiredaccountApplicationExpired

User (banking customer) account application has expired.

object

uid: accountApplicationExpired

A user's account application has expired

_id

required

string

[ 16 .. 48 ] characters

The unique ID of this event. This is an opaque string.

occurredAt

required

string

format: date-time

The RFC 3339 date-time (UTC) when the event occurred.

type

required

string

[ 6 .. 48 ] characters

The message type. This is the name of the message schema.

version

required

string

format: semantic-version

The semantic version number of this message's schema.

userId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the user who performed the action that triggered this event.

userUri

string

format: uri<= 2048 characters

The URI of the Apiture user resource.

userIpAddress

string

[ 8 .. 20 ] characters

The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId

string

must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters

If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the organization resource.

organizationUri

string

[ 16 .. 2048 ] characters

The unique Apiture URI of the organization resource.

applicationId

required

string

[ 16 .. 48 ] characters

The unique resource _id of the Apiture account application resource.

applicationUri

required

string

format: uri<= 2048 characters

The URI of the Apiture account application resource.

required

array<object>

uid: accountProductProperties

required

allOf

A code which identifies the product/account type. This is one of the IFX AcctType values.

string

uid: ifxType

ifxType strings may have one of the following enumerated values:

Value	Description
`CCA`	Credit card account
`CDA`	Certificate of deposit account (CD)
`CLA`	Commercial loan account
`CMA`	Cash management account
`DDA`	Demand deposit account
`EQU`	Home equity loan
`GLA`	General ledger account
`ILA`	Installment loan account
`INV`	Investment account
`IRA`	Individual retirement account
`IRL`	Accounts held in Ireland
`LOC`	Consumer line of credit
`MLA`	Military Lending Account: Credit facility held by former US service member
`MMA`	Money market account
`PBA`	Packaged bank Account: Account with additional benefits that charges a fixed monthly fee.
`PPA`	Private pension administrator
`RWD`	Reward accounts
`SDA`	Savings deposit account

These enumeration values are further described by the label group named ifxType in the response from the getLabels operation.

This schema was resolved from products/ifxType.

"CCA"
"CDA"
"CLA"
"CMA"
"DDA"
"EQU"
"GLA"
"ILA"
"INV"
"IRA"
"IRL"
"LOC"
"MLA"
"MMA"
"PBA"
"PPA"
"RWD"
"SDA"

productId

string

[ 16 .. 48 ] characters

The unique _id of the Apiture banking product resource.

uri

required

string

format: uri<= 2048 characters

The URI of the Apiture banking product resource.

name

required

string

The name of the banking product.

createdAt

required

string

format: date-time

Date-time when the application was created

expiredAt

required

string

format: date-time

The expiration date/time of the application

x-apiture-version

1.2.0

object

uid: abstractAccountApplicationMessage

An abstract schema used to define other message schemas related to account applications.

_id

required

string

[ 16 .. 48 ] characters

The unique ID of this event. This is an opaque string.

occurredAt

required

string

format: date-time

The RFC 3339 date-time (UTC) when the event occurred.

type

required

string

[ 6 .. 48 ] characters

The message type. This is the name of the message schema.

version

required

string

format: semantic-version

The semantic version number of this message's schema.

userId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the user who performed the action that triggered this event.

userUri

string

format: uri<= 2048 characters

The URI of the Apiture user resource.

userIpAddress

string

[ 8 .. 20 ] characters

The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId

string

must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters

If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the organization resource.

organizationUri

string

[ 16 .. 2048 ] characters

The unique Apiture URI of the organization resource.

applicationId

required

string

[ 16 .. 48 ] characters

The unique resource _id of the Apiture account application resource.

applicationUri

required

string

format: uri<= 2048 characters

The URI of the Apiture account application resource.

required

array<object>

uid: accountProductProperties

required

allOf

A code which identifies the product/account type. This is one of the IFX AcctType values.

string

uid: ifxType

ifxType strings may have one of the following enumerated values:

Value	Description
`CCA`	Credit card account
`CDA`	Certificate of deposit account (CD)
`CLA`	Commercial loan account
`CMA`	Cash management account
`DDA`	Demand deposit account
`EQU`	Home equity loan
`GLA`	General ledger account
`ILA`	Installment loan account
`INV`	Investment account
`IRA`	Individual retirement account
`IRL`	Accounts held in Ireland
`LOC`	Consumer line of credit
`MLA`	Military Lending Account: Credit facility held by former US service member
`MMA`	Money market account
`PBA`	Packaged bank Account: Account with additional benefits that charges a fixed monthly fee.
`PPA`	Private pension administrator
`RWD`	Reward accounts
`SDA`	Savings deposit account

These enumeration values are further described by the label group named ifxType in the response from the getLabels operation.

This schema was resolved from products/ifxType.

"CCA"
"CDA"
"CLA"
"CMA"
"DDA"
"EQU"
"GLA"
"ILA"
"INV"
"IRA"
"IRL"
"LOC"
"MLA"
"MMA"
"PBA"
"PPA"
"RWD"
"SDA"

productId

string

[ 16 .. 48 ] characters

The unique _id of the Apiture banking product resource.

uri

required

string

format: uri<= 2048 characters

The URI of the Apiture banking product resource.

name

required

string

The name of the banking product.

x-apiture-version

1.1.0

x-apiture-fragment

true

object

uid: abstractUserMessage

Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.

object

uid: organizationProperties

Properties which identify an organization in event messages possibly related to an organization.

x-apiture-flattened

true

Additional properties are allowed.

x-apiture-flattened

true

Additional properties are allowed.

#Account Applications

Examples

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

This example has been generated automatically.

SUB accountApplications/canceled

A user has canceled a digital account opening account application.

Account Application Canceled

Fired after a customer has canceled an account application.

Operation IDaccountApplicationCanceled

Accepts the following message:

Account Application CanceledaccountApplicationCanceled

User (banking customer) has canceled an account application.

object

uid: accountApplicationCanceled

A user (banking customer) has canceled an account application.

_id

required

string

[ 16 .. 48 ] characters

The unique ID of this event. This is an opaque string.

occurredAt

required

string

format: date-time

The RFC 3339 date-time (UTC) when the event occurred.

type

required

string

[ 6 .. 48 ] characters

The message type. This is the name of the message schema.

version

required

string

format: semantic-version

The semantic version number of this message's schema.

userId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the user who performed the action that triggered this event.

userUri

string

format: uri<= 2048 characters

The URI of the Apiture user resource.

userIpAddress

string

[ 8 .. 20 ] characters

The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId

string

must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters

If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the organization resource.

organizationUri

string

[ 16 .. 2048 ] characters

The unique Apiture URI of the organization resource.

applicationId

required

string

[ 16 .. 48 ] characters

The unique resource _id of the Apiture account application resource.

applicationUri

required

string

format: uri<= 2048 characters

The URI of the Apiture account application resource.

required

array<object>

uid: accountProductProperties

required

allOf

A code which identifies the product/account type. This is one of the IFX AcctType values.

string

uid: ifxType

ifxType strings may have one of the following enumerated values:

Value	Description
`CCA`	Credit card account
`CDA`	Certificate of deposit account (CD)
`CLA`	Commercial loan account
`CMA`	Cash management account
`DDA`	Demand deposit account
`EQU`	Home equity loan
`GLA`	General ledger account
`ILA`	Installment loan account
`INV`	Investment account
`IRA`	Individual retirement account
`IRL`	Accounts held in Ireland
`LOC`	Consumer line of credit
`MLA`	Military Lending Account: Credit facility held by former US service member
`MMA`	Money market account
`PBA`	Packaged bank Account: Account with additional benefits that charges a fixed monthly fee.
`PPA`	Private pension administrator
`RWD`	Reward accounts
`SDA`	Savings deposit account

These enumeration values are further described by the label group named ifxType in the response from the getLabels operation.

This schema was resolved from products/ifxType.

"CCA"
"CDA"
"CLA"
"CMA"
"DDA"
"EQU"
"GLA"
"ILA"
"INV"
"IRA"
"IRL"
"LOC"
"MLA"
"MMA"
"PBA"
"PPA"
"RWD"
"SDA"

productId

string

[ 16 .. 48 ] characters

The unique _id of the Apiture banking product resource.

uri

required

string

format: uri<= 2048 characters

The URI of the Apiture banking product resource.

name

required

string

The name of the banking product.

x-apiture-version

1.1.0

object

uid: abstractAccountApplicationMessage

An abstract schema used to define other message schemas related to account applications.

_id

required

string

[ 16 .. 48 ] characters

The unique ID of this event. This is an opaque string.

occurredAt

required

string

format: date-time

The RFC 3339 date-time (UTC) when the event occurred.

type

required

string

[ 6 .. 48 ] characters

The message type. This is the name of the message schema.

version

required

string

format: semantic-version

The semantic version number of this message's schema.

userId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the user who performed the action that triggered this event.

userUri

string

format: uri<= 2048 characters

The URI of the Apiture user resource.

userIpAddress

string

[ 8 .. 20 ] characters

The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId

string

must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters

If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the organization resource.

organizationUri

string

[ 16 .. 2048 ] characters

The unique Apiture URI of the organization resource.

applicationId

required

string

[ 16 .. 48 ] characters

The unique resource _id of the Apiture account application resource.

applicationUri

required

string

format: uri<= 2048 characters

The URI of the Apiture account application resource.

required

array<object>

uid: accountProductProperties

required

allOf

A code which identifies the product/account type. This is one of the IFX AcctType values.

string

uid: ifxType

ifxType strings may have one of the following enumerated values:

Value	Description
`CCA`	Credit card account
`CDA`	Certificate of deposit account (CD)
`CLA`	Commercial loan account
`CMA`	Cash management account
`DDA`	Demand deposit account
`EQU`	Home equity loan
`GLA`	General ledger account
`ILA`	Installment loan account
`INV`	Investment account
`IRA`	Individual retirement account
`IRL`	Accounts held in Ireland
`LOC`	Consumer line of credit
`MLA`	Military Lending Account: Credit facility held by former US service member
`MMA`	Money market account
`PBA`	Packaged bank Account: Account with additional benefits that charges a fixed monthly fee.
`PPA`	Private pension administrator
`RWD`	Reward accounts
`SDA`	Savings deposit account

These enumeration values are further described by the label group named ifxType in the response from the getLabels operation.

This schema was resolved from products/ifxType.

"CCA"
"CDA"
"CLA"
"CMA"
"DDA"
"EQU"
"GLA"
"ILA"
"INV"
"IRA"
"IRL"
"LOC"
"MLA"
"MMA"
"PBA"
"PPA"
"RWD"
"SDA"

productId

string

[ 16 .. 48 ] characters

The unique _id of the Apiture banking product resource.

uri

required

string

format: uri<= 2048 characters

The URI of the Apiture banking product resource.

name

required

string

The name of the banking product.

x-apiture-version

1.1.0

x-apiture-fragment

true

object

uid: abstractUserMessage

Base abstract schema for all event message schemas for events initiated by or on behalf of banking users.

object

uid: organizationProperties

Properties which identify an organization in event messages possibly related to an organization.

x-apiture-flattened

true

Additional properties are allowed.

x-apiture-flattened

true

Additional properties are allowed.

#Account Applications

Examples

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

This example has been generated automatically.

SUB enrollments/expired

Enrollment as a joint owner or authorized signer on an account has expired.

Enrollment Expired

Fired after a customer's account application has expired.

Operation IDenrollmentExpired

Accepts the following message:

Enrollment ExpiredenrollmentExpired

User (banking customer) account application has expired.

object

uid: enrollmentExpired

A user's enrollment as an account joint owner or authorized signer has expired,

_id

required

string

[ 16 .. 48 ] characters

The unique ID of this event. This is an opaque string.

occurredAt

required

string

format: date-time

The RFC 3339 date-time (UTC) when the event occurred.

type

required

string

[ 6 .. 48 ] characters

The message type. This is the name of the message schema.

version

required

string

format: semantic-version

The semantic version number of this message's schema.

userId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the user who performed the action that triggered this event.

userUri

string

format: uri<= 2048 characters

The URI of the Apiture user resource.

userIpAddress

string

[ 8 .. 20 ] characters

The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId

string

must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters

If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the organization resource.

organizationUri

string

[ 16 .. 2048 ] characters

The unique Apiture URI of the organization resource.

enrollmentId

required

string

The unique resource _id of the Apiture account enrollment resource.

enrollmentUri

required

string

format: uri<= 2048 characters

The URI of the Apiture account enrollment resource.

required

array<object>

non-emptyuid: accountProperties

The account(s) the user is joining as joint owner or authorized signer.

required

allOf

A code which identifies the product/account type. This is one of the IFX AcctType values.

string

uid: ifxType

ifxType strings may have one of the following enumerated values:

Value	Description
`CCA`	Credit card account
`CDA`	Certificate of deposit account (CD)
`CLA`	Commercial loan account
`CMA`	Cash management account
`DDA`	Demand deposit account
`EQU`	Home equity loan
`GLA`	General ledger account
`ILA`	Installment loan account
`INV`	Investment account
`IRA`	Individual retirement account
`IRL`	Accounts held in Ireland
`LOC`	Consumer line of credit
`MLA`	Military Lending Account: Credit facility held by former US service member
`MMA`	Money market account
`PBA`	Packaged bank Account: Account with additional benefits that charges a fixed monthly fee.
`PPA`	Private pension administrator
`RWD`	Reward accounts
`SDA`	Savings deposit account

These enumeration values are further described by the label group named ifxType in the response from the getLabels operation.

This schema was resolved from products/ifxType.

"CCA"
"CDA"
"CLA"
"CMA"
"DDA"
"EQU"
"GLA"
"ILA"
"INV"
"IRA"
"IRL"
"LOC"
"MLA"
"MMA"
"PBA"
"PPA"
"RWD"
"SDA"

accountId

required

string

[ 16 .. 48 ] characters

The unique Apiture _id of the account resource.

accountNumber

required

string

[ 8 .. 32 ] characters

The unique full account number of the account.

accountUri

required

string

format: uri<= 2048 characters

The URI of the Apiture account resource.

createdAt

required

string

format: date-time

Date-time when the application was created.

expiredAt

required

string

format: date-time

The expiration date/time of the enrollment.

x-apiture-version

1.0.0

object

uid: abstractAccountEnrollmentMessage

An abstract schema used to define other message schemas related to joint owner or authorized signer enrollments.

_id

required

string

[ 16 .. 48 ] characters

The unique ID of this event. This is an opaque string.

occurredAt

required

string

format: date-time

The RFC 3339 date-time (UTC) when the event occurred.

type

required

string

[ 6 .. 48 ] characters

The message type. This is the name of the message schema.

version

required

string

format: semantic-version

The semantic version number of this message's schema.

userId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the user who performed the action that triggered this event.

userUri

string

format: uri<= 2048 characters

The URI of the Apiture user resource.

userIpAddress

string

[ 8 .. 20 ] characters

The IP address of the device the user was using when performing a banking action. This is omitted if not available or known.

trackingId

string

must match: ^[-_a-zA-Z0-9$]{4,80}$[ 4 .. 80 ] characters

If the event is correlated to a financial institution tracking ID for a promotion or campaign, this is the unique tracking ID.

organizationId

string

[ 16 .. 48 ] characters

The unique Apiture _id of the organization resource.

organizationUri

string

[ 16 .. 2048 ] characters

The unique Apiture URI of the organization resource.

enrollmentId

required

string

The unique resource _id of the Apiture account enrollment resource.

enrollmentUri

required

string

format: uri<= 2048 characters

The URI of the Apiture account enrollment resource.

required

array<object>

non-emptyuid: accountProperties

The account(s) the user is joining as joint owner or authorized signer.

required

allOf

A code which identifies the product/account type. This is one of the IFX AcctType values.

string

uid: ifxType

ifxType strings may have one of the following enumerated values:

Value	Description
`CCA`	Credit card account
`CDA`	Certificate of deposit account (CD)
`CLA`	Commercial loan account
`CMA`	Cash management account
`DDA`	Demand deposit account
`EQU`	Home equity loan
`GLA`	General ledger account
`ILA`	Installment loan account
`INV`	Investment account
`IRA`	Individual retirement account
`IRL`	Accounts held in Ireland
`LOC`	Consumer line of credit
`MLA`	Military Lending Account: Credit facility held by former US service member
`MMA`	Money market account
`PBA`	Packaged bank Account: Account with additional benefits that charges a fixed monthly fee.
`PPA`	Private pension administrator
`RWD`	Reward accounts
`SDA`	Savings deposit account

These enumeration values are further described by the label group named ifxType in the response from the getLabels operation.

This schema was resolved from products/ifxType.

"CCA"
"CDA"
"CLA"
"CMA"
"DDA"
"EQU"
"GLA"
"ILA"
"INV"
"IRA"
"IRL"
"LOC"
"MLA"
"MMA"
"PBA"
"PPA"
"RWD"
"SDA"

accountId

required

string

[ 16 .. 48 ] characters

The unique Apiture _id of the account resource.

accountNumber

required

string

[ 8 .. 32 ] characters

The unique full account number of the account.

accountUri

required

string

format: uri<= 2048 characters

The URI of the Apiture account resource.

Apiture Public Events 0.14.1

Servers

Operations

SUB userProfile/preferredPhoneChanged

Examples

This example has been generated automatically.

SUB userProfile/preferredEmailAddressChanged

Examples

This example has been generated automatically.

SUB userProfile/taxAddressChanged

Examples

This example has been generated automatically.

SUB userProfile/preferredMailingAddressChanged

Examples

This example has been generated automatically.

SUB userProfile/additionalAddressCreated

Examples

This example has been generated automatically.

SUB userProfile/w9TaxWithholdingsStatusChanged

Examples

This example has been generated automatically.

SUB userProfile/userSmsOptInChanged

Examples

This example has been generated automatically.

SUB organizationProfile/preferredPhoneChanged

Examples

This example has been generated automatically.

SUB organizationProfile/preferredEmailAddressChanged

Examples

This example has been generated automatically.

SUB organizationProfile/taxAddressChanged

Examples

This example has been generated automatically.

SUB organizationProfile/preferredMailingAddressChanged

Examples

This example has been generated automatically.

SUB organizationProfile/additionalAddressCreated

Examples

This example has been generated automatically.

SUB organizationProfile/w9TaxWithholdingsStatusChanged

Examples

This example has been generated automatically.

SUB organizationProfile/websiteUrlChanged

Examples

This example has been generated automatically.

SUB accountApplications/started

Examples

This example has been generated automatically.

SUB accountApplications/approved

Examples

This example has been generated automatically.

SUB accountApplications/blocked

Examples

This example has been generated automatically.

SUB accountApplications/expired

Examples

This example has been generated automatically.

SUB accountApplications/canceled

Examples

This example has been generated automatically.

SUB enrollments/expired