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

CR - ePlanning to Certifier API (v1)

Certificate Register PC API.

Download OpenAPI description
CR - ePlanning to Certifier API v1.0.json
CR - ePlanning to Certifier API v1.0.yaml
Languages
Servers

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

Decline

Request

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

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

Private Certifier organisation ID

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

body

caseStatusstring

Status of the request for additional information

Example: "Complete"
declineDatestring(date)

Date of Decline

declineReasonsArray of objects(DeclineReasonList)required
declineReasons[].​declineReasonstringnon-emptyrequired

It infers the decline reason. One of the below mentioned values must be selected for declineReason 1. InComplete 2. Poor Quality 3. In-sufficient Documentation submitted 4. Payment Not Received 5. Other

Example: "Refer to description for values"
declineReasons[].​declineReasonDescriptionstring<= 512 characters

required only if 'OTHER' is selected for declineReason

curl -i -X PUT \
  'https://dpie-apim-prod.redocly.app/Decline/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyId: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "Complete",
    "declineDate": "2019-08-24",
    "declineReasons": [
      {
        "declineReason": "Refer to description for values",
        "declineReasonDescription": "string"
      }
    ]
  }'

Responses

Case Declined

Body

ReqAddInfo

Request

This operation transfers the council's request for the certifier to provide additional information from the Online Certificate Registration Service to the certifier's IT system.

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

Private Certifier organisation ID

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"

Body*/*required

body

caseStatusstring<= 100 characters

Status of the request for additional information

Example: "Complete"
childCaseIDstring

An AI case id for RFI

requestDatestring(date)

Date and time of response

requestDetailsstring[ 1 .. 512 ] charactersrequired

Short description of request

DocumentsArray of objects(DownloadableDocument)
curl -i -X PUT \
  'https://dpie-apim-prod.redocly.app/ReqAddInfo/{CaseID}' \
  -H 'Content-Type: */*' \
  -H 'IdempotencyId: string' \
  -H 'OrganisationID: string' \
  -d '[object Object]'

Responses

Request created

Body
Response
No content

Register

Request

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

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

Private Certifier organisation ID

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

body

caseStatusstring

Status of the request for additional information

Example: "Complete"
ReferenceNumberstringnon-emptyrequired

Council system Reference Number

Commentsstring

comments or more information

RegistrationDatestring(date)non-emptyrequired

Council system Registration Number

Declarationstringnon-emptyrequired

gives consent that certificate details are correct, payment has been received, relevant checks are done and the certificate has been registered in Council's certificate registration system.

DocumentsArray of objects(DownloadableDocument)
curl -i -X PUT \
  'https://dpie-apim-prod.redocly.app/Register/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyId: string' \
  -H 'OrganisationID: string' \
  -d '{
    "caseStatus": "Complete",
    "ReferenceNumber": "string",
    "Comments": "string",
    "RegistrationDate": "2019-08-24",
    "Declaration": "string",
    "Documents": [
      {
        "documentName": "string",
        "documentType": "string",
        "uploadedDateTime": "2019-08-24T14:15:22Z",
        "documentURL": "http://example.com",
        "documentSize": 0,
        "updatedBy": "Council"
      }
    ]
  }'

Responses

Certificate registered sucessfully

Body

PaymentAck

Request

This operation transfers the payment acknowledgement against the Certificate Registration application from the the Online Certificate Registration Service to the certifier's IT system.

Path
CaseIDstringrequired

A fully qualified application number or case id

Headers
OrganisationIDstringrequired

Private Certifier organisation ID

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

body

transactionReferencestringnon-emptyrequired

Transaction Reference Number

payerNamestringnon-emptyrequired

Payer Name

lGANamestringnon-emptyrequired

LGA Name

amountnumberrequired

Amount of payment done

paymentTransDatestring(date)non-emptyrequired

Date of Payment

paymentReferencestringnon-emptyrequired

Payment case id

Example: "P-XXX"
curl -i -X PUT \
  'https://dpie-apim-prod.redocly.app/PaymentAck/{CaseID}' \
  -H 'Content-Type: application/json' \
  -H 'IdempotencyId: string' \
  -H 'OrganisationID: string' \
  -d '{
    "transactionReference": "string",
    "payerName": "string",
    "lGAName": "string",
    "amount": 0,
    "paymentTransDate": "2019-08-24",
    "paymentReference": "P-XXX"
  }'

Responses

Payment Acknowledged Successfully

Body
© 2025 Your Company. All Rights Reserved.