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

Planning Certificate 10.7 - ePlanning to Council (v1)

Authentication

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

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

https://dpie-apim-prod.redocly.app/

CreatePlanningCertificate

Request

This operation transfers Planning Certificate requests from the Online Section 10.7 Planning Certificate Service into the council IT system.

Path
CaseIDstringrequired

A fully qualified Planning Certificate 10.7 case

Headers
OrganisationIDstringrequired

The council LGA name or Private Certifier Organisation name to indicate where the response is routed to.

Bodyapplication/jsonrequired

Information request object

caseStatusstring<= 80 charactersrequired

Status of the Planning Certificate case

Example: "Submitted"
certificateTypestring
Example: "Planning Certificate 10.7"
primaryApplicantobject(applicantList)

used to hold owner’s Corporation details.

secondaryApplicantsArray of objects(applicantList)
certificateTypeAppliedstring(CertificateType)required

It infers the certificate type. One of the below mentioned values must be selected for CertificateType 1. S10.7 (2) 2. S10.7 (2 & 5)

Example: "Refer to description for values"
siteAddressobject(Location)required
siteAddress.​addressstring<= 250 charactersrequired

Address where the development is happening

Example: "19-33 Elizabeth Street, Narrandera, 2700"
siteAddress.​addressDetailobject(AddressDetail)
siteAddress.​lotsectionplanstring
Example: "1/-/SPXXXXX"
siteAddress.​lgastring<= 30 charactersrequired

Local Government Area under which this case falls

Example: "PENRITH"
payerInformationobjectrequired
payerInformation.​isPayerCompanyboolean(isPayerCompany)

To differentiate whether the payer is a company or an individual.

payerInformation.​payerPersonobject(payerPerson)

Required if Payer Type selected as 'Individual'.

payerInformation.​isManualEntryboolean

Used to hold manual entry flag for Business API search ABN/ACN

payerInformation.​payerCompanyobject(applicantCompany)

If Apply on Behalf of Company is selected as 'Yes'

declarationsArray of strings(declaration10.7)required

Required applicant declaration for planning certificate 10.7

Example: ["Refer to description for values"]
isResendboolean

This is to track if application details are resent. True indicates a retriggered event.

documentsobject
updatedByobject(updatedBy)
curl -i -X POST \
  'https://dpie-apim-prod.redocly.app/CreatePlanningCertificate/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "Submitted",
    "certificateType": "Planning Certificate 10.7",
    "primaryApplicant": {
      "applyOnBehalfOfCompany": true,
      "contactDetails": {
        "title": "Refer to description for values",
        "person": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string",
          "address": "string"
        }
      },
      "isManualEntry": true,
      "applicantCompany": {
        "companyName": "string",
        "ABN": "12 121 567 891",
        "ACN": "123 456 789",
        "tradingName": "string",
        "address": {
          "address": "string",
          "email": "user@example.com"
        }
      }
    },
    "secondaryApplicants": [
      {
        "applyOnBehalfOfCompany": true,
        "contactDetails": {
          "title": "Refer to description for values",
          "person": {
            "firstName": "string",
            "otherName": "string",
            "familyName": "string",
            "contactNumber": "stringst",
            "email": "string",
            "address": "string"
          }
        },
        "isManualEntry": true,
        "applicantCompany": {
          "companyName": "string",
          "ABN": "12 121 567 891",
          "ACN": "123 456 789",
          "tradingName": "string",
          "address": {
            "address": "string",
            "email": "user@example.com"
          }
        }
      }
    ],
    "certificateTypeApplied": "Refer to description for values",
    "siteAddress": {
      "address": "19-33 Elizabeth Street, Narrandera, 2700",
      "addressDetail": {
        "complexUnitType": "string",
        "complexLevelType": "string",
        "complexLevelNumber": "string",
        "complexUnitIdentifier": "string",
        "streetNumber1": "string",
        "streetNumber2": "string",
        "streetName": "string",
        "streetSuffix": "string",
        "streetType": "string",
        "suburb": "string",
        "latitude": 0,
        "longitude": 0,
        "wkid": "string",
        "cadastralID": "string",
        "primarySecondary": "string",
        "state": "string",
        "postCode": 0
      },
      "lotsectionplan": "1/-/SPXXXXX",
      "lga": "PENRITH"
    },
    "payerInformation": {
      "isPayerCompany": true,
      "payerPerson": {
        "title": "Refer to description for values",
        "payerInfo": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string",
          "address": "string"
        }
      },
      "isManualEntry": true,
      "payerCompany": {
        "companyName": "string",
        "ABN": "12 121 567 891",
        "ACN": "123 456 789",
        "tradingName": "string",
        "address": {
          "address": "string",
          "email": "user@example.com"
        }
      }
    },
    "declarations": [
      "Refer to description for values"
    ],
    "isResend": true,
    "documents": {},
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Created

Body
Response
No content

UpdatePlanningCertificate

Request

This operation transfers Planning Certificate requests from the Online Section 10.7 Planning Certificate Service into the council IT system.In this opeartion Council can edit 10.7 Planning Certificate application details

Path
CaseIDstringrequired

A fully qualified Planning Certificate 10.7 case

Headers
OrganisationIDstringrequired

The council LGA name or Private Certifier Organisation name to indicate where the response is routed to.

Bodyapplication/jsonrequired

Information request object

caseStatusstring<= 80 charactersrequired

Status of the Planning Certificate case

Example: "Submitted"
certificateTypestring
Example: "Planning Certificate 10.7"
primaryApplicantobject(applicantList)

used to hold owner’s Corporation details.

secondaryApplicantsArray of objects(applicantList)
certificateTypeAppliedstring(CertificateType)required

It infers the certificate type. One of the below mentioned values must be selected for CertificateType 1. S10.7 (2) 2. S10.7 (2 & 5)

Example: "Refer to description for values"
siteAddressobject(Location)required
siteAddress.​addressstring<= 250 charactersrequired

Address where the development is happening

Example: "19-33 Elizabeth Street, Narrandera, 2700"
siteAddress.​addressDetailobject(AddressDetail)
siteAddress.​lotsectionplanstring
Example: "1/-/SPXXXXX"
siteAddress.​lgastring<= 30 charactersrequired

Local Government Area under which this case falls

Example: "PENRITH"
payerInformationobjectrequired
payerInformation.​isPayerCompanyboolean(isPayerCompany)

To differentiate whether the payer is a company or an individual.

payerInformation.​payerPersonobject(payerPerson)

Required if Payer Type selected as 'Individual'.

payerInformation.​isManualEntryboolean

Used to hold manual entry flag for Business API search ABN/ACN

payerInformation.​payerCompanyobject(applicantCompany)

If Apply on Behalf of Company is selected as 'Yes'

declarationsArray of strings(declaration10.7)required

Required applicant declaration for planning certificate 10.7

Example: ["Refer to description for values"]
deltaDocumentsArray of objects(DownloadableDocument)
documentsArray of objects(DownloadableDocument)
updatedByobject(updatedBy)
curl -i -X PUT \
  'https://dpie-apim-prod.redocly.app/UpdatePlanningCertificate/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "Submitted",
    "certificateType": "Planning Certificate 10.7",
    "primaryApplicant": {
      "applyOnBehalfOfCompany": true,
      "contactDetails": {
        "title": "Refer to description for values",
        "person": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string",
          "address": "string"
        }
      },
      "isManualEntry": true,
      "applicantCompany": {
        "companyName": "string",
        "ABN": "12 121 567 891",
        "ACN": "123 456 789",
        "tradingName": "string",
        "address": {
          "address": "string",
          "email": "user@example.com"
        }
      }
    },
    "secondaryApplicants": [
      {
        "applyOnBehalfOfCompany": true,
        "contactDetails": {
          "title": "Refer to description for values",
          "person": {
            "firstName": "string",
            "otherName": "string",
            "familyName": "string",
            "contactNumber": "stringst",
            "email": "string",
            "address": "string"
          }
        },
        "isManualEntry": true,
        "applicantCompany": {
          "companyName": "string",
          "ABN": "12 121 567 891",
          "ACN": "123 456 789",
          "tradingName": "string",
          "address": {
            "address": "string",
            "email": "user@example.com"
          }
        }
      }
    ],
    "certificateTypeApplied": "Refer to description for values",
    "siteAddress": {
      "address": "19-33 Elizabeth Street, Narrandera, 2700",
      "addressDetail": {
        "complexUnitType": "string",
        "complexLevelType": "string",
        "complexLevelNumber": "string",
        "complexUnitIdentifier": "string",
        "streetNumber1": "string",
        "streetNumber2": "string",
        "streetName": "string",
        "streetSuffix": "string",
        "streetType": "string",
        "suburb": "string",
        "latitude": 0,
        "longitude": 0,
        "wkid": "string",
        "cadastralID": "string",
        "primarySecondary": "string",
        "state": "string",
        "postCode": 0
      },
      "lotsectionplan": "1/-/SPXXXXX",
      "lga": "PENRITH"
    },
    "payerInformation": {
      "isPayerCompany": true,
      "payerPerson": {
        "title": "Refer to description for values",
        "payerInfo": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string",
          "address": "string"
        }
      },
      "isManualEntry": true,
      "payerCompany": {
        "companyName": "string",
        "ABN": "12 121 567 891",
        "ACN": "123 456 789",
        "tradingName": "string",
        "address": {
          "address": "string",
          "email": "user@example.com"
        }
      }
    },
    "declarations": [
      "Refer to description for values"
    ],
    "deltaDocuments": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "updatedBy": "Council"
      }
    ],
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "updatedBy": "Council"
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Created

Body
Response
No content
© 2025 Your Company. All Rights Reserved.