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
Authentication
Path Parameters
Headers
Body
Approve or Unapprove Lodgement Applications
This endpoint is used by conveyancing law firms to approve a lodgement case so the workspace can be prepared.
Path Parameters
Workspace id
Headers
The unique identifier for the request
Body
application/json
Body
Action to perform on lodgement applications
Allowed values: [APPROVE, UNAPPROVE]
Match pattern:^(APPROVE|UNAPPROVE)$
Example:APPROVE
Email address of the user who performed the approval action
Example:approver@lawfirm.com
Response
application/json
Response
ACCEPTED
Lodgement case id for which the applications will be approved or unapproved
Authentication
Path Parameters
Headers
Body
CreateTitleRequest
objectTitle number format: optional 0-3 letters + 1-6 digits
Example:ABC123456
AcknowledgementResponse
objectExample:Request taken up for processing
SubmitSigningRequest
objectIdentifiers 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