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

CR - ePlanning to Council API (v1)

Certificate Register - ePlanning to Council Outbound API

Find out more about the DA process
Download OpenAPI description
CR - ePlanning to Council API v1.0.json
CR - ePlanning to Council API v1.0.yaml
Languages
Servers

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

CreateCR

Request

This operation transfers the certificate registration application entered by the certifier from the Online Certificate Registration Service to the council's IT system. Created case by certifier in ePlanning shared to council for further processing.

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

Used by the API gateway to route the request to the council's API endpoint

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

caseStatusstring[ 1 .. 80 ] charactersrequired

Status of the DA case

Example: "Submitted"
caseSubmittedDatestringnon-empty

This is to track the application submitted date.

certificateTypestringnon-emptyrequired

This is to track the certificate types - Complying Development Certificate - Construction Certificate - Occupation Certificate - Subdivision Certificate - Subdivision Works Certificate - Other

Example: "Refer to description for values"
enterCertificateTypestring<= 50 characters

Required only when user selects OTHER in Certificare type

isExistingCRboolean

This indicates if the user is applying for a modification CR or a new CR. 'true' value indicates modification CR and 'false' value indicates new CR. This is applicable for CDC CRs only.

existingCRRegistrationDatestring(date)

This indicates on what date was the application to be modified registered. This is applicable for modification CDC CRs only (isExistingCR = true).

existingCRNumberstring

This indicates the CR application number to be modified. This is applicable for modification CDC CRs only (isExistingCR = true).

proposedModificationstring

This indicates the description of the proposed modification. This is applicable for modification CDC CRs only.

wasExistingCRAppliedViaNSWPortalboolean

This indicates if the CR applied for was via the NSW planning portal. This is applicable only when applying for modification CDC CRs only (isExistingCR = true).

existingNSWPortalCRNumberstring

This indicates the application number. This is applicable only when isExistingCR is selected as Modification to complying development registration Certificate and when wasExistingCRAppliedViaNSWPortal is true.

contactDetailsobject(ContactDetails)required
contactDetails.​titlestring

This is to track the salutation of user - Miss - Mr - Mrs - Ms

Example: "Refer to description for values"
contactDetails.​contactPersonobject(Person)required
contactDetails.​contactPerson.​firstNamestring[ 1 .. 20 ] charactersrequired
contactDetails.​contactPerson.​otherNamestring<= 20 characters
contactDetails.​contactPerson.​familyNamestring[ 1 .. 20 ] charactersrequired
contactDetails.​contactPerson.​contactNumberstring[ 8 .. 10 ] characters^[0-9]+$
contactDetails.​contactPerson.​emailstring(email)[ 1 .. 250 ] charactersrequired
contactDetails.​addressstring[ 1 .. 250 ] charactersrequired
contactDetails.​companynamestring<= 50 characters
certificateIssuedByboolean

Is the certificate issued by the contact

certifierDetailsobject(CertifierDetails)required
certifierDetails.​titlestring

This is to track the salutation of user - Miss - Mr - Mrs - Ms

Example: "Refer to description for values"
certifierDetails.​certifierPersonobject(Person)required
certifierDetails.​certifierPerson.​firstNamestring[ 1 .. 20 ] charactersrequired
certifierDetails.​certifierPerson.​otherNamestring<= 20 characters
certifierDetails.​certifierPerson.​familyNamestring[ 1 .. 20 ] charactersrequired
certifierDetails.​certifierPerson.​contactNumberstring[ 8 .. 10 ] characters^[0-9]+$
certifierDetails.​certifierPerson.​emailstring(email)[ 1 .. 250 ] charactersrequired
certifierDetails.​addressstring[ 1 .. 250 ] charactersrequired
certifierDetails.​accreditationNumberstring[ 1 .. 50 ] charactersrequired

BPB accreditation number

certifierDetails.​companyNamestring<= 250 characters
DADeterminedboolean

Has the DA been determined

existingDANumberstring<= 20 characters

Required only if user selected Yes for Has the DA been determined

dateOfDADeterminationstring(date)

Required only if user selected Yes for Has the DA been determined

Example: "20/07/2020"
cdcDeterminedboolean

Has the CDC been determined

existingCDCNumberstring<= 40 characters

Required only if user selected Yes for Has the CDC been determined

dateOfCDCDeterminationstring(date)

Required only if user selected Yes for Has the CDC been determined?

Example: "20/07/2020"
certificateDetailsArray of objects(Certificatedetails)required
certificateDetails[].​certRefNumberstring[ 1 .. 50 ] charactersrequired
certificateDetails[].​certificateIssuedbooleanrequired

Was certificate issue

certificateDetails[].​dateOfCertificateIssuestring(date)

Required if the certificate issued is Yes

Example: "20/07/2020"
certificateDetails[].​dateCertificateAppliedstring(date)

Required if the certificate issued is Yes

Example: "20/07/2020"
certificateDetails[].​applicantNamestring[ 1 .. 20 ] charactersrequired
certificateDetails[].​companynamestring<= 50 characters
certificateDetails[].​applicantAddressstring[ 1 .. 250 ] charactersrequired
certificateDetails[].​dateofWorkCommencementstring(date)

Required if the certificate issued is Yes

Example: "20/07/2020"
certificateDetails[].​principalCertifyingAuthoritystring<= 20 characters

Required if the certificate issued is Yes

certificateDetails[].​isDevelopmentTypeResidentialbooleanrequired

dev type

certificateDetails[].​dateofCertificateNotificationstring(date)

Required if the certificate issued is Yes

Example: "20/07/2020"
builderDetailsArray of objects(Builderdetails)

applicable when IsDevelopmentTypeResidential is Yes and user entered a date for Date that works are proposed to commence

siteAddressesArray of objects(Location)required
siteAddresses[].​addressstring[ 1 .. 250 ] charactersrequired

Address where the development is happening

Example: "19-33 Elizabeth Street, Narrandera, 2700"
siteAddresses[].​addressDetailobject(AddressDetail)
siteAddresses[].​LotListArray of objects(LotSectionPlan)
siteAddresses[].​lgastring[ 1 .. 30 ] charactersrequired

Local Government Area under which this application falls

Example: "PENRITH"
siteAddresses[].​isPrimaryboolean

The primary address if multiple

commonApplicationTypesArray of objects(CommonApplicationType)

This is to track the common Application types.This is applicable for CR-CC, CR-OC, CR-PCA and is required for it's corresponding parent cases that are created after 1st of September'23. Example values are 1. Advertising and signage 2. Alterations or additions to an existing building or structure 3. Change of use of land or a building or the classification of a building under the Building Code of Australia 4. Demolition 5. Erection of a new structure 6. Hours of operation and trading 7. Subdivision 8. Temporary building, structure or use

subdivisionTypesArray of strings

This is to track the appropriate subdivision types. This is applicable when 'Subdivision' is one of the common application type('commonApplicationTypes').This is not applicable for CR-CC & CR-OC.Example values are 1. Strata Title 2. Community Title 3. Torrens Title 4. Stratum Title

numOfExistingLotsinteger

This is to track the number of existing lots. This is applicable when 'Subdivision' is one of the common application type('commonApplicationTypes').This is not applicable for CR-CC & CR-OC.

numOfProposedLotsinteger

This is to track the number of proposed lots. This is applicable when 'Subdivision' is one of the common application type('commonApplicationTypes').This is not applicable for CR-CC & CR-OC.

developmentTypesArray of objects(DevelopmentType)
isDevAffectingExistingBuildingboolean

It infers that is Existing building affected by the development or not. If the value is Yes then Record of inspection document type is mandatory document to be provided. isDevAffectingExistingBuilding is mandatory field for Construction Certificate only.

estimatedCostOfWorkstring

Required only if Subdivision Works Certificate is selected for certificate type, currency format

developmentDescriptionstring<= 1500 characters
paymentInformationobject(Payment)required
paymentInformation.​payerNamestringnon-emptyrequired

Payer full name

paymentInformation.​paymentTowardsstringnon-emptyrequired

payment made towards council, council name

paymentInformation.​paymentAmountnumberrequired

Transaction amount

paymentInformation.​trxReferencestringnon-emptyrequired

Transaction reference number, BankRecieptNumber

paymentInformation.​trxDatestring(date)non-emptyrequired

Transaction date

Example: "20/07/2020"
isResendboolean

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

documentsArray of objects(DownloadableDocument)
declarationsArray of strings
curl -i -X POST \
  'https://dpie-apim-prod.redocly.app/CreateCR/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyId: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "Submitted",
    "caseSubmittedDate": "string",
    "certificateType": "Refer to description for values",
    "enterCertificateType": "string",
    "isExistingCR": true,
    "existingCRRegistrationDate": "2019-08-24",
    "existingCRNumber": "string",
    "proposedModification": "string",
    "wasExistingCRAppliedViaNSWPortal": true,
    "existingNSWPortalCRNumber": "string",
    "contactDetails": {
      "title": "Refer to description for values",
      "contactPerson": {
        "firstName": "string",
        "otherName": "string",
        "familyName": "string",
        "contactNumber": "stringst",
        "email": "user@example.com"
      },
      "address": "string",
      "companyname": "string"
    },
    "certificateIssuedBy": true,
    "certifierDetails": {
      "title": "Refer to description for values",
      "certifierPerson": {
        "firstName": "string",
        "otherName": "string",
        "familyName": "string",
        "contactNumber": "stringst",
        "email": "user@example.com"
      },
      "address": "string",
      "accreditationNumber": "string",
      "companyName": "string"
    },
    "DADetermined": true,
    "existingDANumber": "string",
    "dateOfDADetermination": "20/07/2020",
    "cdcDetermined": true,
    "existingCDCNumber": "string",
    "dateOfCDCDetermination": "20/07/2020",
    "certificateDetails": [
      {
        "certRefNumber": "string",
        "certificateIssued": true,
        "dateOfCertificateIssue": "20/07/2020",
        "dateCertificateApplied": "20/07/2020",
        "applicantName": "string",
        "companyname": "string",
        "applicantAddress": "string",
        "dateofWorkCommencement": "20/07/2020",
        "principalCertifyingAuthority": "string",
        "isDevelopmentTypeResidential": true,
        "dateofCertificateNotification": "20/07/2020"
      }
    ],
    "builderDetails": [
      {
        "title": "Refer to description for values",
        "builderPerson": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "user@example.com"
        },
        "address": "string",
        "licensenumber": "string",
        "insurerDetail": [
          {
            "insurerRegisteredBusinessName": "string",
            "insurerlicensenumber": "string"
          }
        ]
      }
    ],
    "siteAddresses": [
      {
        "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",
          "gurasID": "string",
          "primarySecondary": "string",
          "state": "string",
          "postCode": 0
        },
        "LotList": [
          {
            "lotsectionplan": "1/-/SPXXXXX"
          }
        ],
        "lga": "PENRITH",
        "isPrimary": true
      }
    ],
    "commonApplicationTypes": [
      {
        "commonApplicationType": "string"
      }
    ],
    "subdivisionTypes": [
      "string"
    ],
    "numOfExistingLots": 0,
    "numOfProposedLots": 0,
    "developmentTypes": [
      {
        "developmentType": "string"
      }
    ],
    "isDevAffectingExistingBuilding": true,
    "estimatedCostOfWork": "string",
    "developmentDescription": "string",
    "paymentInformation": {
      "payerName": "string",
      "paymentTowards": "string",
      "paymentAmount": 0,
      "trxReference": "string",
      "trxDate": "20/07/2020"
    },
    "isResend": true,
    "documents": [
      {
        "documentName": "string",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "http://example.com",
        "documentSize": 0,
        "updatedBy": "Council"
      }
    ],
    "declarations": [
      "string"
    ]
  }'

Responses

CR created

Body

Withdraw

Request

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

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

Used by the API gateway to route the request to the council's API endpoint

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

caseStatusstringnon-emptyrequired

Status of the case

Example: "Withdrawn"
withdrawalDatestring(date)non-emptyrequired

Date of withdrawal

updatedByobject(Person)required
updatedBy.​firstNamestring[ 1 .. 20 ] charactersrequired
updatedBy.​otherNamestring<= 20 characters
updatedBy.​familyNamestring[ 1 .. 20 ] charactersrequired
updatedBy.​contactNumberstring[ 8 .. 10 ] characters^[0-9]+$
updatedBy.​emailstring(email)[ 1 .. 250 ] charactersrequired
curl -i -X PUT \
  'https://dpie-apim-prod.redocly.app/Withdraw/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyId: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "Withdrawn",
    "withdrawalDate": "2019-08-24",
    "updatedBy": {
      "firstName": "string",
      "otherName": "string",
      "familyName": "string",
      "contactNumber": "stringst",
      "email": "user@example.com"
    }
  }'

Responses

CR withdrawn

Body

UpdateAdditionalInfo

Request

This operation transfers additional information uploaded by the certifier from the Online Certificate Registration Service to the council's IT system.

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

Used by the API gateway to route the request to the council's API endpoint

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

caseStatusstring[ 1 .. 100 ] charactersrequired

Status of the request for additional information

Example: "Complete"
childCaseIDstring

An AI case id for RFI

responseDatestring(date)non-emptyrequired

Date and time of response

responseDetailsstring<= 1500 characters

Additional information description provided by the applicant

DocumentsArray of objects(DownloadableDocument)
updatedByobject(UpdatedBy)
curl -i -X PUT \
  'https://dpie-apim-prod.redocly.app/UpdateAdditionalInfo/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyId: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "Complete",
    "childCaseID": "string",
    "responseDate": "2019-08-24",
    "responseDetails": "string",
    "Documents": [
      {
        "documentName": "string",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "http://example.com",
        "documentSize": 0,
        "updatedBy": "Council"
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Case updated

Body
© 2025 Your Company. All Rights Reserved.