Skip to content
ONLINE BIC SERVICE APIs V1
/
BIC - ePlanning to Council API
/
UpdateBIC

BIC- ePlanning to Council API (v1)

Authentication

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

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

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

CreateBIC

Request

This operation transfers the application created by the applicant from the Building Information certificate Service to the council's IT system.

Path
CaseIDstringrequired

A fully qualified Planning BIC case

Headers
OrganisationIDstringrequired

Used by the API gateway to identify the agency to which the response needs to be routed to.

Bodyapplication/jsonrequired

Information request object

caseStatusstring[ 1 .. 80 ] charactersrequired

Status of the BIC case

Example: "Submitted"
isPrimaryApplicantstring

This is to track primary applicant type for the application. One of the below mentioned values must be selected for the field. 1. The landowner 2. A representative of the landowner 3. The purchaser of a property under a contract of sale 4. A public authority that has notified the owner that you are applying for a Building Information Certificate

Example: "Refer to description for values."
primaryApplicantobject(applicantList)

used to hold owner’s Corporation details.

additionalApplicantsArray of objects(applicantList)
securityConditionsbooleanrequired

This is to track if there are any security or site conditions that may impact on the person undertaking the inspection.

detailsOfSecurityConditionsstring<= 512 characters

This is to track the detailed description of the security or site conditions that impact the person undertaking the inspection. Visible if SecurityConditions is true.

siteAccessPersonDetailsobject(SiteAccessPerson)

This is to track the details of the person that will provide access to the site, if different to the primary applicant.

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

Address of the proposed development.

Example: "19-33 Elizabeth Street, Narrandera, 2700"
siteAddresses[].​addressDetailobject(AddressDetail)
siteAddresses[].​addressNotDisplayedboolean

This is to indicate if address is present in the system or not.

siteAddresses[].​lotListArray of objects(LotSectionPlan)
siteAddresses[].​lgastring[ 1 .. 30 ] charactersrequired

Local Government Area under which the application falls.

Example: "PENRITH"
siteAddresses[].​isPrimarybooleanrequired

This is to track the primary address for the application.

listOfBuildingStructuresArray of objects(buildingStructureList)
structureDescriptionstringnon-emptyrequired

This is to track the detailed description of the structures the Building Information Certificate would apply to.

reasonForApplyingstringnon-emptyrequired

This is to track the reason why Building Information Certificate is applied. One of the below values must be selected. 1. Property sale/purchase 2. Review unauthorised work 3. Other

Example: "Refer to description for values."
doWorkHaveArray of objects(BICWorkList)

This is to track the consent or certificate information for the works proposed. Visible if reasonForApplying is Review unauthorised work.

worksErectedOrAlteredinMonthstring

This is to track the month the works erected or altered. Visible if reasonForApplying is Review unauthorised work or Other.

Example: "March"
worksErectedOrAlteredinYearnumber

This is to track the year the works erected or altered. Visible if reasonForApplying is Review unauthorised work or Other. No future dates are accepted. It's a mandatory field

Example: 2021
isWorksErectAlterDateUnknownboolean

This is to indicate the month and year the works erected or altered is not known. Visible if reasonForApplying is Review unauthorised work or Other.

reasonforOtherstring

This is to track the detailed description of other reason mentioned for appliying certificate. Visible and required if applicant selects reasonForApplying as Other.

contractorDetailsobject(contractorDetails)

Applicable when reasonForApplying is Review unauthorised work or Other

payerInformationobject
isResendboolean

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

documentsArray of objects(DownloadableDocument)
declarationsArray of strings(Declaration)required
updatedByobject(UpdatedBy)
curl -i -X POST \
  'https://dpie-apim-uat.redocly.app/CreateBIC/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "Submitted",
    "isPrimaryApplicant": "Refer to description for values.",
    "primaryApplicant": {
      "applyOnBehalfOfCompany": true,
      "contactDetails": {
        "title": "Refer to description for values.",
        "person": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "user@example.com",
          "address": "string"
        }
      },
      "isManualEntry": true,
      "applicantCompany": {
        "companyName": "string",
        "ABN": "string",
        "ACN": "string",
        "tradingName": "string"
      }
    },
    "additionalApplicants": [
      {
        "applyOnBehalfOfCompany": true,
        "contactDetails": {
          "title": "Refer to description for values.",
          "person": {
            "firstName": "string",
            "otherName": "string",
            "familyName": "string",
            "contactNumber": "stringst",
            "email": "user@example.com",
            "address": "string"
          }
        },
        "isManualEntry": true,
        "applicantCompany": {
          "companyName": "string",
          "ABN": "string",
          "ACN": "string",
          "tradingName": "string"
        }
      }
    ],
    "securityConditions": true,
    "detailsOfSecurityConditions": "string",
    "siteAccessPersonDetails": {
      "title": "Refer to description for values.",
      "firstName": "string",
      "otherName": "string",
      "familyName": "string",
      "contactNumber": "stringst",
      "email": "user@example.com"
    },
    "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",
          "primarySecondary": "string",
          "state": "string",
          "postCode": 0
        },
        "addressNotDisplayed": true,
        "lotList": [
          {
            "lotsectionplan": "1/-/SPXXXXX"
          }
        ],
        "lga": "PENRITH",
        "isPrimary": true
      }
    ],
    "listOfBuildingStructures": [
      {
        "strctureType": "Refer to description for values."
      }
    ],
    "structureDescription": "string",
    "reasonForApplying": "Refer to description for values.",
    "doWorkHave": [
      {
        "WorksHave": "Refer to description for values.",
        "applicationNumber": "string"
      }
    ],
    "worksErectedOrAlteredinMonth": "March",
    "worksErectedOrAlteredinYear": 2021,
    "isWorksErectAlterDateUnknown": true,
    "reasonforOther": "string",
    "contractorDetails": {
      "constructionPersonDetails": {
        "title": "Refer to description for values.",
        "firstName": "string",
        "otherName": "string",
        "familyName": "string",
        "contactNumber": "stringst",
        "email": "user@example.com",
        "addressPostal": "string",
        "licenceOrPermitNumber": "string"
      },
      "isLicenseorPermitNumberUnknown": true,
      "valueOfBuildWorksWithoutConsent": 0,
      "floorArea": 0,
      "isAttachedToAuthorisedBuilding": true
    },
    "payerInformation": {
      "payerType": "Refer to description for values.",
      "payerPerson": {
        "firstName": "string",
        "otherName": "string",
        "familyName": "string",
        "contactNumber": "stringst",
        "email": "user@example.com",
        "billingAddress": "string"
      },
      "isManualEntry": true,
      "payerCompany": {
        "companyName": "string",
        "ABN": "string",
        "ACN": "string",
        "tradingName": "string",
        "billingAddress": "string",
        "email": "user@example.com"
      }
    },
    "isResend": true,
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "updatedBy": "string"
      }
    ],
    "declarations": [
      "string"
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Created

Body
Response
No content

UpdateBIC

Request

This operation transfers the application updates from the Building Information certificate Service to the council's IT system.

Path
CaseIDstringrequired

A fully qualified Planning BIC case

Headers
OrganisationIDstringrequired

Used by the API gateway to identify the agency to which the response needs to be routed to.

Bodyapplication/jsonrequired

Information request object

caseStatusstring[ 1 .. 80 ] charactersrequired

Status of the BIC case

Example: "Submitted"
isPrimaryApplicantstring

This is to track primary applicant type for the application. One of the below mentioned values must be selected for the field. 1. The landowner 2. A representative of the landowner 3. The purchaser of a property under a contract of sale 4. A public authority that has notified the owner that you are applying for a Building Information Certificate

Example: "Refer to description for values."
primaryApplicantobject(applicantList)

used to hold owner’s Corporation details.

additionalApplicantsArray of objects(applicantList)
securityConditionsbooleanrequired

This is to track if there are any security or site conditions that may impact on the person undertaking the inspection.

detailsOfSecurityConditionsstring<= 512 characters

This is to track the detailed description of the security or site conditions that impact the person undertaking the inspection. Visible if SecurityConditions is true.

siteAccessPersonDetailsobject(SiteAccessPerson)

This is to track the details of the person that will provide access to the site, if different to the primary applicant.

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

Address of the proposed development.

Example: "19-33 Elizabeth Street, Narrandera, 2700"
siteAddresses[].​addressDetailobject(AddressDetail)
siteAddresses[].​addressNotDisplayedboolean

This is to indicate if address is present in the system or not.

siteAddresses[].​lotListArray of objects(LotSectionPlan)
siteAddresses[].​lgastring[ 1 .. 30 ] charactersrequired

Local Government Area under which the application falls.

Example: "PENRITH"
siteAddresses[].​isPrimarybooleanrequired

This is to track the primary address for the application.

listOfBuildingStructuresArray of objects(buildingStructureList)
structureDescriptionstringnon-emptyrequired

This is to track the detailed description of the structures the Building Information Certificate would apply to.

reasonForApplyingstringnon-emptyrequired

This is to track the reason why Building Information Certificate is applied. One of the below values must be selected. 1. Property sale/purchase 2. Review unauthorised work 3. Other

Example: "Refer to description for values."
doWorkHaveArray of objects(BICWorkList)

This is to track the consent or certificate information for the works proposed. Visible if reasonForApplying is Review unauthorised work.

worksErectedOrAlteredinMonthstring

This is to track the month the works erected or altered. Visible if reasonForApplying is Review unauthorised work or Other.

Example: "March"
worksErectedOrAlteredinYearnumber

This is to track the year the works erected or altered. Visible if reasonForApplying is Review unauthorised work or Other.

Example: 2021
isWorksErectAlterDateUnknownboolean

This is to indicate the month and year the works erected or altered is not known. Visible if reasonForApplying is Review unauthorised work or Other.

reasonforOtherstring

This is to track the detailed description of other reason mentioned for appliying certificate. Visible and required if applicant selects reasonForApplying as Other.

contractorDetailsobject(contractorDetails)

Applicable when reasonForApplying is Review unauthorised work or Other

payerInformationobject
deltaDocumentsArray of objects(DownloadableDocument)
documentsArray of objects(DownloadableDocument)
declarationsArray of strings(Declaration)required
updatedByobject(UpdatedBy)
curl -i -X PUT \
  'https://dpie-apim-uat.redocly.app/UpdateBIC/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "Submitted",
    "isPrimaryApplicant": "Refer to description for values.",
    "primaryApplicant": {
      "applyOnBehalfOfCompany": true,
      "contactDetails": {
        "title": "Refer to description for values.",
        "person": {
          "firstName": "string",
          "otherName": "string",
          "familyName": "string",
          "contactNumber": "stringst",
          "email": "user@example.com",
          "address": "string"
        }
      },
      "isManualEntry": true,
      "applicantCompany": {
        "companyName": "string",
        "ABN": "string",
        "ACN": "string",
        "tradingName": "string"
      }
    },
    "additionalApplicants": [
      {
        "applyOnBehalfOfCompany": true,
        "contactDetails": {
          "title": "Refer to description for values.",
          "person": {
            "firstName": "string",
            "otherName": "string",
            "familyName": "string",
            "contactNumber": "stringst",
            "email": "user@example.com",
            "address": "string"
          }
        },
        "isManualEntry": true,
        "applicantCompany": {
          "companyName": "string",
          "ABN": "string",
          "ACN": "string",
          "tradingName": "string"
        }
      }
    ],
    "securityConditions": true,
    "detailsOfSecurityConditions": "string",
    "siteAccessPersonDetails": {
      "title": "Refer to description for values.",
      "firstName": "string",
      "otherName": "string",
      "familyName": "string",
      "contactNumber": "stringst",
      "email": "user@example.com"
    },
    "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",
          "primarySecondary": "string",
          "state": "string",
          "postCode": 0
        },
        "addressNotDisplayed": true,
        "lotList": [
          {
            "lotsectionplan": "1/-/SPXXXXX"
          }
        ],
        "lga": "PENRITH",
        "isPrimary": true
      }
    ],
    "listOfBuildingStructures": [
      {
        "strctureType": "Refer to description for values."
      }
    ],
    "structureDescription": "string",
    "reasonForApplying": "Refer to description for values.",
    "doWorkHave": [
      {
        "WorksHave": "Refer to description for values.",
        "applicationNumber": "string"
      }
    ],
    "worksErectedOrAlteredinMonth": "March",
    "worksErectedOrAlteredinYear": 2021,
    "isWorksErectAlterDateUnknown": true,
    "reasonforOther": "string",
    "contractorDetails": {
      "constructionPersonDetails": {
        "title": "Refer to description for values.",
        "firstName": "string",
        "otherName": "string",
        "familyName": "string",
        "contactNumber": "stringst",
        "email": "user@example.com",
        "addressPostal": "string",
        "licenceOrPermitNumber": "string"
      },
      "isLicenseorPermitNumberUnknown": true,
      "valueOfBuildWorksWithoutConsent": 0,
      "floorArea": 0,
      "isAttachedToAuthorisedBuilding": true
    },
    "payerInformation": {
      "payerType": "Refer to description for values.",
      "payerPerson": {
        "firstName": "string",
        "otherName": "string",
        "familyName": "string",
        "contactNumber": "stringst",
        "email": "user@example.com",
        "billingAddress": "string"
      },
      "isManualEntry": true,
      "payerCompany": {
        "companyName": "string",
        "ABN": "string",
        "ACN": "string",
        "tradingName": "string",
        "billingAddress": "string",
        "email": "user@example.com"
      }
    },
    "deltaDocuments": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "updatedBy": "string"
      }
    ],
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "updatedBy": "string"
      }
    ],
    "declarations": [
      "string"
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Created

Body
Response
No content

ResponseToDeferredDetermination

Request

This operation transfers defer determination information provided by the applicant from the Building Information certificate Service to the relevant organisation's IT system.

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

Used by the API gateway to identify the agency to which the response needs to be 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

This field is to track the case status of the defer determination request.

WorkDescriptionstring

This is to track the comments provided by council as part of defer determination request.

isWorksCompletedbooleanrequired

This is to track works completed or not.

worksNotCompletedReasonstring<= 1000 characters

This is to track the reason why Works are not completed. Applicable and mandatory when isWorksCompleted is false

childCaseIDstring

This child case ID is to track the defer determination request.

Example: "DEF-XXXX"
responseDatestring(date)

This is to track the date on which defer determination is provided.

documentsArray of objects(DownloadableDocument)
updatedByobject(UpdatedBy)
curl -i -X PUT \
  'https://dpie-apim-uat.redocly.app/ResponseToDeferredDetermination/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyId: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "string",
    "WorkDescription": "string",
    "isWorksCompleted": true,
    "worksNotCompletedReason": "string",
    "childCaseID": "DEF-XXXX",
    "responseDate": "2019-08-24",
    "documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string",
        "documentSize": 0,
        "updatedBy": "string"
      }
    ],
    "updatedBy": {
      "person": {
        "firstName": "John",
        "familyName": "Smith",
        "email": "john.smith@gmail.com",
        "contactNumber": "stringst"
      }
    }
  }'

Responses

Case ID (AI) created

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