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.


Error type url: https://api.apiture.com/errors/additionalAuthenticationRequired/v1.0.0
Version: 1.0.0
Description: Additional authentication, such as multi-factor authentication, required
Remediation: Complete the additional factors as per the WWW-Authenticate response header and add an additional Authorization to the call


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


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.


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.


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.


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 destination account.
Remediation: Choose a destination account that allows transfers to it.


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


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


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.


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.


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.


Error type url: https://api.apiture.com/errors/invalidCsrfToken/v1.0.0
Version: 1.0.0
Description: The CSRF token is invalid
Remediation: The client application is not correctly configured to send CSRF


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.


Error type url: https://api.apiture.com/errors/invalidRestrictionDateRange/v1.0.0
Version: 1.0.0
Description: The startOn date should be the current day or later, and the endOn date must fall after the startOn date
Remediation: Pass valid values for startOn and endOn


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.


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.


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.


Error type url: https://api.apiture.com/errors/loginIncomplete/v1.0.0
Version: 1.0.0
Description: The user is correctly authenticated but additional actions are required for activating their login session
Remediation: Instruct the user to complete the additional actions to activate their login session


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


Error type url: https://api.apiture.com/errors/nonPositiveAmount/v1.0.0
Version: 1.0.0
Description: Transfer amount may not be 0.00.
Remediation: Set the transfer amount to a positive number.


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.


Error type url: https://api.apiture.com/errors/passwordChangeRequired/v1.0.0
Version: 1.0.0
Description: The user must change their password
Remediation: Instruct the user to change their password or other login credentials


Error type url: https://api.apiture.com/errors/preconditionFailed/v1.0.0
Version: 1.0.0
Description: One or more conditions given in the request header fields evaluated to false when tested on the server.
Remediation: Update resources and use it’s most recent ETag or modification time stamp.


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


Error type url: https://api.apiture.com/errors/sameSourceAndDestinationTransferAccounts/v1.0.0
Version: 1.0.0
Description: Source and destination account are the same.
Remediation: Choose different source and destination accounts.


Error type url: https://api.apiture.com/errors/sessionExpired/v1.0.0
Version: 1.0.0
Description: The user’s session has expired
Remediation: Re-authenticate the user to get a new access token or other authorization


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.


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.


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


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.