Release Notes

Apiture Open Banking APIs Release Notes

This page lists recent Changes and Deprecations in the Apiture Open Banking APIs.

The current release of the platform includes the following APIs and versions:

API Description Version
Accounts Access internal accounts and account details (balances, etc.) at a financial institution, as well as linked external accounts 0.71.0
Account Verifications Verifies access to linked external financial institution accounts 0.22.0
Applications Manages the data and workflow for applications for new banking accounts 0.33.0
Approvals Record the pending review, and approval or rejection of processes, documents or other resources which require manual intervention 0.13.2
Associations Maintain associations and roles between related business objects 0.8.4
Audit Administrative access to user authentication and other banking activity audit records 0.10.0
Authentication Authentication 0.33.0
Business Verifications Allows financial institutions to verify business identities and the identities of authorized representatives connected to the business 0.12.0
Cards Manage banking and debit cards 0.26.0
Check Deposits Deposit checks by submitting pictures from a mobile device 0.12.0
Check Orders Order checkbooks for checking accounts 0.14.0
Contacts Manage people and their personal contact information such as date of birth, addresses, phone numbers, and email addresses 0.25.1
Configurations Platform configuration 0.8.0
Consents Tracks a user’s consent of financial institution policies and documents such as account terms and conditions, electronic consent, and privacy policy 0.11.1
Dates Perform date calculations, such as processing dates 0.7.0
Documents List and download banking documents such as statements, tax forms, and notices 0.6.2
Identity Verify the identity of individuals such as account owners and authorized signers 0.14.0
Invitations Invite others to become joint owners of personal accounts or authorized signers of business accounts 0.6.2
Messages Secure conversational messages between the customer and the financial institution 0.4.1
Notifications In-app contextual messages and global notifications 0.15.0
Organizations Represents businesses, trusts, and other entities, primarily for business accounts ownership 0.38.0
Payments Request payments to a payee, using various payment methods 0.12.0
Products The financial institution’s list of banking products (savings, checking, certificates of deposit); each account is an instance of a product 0.34.0
Text Manage customizable text for client applications 0.11.0
Transfers Transfer funds between a financial institution’s accounts or between an FI’s account and an external account 0.19.3
Transactions Account transaction history 0.26.0
Users People who are enrolled in digital banking, with a user ID and credentials 0.38.0
Vault Document storage in hierarchical folders, with document revision history 0.15.0
Workflow Business processes, included automatic and manual human-driven tasks, such as filling in forms or approving activities 0.24.0

Changes

Below are noteworthy changes in the Apiture Open Banking APIs.

Accounts API Changes

  • Added API operations and schemas to manage overdraft sweep accounts
    • Added new operations: getEligibleOverdraftAccounts, addOverdraftAccount, getOverdraftAccounts, getOverdraftAccount, deleteOverdraftAccounts
    • Added new schemas: overdraftAccount, overdraftAccounts, eligibleOverdraftAccounts
  • A new source property was added to externalAccount; see the new externalAccountSource schema.
  • A new accountUsageAnswers property was added to the createAccount operation.
  • Account API configuration has a new configuration group, accountRelatedQuestions.
  • The personalBeneficiary.birthdate property is no longer required. The Accounts API service will enforce that at least one of taxId or birthdate must be set when adding or updating a personalBeneficiary.
  • External accounts have a new verificationMethod property which indicates if the account was verified through instance verification or micro-deposits.

  • API has two new operations, getAccountTrackingIds and addAccountTrackingIds, to support adding reference IDs, campaign IDs or other forms of tracking IDs to new accounts.

  • Add a new beneficiary.percent property to allow fractional numbers.
  • Add new interestRates.promotionExpiresAt ans interestRates.promotionType properties.
  • Add a new user param to getAccounts and getExternalAccounts operations for admins/operators to find resources for a user
  • Remove required constraint on individualBeneficiary.birthdate

Account Verifications Changes

  • Add an optional request body to createAccountVerificationProviderParameters operation to support micro-deposit verification through a vendor widget.
  • Create new schema createAccountVerificationproviderParameters that is the request body for the accountVerificationProviderParameters endpoint
  • Create new schema providerExternalAccount that extends the existing simpleExternalAccount and adds providerId and verificationReport

Applications API Changes

  • API has two new operations, getApplicationTrackingIds and addApplicationTrackingIds, to support adding reference IDs, campaign IDs or other forms of tracking IDs to applications; these IDs will also be pushed into the account opened at the end of digital account opening.
  • Added validatePromotion operation
  • Added promotionCode and validatedPromotionCode schemas
  • Added property promotionCode to createApplication and application
  • Add the new user param to getApplications and getEnrollments operations for admins/operators to find resources for a user
  • Added operations getAccountTrackingIds, addAccountTrackingIds
  • Add accountVerificationMethod to application schema
  • Add reviewedBy, reviewerFirstName, reviewerLastName properties to application schema
  • Define &filter=/&sortBy= query parameters for getApplications / getEnrollments

Approvals API Changes

  • Add 412 responses for operations which update approvals and consume an ETag header
  • Removed updateApproval schema (use approval)
  • Remove updateApprovalType schema (use approval)
  • Remove patchApprovalType schema (use approval)a
  • Fix state example in approval (active should be approved)

Associations API Changes

  • Removed incorrect 409 response from patchRole. Patching an association role is allowed even if a role is in use.
  • Update operations to use association instead of updateAssociation schema
  • Update operations to use role instead of updateRole schema

Audit API Changes

  • Add userId, operatorId and coreCustomerId to record schema.
  • Fix doc for endAt/startAt/period in getAudiRecords operation

Authentication API Changes

  • Added captcha to the userConfirmation request body used for “Claim Your Account”.
    • This is a new required property which is a breaking change - all clients must be updated. This is done for security reasons.
  • Require encryption of the taxId in the confirmUser request.
    • This is also a breaking change - all clients must be updated. This is done for security reasons.
  • Added error types to the confirmUser operation 422 error:
    • expiredCaptcha
    • invalidCaptcha
    • catchaAlreadyUsed
    • captchaThresholdNotMet
  • Deferred removal of deprecated authorize and createToken operations to version 0.35.0
  • Removed the GET /metadata operation; it was never implemented. Instead, direct clients to https://{issuer-host}/{issuer-path}/.well-known/openid-configuration
  • Remove authMetadata schema (returned by GET /metadata)
  • Document apiture:issuer and apiture:openidConfiguration operations
  • Add emailAddress and mobilePhone to preferredUsername
  • Add maskedTarget to authenticator
  • Changed min/max length for preferredUsername.username to 5/30
  • The confirmUser operation to confirm users that the financial institution migrated into the the digital banking platform now requires a new property reCaptchaResponse in the userConfirmation request body. This is neessary for security purposes to help prevent malicious activity. This was introduced in version 0.33.0 of the Authentication API.

Cards API Changes

  • Cards may be shipped to any valid address, not just preferred mailing address
  • Add shippingAddressId to the createCardRequest and cardRequest shemas
  • Add operations to list/add/remove secondary accounts to cards
  • Add operation to list eligible accounts for a card
  • Add new schemas, responses, and error types to support those operations
  • Add service configuration operations
  • Added activationExpiresOn and shippedOn properties to card

Check Deposits API Changes

  • Add rejectReason to check
  • Add new states acceptedAdjustedDown and acceptedAdjustedUp

Check Orders API Changes

  • In the getOrders operation, the query parameter state may have additional values, processed and failed.
  • Fixed constraint on checkbookQuantity to maximum: 6
  • Remove the deleteOrder operation; it was never implemented
  • Add shippingAddressSource to enable organization or user sourced addresses
  • Updated examples to use product code S-, D-, C- prefixes

Contacts API Changes

  • increase maxLength of otherOccupation to 100.
  • Add extension to phoneNumber schema
  • Add service configuration operations
  • Add maxLength constraints in contactName

Note: Changes in Contacts propagate to other APIs such as Users, Organizations, Account Applications which reuse the schemas from Contacts.

Documents API Changes

  • Added new document type additionalOverdraftCoverage to the types value in the configuration group documents. No api-def change
  • Added createDocumentProviderParameters and getDocumentGroups operations
  • Added new schemas createDocumentProviderParameters, documentGroups, documentGroup
  • Added missing API-Key security requirement on getDocumentTypes and getDocumentCategories
  • fixed pattern and minLength/maxLength on documentType, documentCategory schemas
  • Added configuration group documentProviders
  • Add inboundCorrespondence to documentCategories
  • Change getLabel response from to reuse the common labelGroups schema

Identity API Changes

  • Add service configuration operations
  • Change getLabel response from to reuse the common labelGroups schema

Messages API Changes

  • New API

Notifications API Changes

  • Add service configuration operations
  • Added readState property to summaryNotification
  • Added readAt property to notification
  • Allow for notificationDefinition.contextName to be “none”; this means the notification is not rendered in context but in the Notification Center or other page/view just for notifications.

Organizations API Changes

  • Add taxAddressId property and setTaxAddress operation; update other doc with behavior for setting or deleting the tax address.
  • Fixed misspelling of “Hundred” in getLabels response and examples (was “Hunred”). Add corrected choice values and hide the ones with the misspelling.
  • Added acceptsRcc to regulatory schema

Payments API

  • Change maxLength of payee accountNumber from 34 to 17

Products API Changes

  • Add summaryProduct.promotionalCodesEnabled
  • Add configuration for defining account Action menus per product
  • Add tiers to productInterestRates
  • Removed properties and schemas that were marked to be removed by version 0.29.0 including rate (which was replaced with rates). This required incrementing the major version number of several schemas.
  • Update SummaryProduct version to include new regDEnabled field
  • Add coreBanking.finxact.interestMatrixDimKey
  • highlights and secondaryHighlights may now be templated so rates can be inserted.
  • Added ?unresolved=boolean query param on getProduct

Text API Changes

  • Added a description to textStringFields/textString schemas. Not required.

Transfers API Changes

  • Add transferRegDLimitExceeded error for the preFlightValidate response
  • Add new 200 response for the POST on /scheduledTransfers to use new error
  • Formally deprecated transferAccount.accountTitle ; replace with transferAccount.title

Transactions API Changes

  • Removed providerSummary as a required field from transaction definition
  • Fixed type definition on transactions.inquiries Type has changed but this had not been implemented yet.
  • Changed transaction.inquiry to transactions.inquiries Type has changed but this has not been implemented yet.
  • Changed transaction.inquiry to transactions.inquiry. Type has changed but this has not been implemented yet.
  • Added _links to transactionInquiry
  • Defined the apiture:messageThread link for a transactionInquiry
  • Add verbiage that says cashBackAmount is only returned when network is eft
  • Add purchaseAmount property on transaction
  • Increase maxLength of transactionMemo.text to 500.
  • Move cashBackAmount from electronicFundsTransfer to transaction since it can be returned on check transactions
  • Add payeeIfxAccountType and payerIfxAccountType to ach schema
  • Add transaction.memo, transaction.availableAmount, electronicFundsTransfer.merchantName
  • Add transactionMemo , transactionRecurrence schema
  • Add getTransactionMemo, updateTransactionMemo and deleteTransactionMemo operations.
  • Add service configuration operations

Users API Changes

  • Added new lookupUsers operation (admin use only)
  • Made taxid required in userSearch schema
  • API has two new operations, getUserTrackingIds and addUserTrackingIds, to support adding reference IDs, campaign IDs or other forms of tracking IDs to new accounts.
  • Remove 202 Accepted and Retry protocol for createOpenBankingConsentParameters
  • Fixed pattern constraint on createOpenBankingConsentParameters.integration pattern: ^[a-z][a-zA-Z0-9_$]{3,23}$ to pattern: ^[a-z][a-zA-Z0-9_$]{1,23}$ so the pattern accepts the example fdx and also matches minLength: 2
  • Add createOpenBankingConsentParameters operation and schemas
  • Add noSuchOpenBankingIntegration, invalidOpenBankingParameters error types for createOpenBankingConsentParameters 422 response
  • Redefine searchUsers operation to search by text.
  • Add employerAddress and employerPhoneNumber to kycAnswers
  • Add military to default choices for kycIdentificationType
  • Add identificationCountry to to kycAnswers:
  • Add operations getAccountTrackingIds, addAccountTrackingIds
  • Add taxAddressId, add operations to set tax address.
  • Rename identificationType to kycIdentificationType in choices
  • Fix identificationIssuer to max length 6
  • Update docs on updating/deleting addresses to enforce constraints

Vault API Changes

  • Add stateIdentificationFront and stateIdentificationBack to the list of file categories

Workflow API Changes

  • Add conversion property to binding schema
  • remove use of attributeValue schema - values is just a type: object with additionalAttributes: true

Deprecations

Accounts API Deprecations

  • The beneficiary.percentage integer property will become deprecated. Instead, clients should use the beneficiary.percent number property which can hold fractional allocations. beneficiary.percent will be added in 1.38.0. beneficiary.percentage will be removed in a future release, 1.40.0 or later.

Applications API Deprecations

  • The applicant property of the createEnrollment, summaryEnrollment, and enrollment schemas is deprecated. It will be removed in release 0.30.0 or later of the Applications API, when the schema versions will increase to 2.0.0, 2.0.0, and 2.0.0 respectively. Use the applicants array instead.

Associations API Deprecations

  • The updateAssociation schema is deprecated. Use the association schema for the patchAssociation request body. The updateAssociation schema was deprecated in version 0.8.0 and will be removed on or after version 0.9.0 of the Associations API

  • The updateRole schema is deprecated. Use the role schema for the updateRole and patchRole request bodies. The updateRole schema was deprecated in version 0.8.0 and will be removed on or after version 0.9.0 of the Associations API

Audit API Changes

  • The onBehaldOf and customerid properties in the record schema are deprecated for removal in version 2.0.0 of the record schema, to be removed on or after version 0.11.0 of the Audit API. Use userId instead of customerId to reference the User from the Apiture Users service. Use coreCustomerId to reference the customer from the banking core. If operatorId is set, it is the ID of the financial institution operator who performed the action.

Consents API Deprecations

  • The getLabels operation response schema localizedLabels and the localizedLabel schema are deprecated. They will be replaced by the labelGroups and related schemas (as used in the getLabels operations in other APIs), on or after release 0.11.0 of the Consents API.
  • The criteria for matching existing consents in the getNeededConsents and giveConsent operations is changing in release 0.11.0 of the API to match only the consent type and the document.uri, not the document context.

Contacts API Deprecations

  • The contactVerificationFields in the identifiedContact schema is deprecated and will be removed in version 2.0.0 of the identifiedContact schema, on or after version 0.25.0 of the Contacts API. Instead, use the corresponding verification properties kycAnswers, identityVerificationStatus, and identityVerification in the Users API.

  • The following properties in the createContact, summaryContact, and contact schemas are deprecated and will be removed on or after version 0.25.0 of the Contacts API:
    kycAnswers
    identityVerificationStatus
    identityVerification
    yearsAtAddress
    Replace these properties with the corresponding properties on the user schema in the Users API. Contacts no longer have identity verification properties, only authenticated users do.

  • The following related schemas are also deprecated in the Contacts API and will be removed on or after version 0.25.0 of the Contacts API; corresponding schemas exist in the Users API.
    contactVerificationFields
    identityVerification
    foreignPoliticalFigureAssociation

  • The following properties are currently defined with an enum constraint list in Contacts API. These enumeration constraints will be removed in a future release of the Contacts API. Instead, the list of valid values is configurable by the financial institution for each of these, as defined by the label group of the same name in getLabels operation response. For example, the list of valid values for the phoneNumberType is defined in the label group named phoneNumberType.

Schema or Property Used in Schemas
citizenship identifiedContact, createContact, summaryContact, userContact
occupation identifiedContact, createContact, summaryContact, userContact
preferredContactMethod simpleContact, identifiedContact, createContact, summaryContact, userContact
phoneNumberType phoneNumber
email typedEmailAddress
addressType address

Also note that these properties are included in other schemas composed from or which use these defining schemas, and those schemas may be used in other APIs such as summaryUser and user in the Users API.

Identity API Deprecations

  • The getContactVerification verification operation (GET /identity/contactVerification), contactVerification schema, and the contactUri and userUri query parameters on the getContactVerification operation are deprecated. They will be removed on or after version 0.15.0 of the Identity API. Instead, use the getIdentityVerification operation and the identityVerification schema.

  • The createApproval and getApproval operations and the approval schema are deprecated. They will be removed on or after version 0.15.0 of the Identity API. Instead, use an Approval resource and the approval resource from the Approvals API operation.

Organizations API Deprecations

  • The operations for managing authorized signer for an organization ( createAuthorizedSigner, deleteAuthorizedSigner) in the Organizations API are deprecated as of version 0.38.1 of the API. Authorized signers are implemented per-account in the Accounts API. These operations will be removed in version 0.40.0 of the Organizations API.

  • The expiration property on the organizationIdentification schema is deprecated. It will be removed on version 2.0.0 of the organizationIdentification schema on or after version 0.38.0 of the Organizations API. Use the expiresOn date property instead.

  • The establishedDate property on the organizationIdentification schema is deprecated. It will removed on version 2.0.0 of the organizationIdentification schema on or after version 0.38.0 of the Organizations API. Use the establishedOn date property instead.

  • The following properties are currently defined with an enum constraint list in Organizations API. These enumeration constraints will be removed in a future release of the Contacts API. Instead, the list of valid values is configurable by the financial institution for each of these, as defined by the label group of the same name in getLabels operation response. For example, the list of valid values for the yearsOwned is defined in the label group named yearsOwned.

Schema or Property Used in Schemas
accountPurpose createOrganization, summaryOrganization
estimatedAnnualRevenue regulatory
intermediaryServices regulatory
yearsOwned createOrganization, summaryOrganization
physicalLocationsCount createOrganization, summaryOrganization

Also note that these properties are included in other schemas composed from or which use these defining schemas.

Products API Deprecations

  • The following properties are currently defined with an enum constraint list in Products API. These enumeration constraints will be removed in a future release of the Contacts API. Instead, the list of valid values is configurable by the financial institution for each of these, as defined by the label group of the same name in getLabels operation response. For example, the list of valid values for the productFeeType is defined in the label group named productFeeType.
Schema or Property Used in Schemas
productFeeType fee, productDetails, createProduct, product

Also note that these properties are included in other schemas composed from or which use these defining schemas, such as Accounts API.

Transfers API Deprecations

  • The accountTitle property of the transferAccount schema is deprecated and will be removed on version 2.0.0 of the transferAccount schema. Use the title property instead. The property will be removed on or after version 0.20.0 of the Transfers API. Note that the transferAccount schema is used in other Apiture Open Banking APIs APIs, notably Accounts and Applications.

  • The modifiedBy property in the scheduledTransfer and pastTransfer schemas is deprecated and will be removed on version 2.0.0 of the respective schemas, or after version 0.20.0 of the Transfers API. Use the updatedBy property instead.

Users API Deprecations

  • The searchUsers operation is deprecated. To find users by tax ID (for administrative use), use the new lookupUser operation
  • Deprecate userSearch schema
  • The identityVerification property of the userVerificationFields, userFields, createUser, summaryUser, and user schemas will be removed on version 2.0.0 of the respective schemas, on or after version 0.32.0 of the Users API.