Skip to content
ONLINE 10.7 SERVICE APIs V1
/
Planning Certificate 10.7 - Councils to ePlanning API
/
Authentication

Planning Certificate 10.7 - Councils to ePlanning API (v1)

Authentication

Please use the subscription key provided by the Department to access the APIs.

Download OpenAPI description
Planning Certificate 10.7 - Councils to ePlanning API v1.0.json
Planning Certificate 10.7 - Councils to ePlanning API v1.0.yaml
Overview
Languages
Servers

https://api.apps1.nsw.gov.au/planning/OnlinePlanningCert/v1/

AcceptReturn

Request

This operation transfers the council�s decision to either proceed or not proceed with the Planning Certificate 10.7 request from council�s IT system to the Online Section 10.7 Planning Certificate Service. This operation replicates the action performed on the Completeness Check screen in UI.

Path
CaseIDstringrequired

A fully qualified Portal application number

Headers
OrganisationIDstringrequired

The council LGA name or Private Certifier Organisation name to indicate where the request is originated from.

IdempotencyIDstringrequired

Unique Id for this request. Allows the API to respond in an idempotent way if it has already been called with these parameters and prevents duplicate processing. Typically a UUID such as "63a9ba30-7a4b-4fac-b343-d1f05cf089f1"

Bodyapplication/jsonrequired

Information request object

outcomeOfReviewstring(ReviewOfOutcome)required

What is the outcome of your review, Proceed with certificate request or Not proceed with certificate request. One of the below mentioned values must be selected for ReviewOfOutcome 1. Proceed with certificate request 2. Not proceed with certificate request

Example: "Refer to description for values"
isFeePaidstring

Applicant paid the relevant fees. Mandatory when What is the outcome of your review? equals to:"Proceed with certificate request"

Enum"Yes""No"
feeAmountnumber(decimal)

Total fee paid. Mandatory when Applicant paid the relevant fees? equals to:"Yes"

Example: 1250.9
councilUniqueIDNumbernumber<= 20 characters

Council unique identification number. Mandatory when daFeePaid equals to:"Yes/No"

feeNotPaidReasonstring<= 512 characters

provide a reason why applicant didn't paid the relevant fees. Mandatory when Applicant paid the relevant fees equals to "No"

rejectReasonstring<= 512 characters

Reason for return the applicaion by council. Mandatory when What is the outcome of your review? is equals to "Not proceed with certificate request"

rejectDatestring(date)

applcation rejected date by council. Mandatory when What is the outcome of your review? is equals to "Not proceed with certificate request"

Example: "2020-12-30"
updatedByEmailstring(UpdatedByEmail)required

user mail address who performing the action.

curl -i -X PUT \
  'https://api.apps1.nsw.gov.au/planning/OnlinePlanningCert/v1/AcceptReturn/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyID: string' \
  -H 'OrganisationID: string' \
  -d '{
    "outcomeOfReview": "Refer to description for values",
    "isFeePaid": "Yes",
    "feeAmount": 1250.9,
    "councilUniqueIDNumber": 0,
    "feeNotPaidReason": "string",
    "rejectReason": "string",
    "rejectDate": "2020-12-30",
    "updatedByEmail": "string"
  }'

Responses

Case updated

Body
Response
No content

Issuance

Request

This operation transfers the council�s decision to Issue or not issue the 10.7 Certificate from their IT system to Online Planning Certificate 10.7 Service.

Path
CaseIDstringrequired

A fully qualified Portal application number

Headers
OrganisationIDstringrequired

The council LGA name or Private Certifier Organisation name to indicate where the request is originated from.

Bodyapplication/json

Determination request object

certificateStatusstring(The certificate has been)required

The certificate has been, Issued or Not Issued. One of the below mentioned values must be selected for CertificateIssuanceOutcome 1. Issued 2. Not Issued

Example: "Refer to description for values"
certificateIssuedDatestring(date)

Certificate issued date. Mandatory when The certificate has been :"Issued"

Example: "2020-09-10"
certificateRejectReasonstring

The reason council is not issued Certificate. Only required if The certificate has been :'Not Issued'

DocumentsArray of objects(DownloadableDocument)
updatedByEmailstring(UpdatedByEmail)required

user mail address who performing the action.

curl -i -X PUT \
  'https://api.apps1.nsw.gov.au/planning/OnlinePlanningCert/v1/Issuance/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'OrganisationID: string' \
  -d '{
    "certificateStatus": "Refer to description for values",
    "certificateIssuedDate": "2020-09-10",
    "certificateRejectReason": "string",
    "Documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string"
      }
    ],
    "updatedByEmail": "string"
  }'

Responses

Case updated

Bodyapplication/json
statusCodeinteger
Example: 200
messagestring
activityIdstring
DocumentsArray of objects(DocResponse)

Attached documents with eplanningDocIds.

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