--- metaDescription: false layout: open_api-doc targetEnvSelector: false --- Apiture Public Events 0.14.1 documentation
Apiture Public Events 0.14.1

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.

    • #Users

    Examples

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

    • #Users

    Examples

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

    • #Users

    Examples

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

    • #Users

    Examples

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

    • #Users

    Examples

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

    • #Users

    Examples

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

    • #Users

    Examples

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

    • #Organizations

    Examples

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

    • #Organizations

    Examples

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

    • #Organizations

    Examples

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

    • #Organizations

    Examples

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

    • #Organizations

    Examples

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

    • #Organizations

    Examples

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

    • #Organizations

    Examples

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

    • #Account Applications

    Examples

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

    • #Account Applications

    Examples

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

    • #Account Applications

    Examples

  • 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

    • #Account Applications

    Examples

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

    • #Account Applications

    Examples

  • 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,