SubmitSigningResponse

object
signingInstructionIdstring(uuid)required

Unique identifier for the created signing instruction

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

statusstringrequired

Current status of the signing instruction

Example:CREATED

Example

CancelSigningRequest

object
applicationIdsarray[string](uuid)required

Identifiers of the application(s) to cancel from signing.

>= 1 items<= 1 items

Example:0450bfa9-6810-4276-9d06-b26836d94a9c

cancellationReasonstring

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

cancellationNotesForOtherstring

Mandatory when cancellationReason “OTHER” is provided

>= 1 characters<= 200 characters

Example:Signer no longer available

Example

LodgementApprovalsRequest

object
actionstringrequired

Action to perform on lodgement applications
Allowed values: [APPROVE, UNAPPROVE]

Match pattern:^(APPROVE|UNAPPROVE)$

Example:APPROVE

approvedBystringrequired

Email address of the user who performed the approval action

Example:approver@lawfirm.com

Example

LodgementApprovalsResponse

lodgementCaseIdstring(uuid)required

Lodgement case id for which the applications will be approved or unapproved

Example

IndividualDetailsDto

forenamesstring

Example:Ann

surnamestring

Example:Smith

Example