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

BIC - Council to ePlanning API (v1)

Authentication

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

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

https://api-uat.apps1.nsw.gov.au/planning/onlineBIC/v1/

AcceptReturn

Request

This operation transfers the Council decision to accept or return the Building information Certificate case from the Council IT system to the Online Building information Certificate Service.

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 request is originated from.

Bodyapplication/jsonrequired

Information request object

reviewOutcomestringrequired

This is to track the outcome of council's update on completeness check, Accept application for assessment or return application. 1. Accept application for assessment 2. Return application

Example: "Refer to description for values."
councilCommentsstring<= 100 characters

Comments for Building Information Certificate. Applicable when reviewOutcome is Accept application for assessment

councilUniqueIDNumberstring<= 128 characters

Required Council unique identification number. Applicable when reviewOutcome is Accept application for assessment

isFeePaidboolean

Required Property captures if applicant had paid the fee or not. Applicable when reviewOutcome is Accept application for assessment

totalFeePaidnumber(decimal)

Total fee paid by applicant. Applicable when reviewOutcome is Accept application for assessment

Example: 1250.9
lodgementDatestring

Required to Enter the date the application was lodged into the council system. Applicable when reviewOutcome is Accept application for assessment. Future date is not allowed to be entered.

DocumentsArray of objects(downloadableDocument)
returnReasonstring<= 512 characters

Required to enter Reason for council to return the applicaion. Applicable when reviewOutcome is Return application

updatedByEmailstring<= 250 charactersrequired

User must be registered in the planning portal

Example: "john.smith@gmail.com"
curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/onlineBIC/v1/AcceptReturn/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'OrganisationID: string' \
  -d '{
    "reviewOutcome": "Refer to description for values.",
    "councilComments": "string",
    "councilUniqueIDNumber": "string",
    "isFeePaid": true,
    "totalFeePaid": 1250.9,
    "lodgementDate": "string",
    "Documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string"
      }
    ],
    "returnReason": "string",
    "updatedByEmail": "john.smith@gmail.com"
  }'

Responses

Case Accepted Successfully.

Body
Response
No content

Assessment

Request

This operation transfers the Council assessment information on the Building information Certificate case from the Council IT system to the Building information Certificate Service.

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 request is originated from.

Bodyapplication/jsonrequired

Information request object

siteInspectedDatestring(date)

This indicates the date on which the site inspection was completed. This field does not accept the future dates.

Example: "2020-12-30"
updatedByEmailstring<= 250 charactersrequired

User must be registered in the planning portal

Example: "john.smith@gmail.com"
curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/onlineBIC/v1/Assessment/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'OrganisationID: string' \
  -d '{
    "siteInspectedDate": "2020-12-30",
    "updatedByEmail": "john.smith@gmail.com"
  }'

Responses

Assessment Created sucessfully

Body
Response
No content

InitiateInspection

Request

This operation transfers the council's initial inspection information on the Building Information Certificate case from the council's IT system to the Online Building Information Certificate Service.

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 request is originated from.

Bodyapplication/jsonrequired

Information request object

inspectionTypeArray of strings(inspectionType)required

type of inspection, Required for all types of certificates.

Example: ["Refer to description for values."]
inspectionDescriptionstring<= 512 characters

description of inspection, required for for Building Information Certificate.

updatedByEmailstring<= 250 charactersrequired

User must be registered in the planning portal

Example: "john.smith@gmail.com"
curl -i -X POST \
  'https://api-uat.apps1.nsw.gov.au/planning/onlineBIC/v1/InitiateInspection/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'organisationID: string' \
  -d '{
    "inspectionType": [
      "Refer to description for values."
    ],
    "inspectionDescription": "string",
    "updatedByEmail": "john.smith@gmail.com"
  }'

Responses

CaseID--XXX created Sucessfully.

Body
Response
No content

PerformInspection

Request

This operation transfers the council's perform inspection information on the Building Information Certificate case from the council's IT system. This operation represents the Certficiate Decision action from UI.

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 request is originated from.

Bodyapplication/jsonrequired

Information request object

childCaseIDstringrequired

Inspection case Id linked to the Building Information Certificate case.

inspectionTypeArray of strings(inspectionType)

type of inspection

Example: ["Refer to description for values."]
inspectionCompletedDatestring(date)required

Date of the Inspection was completed.

inspectionResultstringrequired

InspectionResult as part of perform inspection. 1. Works are satisfactory 2. Work has minor defects but is satisfactory 3. Works are not satisfactory

Example: "Refer to description for values."
peformInspectionCommentsstring<= 512 characters

To hold the User entered comments.Optional Field for all certificate types.

DocumentsArray of objects(downloadableDocument)required
Documents[].​documentNamestring<= 150 charactersrequired

document name has to be appended with file extension

Example: "test.docx"
Documents[].​documentTypestring<= 100 charactersrequired
Documents[].​uploadedDateTimestring(date-time)required
Documents[].​documentURLstring(url)<= 500 charactersrequired

URL of the document to be downloaded

updatedByEmailstring<= 250 charactersrequired

User must be registered in the planning portal

Example: "john.smith@gmail.com"
curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/onlineBIC/v1/PerformInspection/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'OrganisationID: string' \
  -d '{
    "childCaseID": "string",
    "inspectionType": [
      "Refer to description for values."
    ],
    "inspectionCompletedDate": "2019-08-24",
    "inspectionResult": "Refer to description for values.",
    "peformInspectionComments": "string",
    "Documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string"
      }
    ],
    "updatedByEmail": "john.smith@gmail.com"
  }'

Responses

Case Performed

Body
Response
No content

CompleteInspection

Request

This operation transfers the council's inspection completion information on the Building Information Certificate case from the council's IT system to the Online Building Information Certificate Service.

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 request is originated from.

Bodyapplication/jsonrequired

Information request object

childCaseIDstringrequired

Inspection case Id linked to the Building Information Certificate case.

issueInspectionResultSheetbooleanrequired

To capture if the inspection sheet can be issued.

isFurtherInspectionRequiredbooleanrequired

Is the further inspection required

declarationsArray of strings(declarationsForInpection)required

This is to track the declarations for inspection result. Required for Building Information Certificate, declaration for inspection result.

Example: ["Refer to description for values."]
DocumentsArray of objects(downloadableDocument)

Mandatory when issueInspectionResultSheet is true

updatedByEmailstring<= 250 charactersrequired

User must be registered in the planning portal

Example: "john.smith@gmail.com"
curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/onlineBIC/v1/CompleteInspection/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'OrganisationID: string' \
  -d '{
    "childCaseID": "string",
    "issueInspectionResultSheet": true,
    "isFurtherInspectionRequired": true,
    "declarations": [
      "Refer to description for values."
    ],
    "Documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string"
      }
    ],
    "updatedByEmail": "john.smith@gmail.com"
  }'

Responses

Case Completed

Body
Response
No content

Determination

Request

This operation transfers the council's Determination decision to Issue or Refuse the Building Information certificate case from the council's IT system to the Online Building Information certificate Service.

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

The council LGA name to indicate where the request is originated from.

Bodyapplication/jsonrequired

Information request object

applicationDecisionstringrequired

To check whether the certificate is approved or refused. This is a mandatory field. 1. Issued 2. Refused

Example: "Refer to description for values."
determinationDatestring(date)required

This indicates the building Information Certificate application's Determination Date. It is applicable for both Approved and refused actions. Only future date to be provided as a value for this field. This is a mandatory attribute.

Example: "2021-09-21"
DocumentsArray of objects(downloadableDocument)required
Documents[].​documentNamestring<= 150 charactersrequired

document name has to be appended with file extension

Example: "test.docx"
Documents[].​documentTypestring<= 100 charactersrequired
Documents[].​uploadedDateTimestring(date-time)required
Documents[].​documentURLstring(url)<= 500 charactersrequired

URL of the document to be downloaded

updatedByEmailstring<= 250 charactersrequired

User must be registered in the planning portal

Example: "john.smith@gmail.com"
curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/onlineBIC/v1/Determination/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'OrganisationID: string' \
  -d '{
    "applicationDecision": "Refer to description for values.",
    "determinationDate": "2021-09-21",
    "Documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string"
      }
    ],
    "updatedByEmail": "john.smith@gmail.com"
  }'

Responses

Case Determined Sucessfully

Body
Response
No content

DeferDetermination

Request

This operation transfers the council's Defer Determination information on the Building Information Certificate case from the council's IT system to the Online Building Information Certificate Service.

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

The council LGA name to indicate where the request is originated from.

Bodyapplication/jsonrequired

Information request object

workDescriptionstring<= 1000 charactersrequired

Details of the work description which will be provide to applicant.

dueDatestring(date)

Due date for required works

Example: "2021-09-21"
DocumentsArray of objects(downloadableDocument)
updatedByEmailstring<= 250 charactersrequired

User must be registered in the planning portal

Example: "john.smith@gmail.com"
curl -i -X POST \
  'https://api-uat.apps1.nsw.gov.au/planning/onlineBIC/v1/DeferDetermination/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'OrganisationID: string' \
  -d '{
    "workDescription": "string",
    "dueDate": "2021-09-21",
    "Documents": [
      {
        "documentName": "test.docx",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "string"
      }
    ],
    "updatedByEmail": "john.smith@gmail.com"
  }'

Responses

CaseID--XXX created Sucessfully.

Body
Response
No content

CloseDeferDetermination

Request

This operation transfers the council's Close Defer Determination information on the Building Information Certificate case from the council's IT system to the Online Building Information Certificate Service.

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

The council LGA name to indicate where the request is originated from.

Bodyapplication/jsonrequired

Information request object

childCaseIDstringrequired
Example: "DEF-XXXX"
updatedByEmailstring<= 250 charactersrequired

User must be registered in the planning portal

Example: "john.smith@gmail.com"
curl -i -X PUT \
  'https://api-uat.apps1.nsw.gov.au/planning/onlineBIC/v1/CloseDeferDetermination/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'OrganisationID: string' \
  -d '{
    "childCaseID": "DEF-XXXX",
    "updatedByEmail": "john.smith@gmail.com"
  }'

Responses

CaseID--XXX created Sucessfully.

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