API Error Types
Below is a list of the RFC 7807 application/problem+json error types that may be returned in 4xx error responses from Apiture Digital Banking APIs. See Error Responses for more details.
accountNotActive
Error type url: https://api.apiture.com/errors/accountNotActive/v1.0.0
Version: 1.0.0
Description: The selected account is not active.
Remediation: Select an account that is active.
accountTypeNotEligibleForLoanPayoffQuote
Error type url: https://api.apiture.com/errors/accountTypeNotEligibleForLoanPayoffQuote/v1.0.0
Version: 1.0.0
Description: The account type is not eligible for displaying a loan payoff quote.
Remediation: Select an account with the viewLoanPayoffQuote entitlement.
antiMalwareRequired
Error type url: https://api.apiture.com/errors/antiMalwareRequired/v1.0.0
Version: 1.0.0
Description: The financial institution requires the customer to have anti-malware software installed.
Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
badRequest
Error type url: https://api.apiture.com/errors/badRequest/v1.0.0
Version: 1.0.0
Description: The request body and/or parameters was not well-formed.
Remediation: Correct any syntax or schema errors in the request body or parameters.
cannotDeletePeerAccount
Error type url: https://api.apiture.com/errors/cannotDeletePeerAccount/v1.0.0
Version: 1.0.0
Description: The caller cannot delete a peer account that is in use in pending transfers.
Remediation: Cancel the transfers that use this peer account, or archive the account.
cannotDeleteProcessedTransfers
Error type url: https://api.apiture.com/errors/cannotDeleteProcessedTransfers/v1.0.0
Version: 1.0.0
Description: The delete operation is only allowed for transfers which have not begun processing.
Remediation: Select a pending or scheduled transfer.
cannotTransferFrom
Error type url: https://api.apiture.com/errors/cannotTransferFrom/v1.0.0
Version: 1.0.0
Description: The customer does not have transferFrom entitlement on the source account.
Remediation: Choose a source account that allows transfers from it.
cannotTransferTo
Error type url: https://api.apiture.com/errors/cannotTransferTo/v1.0.0
Version: 1.0.0
Description: The customer does not have transferTo entitlement on the target account.
Remediation: Choose a target account that allows transfers to it.
cdMaturityTransferAccountAndProductAreMutuallyExclusive
Error type url: https://api.apiture.com/errors/cdMaturityTransferAccountAndProductAreMutuallyExclusive/v1.0.0
Version: 1.0.0
Description: CD maturity may only specify a transfer account or a transfer product, not both.
Remediation: Set only one of a transfer account or a transfer product.
challengeBlocked
Error type url: https://api.apiture.com/errors/challengeBlocked/v1.0.0
Version: 1.0.0
Description: The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication.
Remediation: Have the user end their login session and login again.
challengeRequired
Error type url: https://api.apiture.com/errors/challengeRequired/v1.0.0
Version: 1.0.0
Description: The operation requires the customer to complete an identity challenge.
Remediation: Complete the challenge as per the problem response, and add an additional Challenge header to the call.
conflict
Error type url: https://api.apiture.com/errors/conflict/v1.0.0
Version: 1.0.0
Description: The request could not be completed due to a conflict with the current state of the target resource.
Remediation: Try another operation that is allowed.
creationDateTimeFilterConflict
Error type url: https://api.apiture.com/errors/creationDateTimeFilterConflict/v1.0.0
Version: 1.0.0
Description: The filters creationPeriod and createdAt query parameters are mutually exclusive.
Remediation: Pass only one of creationPeriod and createdAt.
customerDisabled
Error type url: https://api.apiture.com/errors/customerDisabled/v1.0.0
Version: 1.0.0
Description: The customer is disabled.
Remediation: Have the customer contact the financial institution for support.
duplicateOverdraftAccountIds
Error type url: https://api.apiture.com/errors/duplicateOverdraftAccountIds/v1.0.0
Version: 1.0.0
Description: The id values in the request list the same account id more than once.
Remediation: Use eligible unique accounts only.
duplicateOverdraftAccounts
Error type url: https://api.apiture.com/errors/duplicateOverdraftAccounts/v1.0.0
Version: 1.0.0
Description: The items in the request list the same account id more than once.
Remediation: Use eligible unique accounts only.
duplicatePeerAccount
Error type url: https://api.apiture.com/errors/duplicatePeerAccount/v1.0.0
Version: 1.0.0
Description: The customer already has a peer account which matches the given data.
Remediation: Enter data for an unique account.
duplicatePeerAccountNickname
Error type url: https://api.apiture.com/errors/duplicatePeerAccountNickname/v1.0.0
Version: 1.0.0
Description: The customer already has a peer account with the given nickname.
Remediation: Enter a unique nickname for the account.
externalToExternalTransferNotAllowed
Error type url: https://api.apiture.com/errors/externalToExternalTransferNotAllowed/v1.0.0
Version: 1.0.0
Description: Transfers from an external account to another external is not allowed.
Remediation: At least one of the source or target accounts must be an internal account held at the financial institution.
forbidden
Error type url: https://api.apiture.com/errors/forbidden/v1.0.0
Version: 1.0.0
Description: The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access.
Remediation: Check the user’s permissions and entitlements before attempting the operation.
gatewayTimeout
Error type url: https://api.apiture.com/errors/gatewayTimeout/v1.0.0
Version: 1.0.0
Description: The server did not receive a timely response from an upstream server it needed to access in order to complete the request.
Remediation: Wait a few minutes and try again, or gracefully fail the client request.
insufficientFundsForTransfer
Error type url: https://api.apiture.com/errors/insufficientFundsForTransfer/v1.0.0
Version: 1.0.0
Description: The source account has insufficient funds.
Remediation: Reduce the transfer amount to less than the available balance.
invalidAccountId
Error type url: https://api.apiture.com/errors/invalidAccountId/v1.0.0
Version: 1.0.0
Description: The named accountId does not exist or the user is not entitled to access the account.
Remediation: Pass the id of an existing account the caller has access to.
invalidAccountIds
Error type url: https://api.apiture.com/errors/invalidAccountIds/v1.0.0
Version: 1.0.0
Description: One or more account IDs are invalid and do not correspond to accounts.
Remediation: Remove the invalid account IDs from the request and try again.
Error objects of this invalidAccountIds type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
accountIds | array | The list of invalid account IDs. |
invalidCdMaturityTransferAccount
Error type url: https://api.apiture.com/errors/invalidCdMaturityTransferAccount/v1.0.0
Version: 1.0.0
Description: The selected transfer account ID does not match an existing account.
Remediation: Select a deposit account that is eligible for debit transfers for the current user.
invalidChallengeFactor
Error type url: https://api.apiture.com/errors/invalidChallengeFactor/v1.0.0
Version: 1.0.0
Description: The factor in the request does not match available factors.
Remediation: Use a factor that corresponds to the challengeId from the corresponding challenge.
invalidChallengeFactorState
Error type url: https://api.apiture.com/errors/invalidChallengeFactorState/v1.0.0
Version: 1.0.0
Description: The selected challenge factor is not active.
Remediation: Start the challenge factor to set it as active before verifying a user response.
invalidChallengeId
Error type url: https://api.apiture.com/errors/invalidChallengeId/v1.0.0
Version: 1.0.0
Description: The provided challengeId is invalid, expired, already claimed, or does not match the factor or context.
Remediation: Provide the corresponding operationId, factor and id from the challenge.
invalidChallengeOperationId
Error type url: https://api.apiture.com/errors/invalidChallengeOperationId/v1.0.0
Version: 1.0.0
Description: The operationId is invalid.
Remediation: Use the operationId from the corresponding challenge.
invalidIdentityChallengeHeader
Error type url: https://api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0
Version: 1.0.0
Description: The additional on-time Challenge header in this request is expired, already used, or otherwise invalid.
Remediation: Supply a valid, unexpired, unclaimed Challenge header in the request.
invalidLocationParameters
Error type url: https://api.apiture.com/errors/invalidLocationParameters/v1.0.0
Version: 1.0.0
Description: Only one type of location parameter may be included or a location parameter is missing a value.
Remediation: Provide correct location parameters.
invalidLocator
Error type url: https://api.apiture.com/errors/invalidLocator/v1.0.0
Version: 1.0.0
Description: The locator value is invalid for the given locatorType.
Remediation: Pass a valid ABA routing number, IBAN number, or SWIFT/BIC code, as per the given locatorType.
invalidPeerAccountInstitutionData
Error type url: https://api.apiture.com/errors/invalidPeerAccountInstitutionData/v1.0.0
Version: 1.0.0
Description: The caller passed bank properties when the institution is a credit union, or passed credit union data when the institution is a bank, or the caller passed both or neither
Remediation: Pass bank only when the institution is a bank, and pass creditUnion only when the institution is a credit union
invalidPeerAccountState
Error type url: https://api.apiture.com/errors/invalidPeerAccountState/v1.0.0
Version: 1.0.0
Description: This request is not allowed for a peer account in this state.
Remediation: Invoke the operation only on peer accounts in the required state for this operation.
Error objects of this invalidPeerAccountState type may have the following attributes
as defined by this JSON schema
| Property | Type | Description |
|---|---|---|
currentState | undefined | The peer account's current state. |
requiredState | undefined | The state the peer account must be in for this operation |
invalidRestrictionDateRange
Error type url: https://api.apiture.com/errors/invalidRestrictionDateRange/v1.0.0
Version: 1.0.0
Description: The startOn date should be no earlier than a week before the start of the current month, and the endOn date must fall after the startOn date
Remediation: Pass valid values for startOn and endOn
invalidRolloverProduct
Error type url: https://api.apiture.com/errors/invalidRolloverProduct/v1.0.0
Version: 1.0.0
Description: The selected rollover product is not eligible for CD rollover.
Remediation: Select an active CD rollover product that meets the balance and other requirements.
invalidSourceAccountId
Error type url: https://api.apiture.com/errors/invalidSourceAccountId/v1.0.0
Version: 1.0.0
Description: The named sourceAccountId does not exist or the user is not entitled to access the account.
Remediation: Pass the id of an existing account the caller has access to.
invalidTargetAccountId
Error type url: https://api.apiture.com/errors/invalidTargetAccountId/v1.0.0
Version: 1.0.0
Description: The named targetAccountId does not exist or the user is not entitled to access the account.
Remediation: Pass the id of an existing account the caller has access to.
invalidTransferSchedule
Error type url: https://api.apiture.com/errors/invalidTransferSchedule/v1.0.0
Version: 1.0.0
Description: The transfer schedule is invalid.
Remediation: Choose a date that is not in the past or past the cutoff time.
maximumNumberOfPeerAccountsReached
Error type url: https://api.apiture.com/errors/maximumNumberOfPeerAccountsReached/v1.0.0
Version: 1.0.0
Description: The customer/member has reached the maximum number of peer accounts.
Remediation: Instruct the customer to delete an existing peer account.
modificationForbidden
Error type url: https://api.apiture.com/errors/modificationForbidden/v1.0.0
Version: 1.0.0
Description: The customer is properly authenticated but not authorized to create, modify, or delete resources.
Remediation: Avoid modification operation for customers with read-only authorization.
noIdentityChallengeFactors
Error type url: https://api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0
Version: 1.0.0
Description: This operation requires an identity challenge, but the user does not have the necessary registered authentication factors.
Remediation: Have the user register one or more challenge security code delivery factors.
noSuchAccount
Error type url: https://api.apiture.com/errors/noSuchAccount/v1.0.0
Version: 1.0.0
Description: There is no such account at the given accountId
Remediation: Use the accountId of an account the user is entitled to view.
noSuchCdMaturityTransferAccount
Error type url: https://api.apiture.com/errors/noSuchCdMaturityTransferAccount/v1.0.0
Version: 1.0.0
Description: The selected transfer account ID does not match an existing account.
Remediation: Select a deposit account that is eligible for debit transfers for the current user.
noSuchCdMaturityTransferProduct
Error type url: https://api.apiture.com/errors/noSuchCdMaturityTransferProduct/v1.0.0
Version: 1.0.0
Description: The selected transfer product ID does not match an existing product.
Remediation: Select a deposit product that is eligible for new account creation and funding transfer.
noSuchPeerAccount
Error type url: https://api.apiture.com/errors/noSuchPeerAccount/v1.0.0
Version: 1.0.0
Description: There is no such peer account at the financial institution for the given data.
Remediation: Provide the account holder name and account numbers for an active account.
noSuchRolloverProduct
Error type url: https://api.apiture.com/errors/noSuchRolloverProduct/v1.0.0
Version: 1.0.0
Description: The rollover product does not exist.
Remediation: Select an active CD rollover product that meets the balance and other requirements.
noSuchTransaction
Error type url: https://api.apiture.com/errors/noSuchTransaction/v1.0.0
Version: 1.0.0
Description: There is no such transaction at the given transactionId
Remediation: Use the transactionId of a transaction from the list of transaction items.
noTransactionImages
Error type url: https://api.apiture.com/errors/noTransactionImages/v1.0.0
Version: 1.0.0
Description: There are no transaction images associated with this transaction.
Remediation: Invoke this operation only when a transaction has images.
nonPositiveAmount
Error type url: https://api.apiture.com/errors/nonPositiveAmount/v1.0.0
Version: 1.0.0
Description: The transfer amount may not be 0.00.
Remediation: Set the transfer amount to a positive number.
notFound
Error type url: https://api.apiture.com/errors/notFound/v1.0.0
Version: 1.0.0
Description: The resource at the requested URL does not exist.
Remediation: Use the URL of an existing resource.
overdraftAccountNotEligible
Error type url: https://api.apiture.com/errors/overdraftAccountNotEligible/v1.0.0
Version: 1.0.0
Description: The named account is not eligible as an overdraft protection account.
Remediation: Use an account from the listEligibleOverdraftAccounts response for the protected account.
overdraftElectionsViolatesPolicies
Error type url: https://api.apiture.com/errors/overdraftElectionsViolatesPolicies/v1.0.0
Version: 1.0.0
Description: One or mode of the requested the primary and secondary overdraft protection elections violate the financial institution’s policies.
Remediation: Update the election(s) to conform to the financial institution policies, available via the getOverdraftProtectionPolicies operation.
primaryOverdraftProtectionNotAvailable
Error type url: https://api.apiture.com/errors/primaryOverdraftProtectionNotAvailable/v1.0.0
Version: 1.0.0
Description: The caller requested a change to the primary overdraft protection election, but the financial institution does not offer a primary overdraft protection plan for the given account.
Remediation: Only change primary overdraft protection elections for accounts that already have a primary election.
restrictionDateRangeTooLarge
Error type url: https://api.apiture.com/errors/restrictionDateRangeTooLarge/v1.0.0
Version: 1.0.0
Description: The endOn is limited to four years after the startOn date
Remediation: Limit the endOn date to no more than four years after the startOn date
sameSourceAndTargetTransferAccounts
Error type url: https://api.apiture.com/errors/sameSourceAndTargetTransferAccounts/v1.0.0
Version: 1.0.0
Description: The source and target account are the same.
Remediation: Choose different source and target accounts.
secondaryOverdraftProtectionNotAvailable
Error type url: https://api.apiture.com/errors/secondaryOverdraftProtectionNotAvailable/v1.0.0
Version: 1.0.0
Description: The caller requested a change to the secondary overdraft protection election, but the financial institution does not offer a secondary overdraft protection plan for the given account.
Remediation: Only change secondary overdraft protection elections for accounts that already have a secondary election.
targetLoanPayoffDateInThePast
Error type url: https://api.apiture.com/errors/targetLoanPayoffDateInThePast/v1.0.0
Version: 1.0.0
Description: The target loan payoff date is in the past.
Remediation: Select a target loan payoff date that is today or in the future, up to the maximum allowable loan payoff target date.
targetLoanPayoffDatePastAccountMaturityDate
Error type url: https://api.apiture.com/errors/targetLoanPayoffDatePastAccountMaturityDate/v1.0.0
Version: 1.0.0
Description: The target loan payoff date is past the loan account maturity date.
Remediation: Select a target loan payoff date that is before or on the loan account maturity date.
targetLoanPayoffDatePastMaxTargetDate
Error type url: https://api.apiture.com/errors/targetLoanPayoffDatePastMaxTargetDate/v1.0.0
Version: 1.0.0
Description: The target loan payoff date is past the maximum allowable loan payoff target date.
Remediation: Select a target loan payoff date that is before or on the maximum allowable loan payoff target date.
tooManyOverdraftAccounts
Error type url: https://api.apiture.com/errors/tooManyOverdraftAccounts/v1.0.0
Version: 1.0.0
Description: The items in the request contains more than maximumOverdraftAccounts items.
Remediation: Specify at most maximumOverdraftAccounts items in the request.
tooManyRequests
Error type url: https://api.apiture.com/errors/tooManyRequests/v1.0.0
Version: 1.0.0
Description: The client has sent too many requests in a given amount of time, exceeding rate limiting.
Remediation: Slow down the rate of API calls.
transactionsForInternalAccountOnly
Error type url: https://api.apiture.com/errors/transactionsForInternalAccountOnly/v1.0.0
Version: 1.0.0
Description: Transactions are not available for external accounts.
Remediation: Request transactions only for internal accounts.
unauthorized
Error type url: https://api.apiture.com/errors/unauthorized/v1.0.0
Version: 1.0.0
Description: The request lacks valid authentication credentials for the target resource or operation.
Remediation: Authenticate the user and pass the required authorization with the request.
unprocessableEntity
Error type url: https://api.apiture.com/errors/unprocessableEntity/v1.0.0
Version: 1.0.0
Description: The syntax of the request entity is correct but was unable to process the contained instructions.
Remediation: Provide a semantically correct request.
wrongNumberOfResponses
Error type url: https://api.apiture.com/errors/wrongNumberOfResponses/v1.0.0
Version: 1.0.0
Description: The challenge verification sent the wrong number of response strings.
Remediation: Send only one response for one-time passcode challenges, or send exactly one response for each security question.