Describes the event channels and event messages that the Apiture Open digital banking platform publishes for client subscription/consumption.
The DevBank public DevPortal sandbox environment
A user has changed their preferred phone number.
User Preferred Phone Number Changed
Fired after a customer changes their preferred phone number and it is reviewed and accepted.
Accepts the following message:
User (banking customer) changed their preferred phone number.
User (banking customer) changed their preferred phone number.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "userPreferredPhoneChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"phoneNumber": "+19105550155"
}
A user has changed their preferred email address.
User Preferred Email Address Changed
Fired after a customer changes their preferred email address and it is reviewed and accepted.
Accepts the following message:
User (banking customer) changed their preferred email address.
User (banking customer) changed their preferred email address.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "userPreferredEmailAddressChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"emailAddress": "JohnBankCustomer@example.com"
}
A user has changed their tax address.
User Preferred Tax Address Changed
Fired after a customer changes their tax address and it is reviewed and accepted.
Accepts the following message:
User (banking customer) changed their tax address.
User (banking customer) changed their preferred email address.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "userTaxAddressChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"address": {
"_id": "ha5",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
}
}
A user has changed their preferred mailing address.
User Preferred Mailing Address Address Changed
Fired after a customer changes their preferred mailing address and it is reviewed and accepted.
Accepts the following message:
User (banking customer) changed their preferred mailing address.
User (banking customer) changed their preferred email address.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "userPreferredMailingAddressChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"address": {
"_id": "ha5",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
}
}
A user has created a new address.
Additional User Address Created
Fired after a customer creates a new user postal address to their profile.
Accepts the following message:
User (banking customer) added a new postal address to their profile.
The user created a new address in additional their preferred mailing address.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "additionalUserAddressCreated",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"address": {
"_id": "ha5",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
}
}
A user has changed their W-9 tax withholding status.
User W-9 Tax Withholding Created
Fired after a customer changes their W-9 tax withholding status.
Accepts the following message:
User (banking customer) changed their W-9 tax withholding status.
A user changed their W-9 tax withholdings status. true
indicates the user is subject to backup W-9 tax withholdings.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "userW9TaxWithholdingsStatusChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"w9Withholdings": false
}
The user changed their SMS notification opt-in/opt-out setting.
User SMS Opt-In Setting Changed
The user changed their SMS notification opt-in/opt-out setting.
Accepts the following message:
The current user and their SMS notification setting.
Message conveying a user changed their SMS communication option.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "userSmsOptInChanged",
"version": "1.0.0",
"userId": "af2cadf2-8ac9-43f3-b639-06cb6bfa01bb",
"userUri": "https://api.devbank.apiture.com/users/users/af2cadf2-8ac9-43f3-b639-06cb6bfa01bb",
"trackingId": "X47-aaapeye",
"smsNotifications": false
}
A user has changed the organization's preferred phone number.
Organization Preferred Phone Number Changed
Fired after a customer changes the organization's preferred phone number and it is reviewed and accepted.
Accepts the following message:
User (banking customer) changed the organization's preferred phone number.
User (banking customer) changed the organization's preferred phone number.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "organizationPreferredPhoneChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"organizationId": "126d24d0-fcdb",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/126d24d0-fcdb",
"phoneNumber": "+19105550155"
}
A user has changed the organization's preferred email address.
Organization Preferred Email Address Changed
Fired after a customer changes the organization's preferred email address and it is reviewed and accepted.
Accepts the following message:
User (banking customer) changed the organization's preferred email address.
User (banking customer) changed the organization's preferred email address.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "organizationPreferredEmailAddressChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"organizationId": "126d24d0-fcdb",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/126d24d0-fcdb",
"emailAddress": "JohnBankCustomer@example.com"
}
A user has changed the organization's tax address.
Organization Preferred Tax Address Changed
Fired after a customer changes the organization's tax address and it is reviewed and accepted.
Accepts the following message:
User (banking customer) changed the organization's tax address.
User (banking customer) changed the organization's preferred email address.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "organizationTaxAddressChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"organizationId": "126d24d0-fcdb",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/126d24d0-fcdb",
"address": {
"_id": "wa1",
"type": "work",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
}
}
A user has changed the organization's preferred mailing address.
Organization Preferred Mailing Address Address Changed
Fired after a customer changes the organization's preferred mailing address and it is reviewed and accepted.
Accepts the following message:
User (banking customer) changed the organization's preferred mailing address.
User (banking customer) changed the organization's preferred email address.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "organizationPreferredMailingAddressChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"organizationId": "126d24d0-fcdb",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/126d24d0-fcdb",
"address": {
"_id": "ha5",
"type": "home",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
}
}
A user has created a new address.
Additional Organization Address Created
Fired after a customer creates a new user postal address to their profile.
Accepts the following message:
User (banking customer) added a new postal address to their profile.
The user created a new address in additional the organization's preferred mailing address.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "additionalOrganizationAddressCreated",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"organizationId": "126d24d0-fcdb",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/126d24d0-fcdb",
"address": {
"_id": "ba1",
"type": "business",
"addressLine1": "555 N Front Street",
"addressLine2": "Suite 5555",
"city": "Wilmington",
"regionCode": "NC",
"postalCode": "28401-5405",
"countryCode": "US"
}
}
A user has changed the W-9 tax withholding status of an organization.
Organization W-9 Tax Withholdings Status Changed
Fired after a customer changes the W-9 tax withholding status of an organization
Accepts the following message:
User (banking customer) changed the W-9 tax withholding status of an organization
A user changed the organization's W-9 tax withholdings status. true
indicates the organization is subject to backup W-9 tax withholdings.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "organizationW9TaxWithholdingsStatusChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"organizationId": "126d24d0-fcdb",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/126d24d0-fcdb",
"w9Withholdings": false
}
A user has changed the home website URL of an organization.
Organization Website URL Changed
Fired after a customer changes the home website URL of an organization
Accepts the following message:
User (banking customer) changed the home website URL of an organization
A user changed the organization's home website URL.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "organizationWebsiteUrlChanged",
"version": "1.0.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"organizationId": "126d24d0-fcdb",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/126d24d0-fcdb",
"homeUrl": "https://www.smitties-detailing.com"
}
New digital account opening account application started.
Account Application Started
Fired after a customer starts a new account application for review/approval.
Accepts the following message:
User (banking customer) started an account application to open a new account.
A user (banking customer) has started an account application for review/approval.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "accountApplicationStarted",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"applicationUri": "https://api.devbank.apiture.com/accountApplications/applications/491a1529-feba-47f2-a118-1632d5d8675a",
"applicationId": "491a1529-feba-47f2-a118-1632d5d8675a",
"products": {
"0": {
"accountType": "DDA",
"productId": "6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"uri": "https://api.devbank.apiture.com/products/products/6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"name": "Premiere Checking"
}
},
"organizationId": "b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0"
}
New digital account opening account application was approved, either automatically or by the financial institution.
Account Application Approved
Fired after a completed account application was approved.
Accepts the following message:
A completed account application was approved.
An account application has been approved, either automatically or by the financial institution.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "accountApplicationApproved",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"applicationUri": "https://api.devbank.apiture.com/accountApplications/applications/491a1529-feba-47f2-a118-1632d5d8675a",
"applicationId": "491a1529-feba-47f2-a118-1632d5d8675a",
"products": {
"0": {
"accountType": "DDA",
"productId": "6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"uri": "https://api.devbank.apiture.com/products/products/6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"name": "Premiere Checking"
}
},
"organizationId": "b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0"
}
New digital account opening account application has become blocked.
Account Application Blocked
Fired after a customer's account application has become blocked.
Accepts the following message:
User (banking customer) account application has become blocked.
An account application has become blocked.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "accountApplicationBlocked",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"applicationUri": "https://api.devbank.apiture.com/accountApplications/applications/491a1529-feba-47f2-a118-1632d5d8675a",
"applicationId": "491a1529-feba-47f2-a118-1632d5d8675a",
"products": {
"0": {
"accountType": "DDA",
"productId": "6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"uri": "https://api.devbank.apiture.com/products/products/6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"name": "Premiere Checking"
}
},
"organizationId": "b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0"
}
New digital account opening account application has expired.
Account Application Expired
Fired after a customer's account application has expired.
Accepts the following message:
User (banking customer) account application has expired.
A user's account application has expired
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "accountApplicationExpired",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"applicationUri": "https://api.devbank.apiture.com/accountApplications/applications/491a1529-feba-47f2-a118-1632d5d8675a",
"applicationId": "491a1529-feba-47f2-a118-1632d5d8675a",
"products": {
"0": {
"accountType": "DDA",
"productId": "6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"uri": "https://api.devbank.apiture.com/products/products/6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"name": "Premiere Checking"
}
},
"organizationId": "b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"createdAt": "2021-07-08T11:44:01.375Z",
"expiredAt": "2021-08-19T05:57:38.375Z"
}
A user has canceled a digital account opening account application.
Account Application Canceled
Fired after a customer has canceled an account application.
Accepts the following message:
User (banking customer) has canceled an account application.
A user (banking customer) has canceled an account application.
{
"_id": "event1234",
"occurredAt": "2021-05-05T13:21:39.375Z",
"type": "accountApplicationCanceled",
"version": "1.1.0",
"userId": "126d24d0-fcdb",
"userUri": "https://api.devbank.apiture.com/users/users/126d24d0-fcdb",
"trackingId": "X47-aaapeye",
"applicationUri": "https://api.devbank.apiture.com/accountApplications/applications/491a1529-feba-47f2-a118-1632d5d8675a",
"applicationId": "491a1529-feba-47f2-a118-1632d5d8675a",
"products": {
"0": {
"accountType": "DDA",
"productId": "6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"uri": "https://api.devbank.apiture.com/products/products/6cfe0655-146c-4a7a-93b0-39fa57a1b492",
"name": "Premiere Checking"
}
},
"organizationId": "b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0",
"organizationUri": "https://api.devbank.apiture.com/organizations/organization/b4d848a1-8d59-45b0-a307-0c7b2d2ce9d0"
}
Enrollment as a joint owner or authorized signer on an account has expired.
Enrollment Expired
Fired after a customer's account application has expired.
Accepts the following message:
User (banking customer) account application has expired.
A user's enrollment as an account joint owner or authorized signer has expired,