Error codes

Below you will find details for our various response codes.

Code

Description

too-many-sandbox-connections

Limit reached for sandbox connections
You have reached the limit for sandbox connections. Reach out to [email protected] to reset your account.

invalid-credentials

Invalid Attribute
Cannot login to target institution using supplied credentials. Please check credentials and try again.

Introduced new granularity for invalid-credentials code. These are the possible title and detail scenarios for invalid-credentials - see JSON examples

  • invalid-credentials - existing generic title and detail message, fallback where no cases match from below

  • [new] title and detail message for: invalid-username-or-password

  • [new] title and detail message for: locked-account

  • [new] title and detail message for: multi-factor-authentication

internal-server-error

Server Error
Internal server error
All endpoints

access-denied

Access denied
Token has expired

invalid-authorization-token

Unauthorized
Invalid authorization token. Check details message.

parameter-not-supplied

Missing Attribute
Required parameter not supplied. Check details and source message.
e.g. One of 'email' or 'mobile' is required.

parameter-not-valid

Invalid Attribute
Parameter value is not valid. Check details and source message.
e.g. Provided mobile is in bad format.
User ID value is not valid

resource-not-found

Invalid Attribute
Requested resource is not found. Check details message.

resource-already-exists

Invalid Attribute
Resource already exists. Check details message.

invalid-content

Invalid Attribute
Invalid request content. Check details message.
e.g. empty request body

unsupported-content-type

Invalid Attribute
Requested content type is not supported.

unsupported-accept

Invalid Attribute
Accept type is not supported.

service-unavailable

Service Unavailable
Service is currently unavailable. Please try again later.

too-many-requests

Service Unavailable
Request rate limit per connection reached. Follow detail message for futher instructions.

method-not-allowed

Not Allowed
Requested method is not allowed.

unauthorized-access

Unauthorized
Unauthorized access.

invalid-authorization-request

Unauthorized
Invalid authorization request. Check details message.

access-denied

Unauthorized
Please contct us to have your API key enabled for Connections.

no-production-access

Unauthorized
Partner has permission to access Sandbox data only. For accessing live Institution data, please contact us via Intercom or email.

account-not-accessible-requires-user-action

Not Accessible
An action is required from end-user before account details can be returned.

maintenance-error

Not Accessible
Requested resource is currently unavailable due to maintenance on Institution's side.

forbidden-access

Forbidden access
Access to this resource is forbidden

institution-not-supported

Institution is not supported
e.g. Institution AU00000 is not supported on this endpoint

bank-statement-new-product

PDF Bank statement new product
title : "New product requires config."
detail: "Unable to recognise statement product name."

note: requires configuration of product name to account type mapping is missing

bank-statement-parsing-error

PDF Bank statement parsing error
title : "Unable to parse statement."
detail: "Error parsing statement due to new statement layout for this product."

bank-statement-not-supported

PDF bank statement not supported
title : "Statement not supported."
detail : "Statement is not currently supported for this institution - check statement uploaded against correct bank."

bank-statement-invalid

PDF bank statement invalid
title : "Invalid bank statement."
detail : "File uploaded is not an official PDF bank statement."

missing-required-field

CSV missing required field
CSV header does not contain required field

missing-required-field-value

CSV missing required field value
CSV row does not contain value for required field

invalid-field-value

CSV invalid field value
Field value is not valid

account-data-differs

CSV account data differs
Data for single account differs across rows

empty-file

CSV empty file
CSV file has no data rows

row-count-exceeded

CSV row count exceeded
CSV row count is above limit

invalid-request-content

PDF/CSV invalid request content (file type)
Statement is not valid

request-not-valid

PDF/CSV Invalid request
Request too long

Handling Invalid Credentials

invalid-credentials - existing generic title and detail for fallback, where no cases match from below

{
  "title": "verify-credentials",
  "status": "failed",
  "result": {
    "code": "invalid-credentials",
    "title": "Cannot login to target institution, check credentials.",
    "detail": "Cannot login to target institution using supplied credentials. Please check credentials and try again."
  }
}
invalid-credentials - title and detail for scenario: invalid-username-or-password

{
  "title": "verify-credentials",
  "status": "failed",
  "result": {
    "code": "invalid-credentials",
    "title": "Cannot login to target institution: invalid username or password.",
    "detail": "Cannot login to target institution: invalid username or password. Please check credentials and try again."
  }
}
invalid-credentials - title and detail for scenario: locked-account

{
  "title": "verify-credentials",
  "status": "failed",
  "result": {
    "code": "invalid-credentials",
    "title": "Cannot login to target institution: this account is locked.",
    "detail": "Cannot login to target institution: this account is locked. Please contact institution directly."
  }
}
invalid-credentials - title and detail for scenario: multi-factor-authentication

{
  "title": "verify-credentials",
  "status": "failed",
  "result": {
    "code": "invalid-credentials",
    "title": "Cannot login to target institution: multi-factor authentication is not supported.",
    "detail": "Cannot login to target institution: multi-factor authentication is not supported. Please check if multi-factor authentication is enabled on login."
  }
}

Did this page help you?