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 |
|
415 |
415-01 |
Content-Type not supported |
Provide valid Content-Type header |
|
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 |
Nil |