Skip to content

PCC - ePlanning to Certifier API (v1)

Authentication

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

Overview
Languages
Servers

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

CreatePCC

Request

This operation transfers the Post-consent Certificate application created by the applicant from the Online Post-consent Certificate Service to the certifier's IT system.

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

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

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

This is to track the case status of the post consent certificate application.

Example: "Submitted"
caseSubmittedDatestring

This is to track the date on which the applicant submitted the application in the ePlanning portal.

certificateTypestring(CertificateType)

This is to track the type of certificate submitted. Applicable values are 1. Subdivision Certificate 2. Construction Certificate 3. Principal Certifier Appointment 4. Occupation Certificate 5. Subdivision works certificate. Please refer to reference data API for the latest values.

Example: "Refer to description for values"
subTypestring(SubType)

This indicates the subtype of the certificate applied. It is applicable for Subdivision certificate, Construction certificate and Occupation certificate. Example values for SC and CC would be 1.Certificate for part of the development 2.Certificate for the full development. For OC, when the approval type's determination status is 'false' 1.Occupation certificate for a partially completed building 2.Occupation certificate for part of the building 3.Occupation certificate for whole building. For OC, when the approval type's determination status is 'true' 1.Interim Occupation certificate 2.Final occupation certificate. Please refer to the reference data API for the latest values.

Example: "Refer to description for values"
typeofSWCSeekingstring(TypeofSWCSeeking)

This is to track the type of subdivision works certificate that is being sought. Applicable for Subdivision works certificate. One of the below mentioned values to be selected for TypeofSWCSeeking 1. New application 2. Modification to an existing SWC

Example: "Refer to description for values"
relevantSWCForNSWboolean

This is to track the relevant SWC certificates that's applied via NSW planning portal or not. This is applicable for Subdivision works certificate and when TypeofSWCSeeking is 'Modification to an existing SWC'.

existingSWCRefNumstring

This is to track the existing SWC application reference number when available.

SWCDeterminedboolean

This is to track if the relevant SWC has been determined or not. Applicable when TypeofSWCSeeking is 'Modification to an existing SWC'.

dateSWCDeterminedstring(date)

This is to track the determination date of relevant SWC when available.

approvalTypestring(ApprovalType)required

This is to track the related approval type of the certificate applied. Example values would be 1. Development Application number (DA) 2. Complying Development Certificate (CDC) 3. State determined (SSI / SSD). Please refer the reference data API for latest values.

Example: "Refer to description for values"
relatedCaseNumberstring

This is to track the related approval type’s case ID.

hasPortalCaseNumberboolean

This is to track if the related 'approvalType' for the certificate applied is submitted via NSW planning portal. This is only applicable when the user selects the 'approvalType' as Complying Development Certificate (CDC) or Development Application number (DA)

relatedPortalCaseIDstring<= 10 characters

This is to track the caseID of the related 'approvalType' if it is submitted via NSW planning portal. This is applicable when “hasPortalCaseNumber” is selected as true.

isCaseDeterminedboolean

This is to track determination status of the certificate's related DA or CDC or SSI/SSD application.

dateDeterminedstring(date)

This is to track the determination date of the related DA or CDC or SSI/SSD application. This is applicable when 'isCaseDetermined' is true.

applicationToTrackPCAstring

This is to indicate if the application submitted is to track transfer of Principal certifier. This is applicable for PCA certificate type.

classOfDevelopmentsArray of strings(classOfDevelopment)

This is to track the development classes. This may not be applicable for SC and SWC. Please refer to the reference data API for the latest values.

isDevelopmentExemptfromDBPActboolean

This is to track if the development is exempt from DBAAct. This is applicable when 'Class 2', 'Class 3' and 'Class 9c' is chosen for the 'classofdevelopments' and certificateType OC only.

developmentExemptReasonstring<= 510 characters

This is an obsolete attribute as the DBP exempt reasons are captured in the Building Work/ITSOC applications.

modifyApplicationboolean

This is applicable for Construction Certificate when applying for a modification construction certificate.

hasPortalCCCasestring(HasOnlineCCCase)

This is to track the approval type’s related construction certificate that’s applied for via NSW Planning portal. This is applicable for 1.OC when approvalType is other than CDC 2.CC when “modifyApplication” is No & approvalType is DA.

Example: "Refer to description for values"
hasViaPortalModificationCCCaseboolean

This is to track if the related construction certificate is applied via NSW Planning portal. This becomes applicable when 'approvalType' is DA, and 'Modify Application' is selected as 'Yes' for a Construction Certificate.

certificateCCNumberstring

This is to track the related construction certificate number when available.

CCDeterminedboolean

This is to track the related DA approval type’s CC case determination status.

isExemptFromSEPPNonResidentialboolean

This is to track if the development is exempt from the State Environmental Planning Policy (Sustainable Buildings) 2022, Chapter 3, relating to non-residential buildings for any of the following reasons. This is exempted if DA was submitted on the NSW Planning Portal before 1st October 2023 or The DA was submitted on the NSW Planning Portal on or after 1st October 2023 but was deemed exempt due to the reasons outlined in Chapter 3.1. This is applicable for construction certificate.

CCDateDeterminedstring(date)

This is to track the determination date of the construction certificate. This becomes applicable when CCDetermined is true.

isPortalCCCaseByPCAboolean

This is to track if the related Construction certificate for PCA is applied via NSW Planning portal. This becomes applicable when 'approvalType' is DA and Certificate type is Principal Certifier Appointment.

constructionCertificateNumberstring

This is to track the related Construction Certificate number for PCA. This is applicable when 'isPortalCCCaseByPCA' is true.

CCDeterminedByPCAboolean

This is to track the determination status of the construction certificate. This becomes applicable when 'approvalType' is DA and Certificate type is Principal Certifier Appointment.

dateOfCCIssuedbyPCAstring(date)

This is to track the related construction certificate's issuance date. This is applicable for PCA certificate type when 'CCDeterminedByPCA' is true.

PCAPortalCaseIDstring

This is an obsolete attribute and is not relevant anymore. This is to track related caseID of the Principal certifier appointment application applied through NSW planning portal. This is applicable for Occupation certificate for class 2 developments only.

ITSOCCaseNumberstring

This is to track the related caseID of the the ITSOC (Intention to seek Occupation Certificate) application applied through NSW planning portal. This is applicable when 'Class 2', 'Class 3' and 'Class 9c' is chosen for the 'classofdevelopments' and certificateType OC only.

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

Site addresses

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 case falls

Example: "PENRITH"
siteAddresses[].​isPrimaryboolean

This is to track if the address provided is the primary address when multiple lot addresses are provided.

applicantDetailsobject(applicantDetails)
applyOnBehalfOfCompanybooleanrequired

This is to track if the user has applied on behalf of the company.

applicantCompanyobject(applicantCompany)
buildersDetailsOrPrincipalContractorobject

This is to track the builder or Principal Contractor details. This is not applicable to Subdivision certificate.

additionalBuilderDetailsArray of objects(AdditionalBuilderDetails)

This is to track any additional builder details excluding the one mentioned in 'buildersDetailsOrPrincipalContractor'.

ownershipstring(Ownership)required

This is to track the owner of the development site. Example values are 1. I am the sole owner of the development site 2. There are multiple owners of the development site and I am one of them 3. There are one or more owners of the development site and I am NOT one of them 4. A company, business, government entity or other similar body owns the development site

Example: "Refer to description for values"
ownerDetailsArray of objects(OwnerDetails)
buildingWorkstring(BuildingWork)

This indicates the entity that would be doing the building work. One of the below mentioned values to be selected for BuildingWork. Please refer the reference date API for the latest values. 1. Licensed Builder 2. Owner Builder 3. Not determined at this time (This information will be required prior to work commencing).

longServiceLevyPaidstring(LongServiceLevyPaid)

This is to track if the Building and Industry Long Service Levy is paid when the value of the work is $25,000 or more. This is applicable for Constuction certificate. Example values are 1. Yes 2. No 3. NA

securityConditionsboolean

This is to track the security or site conditions which may impact on the person undertaking the inspection like locked gates, dogs, animals etc. This is not applicable for subdivision certificate.

detailsOfSecurityConditionsstring<= 2000 characters

This is to track the details of the security conditions. This is applicable when 'securityConditions' is selected as 'Yes'.

payerInformationobject
developerDetailsobject(developerDetail)

Ths is to track the developer details.

devPurposestring<= 2000 characters

This is to track the detailed description of the development. This is applicable for PCA, SWC, CC & OC, but not applicable for 'Subdivision Certificate'

commonApplicationTypesArray of objects(CommonApplicationType)

This is to track the common Application types.This is required for CC, OC ,PCA and 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. Temporary building, structure or use

typeOfDevelopmentArray of strings(typeOfDevelopment)
isDevelopmentIncludeAffordableHousingboolean

This is to track if the development includes affordable housing. This is applicable only when Approval type is DA and CertficateType is "Occupational certificate" and based on relevant development types.

isApplicationForInfillAffordableHousingboolean

This is to track if the application is submitted for infill affordable housing. This is applicable only when isDevelopmentIncludeAffordableHousing attribute is true.

regCommunityHousingProviderNamestring<= 512 characters

This is to track the name of the registered community housing provider that will be managing the affordable housing component of the site. This is applicable only when Approval type is DA and CertficateType equals "Occupational certificate" and typeOfDevelopment is "Boarding house" and isDevelopmentIncludeAffordableHousing is true.

isBuildToRentHousingboolean

This is to track if the development proposed to be build-to-rent housing. Applicable when Approval type is DA and CertificateType is "Occupational certificate" and when applicable.

typeofSWCProposedArray of strings(TypeofSWCProposed)
Example: ["Refer to description for values"]
typeofSWCdevelopmentArray of strings(TypeofSWCdevelopment)
Example: ["Earthworks, Roadworks, Road pavement, Road furnishings, Stormwater drainage, Water supply works, Sewerage works, Landscaping works, Erosion control works, Other"]
investmentValuestring

This is to track the estimated cost of the development. This indicates the full contract price inclusive of GST

capitalInvestmentValuenumber<= 15 characters

This is to track the capital investment value in accordance with the Environmental Planning and Assessment Regulation 2021.Capital Investment Value of a development or project includes all costs necessary to establish and operate the project.This is applicable for construction certificate.

developmentInformationobject(DevelopmentInformation)

This is applicable for CC, PCA, SC & SWC.

materialsToBeUsedobject(MaterialsToBeUsed)

This is to track the materials that are used for construction. This may not be applicable for SC & SWC.

businessNameobject(BusinessName)required

This is to track the business name of the nominated Principal Certifier. This is obsolete for CC & OC and is replaced by the relevant registeredCertifierOrgDetails & principalCertifierOrgDetails object.

businessName.​nominatedPCCompanyNamestring

This is to track the nominated principal certifier's company name. e.g A Allen Consulting Surveyors Pty Ltd

businessName.​addressstring<= 150 characters

Address Ex- 5/211 Ramsgate Road RAMSGATE BEACH NSW 2217

registeredCertifierOrgDetailsobject(registeredCertifierOrgDetails)

This indicates the organisation details of the nominated Registered certifier. This is applicable for Construction certificates only.

principalCertifierOrgDetailsobject(principalCertifierOrgDetails)

This indicates the organisation details of the nominated Principal certifier. This is applicable for Construction certificates and Occupation certificates only.

buildingpractitionerArray of objects(buildingpractitioner)

This is to track the building practitioner details. This applies to Occupation Certificate where all or part of the development is within 'Class 2', 'Class 3' & 'Class 9C' buildings.

designpractitionerArray of objects(designpractitioner)

This is to track the design Practitioner details.This applies to Occupation Certificate where all or part of the development is within 'Class 2', 'Class 3' & 'Class 9C' buildings.

principaldesignpractitionerArray of objects(principaldesignpractitioner)

This is to track the principal design Practitioner details. This applies to Occupation Certificate where all or part of the development is within 'Class 2', 'Class 3' & 'Class 9C' buildings.

isChangesRequiredInFireSafetySystemboolean

This indicates if the applicant is proposing to carry out alterations/modifications to existing 'relevant fire safety systems'.This is applicable for CC.

isFireSafetyMeasuresRequiredForBuildingboolean

This is to indicate if the proposed fire safety measures are required to be installed in the building. This is applicable for CC.

modifiedSafeteyMeasuresArray of objects(modifiedSafeteyMeasures)

This is to track the types of fire safety measures when carrying out modifications/alterations to the existing fire safety systems. Please refer to the reference data API for the latest values. This is applicable for CC.

proposedSafetyMeasuresArray of objects(proposedSafetyMeasure)

This is to track the types of fire safety measures when accepting to installthe proposed fire safety systems.Please refer to the reference data API for the latest values.

isNABERSFormAccompaniedboolean

This is to track if the NABERS Embodied Emissions Materials Form accompany this application. This is applicable for construction certificate when the development is not exempt from SBSEPP (isExemptFromSEPPNonResidential=false).

emissionsReportVerifierDetailsobject(emissionsReportVerifierDetails)

This is to track the details of the qualified person certifying the embodied emission amounts disclosed in the form. This is applicable for construction certificate when isExemptFromSEPPNonResidential=false & isNABERSFormAccompanied = true

isPrescribedLCDMetTheCriteriaboolean

This is to track if the development is a prescribed large commercial development that involves any of the consideration. This is applicable for construction certificate when the development is not exempt from SBSEPP (isExemptFromSEPPNonResidential=false).

waterReportMethodsRequiredArray of objects(WaterReportMethodsRequired)

This is to track, how the water standards are being achieved by indicating where water saving measured are integrated into drawings and specifications. Please find below example values. This is applicable for construction certificate when the development is a prescribed large commercial development(isPrescribedLCDMetTheCriteria=true). 1. Annotated drawings, and/or 2. Specifications 3. Other

waterReportMethodRequiredOtherstring<= 2000 characters

This is to track the data entered under any 'Other' reason entered by the applicant on the water standards (waterReportMethodsRequired). This is applicable for construction certificate.

waterReportDocumentReferencesstring<= 2000 characters

This is track the details and document references of the water report. This is applicable for construction certificate.

isDevelopmentInCityOfSydneyLGAboolean

This is to track if development is in the City of Sydney Local Government Area. This is applicable for construction certificate when not exempted from SEPP and when the development is a prescribed large commercial development (isExemptFromSEPPNonResidential=false & isPrescribedLCDMetTheCriteria = true ).

developmentRequirementsArray of strings(developmentRequire)

This is to track the proposed development details. This is applicable for 'Subdivision Certificate'.

Example: ["Refer to description for values"]
anticipatedConstructionStartDatestring(date)

This is to track the Building works commencement date. This is applicable for PCA.

anticipatedOCSoughtDatestring(date)

This is to track anticipated OC sought date. This is applicable for Principal Certifier Appointment.

typeOfSubDivisionProposedArray of strings(typeOfSubDivisionProposed)

This is to track if the Type of Subdivision is Proposed. Below are the example values. Please refer to the reference data API for the latest values.

Example: ["Refer to description for values"]
devCategoryForParkingSpacesArray of objects(devCategoryForParkingSpaces)

This is to track the number of parking spaces for application. This is applicable for Occupation certificate.

isNaturalDisasterboolean

This is to track if this application is a direct result of a matter declared by the government to be an emergency and/or a natural disaster (for example, an application for re-building a home destroyed by bushfire). Not applicable when certificateType is 'Principal Certifier Appointment'(PCA)

housingAndProductivityContributionsArray of objects(Stage)

This is to track the stages for which the certificate is being sought. This is applicable when Housing and Productivity contributions have been identified for the certificates for the staged developments. This is not applicable for PCA.

subjectOfOrderboolean

This is to track the subject of an order. This is will hold the value for the question 'Is the subdivision the subject of an order of the Land and Environment Court under section 40 of the Land and Environment Court Act 1979'. This is applicable for Subdivision Certificate.

PPNstring

This is to track the value of Pre-allocated Plan Number. This is applicable for Subdivision certificate type. PPN number is a plan identifier generated by a registered surveyor through NSW Land registry services portal.

referralCasesArray of strings(referralCases)

This is to track the Referral case IDs.

Example: ["REF-XXXX"]
buildingWorkCommencementDtstring(date)

This is to track the date on which the building work would commence.

isResendboolean

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

documentsArray of objects(DownloadableDocument)
declarationsArray of strings(Declaration)
Example: ["I declare that all the information in the application and checklist is, to the best of my knowledge, true and correct."]
curl -i -X POST \
  'https://dpie-apim-prod.redocly.app/CreatePCC/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyId: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "Submitted",
    "caseSubmittedDate": "string",
    "certificateType": "Refer to description for values",
    "subType": "Refer to description for values",
    "typeofSWCSeeking": "Refer to description for values",
    "relevantSWCForNSW": true,
    "existingSWCRefNum": "string",
    "SWCDetermined": true,
    "dateSWCDetermined": "2019-08-24",
    "approvalType": "Refer to description for values",
    "relatedCaseNumber": "string",
    "hasPortalCaseNumber": true,
    "relatedPortalCaseID": "string",
    "isCaseDetermined": true,
    "dateDetermined": "2019-08-24",
    "applicationToTrackPCA": "string",
    "classOfDevelopments": [
      "string"
    ],
    "isDevelopmentExemptfromDBPAct": true,
    "developmentExemptReason": "string",
    "modifyApplication": true,
    "hasPortalCCCase": "Refer to description for values",
    "hasViaPortalModificationCCCase": true,
    "certificateCCNumber": "string",
    "CCDetermined": true,
    "isExemptFromSEPPNonResidential": true,
    "CCDateDetermined": "2019-08-24",
    "isPortalCCCaseByPCA": true,
    "constructionCertificateNumber": "string",
    "CCDeterminedByPCA": true,
    "dateOfCCIssuedbyPCA": "2019-08-24",
    "PCAPortalCaseID": "string",
    "ITSOCCaseNumber": "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
      }
    ],
    "applicantDetails": {
      "title": "Refer to description for values",
      "applicantPerson": {
        "firstName": "string",
        "otherName": "string",
        "familyName": "string",
        "contactNumber": "stringst",
        "email": "string"
      },
      "address": "string"
    },
    "applyOnBehalfOfCompany": true,
    "applicantCompany": {
      "companyName": "string",
      "ABN": "string",
      "ACN": "string",
      "tradingName": "string"
    },
    "buildersDetailsOrPrincipalContractor": {
      "builderType": "Refer to description for values",
      "builderPerson": {
        "title": "Refer to description for values",
        "person": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string"
        },
        "address": "string",
        "licenseNumber": "string"
      },
      "builderCompany": {
        "company": {
          "companyName": "string",
          "ABN": "string",
          "ACN": "string",
          "tradingName": "string"
        },
        "address": "string",
        "email": "string"
      }
    },
    "additionalBuilderDetails": [
      {
        "builderType": "Refer to description for values",
        "builderPerson": {
          "title": "Refer to description for values",
          "person": {
            "firstName": "string",
            "otherName": "string",
            "familyName": "string",
            "contactNumber": "stringst",
            "email": "string"
          },
          "address": "string",
          "licenseNumber": "string"
        },
        "builderCompany": {
          "company": {
            "companyName": "string",
            "ABN": "string",
            "ACN": "string",
            "tradingName": "string"
          },
          "address": "string",
          "email": "string"
        }
      }
    ],
    "ownership": "Refer to description for values",
    "ownerDetails": [
      {
        "isOwnerABuilder": true,
        "title": "Refer to description for values",
        "ownerPerson": {
          "firstName": "John",
          "familyName": "Smith",
          "email": "john.smith@gmail.com",
          "contactNumber": "stringst"
        },
        "ownerCompany": {
          "companyName": "string",
          "ABNorACN": "string"
        },
        "address": "19-33 Elizabeth Street, Narrandera, 2700"
      }
    ],
    "buildingWork": "string",
    "longServiceLevyPaid": "string",
    "securityConditions": true,
    "detailsOfSecurityConditions": "string",
    "payerInformation": {
      "payerType": "string",
      "payerPerson": {
        "title": "Refer to description for values",
        "payerInfo": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string"
        },
        "billingAddress": "string"
      },
      "payerCompany": {
        "applicantCompany": {
          "companyName": "string",
          "ABN": "string",
          "ACN": "string",
          "tradingName": "string"
        },
        "mailingAddress": "string",
        "email": "string"
      }
    },
    "developerDetails": {
      "developerInfo": {
        "companyName": "string",
        "ABN": "string",
        "ACN": "string",
        "tradingName": "string"
      },
      "fullAddress": "string",
      "email": "string"
    },
    "devPurpose": "string",
    "commonApplicationTypes": [
      {
        "commonApplicationType": "string"
      }
    ],
    "typeOfDevelopment": [
      "string"
    ],
    "isDevelopmentIncludeAffordableHousing": true,
    "isApplicationForInfillAffordableHousing": true,
    "regCommunityHousingProviderName": "string",
    "isBuildToRentHousing": true,
    "typeofSWCProposed": [
      "Refer to description for values"
    ],
    "typeofSWCdevelopment": [
      "Earthworks, Roadworks, Road pavement, Road furnishings, Stormwater drainage, Water supply works, Sewerage works, Landscaping works, Erosion control works, Other"
    ],
    "investmentValue": "string",
    "capitalInvestmentValue": 0,
    "developmentInformation": {
      "landArea": 0.1,
      "existingGrossFloorArea": 0.1,
      "proposedGrossFloorArea": 0.1,
      "totalNetLettableArea": 0,
      "currentBuildingUse": "string",
      "proposedBuildingUse": "string",
      "buildingAttached": [
        "Refer to description for values"
      ],
      "oneBedProposedDev": 0.1,
      "twoBedProposedDev": 0.1,
      "threeBedProposedDev": 0.1,
      "fourBedProposedDev": 0.1,
      "height": 0.1,
      "preExistingDwellingsOnSite": 0.1,
      "dwellingsDemolished": 0.1,
      "unitsProposed": 0.1,
      "storiesProposed": 0.1,
      "proposedLots": 0,
      "existingLots": 0,
      "numOfBedrooms": [
        {
          "noOfBedrooms": "Refer to description for values.",
          "noOfDwellingsDemolished": 0,
          "noOfDwellingsErected": 0
        }
      ]
    },
    "materialsToBeUsed": {
      "walls": [
        "Refer to description for values"
      ],
      "roofs": [
        "Refer to description for values"
      ],
      "floor": [
        "Refer to description for values"
      ],
      "frame": [
        "Refer to description for values"
      ]
    },
    "businessName": {
      "nominatedPCCompanyName": "string",
      "address": "string"
    },
    "registeredCertifierOrgDetails": {
      "ABN": "string",
      "ACN": "string",
      "companyName": "string",
      "tradingName": "string",
      "address": "string",
      "email": "user@example.com"
    },
    "principalCertifierOrgDetails": {
      "ABN": "string",
      "ACN": "string",
      "companyName": "string",
      "tradingName": "string",
      "address": "string",
      "email": "user@example.com"
    },
    "buildingpractitioner": [
      {
        "isOrgRegisteredPractioner": "string",
        "isPractitionerRegisteredForClass2": "refer to description for values.",
        "appropriatePractitioner": "string",
        "organisationDetails": {
          "bodyCorporateRegisterationNo": "string",
          "ABN": "string",
          "ACN": "string",
          "legalName": "string",
          "tradingName": "string",
          "companyAddress": "string",
          "companyEmail": "user@example.com"
        },
        "practitionerdetails": {
          "practitionerTypes": [
            "Refer to description for values."
          ],
          "practitionerRegistrationNumber": "string",
          "title": "Refer to description for values",
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "user@example.com",
          "address": "string"
        }
      }
    ],
    "designpractitioner": [
      {
        "isOrgRegisteredPractioner": "string",
        "isPractitionerRegisteredForClass2": "refer to description for values.",
        "appropriatePractitioner": "string",
        "designPractitionerType": "string",
        "organisationDetails": {
          "bodyCorporateRegisterationNo": "string",
          "ABN": "string",
          "ACN": "string",
          "legalName": "string",
          "tradingName": "string",
          "companyAddress": "string",
          "companyEmail": "user@example.com"
        },
        "practitionerdetails": {
          "practitionerTypes": [
            "Refer to description for values."
          ],
          "practitionerRegistrationNumber": "string",
          "title": "Refer to description for values",
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "user@example.com",
          "address": "string"
        }
      }
    ],
    "principaldesignpractitioner": [
      {
        "isOrgRegisteredPractioner": "string",
        "isPractitionerRegisteredForClass2": "refer to description for values.",
        "appropriatePractitioner": "string",
        "organisationDetails": {
          "bodyCorporateRegisterationNo": "string",
          "ABN": "string",
          "ACN": "string",
          "legalName": "string",
          "tradingName": "string",
          "companyAddress": "string",
          "companyEmail": "user@example.com"
        },
        "practitionerdetails": {
          "practitionerTypes": [
            "Refer to description for values."
          ],
          "practitionerRegistrationNumber": "string",
          "title": "Refer to description for values",
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "user@example.com",
          "address": "string"
        }
      }
    ],
    "isChangesRequiredInFireSafetySystem": true,
    "isFireSafetyMeasuresRequiredForBuilding": true,
    "modifiedSafeteyMeasures": [
      {
        "safetyMeasure": "Refer to description for values",
        "isMeasureInstall": "string",
        "enterProposedStandard": "string"
      }
    ],
    "proposedSafetyMeasures": [
      {
        "safetyMeasure": "Refer to description for values",
        "isMeasureInstall": "string",
        "enterProposedStandard": "string"
      }
    ],
    "isNABERSFormAccompanied": true,
    "emissionsReportVerifierDetails": {
      "firstName": "string",
      "familyName": "string",
      "professionalQualification": "string",
      "registrationDetails": "string",
      "businessName": "string",
      "ABN": "string"
    },
    "isPrescribedLCDMetTheCriteria": true,
    "waterReportMethodsRequired": [
      {
        "waterReportMethodsRequired": "string"
      }
    ],
    "waterReportMethodRequiredOther": "string",
    "waterReportDocumentReferences": "string",
    "isDevelopmentInCityOfSydneyLGA": true,
    "developmentRequirements": [
      "Refer to description for values"
    ],
    "anticipatedConstructionStartDate": "2019-08-24",
    "anticipatedOCSoughtDate": "2019-08-24",
    "typeOfSubDivisionProposed": [
      "Refer to description for values"
    ],
    "devCategoryForParkingSpaces": [
      {
        "categoryOfDevelopment": "Refer to description for values.",
        "carParkingSpaces": 0,
        "motorCycleSpaces": 0,
        "biCycleSpaces": 0
      }
    ],
    "isNaturalDisaster": true,
    "housingAndProductivityContributions": [
      {
        "stage": "string"
      }
    ],
    "subjectOfOrder": true,
    "PPN": "string",
    "referralCases": [
      "REF-XXXX"
    ],
    "buildingWorkCommencementDt": "2019-08-24",
    "isResend": true,
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentCaseID": "string",
        "documentTags": [
          "string"
        ],
        "documentSize": 0,
        "updatedBy": "Council"
      }
    ],
    "declarations": [
      "I declare that all the information in the application and checklist is, to the best of my knowledge, true and correct."
    ]
  }'

Responses

Created

Body
Response
No content

UpdatePCC

Request

This operation transfers the Post-consent Certificate application's updated details from the Online Post-consent Certificate Service to the certifier's IT system.

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

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

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

This is to track the Case status of the applied Post Consent certificates.

Example: "Submitted"
caseSubmittedDatestring

This is to track the date on which the applicant submitted the application in the ePlanning portal.

certificateTypestring(CertificateType)

This is to track the type of certificate submitted. Applicable values are 1. Subdivision Certificate 2. Construction Certificate 3. Principal Certifier Appointment 4. Occupation Certificate 5. Subdivision works certificate. Please refer to reference data API for the latest values.

Example: "Refer to description for values"
subTypestring(SubType)

This indicates the subtype of the certificate applied. It is applicable for Subdivision certificate, Construction certificate and Occupation certificate. Example values for SC and CC would be 1.Certificate for part of the development 2.Certificate for the full development. For OC, when the approval type's determination status is 'false' 1.Occupation certificate for a partially completed building 2.Occupation certificate for part of the building 3.Occupation certificate for whole building. For OC, when the approval type's determination status is 'true' 1.Interim Occupation certificate 2.Final occupation certificate. Please refer to the reference data API for the latest values.

Example: "Refer to description for values"
typeofSWCSeekingstring(TypeofSWCSeeking)

This is to track the type of subdivision works certificate that is being sought. Applicable for Subdivision works certificate. One of the below mentioned values to be selected for TypeofSWCSeeking 1. New application 2. Modification to an existing SWC

Example: "Refer to description for values"
relevantSWCForNSWboolean

This is to track if the relevant SWC certificates that's applied via NSW planning portal or not. This is applicable for Subdivision works certificate and when TypeofSWCSeeking is 'Modification to an existing SWC'.

existingSWCRefNumstring

This is to track the existing SWC application reference number when available.

SWCDeterminedboolean

This is to track if the relevant SWC has been determined or not. Applicable when TypeofSWCSeeking is 'Modification to an existing SWC'.

dateSWCDeterminedstring(date)

This is to track the determination date of relevant SWC when available.

approvalTypestring(ApprovalType)required

This is to track the related approval type of the certificate applied. Example values would be 1. Development Application number (DA) 2. Complying Development Certificate (CDC) 3. State determined (SSI / SSD). Please refer the reference data API for latest values.

Example: "Refer to description for values"
relatedCaseNumberstring

This is to track the related approval type’s case ID.

hasPortalCaseNumberboolean

This is to track if the related 'approvalType' for the certificate applied is submitted via NSW planning portal. This is only applicable when the user selects the 'approvalType' as Complying Development Certificate (CDC) or Development Application number (DA)

relatedPortalCaseIDstring<= 10 characters

This is to track the caseID of the related 'approvalType' if it is submitted via NSW planning portal. This is applicable when “hasPortalCaseNumber” is selected as 'true'.

isCaseDeterminedboolean

This is to track determination status of the certificate's related DA or CDC or SSI/SSD application.

dateDeterminedstring(date)

This is to track the determination date of the related DA or CDC or SSI/SSD application. This is applicable when 'isCaseDetermined' is true.

applicationToTrackPCAstring

This is to indicate if the application submitted is to track transfer of Principal certifier. This is applicable for PCA certificate type.

classOfDevelopmentsArray of strings(classOfDevelopment)

This is to track the development classes. This may not be applicable for SC and SWC. Please refer to the reference data API for the latest values

isDevelopmentExemptfromDBPActboolean

This is to track if the development is exempt from DBAAct. This is applicable when 'Class 2', 'Class 3' and 'Class 9c' is chosen for the 'classofdevelopments' and certificateType OC only.

developmentExemptReasonstring<= 510 characters

This is an obsolete attribute as the DBP exempt reasons are captured in the Building Work/ITSOC applications.

modifyApplicationboolean

This is applicable for Construction Certificate when applying for a modification construction certificate.

hasPortalCCCasestring(HasOnlineCCCase)

This is to track the approval type’s related construction certificate that’s applied for via NSW Planning portal. This is applicable for 1.OC when approvalType is other than CDC 2.CC when “modifyApplication” is No & approvalType is DA.

Example: "Refer to description for values"
hasViaPortalModificationCCCaseboolean

This is to track if the related construction certificate is applied via NSW Planning portal. This becomes applicable when 'approvalType' is DA, and 'Modify Application' is selected as 'Yes' for a Construction Certificate.

certificateCCNumberstring

This is to track the related construction certificate number when available.

CCDeterminedboolean

This is to track the related DA approval type’s CC case determination status.

isExemptFromSEPPNonResidentialboolean

This is to track if the development is exempt from the State Environmental Planning Policy (Sustainable Buildings) 2022, Chapter 3, relating to non-residential buildings for any of the following reasons. Either DA was submitted on the NSW Planning Portal before 1st October 2023 or The DA was submitted on the NSW Planning Portal on or after 1st October 2023 but was deemed exempt due to the reasons outlined in Chapter 3.1.

CCDateDeterminedstring(date)

This is to track the determination date of the construction certificate. This becomes applicable when CCDetermined is true.

isPortalCCCaseByPCAboolean

This is to track if the related Construction certificate for PCA is applied via NSW Planning portal. This becomes applicable when 'approvalType' is DA and Certificate type is Principal Certifier Appointment.

constructionCertificateNumberstring

This is to track the related Construction Certificate number for PCA. This is applicable when 'isPortalCCCaseByPCA' is true.

CCDeterminedByPCAboolean

This is to track the determination status of the construction certificate. This becomes applicable when 'approvalType' is DA and Certificate type is Principal Certifier Appointment.

dateOfCCIssuedbyPCAstring(date)

This is to track the related construction certificate's issuance date. This is applicable for PCA certificate type when 'CCDeterminedByPCA' is true.

PCAPortalCaseIDstring

This is an obsolete attribute and is not relevant anymore. This is to track related caseID of the Principal certifier appointment application applied through NSW planning portal. This is applicable for Occupation certificate for class 2 developments only.

ITSOCCaseNumberstring

This is to track the related caseID of the the ITSOC (Intention to seek Occupation Certificate) application applied through NSW planning portal. This is applicable when 'Class 2', 'Class 3' and 'Class 9c' is chosen for the 'classofdevelopments' and certificateType OC only.

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

Site addresses

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 case falls

Example: "PENRITH"
siteAddresses[].​isPrimaryboolean

This is to track if the address provided is the primary address when multiple lot addresses are provided.

applicantDetailsobject(applicantDetails)
applyOnBehalfOfCompanybooleanrequired

This is to track whether the applicant is company or Not. If YES need to provide the company details.

applicantCompanyobject(applicantCompany)
buildersDetailsOrPrincipalContractorobject

This is to track the Builder or Principal Contractor details. This is not applicable to Subdivision certificate.

additionalBuilderDetailsArray of objects(AdditionalBuilderDetails)

This is to track any additional builder details excluding the one mentioned in 'buildersDetailsOrPrincipalContractor'.

ownershipstring(Ownership)required

This is to track the owner of the development site. Example values are 1. I am the sole owner of the development site 2. There are multiple owners of the development site and I am one of them 3. There are one or more owners of the development site and I am NOT one of them 4. A company, business, government entity or other similar body owns the development site

Example: "Refer to description for values"
ownerDetailsArray of objects(OwnerDetails)

This is to track the ownerdetails. Either individual(ownerPerson) or Company(ownerCompany)

buildingWorkstring(BuildingWork)

This indicates the entity that would be doing the building work. One of the below mentioned values to be selected for BuildingWork. Please refer the reference date API for the latest values. 1. Licensed Builder 2. Owner Builder 3. Not determined at this time (This information will be required prior to work commencing).

longServiceLevyPaidstring(LongServiceLevyPaid)

This is to track if the Building and Industry Long Service Levy is paid when the value of the work is $25,000 or more. This is applicable for Constuction certificate. Example values are 1. Yes 2. No 3. NA

securityConditionsboolean

This is to track the security or site conditions which may impact on the person undertaking the inspection like locked gates, dogs, animals etc. This is not applicable for subdivision certificate.

detailsOfSecurityConditionsstring<= 2000 characters

This is to track the details of the security conditions. This is applicable when 'securityConditions' is selected as 'Yes'

payerInformationobject
developerDetailsobject(developerDetail)

Ths is to track the developer details.

devPurposestring<= 2000 characters

This is to track the detailed description of the development. Not applicable for 'Subdivision Certificate'

commonApplicationTypesArray of objects(CommonApplicationType)

This is to track the common Application types.This is required for CC, OC ,PCA and 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. Temporary building, structure or use

typeOfDevelopmentArray of strings(typeOfDevelopment)
isDevelopmentIncludeAffordableHousingboolean

This is to track if the development includes affordable housing. This is applicable only when Approval type is DA and CertficateType is "Occupational certificate" and based on relevant development types.

isApplicationForInfillAffordableHousingboolean

This is to track if the application is submitted for infill affordable housing. This is applicable only when isDevelopmentIncludeAffordableHousing attribute is true.

regCommunityHousingProviderNamestring<= 512 characters

This is to track the name of the registered community housing provider that will be managing the affordable housing component of the site. This is applicable only when Approval type is DA and CertficateType equals "Occupational certificate" and typeOfDevelopment is "Boarding house" and isDevelopmentIncludeAffordableHousing is true.

isBuildToRentHousingboolean

This is to track if the development proposed to be build-to-rent housing. Applicable when Approval type is DA and CertificateType is "Occupational certificate" and typeOfDevelopment is "Residential flat building","Shop top housing","Multi-dwelling housing".

typeofSWCProposedArray of strings(TypeofSWCProposed)
Example: ["Refer to description for values"]
typeofSWCdevelopmentArray of strings(TypeofSWCdevelopment)
Example: ["Earthworks, Roadworks, Road pavement, Road furnishings, Stormwater drainage, Water supply works, Sewerage works, Landscaping works, Erosion control works, Other"]
investmentValuestring

This is to track the estimated cost of the development. Full contract price inclusive of GST is indicated.

capitalInvestmentValuenumber<= 15 characters

This is to track the capital investment value in accordance with the Environmental Planning and Assessment Regulation 2021.Capital Investment Value of a development or project includes all costs necessary to establish and operate the project.This is applicable for construction certificate.

developmentInformationobject(DevelopmentInformation)

This is applicable for CC, PCA, SC & SWC.

materialsToBeUsedobject(MaterialsToBeUsed)

This is to track the materials that are used for construction. This may not be applicable for SC & SWC.

businessNameobject(BusinessName)required

This is to track the business name of the nominated Principal Certifier. This is obsolete for CC & OC and is replaced by the relevant registeredCertifierOrgDetails & principalCertifierOrgDetails object.

businessName.​nominatedPCCompanyNamestring

This is to track the nominated principal certifier's company name. e.g A Allen Consulting Surveyors Pty Ltd

businessName.​addressstring<= 150 characters

Address Ex- 5/211 Ramsgate Road RAMSGATE BEACH NSW 2217

registeredCertifierOrgDetailsobject(registeredCertifierOrgDetails)

This indicates the organisation details of the nominated Registered certifier. This is applicable for Construction certificates only.

principalCertifierOrgDetailsobject(principalCertifierOrgDetails)

This indicates the organisation details of the nominated Principal certifier. This is applicable for Construction certificates and Occupation certificates only.

buildingpractitionerArray of objects(buildingpractitioner)

This is to track the building practitioner details. This applies to Occupation Certificate where all or part of the development is within 'Class 2', 'Class 3' & 'Class 9C' buildings .

designpractitionerArray of objects(designpractitioner)

This is to track the design Practitioner details.This applies to Occupation Certificate where all or part of the development is within 'Class 2', 'Class 3' & 'Class 9C' buildings.

principaldesignpractitionerArray of objects(principaldesignpractitioner)

This is to track the principal design Practitioner details. This applies to Occupation Certificate where all or part of the development is within 'Class 2', 'Class 3' & 'Class 9C' buildings.

isChangesRequiredInFireSafetySystemboolean

This is to track the values(yes/no) whether are we going to modify existing relevant fire safety systems or not.Not required for 'Subdivision works certificate'.

isFireSafetyMeasuresRequiredForBuildingboolean

This is to track whether values(yes/no) whether are we proposed fire safety measures to be installed in the building or not.Not required for 'Subdivision works certificate'.

modifiedSafeteyMeasuresArray of objects(modifiedSafeteyMeasures)

If RelevantSafety selected as 'Yes'.

proposedSafetyMeasuresArray of objects(proposedSafetyMeasure)

If Relevant Safety selected as 'Yes' and Safety Measures selected as 'Yes'

isNABERSFormAccompaniedboolean

This is to track if the NABERS Embodied Emissions Materials Form accompany this application. This is applicable for construction certificate when the development is not exempt from SBSEPP (isExemptFromSEPPNonResidential=false).

emissionsReportVerifierDetailsobject(emissionsReportVerifierDetails)

This is to track the details of the qualified person certifying the embodied emission amounts disclosed in the form. This is applicable for construction certificate when isExemptFromSEPPNonResidential=false & isNABERSFormAccompanied = true

isPrescribedLCDMetTheCriteriaboolean

This is to track if the development is a prescribed large commercial development that involves any of the consideration. This is applicable for construction certificate when the development is not exempt from SBSEPP (isExemptFromSEPPNonResidential=false).

waterReportMethodsRequiredArray of objects(WaterReportMethodsRequired)

This is to track, how the water standards are being achieved by indicating where water saving measured are integrated into drawings and specifications. Please find below example values. This is applicable for construction certificate when the development is a prescribed large commercial development(isPrescribedLCDMetTheCriteria=true). 1. Annotated drawings, and/or 2. Specifications 3. Other

waterReportMethodRequiredOtherstring<= 2000 characters

This is to track the data entered under any 'Other' reason entered by the applicant on the water standards (waterReportMethodsRequired).This is applicable for construction certificate.

waterReportDocumentReferencesstring<= 2000 characters

This is track the details and document references of the water report.This is applicable for construction certificate.

isDevelopmentInCityOfSydneyLGAboolean

This is to track if development is in the City of Sydney Local Government Area. This is applicable for construction certificate when the development is not exempt from SBSEPP and when the development is a prescribed large commercial development (isExemptFromSEPPNonResidential=false & isPrescribedLCDMetTheCriteria = true ).

developmentRequirementsArray of strings(developmentRequire)

This is to track the proposed development details. This is applicable for 'Subdivision Certificate'.

Example: ["Refer to description for values"]
anticipatedConstructionStartDatestring(date)

This is to track the Building works commencement date. This is applicable for PCA.

anticipatedOCSoughtDatestring(date)

This is to track anticipated OC sought date. This is applicable for Principal Certifier Appointment.

typeOfSubDivisionProposedArray of strings(typeOfSubDivisionProposed)

This is to track the type of subdivision proposed. This is applicable for Subdivision Certificate.

Example: ["Refer to description for values"]
devCategoryForParkingSpacesArray of objects(devCategoryForParkingSpaces)

This is to track the number of parking spaces for application. This is applicable for Occupation certificate.

isNaturalDisasterboolean

This is to track if this application is a direct result of a matter declared by the government to be an emergency and/or a natural disaster (for example, an application for re-building a home destroyed by bushfire).This is not applicable when certificateType is 'Principal Certifier Appointment'(PCA)

housingAndProductivityContributionsArray of objects(Stage)

This is to track the stages for which the certificate is being sought. This is applicable when Housing and Productivity contributions have been identified for the certificates for the staged developments. This is not applicable for PCA.

subjectOfOrderboolean

This is to track the subject of an order. This is will hold the value for the question 'Is the subdivision the subject of an order of the Land and Environment Court under section 40 of the Land and Environment Court Act 1979'. This is applicable for Subdivision Certificate.

PPNstring

This is to track the value of Pre-allocated Plan Number. This is applicable for Subdivision certificate type. PPN number is a plan identifier generated by a registered surveyor through NSW Land registry services portal.

referralCasesArray of strings(referralCases)

This is to track the referral case IDs and they are applicable for Subdivision certificate.

Example: ["REF-XXXX"]
buildingWorkCommencementDtstring(date)

This is to track the date of the Building work commencement.

documentsArray of objects(DownloadableDocument)

This block will contain the full set of documents.

deltaDocumentsArray of objects(DownloadableDocument)

This block will be sending the delta documents uploaded or updated as part of update operation.

postDeterminationobject(PostDetermination)

This is to track Post determination. This will be applicable only for OC when class of development is Class 2.

declarationsArray of strings(Declaration)
Example: ["I declare that all the information in the application and checklist is, to the best of my knowledge, true and correct."]
determinationOutcomestring

This is to track the determination outcome of the application. This is applicable for the UpdatePCC which is emitted post determination and for all certificates except PCA.

curl -i -X PUT \
  'https://dpie-apim-prod.redocly.app/UpdatePCC/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyId: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "Submitted",
    "caseSubmittedDate": "string",
    "certificateType": "Refer to description for values",
    "subType": "Refer to description for values",
    "typeofSWCSeeking": "Refer to description for values",
    "relevantSWCForNSW": true,
    "existingSWCRefNum": "string",
    "SWCDetermined": true,
    "dateSWCDetermined": "2019-08-24",
    "approvalType": "Refer to description for values",
    "relatedCaseNumber": "string",
    "hasPortalCaseNumber": true,
    "relatedPortalCaseID": "string",
    "isCaseDetermined": true,
    "dateDetermined": "2019-08-24",
    "applicationToTrackPCA": "string",
    "classOfDevelopments": [
      "string"
    ],
    "isDevelopmentExemptfromDBPAct": true,
    "developmentExemptReason": "string",
    "modifyApplication": true,
    "hasPortalCCCase": "Refer to description for values",
    "hasViaPortalModificationCCCase": true,
    "certificateCCNumber": "string",
    "CCDetermined": true,
    "isExemptFromSEPPNonResidential": true,
    "CCDateDetermined": "2019-08-24",
    "isPortalCCCaseByPCA": true,
    "constructionCertificateNumber": "string",
    "CCDeterminedByPCA": true,
    "dateOfCCIssuedbyPCA": "2019-08-24",
    "PCAPortalCaseID": "string",
    "ITSOCCaseNumber": "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
      }
    ],
    "applicantDetails": {
      "title": "Refer to description for values",
      "applicantPerson": {
        "firstName": "string",
        "otherName": "string",
        "familyName": "string",
        "contactNumber": "stringst",
        "email": "string"
      },
      "address": "string"
    },
    "applyOnBehalfOfCompany": true,
    "applicantCompany": {
      "companyName": "string",
      "ABN": "string",
      "ACN": "string",
      "tradingName": "string"
    },
    "buildersDetailsOrPrincipalContractor": {
      "builderType": "Refer to description for values",
      "builderPerson": {
        "title": "Refer to description for values",
        "person": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string"
        },
        "address": "string",
        "licenseNumber": "string"
      },
      "builderCompany": {
        "company": {
          "companyName": "string",
          "ABN": "string",
          "ACN": "string",
          "tradingName": "string"
        },
        "address": "string",
        "email": "string"
      }
    },
    "additionalBuilderDetails": [
      {
        "builderType": "Refer to description for values",
        "builderPerson": {
          "title": "Refer to description for values",
          "person": {
            "firstName": "string",
            "otherName": "string",
            "familyName": "string",
            "contactNumber": "stringst",
            "email": "string"
          },
          "address": "string",
          "licenseNumber": "string"
        },
        "builderCompany": {
          "company": {
            "companyName": "string",
            "ABN": "string",
            "ACN": "string",
            "tradingName": "string"
          },
          "address": "string",
          "email": "string"
        }
      }
    ],
    "ownership": "Refer to description for values",
    "ownerDetails": [
      {
        "isOwnerABuilder": true,
        "title": "Refer to description for values",
        "ownerPerson": {
          "firstName": "John",
          "familyName": "Smith",
          "email": "john.smith@gmail.com",
          "contactNumber": "stringst"
        },
        "ownerCompany": {
          "companyName": "string",
          "ABNorACN": "string"
        },
        "address": "19-33 Elizabeth Street, Narrandera, 2700"
      }
    ],
    "buildingWork": "string",
    "longServiceLevyPaid": "string",
    "securityConditions": true,
    "detailsOfSecurityConditions": "string",
    "payerInformation": {
      "payerType": "string",
      "payerPerson": {
        "title": "Refer to description for values",
        "payerInfo": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "string"
        },
        "billingAddress": "string"
      },
      "payerCompany": {
        "applicantCompany": {
          "companyName": "string",
          "ABN": "string",
          "ACN": "string",
          "tradingName": "string"
        },
        "mailingAddress": "string",
        "email": "string"
      }
    },
    "developerDetails": {
      "developerInfo": {
        "companyName": "string",
        "ABN": "string",
        "ACN": "string",
        "tradingName": "string"
      },
      "fullAddress": "string",
      "email": "string"
    },
    "devPurpose": "string",
    "commonApplicationTypes": [
      {
        "commonApplicationType": "string"
      }
    ],
    "typeOfDevelopment": [
      "string"
    ],
    "isDevelopmentIncludeAffordableHousing": true,
    "isApplicationForInfillAffordableHousing": true,
    "regCommunityHousingProviderName": "string",
    "isBuildToRentHousing": true,
    "typeofSWCProposed": [
      "Refer to description for values"
    ],
    "typeofSWCdevelopment": [
      "Earthworks, Roadworks, Road pavement, Road furnishings, Stormwater drainage, Water supply works, Sewerage works, Landscaping works, Erosion control works, Other"
    ],
    "investmentValue": "string",
    "capitalInvestmentValue": 0,
    "developmentInformation": {
      "landArea": 0.1,
      "existingGrossFloorArea": 0.1,
      "proposedGrossFloorArea": 0.1,
      "totalNetLettableArea": 0,
      "currentBuildingUse": "string",
      "proposedBuildingUse": "string",
      "buildingAttached": [
        "Refer to description for values"
      ],
      "oneBedProposedDev": 0.1,
      "twoBedProposedDev": 0.1,
      "threeBedProposedDev": 0.1,
      "fourBedProposedDev": 0.1,
      "height": 0.1,
      "preExistingDwellingsOnSite": 0.1,
      "dwellingsDemolished": 0.1,
      "unitsProposed": 0.1,
      "storiesProposed": 0.1,
      "proposedLots": 0,
      "existingLots": 0,
      "numOfBedrooms": [
        {
          "noOfBedrooms": "Refer to description for values.",
          "noOfDwellingsDemolished": 0,
          "noOfDwellingsErected": 0
        }
      ]
    },
    "materialsToBeUsed": {
      "walls": [
        "Refer to description for values"
      ],
      "roofs": [
        "Refer to description for values"
      ],
      "floor": [
        "Refer to description for values"
      ],
      "frame": [
        "Refer to description for values"
      ]
    },
    "businessName": {
      "nominatedPCCompanyName": "string",
      "address": "string"
    },
    "registeredCertifierOrgDetails": {
      "ABN": "string",
      "ACN": "string",
      "companyName": "string",
      "tradingName": "string",
      "address": "string",
      "email": "user@example.com"
    },
    "principalCertifierOrgDetails": {
      "ABN": "string",
      "ACN": "string",
      "companyName": "string",
      "tradingName": "string",
      "address": "string",
      "email": "user@example.com"
    },
    "buildingpractitioner": [
      {
        "isOrgRegisteredPractioner": "string",
        "isPractitionerRegisteredForClass2": "refer to description for values.",
        "appropriatePractitioner": "string",
        "organisationDetails": {
          "bodyCorporateRegisterationNo": "string",
          "ABN": "string",
          "ACN": "string",
          "legalName": "string",
          "tradingName": "string",
          "companyAddress": "string",
          "companyEmail": "user@example.com"
        },
        "practitionerdetails": {
          "practitionerTypes": [
            "Refer to description for values."
          ],
          "practitionerRegistrationNumber": "string",
          "title": "Refer to description for values",
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "user@example.com",
          "address": "string"
        }
      }
    ],
    "designpractitioner": [
      {
        "isOrgRegisteredPractioner": "string",
        "isPractitionerRegisteredForClass2": "refer to description for values.",
        "appropriatePractitioner": "string",
        "designPractitionerType": "string",
        "organisationDetails": {
          "bodyCorporateRegisterationNo": "string",
          "ABN": "string",
          "ACN": "string",
          "legalName": "string",
          "tradingName": "string",
          "companyAddress": "string",
          "companyEmail": "user@example.com"
        },
        "practitionerdetails": {
          "practitionerTypes": [
            "Refer to description for values."
          ],
          "practitionerRegistrationNumber": "string",
          "title": "Refer to description for values",
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "user@example.com",
          "address": "string"
        }
      }
    ],
    "principaldesignpractitioner": [
      {
        "isOrgRegisteredPractioner": "string",
        "isPractitionerRegisteredForClass2": "refer to description for values.",
        "appropriatePractitioner": "string",
        "organisationDetails": {
          "bodyCorporateRegisterationNo": "string",
          "ABN": "string",
          "ACN": "string",
          "legalName": "string",
          "tradingName": "string",
          "companyAddress": "string",
          "companyEmail": "user@example.com"
        },
        "practitionerdetails": {
          "practitionerTypes": [
            "Refer to description for values."
          ],
          "practitionerRegistrationNumber": "string",
          "title": "Refer to description for values",
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "user@example.com",
          "address": "string"
        }
      }
    ],
    "isChangesRequiredInFireSafetySystem": true,
    "isFireSafetyMeasuresRequiredForBuilding": true,
    "modifiedSafeteyMeasures": [
      {
        "safetyMeasure": "Refer to description for values",
        "isMeasureInstall": "string",
        "enterProposedStandard": "string"
      }
    ],
    "proposedSafetyMeasures": [
      {
        "safetyMeasure": "Refer to description for values",
        "isMeasureInstall": "string",
        "enterProposedStandard": "string"
      }
    ],
    "isNABERSFormAccompanied": true,
    "emissionsReportVerifierDetails": {
      "firstName": "string",
      "familyName": "string",
      "professionalQualification": "string",
      "registrationDetails": "string",
      "businessName": "string",
      "ABN": "string"
    },
    "isPrescribedLCDMetTheCriteria": true,
    "waterReportMethodsRequired": [
      {
        "waterReportMethodsRequired": "string"
      }
    ],
    "waterReportMethodRequiredOther": "string",
    "waterReportDocumentReferences": "string",
    "isDevelopmentInCityOfSydneyLGA": true,
    "developmentRequirements": [
      "Refer to description for values"
    ],
    "anticipatedConstructionStartDate": "2019-08-24",
    "anticipatedOCSoughtDate": "2019-08-24",
    "typeOfSubDivisionProposed": [
      "Refer to description for values"
    ],
    "devCategoryForParkingSpaces": [
      {
        "categoryOfDevelopment": "Refer to description for values.",
        "carParkingSpaces": 0,
        "motorCycleSpaces": 0,
        "biCycleSpaces": 0
      }
    ],
    "isNaturalDisaster": true,
    "housingAndProductivityContributions": [
      {
        "stage": "string"
      }
    ],
    "subjectOfOrder": true,
    "PPN": "string",
    "referralCases": [
      "REF-XXXX"
    ],
    "buildingWorkCommencementDt": "2019-08-24",
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentCaseID": "string",
        "documentTags": [
          "string"
        ],
        "documentSize": 0,
        "updatedBy": "Council"
      }
    ],
    "deltaDocuments": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentCaseID": "string",
        "documentTags": [
          "string"
        ],
        "documentSize": 0,
        "updatedBy": "Council"
      }
    ],
    "postDetermination": {
      "isPractitionerDeclaredAsBuiltVariationConfirmation": true,
      "buildingComplianceDeclaration": {
        "isbuildingWorkComplied": true,
        "reasonForbuildingWorkNotCompliant": "string",
        "stepsToEnsureCompliance": "string",
        "isDesignPreparedByRegisteredPractitioner": true,
        "reasonForDesignNotPreparedByRegisteredPractitioner": "string",
        "isDesignComplianceDeclarationObtained": true,
        "designComplianceDeclarationObtainedInfo": "string",
        "isRegisteredPrincipalDesignPractitionerAppointed": true,
        "isPrincipalComplianceDeclarationObtained": true,
        "principalComplianceDeclarationObtainedInfo": "string"
      },
      "buildingdesignComplianceDeclarations": [
        "Refer to description for values"
      ]
    },
    "declarations": [
      "I declare that all the information in the application and checklist is, to the best of my knowledge, true and correct."
    ],
    "determinationOutcome": "string"
  }'

Responses

Created

Body
Response
No content

UpdateAdditionalInfo

Request

This operation transfers the additional information uploaded by the applicant from the Online Post-consent Certificate Service to the certifier's IT system.

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

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

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 request for additional information

Example: "Complete"
childCaseIDstring

An AI case id for RFI

Example: "AI-XXXX"
responseDatestring(date)non-emptyrequired

Date and time of response

responseDetailsstring

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": "AI-XXXX",
    "responseDate": "2019-08-24",
    "responseDetails": "string",
    "Documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentCaseID": "string",
        "documentTags": [
          "string"
        ],
        "documentSize": 0,
        "updatedBy": "Council"
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Request created

Body
Response
No content

Withdraw

Request

This operation transfers the applicant's decision to withdraw the Post-consent Certificate application from the Online Post-consent Certificate Service to the certifier's IT system.

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

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

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

case status

withdrawalReasonstring

This is to track the Reason for withdrawal of the application.

withdrawalDatestring(date)non-emptyrequired

This is to track the Date on which case is withdrawn.

Example: "2020-09-10"
updatedByobject(updatedBy)required
updatedBy.​personobject(PersonBody)
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": "string",
    "withdrawalReason": "string",
    "withdrawalDate": "2020-09-10",
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Case withdrawn

Body
Response
No content

ReqAddInfo

Request

This operation requests further information from certifier to process the case

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

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

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

childCaseIDstring

Used to hold the child case ID to perform RFI.

Example: "AI-XXXX"
primaryCaseIDstring

Used to hold Post Consent Certificate case ID.

Example: "CFT-XXXX"
caseStatusstring

Used to hold the case status of ITSOC/SB

requestDatestring(date)

Date and time of request

requestDetailsstring[ 1 .. 2000 ] charactersrequired

Short description of request

DocumentsArray of objects(DownloadableDocument)
updatedByobjectrequired
updatedBy.​personobject(PersonBodyOut)
curl -i -X PUT \
  'https://dpie-apim-prod.redocly.app/ReqAddInfo/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyId: string' \
  -H 'OrganisationID: string' \
  -d '{
    "childCaseID": "AI-XXXX",
    "primaryCaseID": "CFT-XXXX",
    "caseStatus": "string",
    "requestDate": "2019-08-24",
    "requestDetails": "string",
    "Documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentCaseID": "string",
        "documentTags": [
          "string"
        ],
        "documentSize": 0,
        "updatedBy": "Council"
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Case ID (AI) created

Body
Response
No content

IntentToCommenceWork

Request

This operation transfers the 'Intentiontocommencework' related application details in the Post-consent Certificate application ( PCA )created by the applicant from the Online Post-consent Certificate Service to the certifier's IT system. This is applicable only for principal certifiying authority appointment (PCA).

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

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

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

typeOfWorkIntendedToCommencestringnon-emptyrequired

This is to track the type of work intended for commencement. One of the below mentioned values to be selected for typeOfWorkIntendedToCommence. Please refer to the reference data API for the latest values. 1.Erection of the building 2.Subdivision work

Example: "Refer to description for values."
buildingWorkCommencementDatestring(date)non-emptyrequired

This is to track the commencement date for building work.

relatedDevelopmentConsentstringnon-emptyrequired

This is to track the related development consent. One of the below mentioned values to be selected for relatedDevelopmentConsent. Please refer to the reference data API for the latest values. 1.Development Application number (DA) 2.Complying Development Certificate (CDC) 3.State determined (SSI / SSD)

Example: "Refer to description for values."
relatedDevelopmentConsentCaseIDstring[ 1 .. 20 ] charactersrequired

This is to track the related development consent (DA) caseID.

relatedDevelopmentConsentDeterminationDatestring(date)non-emptyrequired

This is to track the development consent determination date.

relatedCCCaseIDstring[ 1 .. 20 ] charactersrequired

This is to track the related construction certificate reference number. This field is not applicable when related development consent type is CDC and is an applicable field.

relatedCCIssueDatestring(date)non-emptyrequired

This is to track the related construction certificate's issue date. This field is not applicable when related development consent type is CDC.

documentsArray of objects(DownloadableDocument)
updatedByobject(updatedBy)required
updatedBy.​personobject(PersonBody)
curl -i -X PUT \
  'https://dpie-apim-prod.redocly.app/IntentToCommenceWork/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyId: string' \
  -H 'OrganisationID: string' \
  -d '{
    "typeOfWorkIntendedToCommence": "Refer to description for values.",
    "buildingWorkCommencementDate": "2019-08-24",
    "relatedDevelopmentConsent": "Refer to description for values.",
    "relatedDevelopmentConsentCaseID": "string",
    "relatedDevelopmentConsentDeterminationDate": "2019-08-24",
    "relatedCCCaseID": "string",
    "relatedCCIssueDate": "2019-08-24",
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentCaseID": "string",
        "documentTags": [
          "string"
        ],
        "documentSize": 0,
        "updatedBy": "Council"
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Request created

Body
Response
No content

ReferralAssessment

Request

This operation sends the information of the assessment of Referrals to Certifier's IT system.

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

The council LGA name or Private Certifier or Agency 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

primaryCaseIDstring

This is to track the Post Consent Certificate case ID.

Example: "CFT-XXXX"
caseStatusstring[ 1 .. 80 ] charactersrequired

Status of the Referral case

Example: "Submitted"
referralDetailsobject(agencyToConsultWith)

Add agency

reviewOfOutcomestring(ReviewOfOutcome)required

This is to track the outcome of the review One of the below mentioned values are applicable for ReviewOfOutcome. Please refer to the reference data API for the latest values. 1 . Accept application 2. Return application 3. Referral noted, decision not required

Example: "Refer to description for values"
preliminaryReviewstring(Preliminary Review)

This is to track the Preliminary review outcome. Applicable if the reviewOfOutcome is 'Accept application'. One of the below mentioned values to be selected for PreliminaryReview. Please refer to the reference data API for the latest values. 1. Yes, the application is ready for decision 2. No, need more information

Example: "Refer to description for values"
retunApplicationstring<= 1500 characters

This is to track the reviewoutcome. Required if the reviewOfOutcome is 'Return application'

commentsOnDecisionNotRequiredstring<= 1500 characters

This is to track the the comments, when the decision is not required. This becomes application when reviewOfOutcome is 'Referral noted, decision not required'

DocumentsArray of objects(DownloadableDocument)

This is to track the Documents avialble if the reviewOfOutcome is 'Return application'

updatedByobject(updatedBy)required
updatedBy.​personobject(PersonBody)
curl -i -X PUT \
  'https://dpie-apim-prod.redocly.app/ReferralAssessment/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyId: string' \
  -H 'OrganisationID: string' \
  -d '{
    "primaryCaseID": "CFT-XXXX",
    "caseStatus": "Submitted",
    "referralDetails": {
      "agencyName": "string",
      "agencyReferenceNumber": "string",
      "reasonForReferral": "string",
      "referredBy": "string",
      "selectRequiredDocuments": [
        "Refer to description for values"
      ]
    },
    "reviewOfOutcome": "Refer to description for values",
    "preliminaryReview": "Refer to description for values",
    "retunApplication": "string",
    "commentsOnDecisionNotRequired": "string",
    "Documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentCaseID": "string",
        "documentTags": [
          "string"
        ],
        "documentSize": 0,
        "updatedBy": "Council"
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Case Submitted by Applicant

Body
Response
No content

ReferralDecision

Request

This operation sends referral case information of subdivision PCC case created by the applicant from the eplanning to the certifier's IT system.

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

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

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

parentCaseIDstring
Example: "CFT-XXXX"
caseStatusstring[ 1 .. 80 ] charactersrequired

This is to track the case status of the post consent certificate application.

Example: "Submitted"
referralDetailsobject(agencyToConsultWith)

Add agency

reviewOfOutcomestring(ReviewOfOutcome)

This is to track the outcome of the review One of the below mentioned values are applicable for ReviewOfOutcome. Please refer to the reference data API for the latest values. 1 . Accept application 2. Return application 3. Referral noted, decision not required

Example: "Refer to description for values"
preliminaryReviewstring(Preliminary Review)

This is to track the Preliminary review outcome. Applicable if the reviewOfOutcome is 'Accept application'. One of the below mentioned values to be selected for PreliminaryReview. Please refer to the reference data API for the latest values. 1. Yes, the application is ready for decision 2. No, need more information

Example: "Refer to description for values"
retunApplicationstring

Required if the reviewOfOutcome is 'Return application'

commentsOnDecisionNotRequiredstring

This field will be available on UI if the reviewOfOutcome is 'Referral noted, decision not required'

decisionOutcomestring(DecisionOutcome)

This is to track the outcome of the review. One of the below mentioned values to be selected for DecisionOutcome 1. Approved 2. Not Approved

Example: "Refer to description for values"
commentsstring<= 2000 characters

This is to track the Decision outcome comments.

DocumentsArray of objects(DownloadableDocument)

This is to track the Documents avialable if the reviewOfOutcome is 'Return application'

updatedByobject(updatedBy)
curl -i -X PUT \
  'https://dpie-apim-prod.redocly.app/ReferralDecision/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyId: string' \
  -H 'OrganisationID: string' \
  -d '{
    "parentCaseID": "CFT-XXXX",
    "caseStatus": "Submitted",
    "referralDetails": {
      "agencyName": "string",
      "agencyReferenceNumber": "string",
      "reasonForReferral": "string",
      "referredBy": "string",
      "selectRequiredDocuments": [
        "Refer to description for values"
      ]
    },
    "reviewOfOutcome": "Refer to description for values",
    "preliminaryReview": "Refer to description for values",
    "retunApplication": "string",
    "commentsOnDecisionNotRequired": "string",
    "decisionOutcome": "Refer to description for values",
    "comments": "string",
    "Documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentCaseID": "string",
        "documentTags": [
          "string"
        ],
        "documentSize": 0,
        "updatedBy": "Council"
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Created

Body
Response
No content