Last modified
Overview
This page lists the common response messages that you may get when making calls to the APIs available in our API catalogue.
The format the response message will take is:
{
"errors": [
{
"code": " AUTH.10001",
"detail": Relevant code detail provided here within “ ”,
"source":
"parameter": source and parameter provided if relevant within “ “
}
]
}
Response messages
| HTTP status | Error code | Error detail | Troubleshooting |
|---|---|---|---|
| 400 | OAS.VAL.00000 | Exact message will be provided as per OAS schema validation. Exact pointer will be provided as per OAS schema validation. | Refer to error message provided by OAS Validation to outline where the issue is being picked up |
| 400 | 400-01 | Bad request | Refer to OAS for correct syntax |
| 401 | 401-01 | API key is invalid | Provide a valid apikey |
| 401 | 401-01 | Invalid credential | Provide a valid access token |
| 403 | 403-01 | Forbidden | Provide valid scope and identifiers |
| 403 | AUTH.10001 | The agent number used with your ABN or credential is not related. | Provide the correct agent number |
| 403 | AUTH.10002 | You are not authorised to lodge on behalf of this client. | Check authorisation details in Relationship Authorisation Manager (RAM) |
| 403 | AUTH.10003 | Your credential is not linked to this registered agent number in Access Manager. | Check authorisation details in Relationship Authorisation Manager (RAM) |
| 403 | AUTH.10004 | You do not have the correct permission for this action. | Check authorisation details in Relationship Authorisation Manager (RAM) |
| 403 | AUTH.10005 | You are not authorised to lodge on behalf of this client. | Check authorisation details in Relationship Authorisation Manager (RAM) |
| 403 | AUTH.10006 | The client you transmitted is not associated with the agent number you supplied and cannot be authorised. | Check authorisation details in Relationship Authorisation Manager (RAM) |
| 403 | AUTH.10007 | An unexpected error has occurred. Please contact the Tax Office. | Check authorisation details in Relationship Authorisation Manager (RAM) |
| 403 | AUTH.10008 | You are not authorised to submit this request. Review permissions in Access Manager and try again. | Check authorisation details in Relationship Authorisation Manager (RAM) |
| 403 | AUTH.10010 | Unauthorised to view the client record. | Check authorisation details in Relationship Authorisation Manager (RAM) |
| 403 | AUTH.10011 | Invalid context | Ensure context query parameters are provided in the correct format |
| 403 | AUTH.10012 | Invalid path parameter | Ensure URI path parameters are provided in the correct format |
| 415 | 415-01 | Content-Type not supported | Provide valid Content-Type header |
| 422 | ADDR.00001 | Postcode must be in the range of 0200-9999 for an Australian address | Provide valid value. |
| 422 | ADDR.00002 | State/Territory code must be provided for an Australian address | Provide the required information. |
| 422 | ADDR.00003 | {field_title} must not contain only 'AS ABOVE' | This validation is applicable to Address line 1 and Address line 2. |
| 422 | ADDR.00004 | Suburb/Town/Locality must not contain any Australian state codes for an Australian address | Suburb/Town/Locality must not contain any of these state codes "AAT", "ACT", "NSW", "NT", "QLD", "SA", "TAS","VIC", "WA" |
| 422 | ADDR.00005 | State/Territory code must not be provided for an overseas address | If the address is outside Australia, do not enter a value in the stateOrTerritory field. |
| 422 | ADDR.00006 | Address line 2 must be provided if address line 1 starts with a 'Care of' term | Address line 2 must be provided if address line 1 starts with a "Care of" term, including: "C/-", "C\-", "C/ ", "CO ", "C/0", "C0 ", "C\ ", "C\O", "C\0", "C O ", "C 0 ", "C/O ", "CARE OF" |
| 422 | ADDR.00007 | Address line 2 must not start with a Post Office Reference if address line 1 does not start with a 'Care of' term | Address line 2 must not start with Post Office References unless address line 1 starts with a "Care of" term Care of Terms are: "C/-", "C\-", "C/ ", "CO ", "C/0", "C0 ", "C\ ", "C\O", "C\0", "C O ", "C 0 ", "C/O ", "CARE OF" Post office references are: "P/-", "P/ ", "P0 ", "P/0", "PO ", "P O ", "G P ", "P/O ", "P 0 ", "BOX ", "GPO ", "RSD ", "RMD ", "RMB ", "POST ", "G P O ", "POSTBOX", "LOCKED BAG", "PRIVATE BAG" |
| 422 | ADDR.00008 | {field_title} must not contain only numbers, spaces, hyphens (-) and forward slashes (/) | This validation is applicable to Address line 1 and Address line 2. |
| 422 | ADDR.00009 | {field_title} must not contain 3 or more repeated consecutive alphabetic or special characters | This validation is applicable to Address line 1, Address line 2 and Suburb/town/locality. |
| 422 | ADDR.00010 | Suburb/town/locality cannot contain repeated hyphen, apostrophe, or space characters | Provide valid value. |
| 422 | EMAIL.00001 | Email address is invalid | Provide a valid value. The email address should comply with RFC 5322. - Before the @: only letters, numbers, and the characters (.), (_), (%) ,(+), (-) - After the @: only letters, numbers, dots (.), and hyphens (-) - After the last dot (TopLevelDomain): letters only) |
| 422 | NAME.00001 | {field_title} must contain at least one alphabetical character | This validation is applicable to Family name, Given name and Other given name. |
| 422 | NAME.00002 | {field_title} cannot contain 'Exec for', 'Rep for' or 'Trustee for' | This validation is applicable to Family name, Given name and Other given name. |
| 422 | NAME.00003 | {field_title} cannot contain repeated hyphen, apostrophe, or space characters | This validation is applicable to Family name, Given name and Other given name. |
| 422 | NAME.00004 | {field_title} must not contain only 'AS ABOVE' | This validation is applicable to Family name, Given name and Other given name. |
| 422 | ORGNAME.00001 | {field_title} must not contain only 'AS ABOVE' | This validation is applicable to Entity name and Business name. |
| 422 | ORGNAME.00002 | {field_title} cannot contain repeated hyphen, apostrophe, or space characters | This validation is applicable to Entity name and Business name. |
| 422 | PYID.00001 | ABN is invalid | Provide valid ABN |
| 422 | PYID.00002 | RAN is invalid | Provide valid RAN |
| 422 | PYID.00003 | TAN is invalid | Provide valid TAN |
| 422 | PYID.00004 | WPN is invalid | Provide valid WPN |
| 422 | PYID.00005 | TFN is invalid | Provide valid TFN |
| 429 | 429.02.001 | Rate limit has been exhausted | Rate limit has been exceeded wait approximately a minute before hitting API again |
| 500 | 500-01 | Internal Server Error | Contact the ATO |
| 500 | AUTH.10009 | An unexpected error has occurred. Please try again. If the problem persists, please contact the Tax Office | Try again. Contact ATO if the problem persists. |