Submit Lodgement Case to HMLR
This API is used to manually submit a lodgement case to HMLR for processing. This triggers the submission workflow for the specified lodgement case.
Path Parameters
Lodgement case id
Headers
The unique identifier for the request
Response
Response
NO CONTENT - Lodgement case submitted successfully
Authentication
Path Parameters
Headers
Download Title Document - JSON
This API is used to download document content in JSON format from an existing workspace
Query Parameters
Supported document types in title
Allowed values:TITLE_REGISTERTITLE_INFORMATION_DOCUMENTEARLY_COMPLETION_TITLE_INFORMATION_DOCUMENT
Path Parameters
Lodgement case id
Title id
Headers
The unique identifier for the request
Response
application/json
Response
OK
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Headers
Add Title To Workspace
Add title to workspace to be retrieved from HMLR using Title number
Path Parameters
Workspace id
Headers
The unique identifier for the request
Body
application/json
Body
Title number format: optional 0-3 letters + 1-6 digits
Example:ABC123456
Response
application/json
Response
ACCEPTED
Example:Request taken up for processing
Authentication
Path Parameters
Headers
Body
Submit Signing Request
This API is used to initiate the QES signing process for a lodgement application.
Path Parameters
Lodgement case id
Headers
The unique identifier for the request
Body
application/json
Body
Identifiers of the application document(s) to submit for signing. Exactly one application id is currently supported.
>= 1 items<= 1 items
Example:["0450bfa9-6810-4276-9d06-b26836d94a9c"]
Response
application/json
Response
CREATED - Signing request submitted successfully
Unique identifier for the created signing instruction
Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890
Current status of the signing instruction
Example:CREATED
Authentication
Path Parameters
Headers
Body
Cancel Signing Request
This API is used to cancel the signing request for a lodgement application.
Path Parameters
Lodgement case id
Headers
The unique identifier for the request
Body
application/json
Body
Identifiers of the application(s) to cancel from signing.
>= 1 items<= 1 items
Example:["0450bfa9-6810-4276-9d06-b26836d94a9c"]
Reason for cancelling the signing request.
Allowed values:
[INCORRECT_EMAIL_ADDRESS, IDENTITY_VERIFICATION_FAILED, CORRECTION_TO_BE_MADE_TO_THE_DOCUMENT, SIGNER_DOES_NOT_WANT_TO_PROCEED_WITH_QES, OTHER]
Match pattern:^(INCORRECT_EMAIL_ADDRESS|IDENTITY_VERIFICATION_FAILED|CORRECTION_TO_BE_MADE_TO_THE_DOCUMENT|SIGNER_DOES_NOT_WANT_TO_PROCEED_WITH_QES|OTHER)$
Example:INCORRECT_EMAIL_ADDRESS
Mandatory when cancellationReason “OTHER” is provided
>= 1 characters<= 200 characters
Example:Signer no longer available
Response
Response
NO CONTENT - Signing request cancelled successfully