You need to use these application programming interface (API) endpoints to add, remove, update and see information about associated providers.
Select an operation in the list to see the endpoint details, including:
- path parameters
- request requirements
- response information.
Base URL: https://api.agedcarequality.gov.au/change-in-circumstance/v1
POST /providers/{providerId}/add-associated-providers
Adds one or more new associated providers to your registration.
Path parameters
- providerId (required): your provider identifier, for example PRV-7958
Request body
Requires:
- meta: transaction metadata (correlation ID, transaction ID, timestamp)
- providerId, providerName
- associatedProviders: a list of the providers to add. Each one requires a correlation ID, ABN, entity name, entity type, physical address, contact details, parent company relationship, and the services they'll provide.
Sample Request Payload:
{
"meta": {
"transactionMetadata": {
"correlationId": "3267e50f-27ae-4dd0-b39e-d226beb6ae00",
"transactionId": "BSC0001",
"timestamp": "1970-01-01T06:30:59.724000+00:00"
}
},
"authorisedGroupId": "string",
"providerId": "string",
"providerName": "string",
"associatedProviders": [
{
"correlationId": "3267e50f-27ae-4dd0-b39e-d226beb6ae00",
"associatedProviderId": "APRV-001/SDO-001",
"abn": "string",
"entityName": "PACKARD GOOSE PTY LTD",
"businessName": "CROCODILE DUNNEE",
"entityType": "australian Private Company",
"physicalAddress": {
"unitNumber": "21",
"levelNumber": "2",
"buildingName": "netsquare",
"streetNumber": "135",
"streetName": "cascade",
"streetType": "Street",
"streetSuffix": "WEST",
"suburb": "cleveland",
"state": "QLD",
"postalCode": "4163"
},
"postalAddress": {
"unitNumber": "21",
"levelNumber": "2",
"buildingName": "netsquare",
"streetNumber": "135",
"streetName": "Cascade",
"streetType": "Street",
"streetSuffix": "WEST",
"suburb": "cleveland",
"state": "QLD",
"postalCode": "4163",
"isPOBox": true,
"poBoxType": "Care PO",
"poBoxNumber": "2500"
},
"contact": {
"businessPhonePrefix": "+672",
"businessPhone": "56713452",
"businessEmail": "info@crocodiledunnee.com",
"businessWebsite": "https://www.crocodiledunnee.com",
"firstName": "Julia",
"lastName": "Simons",
"mobilePrefix": "+61",
"mobileNumber": "0424561231",
"email": "julia.simons@crocodiledunnee.com"
},
"parentCompanyRelationship": {
"sharedParentCompanyOrLegalRelationship": true,
"sharedParentCompanyDetails": "Test details",
"arrangementStartDate": "2026-05-19",
"arrangementOverview": "Test overview",
"arrangementDurationType": "Specified expiry date",
"arrangementReviewDate": "2026-05-19"
},
"services": [
"Domestic assistance",
"Meals"
],
"residentialCareHome": {
"rchName": "Nothing but the Best Residential Care Home",
"rchAddress": {
"unitNumber": "21",
"levelNumber": "2",
"buildingName": "Netsquare",
"streetNumber": "135",
"streetName": "Cascade",
"streetType": "Street",
"streetSuffix": "WEST",
"suburb": "Cleveland",
"state": "QLD",
"postalCode": "4163"
}
},
"rolesAndResponsibilities": {
"relationshipWithAssociatedProvider": "This is just a free text value",
"deliveryOfRequestedServices": "This is just a free text value",
"systemsToManageAssociatedProvider": "This is just a free text value",
"hasManagementOrExecutiveDecisions": true,
"managementOrExecutiveResponsibilities": "This is just a free text value",
"managementOrExecutiveGovernanceArrangements": "This is just a free text value"
}
}
]
}
Response
202 Accepted. The request is processed asynchronously. It returns a transaction ID, correlation ID, provider ID and status.
Sample 202 Accepted Response Payload:
{
"transactionId": "string",
"correlationId": "string",
"providerId": "string",
"status": "string"
}
Possible errors: 400 Bad Request, 401 Unauthorized, 403 Forbidden, 500 Internal Server Error.
Sample 400 Bad Request Response Payload:
{
"errorMessage": {
"error": [
{
"transaction_id": "BSC-0001",
"correlation_id": "ceaddcc9-99fe-4ea4-9d2a-32ce25e26ade",
"id": 1,
"details": "The Provider 'ABC123' is not in the expected format.",
"code": "400",
"errorSource": {
"parameter": "providerId"
}
}
]
}
}
POST /providers/{providerId}/remove-associated-providers
Removes one or more associated providers from your registration.
Path parameters
- providerId (required)
Request body
Requires:
- meta, providerId, providerName
- removedAssociatedProviders: at least one provider to remove. Each one requires a correlation ID, associated provider ID and name, ABN, end date, reason, and a description of the change.
Sample Request Payload:
{
"meta": {
"transactionMetadata": {
"correlationId": "CORR-001",
"transactionId": "BSC-0001",
"timestamp": "1970-01-01T06:30:59.724000+00:00"
}
},
"authorisedGroupId": "AGG-1111",
"providerId": "PRV-XXXX",
"providerName": "Bellingen Shire Council",
"removedAssociatedProviders": [
{
"correlationId": "string",
"associatedProviderId": "string",
"associatedProviderName": "string",
"associatedProviderBusinessName": "string",
"abn": "16086123471",
"residentialCareHome": {
"rchName": "string",
"rchAddress": {
"unitNumber": "string",
"levelNumber": "string",
"buildingName": "string",
"streetNumber": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"suburb": "string",
"state": "string",
"postalCode": "string"
}
},
"endDate": "2026-07-01",
"reason": "Contract expired",
"description": "The service agreement has expired and all clients have been transitioned to another Associated Provider with no interruption to service delivery.\n"
}
]
}
Response
202 Accepted, same response shape as Add.
Sample 202 Accepted Response Payload:
{
"transactionId": "string",
"correlationId": "string",
"providerId": "string",
"status": "string"
}
Possible errors: 400, 401, 403, 500.
Sample 400 Bad Request Payload:
{
"errorMessage": {
"error": [
{
"transaction_id": "BSC-0001",
"correlation_id": "ceaddcc9-99fe-4ea4-9d2a-32ce25e26ade",
"id": 1,
"details": "The Provider 'ABC123' is not in the expected format.",
"code": "400",
"errorSource": {
"parameter": "providerId"
}
}
]
}
}
POST /providers/{providerId}/change-associated-providers
Updates the arrangement details for one or more existing associated providers.
Path parameters
- providerId (required)
Request body
Requires:
- meta, providerId, providerName
- changedAssociatedProviders: at least one provider to update. Each one requires a correlation ID, associated provider ID and name, ABN, the date the change takes effect, and a description of what's changed.
Sample Request Payload:
{
"meta": {
"transactionMetadata": {
"correlationId": "string",
"transactionId": "string",
"timestamp": "2026-09-02T01:49:01.882Z"
}
},
"authorisedGroupId": "AGI-0001",
"providerId": "PRV-XXXX",
"providerName": "Bellingen Shire Council",
"changedAssociatedProviders": [
{
"correlationId": "df9b9b02-5f4c-48ed-8a34-93f96afa2889",
"associatedProviderId": "APRV-001/SDO-001",
"associatedProviderName": "PACKARD GOOSE PTY LTD",
"associatedProviderBusinessName": "PACKARD GOOSE PTY LTD",
"abn": "16086123471",
"description": "The scope of services has changed and the Associated Provider will now deliver additional nursing care services.",
"changeDate": "2026-07-20",
"residentialCareHome": {
"rchName": "The best Residential Care Home",
"rchAddress": {
"unitNumber": "string",
"levelNumber": "string",
"buildingName": "string",
"streetNumber": "string",
"streetName": "string",
"streetType": "string",
"streetSuffix": "string",
"suburb": "string",
"state": "string",
"postalCode": "string"
}
}
}
]
}
Response
202 Accepted, same response shape as Add.
Sample 202 Accepted Response:
{
"transactionId": "string",
"correlationId": "string",
"providerId": "string",
"status": "string"
}
Possible errors: 400, 401, 403, 500.
Sample 400 Bad Request Response:
{
"errorMessage": {
"error": [
{
"transaction_id": "BSC-0001",
"correlation_id": "ceaddcc9-99fe-4ea4-9d2a-32ce25e26ade",
"id": 1,
"details": "The Provider 'ABC123' is not in the expected format.",
"code": "400",
"errorSource": {
"parameter": "providerId"
}
}
]
}
}
GET /providers/{providerId}/associated-providers
Returns all associated providers linked to your registration.
Path parameters
- providerId (required)
Response
200 OK: returns a list of associated providers.
Sample 200 Success Response:
{
"associatedProviders": [
{
"abn": "16086123471",
"associatedProviderId": "APRV-0001",
"entityName": "PACKARD GOOSE PTY LTD",
"businessName": "CROCODILE DUNNEE",
"entityType": "Australian Private Company",
"physicalAddress": {
"unitNumber": "21",
"levelNumber": "2",
"buildingName": "NetSqaure",
"streetNumber": "135",
"streetName": "Cascade",
"streetType": "Street",
"streetSuffix": "WEST",
"suburb": "Cleveland",
"state": "QLD",
"postalCode": "4163"
},
"postalAddress": {
"unitNumber": "21",
"levelNumber": "2",
"buildingName": "NetSqaure",
"streetNumber": "135",
"streetName": "Cascade",
"streetType": "Street",
"streetSuffix": "WEST",
"suburb": "Cleveland",
"state": "QLD",
"postalCode": "4163",
"isPOBox": true,
"poBoxType": "Locked Bag",
"poBoxNumber": "2500"
},
"contact": {
"businessPhonePrefix": "3",
"businessPhone": "5671 3452",
"businessEmail": "info@crocodiledunnee.com",
"businessWebsite": "www.crocodiledunnee.com"
},
"parentCompanyRelationship": {
"arrangementStartDate": "2026-05-19",
"arrangementDurationType": "Specified expiry date",
"arrangementReviewDate": "2026-05-19"
},
"services": "['Domestic assistance', 'Therapeutic services for independent living', 'Residential accommodation']"
}
]
}
Possible errors: 401 Unauthorized, 404 Not Found.
Sample 404 Not Found Response:
{
"errorMessage": {
"error": [
{
"transaction_id": "BSC-0001",
"correlation_id": "ceaddcc9-99fe-4ea4-9d2a-32ce25e26ade",
"id": 1,
"details": "The Provider 'ABC123' not found in the system.",
"code": "404",
"errorSource": {
"parameter": "providerId"
}
}
]
}
}
GET/providers/{providerId}/associated-providers/{associatedProviderId}
Returns the details for a single associated provider.
Path parameters
- providerId (required)
- associatedProviderId (required)
Response
200 OK: returns the associated provider's details.
Sample 200 Success Response:
{
"abn": "16086123471",
"associatedProviderId": "APRV-0001",
"entityName": "PACKARD GOOSE PTY LTD",
"businessName": "CROCODILE DUNNEE",
"entityType": "Australian Private Company",
"physicalAddress": {
"unitNumber": "21",
"levelNumber": "2",
"buildingName": "NetSqaure",
"streetNumber": "135",
"streetName": "Cascade",
"streetType": "Street",
"streetSuffix": "WEST",
"suburb": "Cleveland",
"state": "QLD",
"postalCode": "4163"
},
"postalAddress": {
"unitNumber": "21",
"levelNumber": "2",
"buildingName": "NetSqaure",
"streetNumber": "135",
"streetName": "Cascade",
"streetType": "Street",
"streetSuffix": "WEST",
"suburb": "Cleveland",
"state": "QLD",
"postalCode": "4163",
"isPOBox": true,
"poBoxType": "Locked Bag",
"poBoxNumber": "2500"
},
"contact": {
"businessPhonePrefix": "3",
"businessPhone": "5671 3452",
"businessEmail": "info@crocodiledunnee.com",
"businessWebsite": "www.crocodiledunnee.com"
},
"parentCompanyRelationship": {
"arrangementStartDate": "2026-05-19",
"arrangementDurationType": "Specified expiry date",
"arrangementReviewDate": "2026-05-19"
},
"services": [
"string"
]
}
Possible errors: 401, 404.
Sample 404 Not Found Response:
{
"errorMessage": {
"error": [
{
"transaction_id": "BSC-0001",
"correlation_id": "ceaddcc9-99fe-4ea4-9d2a-32ce25e26ade",
"id": 1,
"details": "The Provider 'ABC123' not found in the system.",
"code": "404",
"errorSource": {
"parameter": "providerId"
}
}
]
}
}
How responses work
Add, remove and change requests are processed asynchronously. A successful call returns 202 OK: Accepted immediately, along with a transaction ID.
{
"transactionId": "DFG-0001",
"correlationId": "ceaddcc9-99fe-4ea4-9d2a-32ce88e26ade",
"providerId": "abc123",
"status": "complete"
}
Errors
All operations can return these error responses:
- 400 Bad Request: the request is invalid or contains malformed data
- 401 Unauthorized: authentication is required, or your bearer token is invalid or has expired
- 403 Forbidden: you don't have permission to perform this operation
- 404 Not Found: the requested resource doesn't exist
- 500 Internal Server Error: an unexpected error occurred
- 503 Service Unavailable: the service is temporarily unavailable.
Each error response includes a transaction ID, correlation ID, error code and details, to help you troubleshoot.