Create ABN lookups
/abn-lookupsAsk the register about an ABN. The answer is the lookup, nothing is stored, so keep it.
Permissions
referenceData:queryRequires the `query` action on `referenceData` for the supplied runtime context
Request body
This body is a tagged shape: type is always "AbnlkCmdByNumber". Send it; more variants can be added, and a caller that switches on it keeps working when they are.
typetype = "AbnlkCmdByNumber"abnstringrequiredThe ABN, digits only. The register is asked directly, so an unknown one is a 404 from it rather than from us.
curl -X POST https://api.tst.au.apgpay.dev/abn-lookups \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"type": "AbnlkCmdByNumber",
"abn": "string"
}'Responses
The response is a tagged shape: type is always "AbnlkCreateRspAttributes". Switch on it; subtypes can be added, and a client that already reads it will not break.
typetype = "AbnlkCreateRspAttributes"The resource that was created.
typeenumrequiredAbnlkViewAttributesThe ABN as the register holds it, and whether it is the entity's current one.
typeenumrequiredAbnlkIdentifierAttributesvaluestringrequiredcurrentIndicatorstringrequiredThe register's own indicator, verbatim, Y where this is the entity's current ABN.
lastUpdatedstring (date)requiredWhen the register last revised this entity's record.
Example 2026-08-19
The entity's registration status over time. More than one record means it has lapsed and resumed.
typeenumrequiredAbnlkStatusAttributescodestringrequiredThe register's own status code, ACT for active, CAN for cancelled.
effectiveFromstring (date)requiredExample 2026-08-19
effectiveTostring (date)When it stopped applying. Absent means it still does.
Example 2026-08-19
The entity's type, as the register classifies it.
typeenumrequiredAbnlkEntityTypeAttributescodestringrequiredThe register's own code, PRV for an Australian private company.
descriptionstringrequiredThe same thing in words.
When the entity was registered for GST, and until when. Absent where it never has been.
typeenumrequiredAbnlkPeriodAttributeseffectiveFromstring (date)requiredExample 2026-08-19
effectiveTostring (date)Absent means it still applies.
Example 2026-08-19
asicNumberstringThe ASIC company number, where the entity has one.
The entity's legal names over time.
typeenumrequiredAbnlkNameAttributesnamestringrequiredExample Ada Lovelace
effectiveFromstring (date)requiredExample 2026-08-19
effectiveTostring (date)Absent means it is still in use.
Example 2026-08-19
Its registered trading names over time. A business trades under these; it contracts under a legal name.
typeenumrequiredAbnlkNameAttributesnamestringrequiredExample Ada Lovelace
effectiveFromstring (date)requiredExample 2026-08-19
effectiveTostring (date)Absent means it is still in use.
Example 2026-08-19
Where the entity does business, by state and postcode, over time.
typeenumrequiredAbnlkLocationAttributesstatestringrequiredAustralian state or territory code, NSW, VIC.
postcodestringrequiredExample 3000
effectiveFromstring (date)requiredExample 2026-08-19
effectiveTostring (date)Example 2026-08-19
{
"type": "AbnlkCreateRspAttributes",
"created": {
"type": "AbnlkViewAttributes",
"abn": {
"type": "AbnlkIdentifierAttributes",
"value": "string",
"currentIndicator": "string"
},
"lastUpdated": "2026-08-19",
"entityStatus": {
"type": "AbnlkStatusAttributes",
"code": "string",
"effectiveFrom": "2026-08-19",
"effectiveTo": "2026-08-19"
},
"entityType": {
"type": "AbnlkEntityTypeAttributes",
"code": "string",
"description": "string"
},
"gstStatus": {
"type": "AbnlkPeriodAttributes",
"effectiveFrom": "2026-08-19",
"effectiveTo": "2026-08-19"
},
"asicNumber": "string",
"legalNames": [
{
"type": "AbnlkNameAttributes",
"name": "Ada Lovelace",
"effectiveFrom": "2026-08-19",
"effectiveTo": "2026-08-19"
}
],
"tradingNames": [
{
"type": "AbnlkNameAttributes",
"name": "Ada Lovelace",
"effectiveFrom": "2026-08-19",
"effectiveTo": "2026-08-19"
}
],
"locations": [
{
"type": "AbnlkLocationAttributes",
"state": "string",
"postcode": "3000",
"effectiveFrom": "2026-08-19",
"effectiveTo": "2026-08-19"
}
]
}
}Error responses
statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}statusCodeinteger (int32)requiredHTTP status code for this error
errorCodestringrequiredAn APG Pay code providing a brief explanation of the underlying error. Use this if you wish to provide custom behaviour based on the error type.
messagestringrequiredHuman readable description of the error
tracerstringAn unique identifier for the request. Provide this to the support team if you wish to query a particular error.
detailstringOptional additional details for the error.
errorTypeDescriptionstringA description of the category of errors for the given statusCode.
metadataobjectOptional key value list of metadata
{
"statusCode": 100,
"errorCode": "string",
"message": "string",
"tracer": "string",
"detail": "string",
"errorTypeDescription": "string"
}