Codes

Response Code Reference

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. Please contact [email protected] to reset your account.
`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 further 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.
`no-production-access`	Unauthorized Partner can access Sandbox data only. Contact us via Intercom or email for live data access.
`account-not-accessible-requires-user-action`	Not Accessible User action required before account details can be returned.
`maintenance-error`	Not Accessible Institution resource is under maintenance.
`forbidden-access`	Forbidden Access Access to this resource is forbidden.
`institution-not-supported`	Institution 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."
`bank-statement-parsing-error`	PDF Bank Statement Parsing Error `title`: "Unable to parse statement." `detail`: "New layout not supported."
`bank-statement-not-supported`	PDF Bank Statement Not Supported `title`: "Statement not supported." `detail`: "Unsupported institution 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 a single account differs across rows.
`empty-file`	CSV Empty File CSV file has no data rows.
`row-count-exceeded`	CSV Row Count Exceeded Row count exceeds limit.
`invalid-request-content`	PDF/CSV Invalid Request Content Statement file is not valid.
`request-not-valid`	Request Not Valid Request too long or too frequent (403 for token endpoint).
`bank-statement-invalid`	PDF Bank Statement Invalid `title`: "Invalid bank statement." `detail`: "File is not an official PDF bank statement."
`invalid-credentials`	Invalid Attribute Cannot login to institution using supplied credentials.

Handling Invalid Credentials

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-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."
  }
}

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."
  }
}