PackageResponse {
PackageReference (
string,
optional),
PackageName (
string,
optional),
PackageStatus (
string,
optional),
Documents (
Array[DocumentResponse],
optional)
}
DocumentResponse {
Name (
string):
File Name,
FormDirectReference (
string,
optional):
Form reference,
Signers (
Array[SignerStatusResponse]):
List of signers,
Status (
string,
optional) =
['Complete' or 'Declined' or 'Expired' or 'Rejected' or 'Signed' or 'Filling' or 'Filling Form' or 'InProgress' or 'Signing' or 'NotStart' or '# of # Signed']:
Document signing status,
DueDate (
Date,
optional):
Due Date of document,
GMT (
string,
optional):
GMT Offset,
LastSignedDate (
Date,
optional):
Date of latest signature,
Folder (
Date,
optional) =
['InBox' or 'Progress' or 'Signed']:
The folder of the document,
Logs (
Array[DocumentLog],
optional):
Document logs,
HasFileUploaded (
boolean):
Whether invitee uploaded any files during signing process.,
PackageReference (
string,
optional):
Package reference,
ClientReference (
string,
optional):
client side referese; e.g. external id etc.,
EditUrl (
string,
optional),
IDVerificationRequested (
boolean):
ID Verification requested.,
Reference (
string):
Document reference, used for document access
}
SignerStatusResponse {
HasSigned (
boolean):
User signing status,
DeclinedReason (
string,
optional):
Declined reason. Return only when invitee declined to sign.,
VideoConfirmationDetail (
VideoConfirmationDetail,
optional),
IDCheckStatus (
string,
optional),
IDVerificationStatus (
string,
optional),
IDVerificationResult (
string,
optional),
IDVerificationFaceMatchResult (
string,
optional),
IDVerificationLivenessResult (
string,
optional),
SigningKey (
string,
optional):
Url for access to signing; Only when this is an embedded signer,
SignerReference (
string,
optional):
Signer reference,
IsFaceToFaceSigning (
boolean),
VideoConfirmationEnabled (
boolean),
ReviewBeforeSigningEnabled (
boolean),
MobileNumber (
string,
optional):
Mobile number of signer, for SMS secured forms. Must include the mobile carrier code e.g. Australia 04, New Zealand 027 or 021 etc,
MobileCountry (
string,
optional):
Mobile Country code for phone number e.g. Australia 61, New Zealand 64 etc,
ShareUsers (
Array[ShareUser],
optional),
ClientReference (
string,
optional),
FirstName (
string):
First name of user,
MiddleName (
string,
optional):
Middle name of user,
LastName (
string):
Last name of user,
Email (
string):
Email address of user
}
VideoConfirmationDetail {
Name (
string,
optional),
ShortUrl (
string,
optional),
IsVideoReady (
boolean),
Password (
string,
optional),
Email (
string,
optional),
IsWitness (
boolean),
IsVideoDisabled (
boolean),
IsVideoOptOut (
boolean),
WitnessOwner (
string,
optional)
}
ShareUser {
IsDefault (
boolean),
IsOwner (
boolean),
FirstName (
string):
First name of user,
MiddleName (
string,
optional):
Middle name of user,
LastName (
string):
Last name of user,
Email (
string):
Email address of user
}
DocumentLog {
Name (
string,
optional):
Name of user responsible for action,
Action (
string,
optional):
Log entry,
Date (
date,
optional):
Date of log entry,
GMT (
string,
optional):
GMT Offset,
Role (
string,
optional):
Role of user responsible for action
}
{
"PackageReference": "",
"PackageName": "",
"PackageStatus": "",
"Documents": [
{
"Name": "",
"FormDirectReference": "",
"Signers": [
{
"HasSigned": false,
"DeclinedReason": "",
"VideoConfirmationDetail": {
"Name": "",
"ShortUrl": "",
"IsVideoReady": false,
"Password": "",
"Email": "",
"IsWitness": false,
"IsVideoDisabled": false,
"IsVideoOptOut": false,
"WitnessOwner": ""
},
"IDCheckStatus": "",
"IDVerificationStatus": "",
"IDVerificationResult": "",
"IDVerificationFaceMatchResult": "",
"IDVerificationLivenessResult": "",
"SigningKey": "",
"SignerReference": "",
"IsFaceToFaceSigning": false,
"VideoConfirmationEnabled": false,
"ReviewBeforeSigningEnabled": false,
"MobileNumber": "",
"MobileCountry": "",
"ShareUsers": [
{
"IsDefault": false,
"IsOwner": false,
"FirstName": "",
"MiddleName": "",
"LastName": "",
"Email": ""
}
],
"ClientReference": "",
"FirstName": "",
"MiddleName": "",
"LastName": "",
"Email": ""
}
],
"Status": "",
"DueDate": "Date",
"GMT": "",
"LastSignedDate": "Date",
"Folder": "Date",
"Logs": [
{
"Name": "",
"Action": "",
"Date": "date",
"GMT": "",
"Role": ""
}
],
"HasFileUploaded": false,
"PackageReference": "",
"ClientReference": "",
"EditUrl": "",
"IDVerificationRequested": false,
"Reference": ""
}
]
}