Skip to content
ONLINE CERTIFICATE REGISTRATION SERVICE APIS V1
/
CR - Council to ePlanning API

CR - Council to ePlanning API (v1)

Certification Management API for Council.

Download OpenAPI description
CR - Council to ePlanning API v1.0.json
CR - Council to ePlanning API v1.0.yaml
Languages
Servers

https://api-uat.apps1.nsw.gov.au/planning/CRMgmt/Councils/v1/

Decline

Request

This operation transfers the council's decision to decline the Certificate Registration application from the council's IT system to the Online Certificate Registration Service.

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

The council LGA name to indicate the request is originating from a specific council

Body*/*required

body

declineReasonsArray of objects(declineReasonList)required
declineReasons[].​declineReasonstringrequired

One of the below mentioned values must be selected for declineReason 1. InComplete 2. Poor Quality 3. In-sufficient Documentation submitted 4. Payment Not Received 5. Other

Example: "Refer to description for values"
declineReasonDescriptionstring<= 512 characters

required only if 'OTHER' is selected for declineReason

updatedByEmailstring<= 250 charactersrequired

User must be registered in the planning portal

Example: "john.smith@gmail.com"
curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/CRMgmt/Councils/v1/Decline/{CaseID}' \
  -H 'Content-Type: */*' \
  -H 'OrganisationID: string' \
  -d '[object Object]'

Responses

Case Declined

Body*/*
statusCodeinteger
Example: 200
messagestring
activityIdstring
caseIDstring

Visible when case id is created during the process.

Register

Request

This operation transfers the council's decision to accept the Certificate Registration from the council's IT system to the Online Certificate Registration Service.

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

The council LGA name to indicate where the request is originated from

Body*/*required

body

ReferenceNumberstringrequired

Council system Reference Number

Commentsstring

Additional comments

RegistrationDatestring(date)required

Council system Registration date

Declarationbooleanrequired

gives consent that certificate details are correct, payment has been received, relevant checks are done and the certificate has been registered in Council's certificate registration system.

DocumentsArray of objects(DownloadableDocument)
updatedByEmailstring<= 250 charactersrequired

User must be registered in the planning portal

Example: "john.smith@gmail.com"
curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/CRMgmt/Councils/v1/Register/{CaseID}' \
  -H 'Content-Type: */*' \
  -H 'OrganisationID: string' \
  -d '[object Object]'

Responses

Certificate registered sucessfully

Bodyapplication/json
statusCodeinteger
Example: 200
messagestring
activityIdstring
caseIDstring

Visible when case id is created during the process.

DocumentsArray of objects(DocResponse)

Attached documents with eplanningDocIds.

Response
application/json
{
  "statusCode": 200,
  "message": "string",
  "activityId": "string",
  "caseID": "string",
  "Documents": [
    { … }
  ]
}
© 2025 Your Company. All Rights Reserved.