eSignLive API documentation API Reference

API endpoints and schema definitions

API Endpoint
https://localhost:8080/aws/rest/services
Schemes: http, https
Version: 16.24.7

packages{packageId}documentsvisibility

Retrieve document visibility information for a package

GET /packages/{packageId}/documents/visibility
packageId: string
in path

(no description)

successful operation

401 Unauthorized

Not authorized

Response Content-Types: application/json
Response Example (200 OK)
{
  "configurations": [
    {
      "roleUids": [
        "string"
      ],
      "documentUid": "string",
      "id": "string",
      "data": "object",
      "name": "string"
    }
  ],
  "id": "string",
  "data": "object",
  "name": "string"
}

accountcustomfields

Find account custom fields with paging criteria

GET /account/customfields
dir: string
in query

(no description)

from: integer (int32)
in query

(no description)

to: integer (int32)
in query

(no description)

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "string",
    "data": "object",
    "translations": [
      {
        "id": "string",
        "data": "object",
        "description": "string",
        "language": "string",
        "name": "string"
      }
    ],
    "required": "boolean",
    "value": "string",
    "name": "string"
  }
]

Find an account custom field by Id

GET /account/customfields/{customFieldId}

Custom field id must be alphanumeric

customFieldId: string
in path

The id of the custom field to be retrieved.

200 OK

successful operation

400 Bad Request

Invalid field Id

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "string",
  "data": "object",
  "translations": [
    {
      "id": "string",
      "data": "object",
      "description": "string",
      "language": "string",
      "name": "string"
    }
  ],
  "required": "boolean",
  "value": "string",
  "name": "string"
}

usercustomfields

Find user custom fields

GET /user/customfields

This route returns a List of UserCustomFields, not a simple CustomField.

successful operation

401 Unauthorized

Not authorized

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "string",
    "data": "object",
    "translations": [
      {
        "id": "string",
        "data": "object",
        "description": "string",
        "language": "string",
        "name": "string"
      }
    ],
    "value": "string",
    "name": "string"
  }
]

Find a user custom field by Id

GET /user/customfields/{customFieldId}

Custom field id must be alphanumeric

customFieldId: string
in path

The id of the user custom field to be retrieved.

successful operation

401 Unauthorized

Not authorized

403 Forbidden

Invalid custom Id

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "string",
  "data": "object",
  "translations": [
    {
      "id": "string",
      "data": "object",
      "description": "string",
      "language": "string",
      "name": "string"
    }
  ],
  "value": "string",
  "name": "string"
}

nativeBridge

Retrieve an account feature for a package sender.

GET /nativeBridge/{packageId}/enabled
packageId: string
in path

(no description)

200 OK

successful operation

type
boolean
Response Content-Types: application/json
Response Example (200 OK)
"boolean"

Retrieve an package sender's native bridge configuration.

GET /nativeBridge/{packageId}/configuration
packageId: string
in path

(no description)

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "url": "string",
  "version": "string"
}

packages{packageId}designer

Retrieve designer settings profile for a package.

GET /packages/{packageId}/designer/{profileName}
packageId: string
in path

(no description)

profileName: string
in path

(no description)

successful operation

403 Forbidden

error.forbidden.cannotViewDeletePkg

Response Content-Types: application/json
Response Example (200 OK)
{
  "saveLayout": "boolean",
  "applyLayout": "boolean",
  "addSigner": "boolean",
  "settings": "boolean",
  "send": "boolean",
  "rolePickerSender": "boolean",
  "rolePickerAddSigner": "boolean",
  "addBarcode": "boolean",
  "documentTitle": "boolean",
  "documentDescription": "boolean",
  "banner": "string",
  "info": "boolean",
  "addDocument": "boolean",
  "editDocument": "boolean",
  "deleteDocument": "boolean",
  "fieldSettings": "object",
  "header": "boolean",
  "documentCollectionDefaultViewType": "string"
}

Retrieve default designer settings for a package.

GET /packages/{packageId}/designer
packageId: string
in path

(no description)

successful operation

403 Forbidden

error.forbidden.cannotViewDeletePkg

Response Content-Types: application/json
Response Example (200 OK)
{
  "saveLayout": "boolean",
  "applyLayout": "boolean",
  "addSigner": "boolean",
  "settings": "boolean",
  "send": "boolean",
  "rolePickerSender": "boolean",
  "rolePickerAddSigner": "boolean",
  "addBarcode": "boolean",
  "documentTitle": "boolean",
  "documentDescription": "boolean",
  "banner": "string",
  "info": "boolean",
  "addDocument": "boolean",
  "editDocument": "boolean",
  "deleteDocument": "boolean",
  "fieldSettings": "object",
  "header": "boolean",
  "documentCollectionDefaultViewType": "string"
}

account

Retrieve details about an account.

GET /account
200 OK

successful operation

403 Forbidden

Forbidden from viewing account details: current session is limited to signing a specific package.

Response Content-Types: application/json
Response Example (200 OK)
{
  "updated": "string (date-time)",
  "timezoneId": "string",
  "company": {
    "id": "string",
    "data": "object",
    "address": {
      "address1": "string",
      "address2": "string",
      "city": "string",
      "country": "string",
      "zipcode": "string",
      "state": "string"
    },
    "name": "string"
  },
  "created": "string (date-time)",
  "customFields": [
    {
      "id": "string",
      "data": "object",
      "translations": [
        {
          "id": "string",
          "data": "object",
          "description": "string",
          "language": "string",
          "name": "string"
        }
      ],
      "required": "boolean",
      "value": "string",
      "name": "string"
    }
  ],
  "logoAltTextKey": "string",
  "logoUrl": "string",
  "id": "string",
  "licenses": [
    {
      "created": "string (date-time)",
      "paidUntil": "string (date-time)",
      "transactions": [
        {
          "created": "string (date-time)",
          "creditCard": {
            "cvv": "string",
            "number": "string",
            "type": "string",
            "expiration": {
              "month": "integer (int32)",
              "year": "integer (int32)"
            },
            "name": "string"
          },
          "price": {
            "amount": "integer (int32)",
            "currency": {
              "id": "string",
              "data": "object",
              "name": "string"
            }
          }
        }
      ],
      "plan": {
        "group": "string",
        "id": "string",
        "freeCycles": {
          "count": "integer (int32)",
          "cycle": "string"
        },
        "quotas": [
          {
            "scope": "string",
            "cycle": "string",
            "limit": "integer (int32)",
            "target": "string"
          }
        ],
        "cycle": "string",
        "contract": "string",
        "data": "object",
        "price": {
          "amount": "integer (int32)",
          "currency": {
            "id": "string",
            "data": "object",
            "name": "string"
          }
        },
        "original": "string",
        "features": "object",
        "description": "string",
        "name": "string"
      },
      "status": "string"
    }
  ],
  "data": "object",
  "providers": {
    "documents": [
      null
    ]
  }
}

Retrieve information about a sender.

GET /account/senders/{senderId}

Anyone can view their own sender details. Only account managers can view other details of other senders in their account.

senderId: string
in path

(no description)

rawSignatureCapture: boolean false
in query

(no description)

200 OK

successful operation

400 Bad Request

Attempting to view a sender from a different account.

403 Forbidden

Forbidden from viewing another sender's details (not an account manager).

Response Content-Types: application/json
Response Example (200 OK)
{
  "signature": {
    "textual": {
      "font": "string",
      "color": "string"
    },
    "handdrawn": "string"
  },
  "account": {
    "updated": "string (date-time)",
    "timezoneId": "string",
    "company": {
      "id": "string",
      "data": "object",
      "address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "country": "string",
        "zipcode": "string",
        "state": "string"
      },
      "name": "string"
    },
    "created": "string (date-time)",
    "customFields": [
      {
        "id": "string",
        "data": "object",
        "translations": [
          {
            "id": "string",
            "data": "object",
            "description": "string",
            "language": "string",
            "name": "string"
          }
        ],
        "required": "boolean",
        "value": "string",
        "name": "string"
      }
    ],
    "logoAltTextKey": "string",
    "logoUrl": "string",
    "id": "string",
    "licenses": [
      {
        "created": "string (date-time)",
        "paidUntil": "string (date-time)",
        "transactions": [
          {
            "created": "string (date-time)",
            "creditCard": {
              "cvv": "string",
              "number": "string",
              "type": "string",
              "expiration": {
                "month": "integer (int32)",
                "year": "integer (int32)"
              },
              "name": "string"
            },
            "price": {
              "amount": "integer (int32)",
              "currency": {
                "id": "string",
                "data": "object",
                "name": "string"
              }
            }
          }
        ],
        "plan": {
          "group": "string",
          "id": "string",
          "freeCycles": {
            "count": "integer (int32)",
            "cycle": "string"
          },
          "quotas": [
            {
              "scope": "string",
              "cycle": "string",
              "limit": "integer (int32)",
              "target": "string"
            }
          ],
          "cycle": "string",
          "contract": "string",
          "data": "object",
          "price": {
            "amount": "integer (int32)",
            "currency": {
              "id": "string",
              "data": "object",
              "name": "string"
            }
          },
          "original": "string"
        }
      }
    ]
  }
}

GET /account/designerSettings

profile: string
in query

profile

default

successful operation

Response Content-Types: application/json

GET /account/defaultConsentDocument

Accept: string
in header

(no description)

language: string
in query

Language

default

successful operation

Response Content-Types: application/octet-stream

GET /account/defaultConsentProperties

language: string
in query

Language

default

successful operation

Response Content-Types: application/json

Retrieve a list of the users in an account.

GET /account/senders
search: string
in query

Filter for the user first name, last name and email

from: integer (int32)
in query

The first record requested in the results (useful for paging)

to: integer (int32)
in query

The last record requested in the results (useful for paging)

dir: string asc, desc
in query

The direction of the sorting of the results

200 OK

successful operation

type
403 Forbidden

Forbidden from viewing other senders' details (not an account manager).

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "signature": {
      "textual": {
        "font": "string",
        "color": "string"
      },
      "handdrawn": "string"
    },
    "account": {
      "updated": "string (date-time)",
      "timezoneId": "string",
      "company": {
        "id": "string",
        "data": "object",
        "address": {
          "address1": "string",
          "address2": "string",
          "city": "string",
          "country": "string",
          "zipcode": "string",
          "state": "string"
        },
        "name": "string"
      },
      "created": "string (date-time)",
      "customFields": [
        {
          "id": "string",
          "data": "object",
          "translations": [
            {
              "id": "string",
              "data": "object",
              "description": "string",
              "language": "string",
              "name": "string"
            }
          ],
          "required": "boolean",
          "value": "string",
          "name": "string"
        }
      ],
      "logoAltTextKey": "string",
      "logoUrl": "string",
      "id": "string",
      "licenses": [
        {
          "created": "string (date-time)",
          "paidUntil": "string (date-time)",
          "transactions": [
            {
              "created": "string (date-time)",
              "creditCard": {
                "cvv": "string",
                "number": "string",
                "type": "string",
                "expiration": {
                  "month": "integer (int32)",
                  "year": "integer (int32)"
                },
                "name": "string"
              },
              "price": {
                "amount": "integer (int32)",
                "currency": {
                  "id": "string",
                  "data": "object",
                  "name": "string"
                }
              }
            }
          ],
          "plan": {
            "group": "string",
            "id": "string",
            "freeCycles": {
              "count": "integer (int32)",
              "cycle": "string"
            },
            "quotas": [
              {
                "scope": "string",
                "cycle": "string",
                "limit": "integer (int32)",
                "target": "string"
              }
            ],
            "cycle": "string",
            "contract": "string",
            "data": "object",
            "price": {
              "amount": "integer (int32)",
              "currency": {
                "id": "string",
                "data": "object",
                "name": "string"
              }
            }
          }
        }
      ]
    }
  }
]

GET /account/senders/{senderId}/apiKey

senderId: string
in path

(no description)

default

successful operation

Response Content-Types: application/json

GET /account/packageSettings

default

successful operation

Response Content-Types: application/json

packages{packageId}documents{documentId}approvals

Retrieve an existing field related to an existing approval.

GET /packages/{packageId}/documents/{documentId}/approvals/{approvalId}/fields/{fieldId}
Accept: string
in header

(no description)

packageId: string
in path

The id of the package that contains the field

documentId: string
in path

The id of the document that contains the field

approvalId: string
in path

The id of the approval that contains the field

fieldId: string
in path

The id of field that is requested

200 OK

successful operation

404 Not Found

Not Found. The field itself, or the package, document and approval containing the field could not be found

412 Precondition Failed

error.forbidden.cannotViewDeletePkg. The user that requested the field did not have access to that information.

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "binding": "string",
  "top": "number (double)",
  "id": "string",
  "subtype": "string",
  "data": "object",
  "extract": "boolean",
  "width": "number (double)",
  "height": "number (double)",
  "left": "number (double)",
  "extractAnchor": {
    "width": "integer (int32)",
    "height": "integer (int32)",
    "anchorPoint": "string",
    "characterIndex": "integer (int32)",
    "leftOffset": "integer (int32)",
    "topOffset": "integer (int32)",
    "index": "integer (int32)",
    "text": "string"
  },
  "validation": {
    "errorCode": "integer (int32)",
    "maxLength": "integer (int32)",
    "minLength": "integer (int32)",
    "errorMessage": "string",
    "enum": [
      "string"
    ],
    "required": "boolean",
    "pattern": "string"
  },
  "type": "string",
  "value": "string",
  "name": "string"
}

Retrieve an existing approval.

GET /packages/{packageId}/documents/{documentId}/approvals/{approvalId}
packageId: string
in path

The id of the package that contains the approval

documentId: string
in path

The id of the document that contains the approval

approvalId: string
in path

The id of the approval retrieved

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "string",
  "role": "string",
  "data": "object",
  "accepted": "string (date-time)",
  "enforceCaptureSignature": "boolean",
  "signed": "string (date-time)",
  "optional": "boolean",
  "fields": [
    {
      "page": "integer (int32)",
      "binding": "string",
      "top": "number (double)",
      "id": "string",
      "subtype": "string",
      "data": "object",
      "extract": "boolean",
      "width": "number (double)",
      "height": "number (double)",
      "left": "number (double)",
      "extractAnchor": {
        "width": "integer (int32)",
        "height": "integer (int32)",
        "anchorPoint": "string",
        "characterIndex": "integer (int32)",
        "leftOffset": "integer (int32)",
        "topOffset": "integer (int32)",
        "index": "integer (int32)",
        "text": "string"
      },
      "validation": {
        "errorCode": "integer (int32)",
        "maxLength": "integer (int32)",
        "minLength": "integer (int32)",
        "errorMessage": "string",
        "enum": [
          "string"
        ],
        "required": "boolean",
        "pattern": "string"
      },
      "type": "string",
      "value": "string",
      "name": "string"
    }
  ],
  "name": "string"
}

packages{packageId}documents

Retrieve a single document

GET /packages/{packageId}/documents/{documentId}
Accept: string
in header

(no description)

packageId: string
in path

(no description)

documentId: string
in path

(no description)

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "status": "string",
  "external": {
    "id": "string",
    "providerName": "string",
    "provider": "string",
    "data": "object"
  },
  "id": "string",
  "signedHash": "string",
  "data": "object",
  "signerVerificationToken": "string",
  "approvals": [
    {
      "id": "string",
      "role": "string",
      "data": "object",
      "accepted": "string (date-time)",
      "enforceCaptureSignature": "boolean",
      "signed": "string (date-time)",
      "optional": "boolean",
      "fields": [
        {
          "page": "integer (int32)",
          "binding": "string",
          "top": "number (double)",
          "id": "string",
          "subtype": "string",
          "data": "object",
          "extract": "boolean",
          "width": "number (double)",
          "height": "number (double)",
          "left": "number (double)",
          "extractAnchor": {
            "width": "integer (int32)",
            "height": "integer (int32)",
            "anchorPoint": "string",
            "characterIndex": "integer (int32)",
            "leftOffset": "integer (int32)",
            "topOffset": "integer (int32)",
            "index": "integer (int32)",
            "text": "string"
          },
          "validation": {
            "errorCode": "integer (int32)",
            "maxLength": "integer (int32)",
            "minLength": "integer (int32)",
            "errorMessage": "string",
            "enum": [
              "string"
            ],
            "required": "boolean",
            "pattern": "string"
          },
          "type": "string",
          "value": "string",
          "name": "string"
        }
      ],
      "name": "string"
    }
  ],
  "extract": "boolean",
  "extractionTypes": [
    "string"
  ],
  "tagged": "boolean",
  "pages": [
    {
      "top": "number (double)",
      "id": "string",
      "width": "number (double)",
      "height": "number (double)",
      "left": "number (double)",
      "version": "integer (int32)",
      "index": "integer (int32)"
    }
  ],
  "fields": [
    {
      "page": "integer (int32)",
      "binding": "string",
      "top": "number (double)",
      "id": "string",
      "subtype": "string",
      "data": "object",
      "extract": "boolean",
      "width": "number (double)",
      "height": "number (double)",
      "left": "number (double)",
      "extractAnchor": {
        "width": "integer (int32)",
        "height": "integer (int32)",
        "anchorPoint": "string",
        "characterIndex": "integer (int32)",
        "leftOffset": "integer (int32)",
        "topOffset": "integer (int32)",
        "index": "integer (int32)",
        "text": "string"
      },
      "validation": {
        "errorCode": "integer (int32)"
      }
    }
  ]
}

GET /packages/{packageId}/documents/{documentId}/original

Accept: string
in header

(no description)

packageId: string
in path

(no description)

documentId: string
in path

(no description)

utf8: string
in query

(no description)

default

successful operation

Response Content-Types: application/pdf, application/*, */*

Retrieve a pdf document

GET /packages/{packageId}/documents/{documentId}/pdf
Accept: string
in header

(no description)

packageId: string
in path

(no description)

documentId: string
in path

(no description)

flatten: boolean false
in query

(no description)

utf8: string
in query

(no description)

200 OK

successful operation

Response Content-Types: application/pdf, application/*, */*
Response Example (200 OK)
{
  "status": "string",
  "external": {
    "id": "string",
    "providerName": "string",
    "provider": "string",
    "data": "object"
  },
  "id": "string",
  "signedHash": "string",
  "data": "object",
  "signerVerificationToken": "string",
  "approvals": [
    {
      "id": "string",
      "role": "string",
      "data": "object",
      "accepted": "string (date-time)",
      "enforceCaptureSignature": "boolean",
      "signed": "string (date-time)",
      "optional": "boolean",
      "fields": [
        {
          "page": "integer (int32)",
          "binding": "string",
          "top": "number (double)",
          "id": "string",
          "subtype": "string",
          "data": "object",
          "extract": "boolean",
          "width": "number (double)",
          "height": "number (double)",
          "left": "number (double)",
          "extractAnchor": {
            "width": "integer (int32)",
            "height": "integer (int32)",
            "anchorPoint": "string",
            "characterIndex": "integer (int32)",
            "leftOffset": "integer (int32)",
            "topOffset": "integer (int32)",
            "index": "integer (int32)",
            "text": "string"
          },
          "validation": {
            "errorCode": "integer (int32)",
            "maxLength": "integer (int32)",
            "minLength": "integer (int32)",
            "errorMessage": "string",
            "enum": [
              "string"
            ],
            "required": "boolean",
            "pattern": "string"
          },
          "type": "string",
          "value": "string",
          "name": "string"
        }
      ],
      "name": "string"
    }
  ],
  "extract": "boolean",
  "extractionTypes": [
    "string"
  ],
  "tagged": "boolean",
  "pages": [
    {
      "top": "number (double)",
      "id": "string",
      "width": "number (double)",
      "height": "number (double)",
      "left": "number (double)",
      "version": "integer (int32)",
      "index": "integer (int32)"
    }
  ],
  "fields": [
    {
      "page": "integer (int32)",
      "binding": "string",
      "top": "number (double)",
      "id": "string",
      "subtype": "string",
      "data": "object",
      "extract": "boolean",
      "width": "number (double)",
      "height": "number (double)",
      "left": "number (double)",
      "extractAnchor": {
        "width": "integer (int32)",
        "height": "integer (int32)",
        "anchorPoint": "string",
        "characterIndex": "integer (int32)",
        "leftOffset": "integer (int32)",
        "topOffset": "integer (int32)",
        "index": "integer (int32)",
        "text": "string"
      },
      "validation": {
        "errorCode": "integer (int32)"
      }
    }
  ]
}

Retrieve a zipped document

GET /packages/{packageId}/documents/zip
packageId: string
in path

(no description)

flatten: boolean false
in query

(no description)

default

successful operation

Response Content-Types: application/zip

Returns ADA Html of the requested document.

GET /packages/{packageId}/documents/{documentId}/ada
packageId: string
in path

(no description)

documentId: string
in path

(no description)

language: string en
in query

(no description)

default

successful operation

Response Content-Types: text/html

packages{packageId}documents{documentId}signers

GET /packages/{packageId}/documents/{documentId}/signers/{signerId}/approvals

packageId: string
in path

(no description)

documentId: string
in path

(no description)

signerId: string
in path

(no description)

default

successful operation

Response Content-Types: application/json

fastTrack

GET /fastTrack

token: string
in query

(no description)

default

successful operation

Response Content-Types: application/json

GET /fastTrack/{packageId}/qr

Accept: string
in header

(no description)

packageId: string
in path

(no description)

signing: boolean
in query

(no description)

default

successful operation

Response Content-Types: image/png

GET /fastTrack/{packageId}/url

packageId: string
in path

(no description)

signing: boolean
in query

(no description)

default

successful operation

Response Content-Types: application/json

groups

Retrieve a Group.

GET /groups/{groupId}
groupId: string
in path

Id of Group to be retrieved

200 OK

successful operation

400 Bad Request

Invalid Group Id

401 Unauthorized

Not authorized

404 Not Found

error.notFound.groupNotFound. Means the the requested group could not be found

Response Content-Types: application/json
Response Example (200 OK)
{
  "account": {
    "updated": "string (date-time)",
    "timezoneId": "string",
    "company": {
      "id": "string",
      "data": "object",
      "address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "country": "string",
        "zipcode": "string",
        "state": "string"
      },
      "name": "string"
    },
    "created": "string (date-time)",
    "customFields": [
      {
        "id": "string",
        "data": "object",
        "translations": [
          {
            "id": "string",
            "data": "object",
            "description": "string",
            "language": "string",
            "name": "string"
          }
        ],
        "required": "boolean",
        "value": "string",
        "name": "string"
      }
    ],
    "logoAltTextKey": "string",
    "logoUrl": "string",
    "id": "string",
    "licenses": [
      {
        "created": "string (date-time)",
        "paidUntil": "string (date-time)",
        "transactions": [
          {
            "created": "string (date-time)",
            "creditCard": {
              "cvv": "string",
              "number": "string",
              "type": "string",
              "expiration": {
                "month": "integer (int32)",
                "year": "integer (int32)"
              },
              "name": "string"
            },
            "price": {
              "amount": "integer (int32)",
              "currency": {
                "id": "string",
                "data": "object",
                "name": "string"
              }
            }
          }
        ],
        "plan": {
          "group": "string",
          "id": "string",
          "freeCycles": {
            "count": "integer (int32)",
            "cycle": "string"
          },
          "quotas": [
            {
              "scope": "string",
              "cycle": "string",
              "limit": "integer (int32)",
              "target": "string"
            }
          ],
          "cycle": "string",
          "contract": "string",
          "data": "object",
          "price": {
            "amount": "integer (int32)",
            "currency": {
              "id": "string",
              "data": "object",
              "name": "string"
            }
          },
          "original": "string",
          "features": "object",
          "description": "string",
          "name": "string"
        },
        "status": "string"
      }
    ],
    "data": "object",
    "providers": {}
  }
}

Retrieve a List of all Groups in this account.

GET /groups

Results can be returned in a paginated form if the 'from', 'to' and 'dir' query params are used. The results are returned as a List of Groups, not as a simple Group.

from: integer (int32)
in query

The index of the first result to return

to: integer (int32)
in query

The index of the last result to return

dir: string
in query

The order in which to sort the results, either 'asc' or 'desc', according to Group name.

requestType: string
in query

If the request type is manager, return only the groups that the request user is a manager of.

200 OK

successful operation

401 Unauthorized

Not authorized

Response Content-Types: application/json
Response Example (200 OK)
{
  "account": {
    "updated": "string (date-time)",
    "timezoneId": "string",
    "company": {
      "id": "string",
      "data": "object",
      "address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "country": "string",
        "zipcode": "string",
        "state": "string"
      },
      "name": "string"
    },
    "created": "string (date-time)",
    "customFields": [
      {
        "id": "string",
        "data": "object",
        "translations": [
          {
            "id": "string",
            "data": "object",
            "description": "string",
            "language": "string",
            "name": "string"
          }
        ],
        "required": "boolean",
        "value": "string",
        "name": "string"
      }
    ],
    "logoAltTextKey": "string",
    "logoUrl": "string",
    "id": "string",
    "licenses": [
      {
        "created": "string (date-time)",
        "paidUntil": "string (date-time)",
        "transactions": [
          {
            "created": "string (date-time)",
            "creditCard": {
              "cvv": "string",
              "number": "string",
              "type": "string",
              "expiration": {
                "month": "integer (int32)",
                "year": "integer (int32)"
              },
              "name": "string"
            },
            "price": {
              "amount": "integer (int32)",
              "currency": {
                "id": "string",
                "data": "object",
                "name": "string"
              }
            }
          }
        ],
        "plan": {
          "group": "string",
          "id": "string",
          "freeCycles": {
            "count": "integer (int32)",
            "cycle": "string"
          },
          "quotas": [
            {
              "scope": "string",
              "cycle": "string",
              "limit": "integer (int32)",
              "target": "string"
            }
          ],
          "cycle": "string",
          "contract": "string",
          "data": "object",
          "price": {
            "amount": "integer (int32)",
            "currency": {
              "id": "string",
              "data": "object",
              "name": "string"
            }
          },
          "original": "string",
          "features": "object",
          "description": "string",
          "name": "string"
        },
        "status": "string"
      }
    ],
    "data": "object",
    "providers": {}
  }
}

groupssummary

Retrieve summaries for all groups for the current account.

GET /groups/summary
200 OK

successful operation

401 Unauthorized

Not authorized

Response Content-Types: application/json
Response Example (200 OK)
{
  "email": "string",
  "id": "string",
  "data": "object",
  "name": "string"
}

layouts

Search for a list of the available layouts

GET /layouts
Accept: string
in header

(no description)

type: string TEMPLATE
in query

(no description)

searchtype: string exact, exactname
in query

When empty, a wildcard search will be done in the layout name and description for the search value, otherwise the allowable values will make more restrictive searches

visibility: string ACCOUNT, SENDER ACCOUNT
in query

The visibility used to search for the layout.

from: integer (int32)
in query

The first record that will be returned. Useful for pagination.

to: integer (int32)
in query

The last record that will be returned. Useful for pagination.

sort: string created, updated, name
in query

The field according to which the data will be sorted

dir: string asc, desc
in query

The direction according to which the data will be sorted. 'asc' for ascending and 'des' for descending

200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "updated": "string (date-time)",
  "id": "string",
  "data": "object",
  "autocomplete": "boolean",
  "visibility": "string",
  "sender": {
    "signature": {
      "textual": {
        "font": "string",
        "color": "string"
      },
      "handdrawn": "string"
    },
    "account": {
      "updated": "string (date-time)",
      "timezoneId": "string",
      "company": {
        "id": "string",
        "data": "object",
        "address": {
          "address1": "string",
          "address2": "string",
          "city": "string",
          "country": "string",
          "zipcode": "string",
          "state": "string"
        },
        "name": "string"
      },
      "created": "string (date-time)",
      "customFields": [
        {
          "id": "string",
          "data": "object",
          "translations": [
            {
              "id": "string",
              "data": "object",
              "description": "string",
              "language": "string",
              "name": "string"
            }
          ],
          "required": "boolean",
          "value": "string",
          "name": "string"
        }
      ],
      "logoAltTextKey": "string",
      "logoUrl": "string",
      "id": "string",
      "licenses": [
        {
          "created": "string (date-time)",
          "paidUntil": "string (date-time)",
          "transactions": [
            {
              "created": "string (date-time)",
              "creditCard": {
                "cvv": "string",
                "number": "string",
                "type": "string",
                "expiration": {
                  "month": "integer (int32)",
                  "year": "integer (int32)"
                },
                "name": "string"
              },
              "price": {
                "amount": "integer (int32)",
                "currency": {
                  "id": "string",
                  "data": "object",
                  "name": "string"
                }
              }
            }
          ],
          "plan": {
            "group": "string",
            "id": "string",
            "freeCycles": {
              "count": "integer (int32)",
              "cycle": "string"
            },
            "quotas": [
              {
                "scope": "string",
                "cycle": "string",
                "limit": "integer (int32)",
                "target": "string"
              }
            ],
            "cycle": "string",
            "contract": "string",
            "data": "object",
            "price": {}
          }
        }
      ]
    }
  }
}

user{userId}journal

Retrieve all of the user's notary e-journal entries.

GET /user/{userId}/journal
userId: string
in path

The ID of the user whose e-journal entries are being retrieved.

from: integer (int32)
in query

The first record that will be returned. Useful for pagination.

to: integer (int32)
in query

The last record that will be returned. Useful for pagination.

startDate: string
in query

The date after which entries must have been created in order to be retrieved.

endDate: string
in query

The date before which entries must have been created in order to be retrieved.

dir: string asc, desc
in query

The direction according to which the data will be sorted. 'asc' for ascending and 'desc' for descending

successful operation

401 Unauthorized

Not authorized

Response Content-Types: application/json
Response Example (200 OK)
{
  "sequenceNumber": "integer (int32)",
  "creationDate": "string (date-time)",
  "documentType": "string",
  "documentName": "string",
  "signerName": "string",
  "signatureType": "string",
  "idType": "string",
  "idValue": "string",
  "jurisdiction": "string",
  "comment": "string"
}

Download all of the user's notary e-journal entries.

GET /user/{userId}/journal/download
userId: string
in path

The ID of the user whose e-journal entries are being retrieved.

from: integer (int32)
in query

The first record that will be returned. Useful for pagination.

to: integer (int32)
in query

The last record that will be returned. Useful for pagination.

startDate: string
in query

The date after which entries must have been created in order to be retrieved.

endDate: string
in query

The date before which entries must have been created in order to be retrieved.

dir: string asc, desc
in query

The direction according to which the data will be sorted. 'asc' for ascending and 'des' for descending

successful operation

401 Unauthorized

Not authorized

Response Content-Types: text/csv
Response Example (200 OK)
{
  "sequenceNumber": "integer (int32)",
  "creationDate": "string (date-time)",
  "documentType": "string",
  "documentName": "string",
  "signerName": "string",
  "signatureType": "string",
  "idType": "string",
  "idValue": "string",
  "jurisdiction": "string",
  "comment": "string"
}

packages{packageId}reminders

Retrieve reminder schedule of a package.

GET /packages/{packageId}/reminders
packageId: string
in path

(no description)

successful operation

400 Bad Request

Could not find a package

401 Unauthorized

Not authorized

Response Content-Types: application/json
Response Example (200 OK)
{
  "packageId": "string",
  "startInDaysDelay": "integer (int32)",
  "repetitionsCount": "integer (int32)",
  "intervalInDays": "integer (int32)",
  "reminders": [
    {
      "sentDate": "string (date-time)",
      "date": "string (date-time)"
    }
  ]
}

packages

Retrieve counts of packages by status

GET /packages/overview
startDate: string
in query

The date after which the package needs to have been last updated to be included in overview.

endDate: string
in query

The date before which the package needs to have been last updated to be included in overview.

filter: string Any combination of: inbox, draft, archived, trashed all
in query

(no description)

401 Unauthorized

Not authorized.

Response Content-Types: application/json

Retrieve a single package information.

GET /packages/{packageId}
Accept: string
in header

(no description)

packageId: string
in path

(no description)

rawSignatureCapture: boolean false
in query

(no description)

200 OK

successful operation

401 Unauthorized

Not authorized

404 Not Found

Not Found. The package Uid passed was not found or you cannot see this package.

Response Content-Types: application/json
Response Example (200 OK)
{
  "updated": "string (date-time)",
  "timezoneId": "string",
  "id": "string",
  "trashed": "boolean",
  "notaryRoleId": "string",
  "data": "object",
  "autocomplete": "boolean",
  "visibility": "string",
  "sender": {
    "signature": {
      "textual": {
        "font": "string",
        "color": "string"
      },
      "handdrawn": "string"
    },
    "account": {
      "updated": "string (date-time)",
      "timezoneId": "string",
      "company": {
        "id": "string",
        "data": "object",
        "address": {
          "address1": "string",
          "address2": "string",
          "city": "string",
          "country": "string",
          "zipcode": "string",
          "state": "string"
        },
        "name": "string"
      },
      "created": "string (date-time)",
      "customFields": [
        {
          "id": "string",
          "data": "object",
          "translations": [
            {
              "id": "string",
              "data": "object",
              "description": "string",
              "language": "string",
              "name": "string"
            }
          ],
          "required": "boolean",
          "value": "string",
          "name": "string"
        }
      ],
      "logoAltTextKey": "string",
      "logoUrl": "string",
      "id": "string",
      "licenses": [
        {
          "created": "string (date-time)",
          "paidUntil": "string (date-time)",
          "transactions": [
            {
              "created": "string (date-time)",
              "creditCard": {
                "cvv": "string",
                "number": "string",
                "type": "string",
                "expiration": {
                  "month": "integer (int32)",
                  "year": "integer (int32)"
                },
                "name": "string"
              },
              "price": {
                "amount": "integer (int32)",
                "currency": {
                  "id": "string",
                  "data": "object",
                  "name": "string"
                }
              }
            }
          ],
          "plan": {
            "group": "string",
            "id": "string",
            "freeCycles": {
              "count": "integer (int32)",
              "cycle": "string"
            },
            "quotas": [
              {
                "scope": "string",
                "cycle": "string",
                "limit": "integer (int32)",
                "target": "string"
              }
            ],
            "cycle": "string",
            "contract": "string"
          }
        }
      ]
    }
  }
}

Retrieve the signing status of a package

GET /packages/{packageId}/signingStatus
packageId: string
in path

(no description)

signer: string
in query

(no description)

document: string
in query

(no description)

200 OK

successful operation

type
string
401 Unauthorized

Not authorized

Response Content-Types: application/json
Response Example (200 OK)
"string"

Validate if the package is ready for prepare or send steps

GET /packages/{packageId}/readiness
packageId: string
in path

(no description)

stageName: string
in query

(no description)

checkSenderVisibility: boolean false
in query

(no description)

200 OK

successful operation

type
string
401 Unauthorized

Not authorized

Response Content-Types: application/json
Response Example (200 OK)
"string"

Retrieve a list of packages with their information.

GET /packages

Passing the different query parameters will provide different searches

Accept: string
in header

(no description)

query: string drafts, inbox, trashed
in query

(no description)

type: string TEMPLATE
in query

(no description)

search: string
in query

Any text which is going to be used in conjunction with the searchtype if provided

searchtype: string exact, exactname
in query

When empty, a wildcard search will be done in the package name and description for the search value, otherwise the allowable values will make more restrictive searches

predefined: string all, awaitingSignature, sent, completed, expiringSoon
in query

(no description)

visibility: string ACCOUNT, SENDER
in query

The visibility used to search for the template. ONLY used for templates

lastUpdatedStartDate: string
in query

The date after which packages need to have been last updated in order to be retrieved.

lastUpdatedEndDate: string
in query

The date before which packages need to have been last updated in order to be retrieved.

from: integer (int32)
in query

The first record that will be returned. Useful for pagination.

to: integer (int32)
in query

The last record that will be returned. Useful for pagination.

sort: string APPROVAL_SIGNING_DATE, attributeValue, created, completed, updated, due, name, status
in query

The field according to which the data will be sorted

dir: string asc, desc
in query

The direction according to which the data will be sorted. 'asc' for ascending and 'des' for descending

401 Unauthorized

Not authorized.

Response Content-Types: application/json

reports

Delegation report for a sender.

GET /reports/delegation
from: string
in query

The date from which to produce the report.

to: string
in query

The date up to which to produce the report.

senderId: string
in query

The sender about which to produce the report.

default

successful operation

Response Content-Types: application/json

Usage report for a sender in CSV.

GET /reports/usage
from: string
in query

The date from which to produce the report.

to: string
in query

The date up to which to produce the report.

default

successful operation

Response Content-Types: text/csv

Completion report for a sender in CSV.

GET /reports/completion
from: string
in query

The date from which to produce the report.

to: string
in query

The date up to which to produce the report.

senderId: string
in query

The sender for which to produce the report.

status: string draft, sent, completed, archived, declined, opted_out, expired
in query

(no description)

summary: boolean false
in query

Get summarized report: omit signers and document information.

default

successful operation

Response Content-Types: text/csv

packages{packageId}roles

Retrieve all roles for the package.

GET /packages/{packageId}/roles
packageId: string
in path

(no description)

200 OK

successful operation

type
412 Precondition Failed

error.forbidden.cannotViewDeletePkg

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "specialTypes": [
      "string"
    ],
    "locked": "boolean",
    "id": "string",
    "data": "object",
    "emailMessage": {
      "content": "string"
    },
    "reassign": "boolean",
    "attachmentRequirements": [
      {
        "id": "string",
        "status": "string",
        "description": "string",
        "required": "boolean",
        "comment": "string",
        "name": "string",
        "data": "object"
      }
    ],
    "type": "string",
    "index": "integer (int32)",
    "signers": [
      {
        "signature": {
          "textual": {
            "font": "string",
            "color": "string"
          },
          "handdrawn": "string"
        },
        "auth": {
          "challenges": [
            {
              "answer": "string",
              "question": "string",
              "maskInput": "boolean"
            }
          ],
          "scheme": "string"
        },
        "knowledgeBasedAuthentication": {
          "knowledgeBasedAuthenticationStatus": "string",
          "signerInformationForEquifaxCanada": {
            "firstName": "string",
            "lastName": "string",
            "city": "string",
            "dateOfBirth": "string (date-time)",
            "streetAddress": "string",
            "timeAtAddress": "integer (int32)",
            "province": "string",
            "postalCode": "string",
            "socialInsuranceNumber": "string",
            "homePhoneNumber": "string",
            "driversLicenseNumber": "string"
          },
          "signerInformationForEquifaxUSA": {
            "firstName": "string",
            "lastName": "string",
            "zip": "string",
            "city": "string",
            "dateOfBirth": "string (date-time)",
            "streetAddress": "string",
            "timeAtAddress": "integer (int32)",
            "socialSecurityNumber": "string",
            "homePhoneNumber": "string",
            "driversLicenseNumber": "string",
            "state": "string",
            "valid": "boolean"
          },
          "equifaxCanada": "boolean",
          "equifaxUSA": "boolean"
        },
        "delivery": {
          "email": "boolean",
          "provider": "boolean",
          "download": "boolean"
        },
        "signerType": "string",
        "group": {
          "account": {
            "updated": "string (date-time)",
            "timezoneId": "string",
            "company": {
              "id": "string",
              "data": "object",
              "address": {
                "address1": "string",
                "address2": "string",
                "city": "string",
                "country": "string",
                "zipcode": "string",
                "state": "string"
              },
              "name": "string"
            }
          }
        }
      }
    ]
  }
]

Retrieve a single role.

GET /packages/{packageId}/roles/{roleId}
packageId: string
in path

(no description)

roleId: string
in path

(no description)

200 OK

successful operation

412 Precondition Failed

error.forbidden.cannotViewDeletePkg

Response Content-Types: application/json
Response Example (200 OK)
{
  "specialTypes": [
    "string"
  ],
  "locked": "boolean",
  "id": "string",
  "data": "object",
  "emailMessage": {
    "content": "string"
  },
  "reassign": "boolean",
  "attachmentRequirements": [
    {
      "id": "string",
      "status": "string",
      "description": "string",
      "required": "boolean",
      "comment": "string",
      "name": "string",
      "data": "object"
    }
  ],
  "type": "string",
  "index": "integer (int32)",
  "signers": [
    {
      "signature": {
        "textual": {
          "font": "string",
          "color": "string"
        },
        "handdrawn": "string"
      },
      "auth": {
        "challenges": [
          {
            "answer": "string",
            "question": "string",
            "maskInput": "boolean"
          }
        ],
        "scheme": "string"
      },
      "knowledgeBasedAuthentication": {
        "knowledgeBasedAuthenticationStatus": "string",
        "signerInformationForEquifaxCanada": {
          "firstName": "string",
          "lastName": "string",
          "city": "string",
          "dateOfBirth": "string (date-time)",
          "streetAddress": "string",
          "timeAtAddress": "integer (int32)",
          "province": "string",
          "postalCode": "string",
          "socialInsuranceNumber": "string",
          "homePhoneNumber": "string",
          "driversLicenseNumber": "string"
        },
        "signerInformationForEquifaxUSA": {
          "firstName": "string",
          "lastName": "string",
          "zip": "string",
          "city": "string",
          "dateOfBirth": "string (date-time)",
          "streetAddress": "string",
          "timeAtAddress": "integer (int32)",
          "socialSecurityNumber": "string",
          "homePhoneNumber": "string",
          "driversLicenseNumber": "string",
          "state": "string",
          "valid": "boolean"
        },
        "equifaxCanada": "boolean",
        "equifaxUSA": "boolean"
      },
      "delivery": {
        "email": "boolean",
        "provider": "boolean",
        "download": "boolean"
      },
      "signerType": "string",
      "group": {
        "account": {
          "updated": "string (date-time)",
          "timezoneId": "string",
          "company": {
            "id": "string",
            "data": "object",
            "address": {
              "address1": "string",
              "address2": "string",
              "city": "string",
              "country": "string",
              "zipcode": "string",
              "state": "string"
            },
            "name": "string"
          },
          "created": "string (date-time)"
        }
      }
    }
  ]
}

packages{packageId}signers{signerId}

GET /packages/{packageId}/signers/{signerId}/approvals

packageId: string
in path

(no description)

signerId: string
in path

(no description)

default

successful operation

Response Content-Types: application/json

packages{packageId}signers{signerId}context

Retrieve the context (features and configurations) of the requested signer

GET /packages/{packageId}/signers/{signerId}/context

me is the only supported signerId at this point. Me means the current user

packageId: string
in path

(no description)

signerId: string
in path

(no description)

successful operation

400 Bad Request

error.notFound.signerNotFound

403 Forbidden

error.forbidden.cannotPkgExpired

412 Precondition Failed

error.forbidden.cannotViewPkg

Response Content-Types: application/json
Response Example (200 OK)
{
  "attachmentRequirements": "boolean",
  "changeSigner": "boolean",
  "groupSigning": "boolean",
  "notarized": "boolean",
  "optOut": "boolean",
  "handOverUrl": "boolean",
  "certificateSigning": "boolean",
  "externalVerification": "boolean",
  "inPerson": "boolean",
  "decline": "boolean",
  "ada": "boolean",
  "clickToSign": "boolean",
  "clickToInitial": "boolean",
  "captureSignature": "boolean",
  "mobileCaptureSignature": "boolean",
  "sendToMobile": "boolean",
  "signingDate": "boolean",
  "signerName": "boolean",
  "signerTitle": "boolean",
  "signerCompany": "boolean",
  "text": "boolean",
  "textArea": "boolean",
  "checkbox": "boolean",
  "customField": "boolean",
  "notaryField": "boolean",
  "radio": "boolean",
  "list": "boolean",
  "date": "boolean"
}

packages{packageId}roles{roleId}verification

Retrieve a verification object for the recipient

GET /packages/{packageId}/roles/{roleId}/verification
packageId: string
in path

(no description)

roleId: string
in path

(no description)

200 OK

successful operation

400 Bad Request

error.notFound.signerNotFound

403 Forbidden

error.forbidden.cannotPkgExpired

412 Precondition Failed

error.forbidden.cannotViewPkg

Response Content-Types: application/json
Response Example (200 OK)
{
  "payload": "string",
  "typeId": "string"
}

packages{packageId}signers{signerId}verification

Retrieve a verification object for the signerId

GET /packages/{packageId}/signers/{signerId}/verification

me is the only supported signerId at this point. Me means the current user

packageId: string
in path

(no description)

signerId: string
in path

(no description)

200 OK

successful operation

400 Bad Request

error.notFound.signerNotFound

403 Forbidden

error.forbidden.cannotPkgExpired

412 Precondition Failed

error.forbidden.cannotViewPkg

Response Content-Types: application/json
Response Example (200 OK)
{
  "payload": "string",
  "typeId": "string"
}

Retrieve a verification type for the signer verification

GET /packages/{packageId}/signers/{signerId}/verification/verificationType

me is the only supported signerId at this point. Me means the current user

packageId: string
in path

(no description)

signerId: string
in path

(no description)

200 OK

successful operation

400 Bad Request

error.notFound.signerNotFound

403 Forbidden

error.forbidden.cannotPkgExpired

404 Not Found

error.notFound.signerVerificationTypeNotFound

412 Precondition Failed

error.forbidden.cannotViewPkg

Response Content-Types: application/json
Response Example (200 OK)
{
  "payload": "string",
  "typeId": "string"
}

account{accountId}verificationTypes

Retrieve a verification type object for the account

GET /account/{accountId}/verificationTypes
200 OK

successful operation

Response Content-Types: application/json
Response Example (200 OK)
{
  "payload": "string",
  "typeId": "string"
}

packages{packageId}roles{roleId}signingUrl

Retrieve an the url that a signer can use to sign a package.

GET /packages/{packageId}/roles/{roleId}/signingUrl
packageId: string
in path

(no description)

roleId: string
in path

(no description)

412 Precondition Failed

error.forbidden.cannotViewDeletePkg

Response Content-Types: application/json

Schema Definitions

SenderAuthenticationToken: object

packageId: string

PackageId

value: string

Value

Example
{
  "packageId": "string",
  "value": "string"
}

AuthenticationToken: object

value: string

Value

Example
{
  "value": "string"
}

SessionFields: object

Example
"object"

SignerAuthenticationToken: object

sessionFields: SessionFields

SessionFields

packageId: string

PackageId

signerId: string

SignerId

value: string

Value

Example
{
  "sessionFields": "object",
  "packageId": "string",
  "signerId": "string",
  "value": "string"
}

DocumentVisibility: object

configurations: DocumentVisibilityConfiguration

Configurations

DocumentVisibilityConfiguration
id: string

Id

data: object

Data

name: string

Name

Example
{
  "configurations": [
    {
      "roleUids": [
        "string"
      ],
      "documentUid": "string",
      "id": "string",
      "data": "object",
      "name": "string"
    }
  ],
  "id": "string",
  "data": "object",
  "name": "string"
}

DocumentVisibilityConfiguration: object

roleUids: string[]

RoleUids

string
documentUid: string

DocumentUid

id: string

Id

data: object

Data

name: string

Name

Example
{
  "roleUids": [
    "string"
  ],
  "documentUid": "string",
  "id": "string",
  "data": "object",
  "name": "string"
}

CustomField: object

id: string

Id

data: object

Data

translations: Translation

Translations

Translation
required: boolean

Required

value: string

Value

name: string

Name

Example
{
  "id": "string",
  "data": "object",
  "translations": [
    {
      "id": "string",
      "data": "object",
      "description": "string",
      "language": "string",
      "name": "string"
    }
  ],
  "required": "boolean",
  "value": "string",
  "name": "string"
}

Translation: object

id: string

Id

data: object

Data

description: string

Description

language: string

Language

name: string

Name

Example
{
  "id": "string",
  "data": "object",
  "description": "string",
  "language": "string",
  "name": "string"
}

UserCustomField: object

id: string

Id

data: object

Data

translations: Translation

Translations

Translation
value: string

Value

name: string

Name

Example
{
  "id": "string",
  "data": "object",
  "translations": [
    {
      "id": "string",
      "data": "object",
      "description": "string",
      "language": "string",
      "name": "string"
    }
  ],
  "value": "string",
  "name": "string"
}

NativeBridgeConfiguration: object

url: string

Url

version: string

Version

Example
{
  "url": "string",
  "version": "string"
}

DesignerSettings: object

saveLayout: boolean

Save Layout

applyLayout: boolean

Apply Layout

addSigner: boolean

Add Signer

settings: boolean

Settings

send: boolean

Send

rolePickerSender: boolean

Role Picker Sender

rolePickerAddSigner: boolean

Role Picker Add Signer

addBarcode: boolean

Add Barcode

documentTitle: boolean

Document Title

documentDescription: boolean

Document Description

banner: string

Banner

info: boolean

Info

addDocument: boolean

Add Document

editDocument: boolean

Edit Document

deleteDocument: boolean

Delete Document

fieldSettings: object

FieldSettings

header: boolean

Header

documentCollectionDefaultViewType: string grid, list

Document Collection Default View Type

Example
{
  "saveLayout": "boolean",
  "applyLayout": "boolean",
  "addSigner": "boolean",
  "settings": "boolean",
  "send": "boolean",
  "rolePickerSender": "boolean",
  "rolePickerAddSigner": "boolean",
  "addBarcode": "boolean",
  "documentTitle": "boolean",
  "documentDescription": "boolean",
  "banner": "string",
  "info": "boolean",
  "addDocument": "boolean",
  "editDocument": "boolean",
  "deleteDocument": "boolean",
  "fieldSettings": "object",
  "header": "boolean",
  "documentCollectionDefaultViewType": "string"
}

ExtractAnchor: object

width: integer (int32)

Width

height: integer (int32)

Height

anchorPoint: string

AnchorPoint

characterIndex: integer (int32)

CharacterIndex

leftOffset: integer (int32)

LeftOffset

topOffset: integer (int32)

TopOffset

index: integer (int32)

Index

text: string

Text

Example
{
  "width": "integer (int32)",
  "height": "integer (int32)",
  "anchorPoint": "string",
  "characterIndex": "integer (int32)",
  "leftOffset": "integer (int32)",
  "topOffset": "integer (int32)",
  "index": "integer (int32)",
  "text": "string"
}

Field: object

page: integer (int32)

Page

binding: string

Binding

top: number (double)

Top

id: string

Id

subtype: string FULLNAME, INITIALS, CAPTURE, LABEL, TEXTFIELD, TEXTAREA, CHECKBOX, DATE, RADIO, LIST, QRCODE, CUSTOMFIELD, SEAL, MOBILE_CAPTURE, RAW_CAPTURE, DATEPICKER

Subtype

data: object

Data

extract: boolean

Extract

width: number (double)

Width

height: number (double)

Height

left: number (double)

Left

extractAnchor: ExtractAnchor

ExtractAnchor

validation: FieldValidation

Validation

type: string SIGNATURE, INPUT, IMAGE

Type

value: string

Value

name: string

Name

Example
{
  "page": "integer (int32)",
  "binding": "string",
  "top": "number (double)",
  "id": "string",
  "subtype": "string",
  "data": "object",
  "extract": "boolean",
  "width": "number (double)",
  "height": "number (double)",
  "left": "number (double)",
  "extractAnchor": {
    "width": "integer (int32)",
    "height": "integer (int32)",
    "anchorPoint": "string",
    "characterIndex": "integer (int32)",
    "leftOffset": "integer (int32)",
    "topOffset": "integer (int32)",
    "index": "integer (int32)",
    "text": "string"
  },
  "validation": {
    "errorCode": "integer (int32)",
    "maxLength": "integer (int32)",
    "minLength": "integer (int32)",
    "errorMessage": "string",
    "enum": [
      "string"
    ],
    "required": "boolean",
    "pattern": "string"
  },
  "type": "string",
  "value": "string",
  "name": "string"
}

FieldSettings: object

visibility: boolean

Visibility

template: Field

Template

Example
{
  "visibility": "boolean",
  "template": {
    "page": "integer (int32)",
    "binding": "string",
    "top": "number (double)",
    "id": "string",
    "subtype": "string",
    "data": "object",
    "extract": "boolean",
    "width": "number (double)",
    "height": "number (double)",
    "left": "number (double)",
    "extractAnchor": {
      "width": "integer (int32)",
      "height": "integer (int32)",
      "anchorPoint": "string",
      "characterIndex": "integer (int32)",
      "leftOffset": "integer (int32)",
      "topOffset": "integer (int32)",
      "index": "integer (int32)",
      "text": "string"
    },
    "validation": {
      "errorCode": "integer (int32)",
      "maxLength": "integer (int32)",
      "minLength": "integer (int32)",
      "errorMessage": "string",
      "enum": [
        "string"
      ],
      "required": "boolean",
      "pattern": "string"
    },
    "type": "string",
    "value": "string",
    "name": "string"
  }
}

FieldValidation: object

errorCode: integer (int32)

ErrorCode

maxLength: integer (int32)

MaxLength

minLength: integer (int32)

MinLength

errorMessage: string

ErrorMessage

enum: string[]

Enum

string
required: boolean

Required

pattern: string

Pattern

Example
{
  "errorCode": "integer (int32)",
  "maxLength": "integer (int32)",
  "minLength": "integer (int32)",
  "errorMessage": "string",
  "enum": [
    "string"
  ],
  "required": "boolean",
  "pattern": "string"
}

Account: object

updated: string (date-time)

Updated

timezoneId: string

TimezoneId

company: Company

Company

created: string (date-time)

Created

customFields: CustomField

CustomFields

CustomField
logoAltTextKey: string

LogoAltTextKey

logoUrl: string

LogoUrl

id: string

Id

licenses: License

Licenses

License
data: object

Data

providers: AccountProviders

Providers

owner: string

Owner

name: string

Name

Example
{
  "updated": "string (date-time)",
  "timezoneId": "string",
  "company": {
    "id": "string",
    "data": "object",
    "address": {
      "address1": "string",
      "address2": "string",
      "city": "string",
      "country": "string",
      "zipcode": "string",
      "state": "string"
    },
    "name": "string"
  },
  "created": "string (date-time)",
  "customFields": [
    {
      "id": "string",
      "data": "object",
      "translations": [
        {
          "id": "string",
          "data": "object",
          "description": "string",
          "language": "string",
          "name": "string"
        }
      ],
      "required": "boolean",
      "value": "string",
      "name": "string"
    }
  ],
  "logoAltTextKey": "string",
  "logoUrl": "string",
  "id": "string",
  "licenses": [
    {
      "created": "string (date-time)",
      "paidUntil": "string (date-time)",
      "transactions": [
        {
          "created": "string (date-time)",
          "creditCard": {
            "cvv": "string",
            "number": "string",
            "type": "string",
            "expiration": {
              "month": "integer (int32)",
              "year": "integer (int32)"
            },
            "name": "string"
          },
          "price": {
            "amount": "integer (int32)",
            "currency": {
              "id": "string",
              "data": "object",
              "name": "string"
            }
          }
        }
      ],
      "plan": {
        "group": "string",
        "id": "string",
        "freeCycles": {
          "count": "integer (int32)",
          "cycle": "string"
        },
        "quotas": [
          {
            "scope": "string",
            "cycle": "string",
            "limit": "integer (int32)",
            "target": "string"
          }
        ],
        "cycle": "string",
        "contract": "string",
        "data": "object",
        "price": {
          "amount": "integer (int32)",
          "currency": {
            "id": "string",
            "data": "object",
            "name": "string"
          }
        },
        "original": "string",
        "features": "object",
        "description": "string",
        "name": "string"
      },
      "status": "string"
    }
  ],
  "data": "object",
  "providers": {
    "documents": [
      {}
    ]
  }
}

AccountProviders: object

documents: Provider

Documents

Provider
users: Provider

Users

Provider
Example
{
  "documents": [
    {
      "id": "string",
      "data": "object",
      "provides": "string",
      "name": "string"
    }
  ],
  "users": [
    {
      "id": "string",
      "data": "object",
      "provides": "string",
      "name": "string"
    }
  ]
}

Address: object

address1: string

Address1

address2: string

Address2

city: string

City

country: string

Country

zipcode: string

Zipcode

state: string

State

Example
{
  "address1": "string",
  "address2": "string",
  "city": "string",
  "country": "string",
  "zipcode": "string",
  "state": "string"
}

CcExpiration: object

month: integer (int32)

Month

year: integer (int32)

Year

Example
{
  "month": "integer (int32)",
  "year": "integer (int32)"
}

Company: object

id: string

Id

data: object

Data

address: Address

Address

name: string

Name

Example
{
  "id": "string",
  "data": "object",
  "address": {
    "address1": "string",
    "address2": "string",
    "city": "string",
    "country": "string",
    "zipcode": "string",
    "state": "string"
  },
  "name": "string"
}

CreditCard: object

cvv: string

Cvv

number: string

Number

type: string

Type

expiration: CcExpiration

Expiration

name: string

Name

Example
{
  "cvv": "string",
  "number": "string",
  "type": "string",
  "expiration": {
    "month": "integer (int32)",
    "year": "integer (int32)"
  },
  "name": "string"
}

Currency: object

id: string

Id

data: object

Data

name: string

Name

Example
{
  "id": "string",
  "data": "object",
  "name": "string"
}

CycleCount: object

count: integer (int32)

Count

cycle: string DAY, MONTH, YEAR

Cycle

Example
{
  "count": "integer (int32)",
  "cycle": "string"
}

License: object

created: string (date-time)

Created

paidUntil: string (date-time)

PaidUntil

transactions: Transaction

Transactions

Transaction
plan: Plan

Plan

status: string ACTIVE, PENDING, GRACE

Status

Example
{
  "created": "string (date-time)",
  "paidUntil": "string (date-time)",
  "transactions": [
    {
      "created": "string (date-time)",
      "creditCard": {
        "cvv": "string",
        "number": "string",
        "type": "string",
        "expiration": {
          "month": "integer (int32)",
          "year": "integer (int32)"
        },
        "name": "string"
      },
      "price": {
        "amount": "integer (int32)",
        "currency": {
          "id": "string",
          "data": "object",
          "name": "string"
        }
      }
    }
  ],
  "plan": {
    "group": "string",
    "id": "string",
    "freeCycles": {
      "count": "integer (int32)",
      "cycle": "string"
    },
    "quotas": [
      {
        "scope": "string",
        "cycle": "string",
        "limit": "integer (int32)",
        "target": "string"
      }
    ],
    "cycle": "string",
    "contract": "string",
    "data": "object",
    "price": {
      "amount": "integer (int32)",
      "currency": {
        "id": "string",
        "data": "object",
        "name": "string"
      }
    },
    "original": "string",
    "features": "object",
    "description": "string",
    "name": "string"
  },
  "status": "string"
}

Plan: object

group: string

Group

id: string

Id

freeCycles: CycleCount

FreeCycles

quotas: Quota

Quotas

Quota
cycle: string DAY, MONTH, YEAR

Cycle

contract: string DAY, MONTH, YEAR

Contract

data: object

Data

price: Price

Price

original: string

Original

features: object

Features

description: string

Description

name: string

Name

Example
{
  "group": "string",
  "id": "string",
  "freeCycles": {
    "count": "integer (int32)",
    "cycle": "string"
  },
  "quotas": [
    {
      "scope": "string",
      "cycle": "string",
      "limit": "integer (int32)",
      "target": "string"
    }
  ],
  "cycle": "string",
  "contract": "string",
  "data": "object",
  "price": {
    "amount": "integer (int32)",
    "currency": {
      "id": "string",
      "data": "object",
      "name": "string"
    }
  },
  "original": "string",
  "features": "object",
  "description": "string",
  "name": "string"
}

Price: object

amount: integer (int32)

Amount

currency: Currency

Currency

Example
{
  "amount": "integer (int32)",
  "currency": {
    "id": "string",
    "data": "object",
    "name": "string"
  }
}

Provider: object

id: string

Id

data: object

Data

provides: string

Provides

name: string

Name

Example
{
  "id": "string",
  "data": "object",
  "provides": "string",
  "name": "string"
}

Quota: object

scope: string SENDER, DOCUMENT, PACKAGE, ACCOUNT

Scope

cycle: string DAY, MONTH, YEAR

Cycle

limit: integer (int32)

Limit

target: string SIGNER, SENDER, DOCUMENT, PACKAGE, STORAGE

Target

Example
{
  "scope": "string",
  "cycle": "string",
  "limit": "integer (int32)",
  "target": "string"
}

Transaction: object

created: string (date-time)

Created

creditCard: CreditCard

CreditCard

price: Price

Price

Example
{
  "created": "string (date-time)",
  "creditCard": {
    "cvv": "string",
    "number": "string",
    "type": "string",
    "expiration": {
      "month": "integer (int32)",
      "year": "integer (int32)"
    },
    "name": "string"
  },
  "price": {
    "amount": "integer (int32)",
    "currency": {
      "id": "string",
      "data": "object",
      "name": "string"
    }
  }
}

External: object

id: string

Id

providerName: string

ProviderName

provider: string

Provider

data: object

Data

Example
{
  "id": "string",
  "providerName": "string",
  "provider": "string",
  "data": "object"
}

GroupMembership: object

groupName: string

GroupName

memberType: string REGULAR, MANAGER

MemberType

groupId: string

GroupId

Example
{
  "groupName": "string",
  "memberType": "string",
  "groupId": "string"
}

ProfessionalIdentityField: object

id: string

Id

category: string

Category

data: object

Data

translations: Translation

Translations

Translation
type: string

Type

value: string

Value

name: string

Name

Example
{
  "id": "string",
  "category": "string",
  "data": "object",
  "translations": [
    {
      "id": "string",
      "data": "object",
      "description": "string",
      "language": "string",
      "name": "string"
    }
  ],
  "type": "string",
  "value": "string",
  "name": "string"
}

Sender: object

signature: SignatureStyle

Signature

account: Account

Account

updated: string (date-time)

Updated

timezoneId: string

TimezoneId

userCustomFields: UserCustomField

UserCustomFields

UserCustomField
email: string

Email

activated: string (date-time)

Activated

company: string

Company

external: External

External

locked: string (date-time)

Locked

memberships: GroupMembership

Memberships

GroupMembership
phone: string

Phone

professionalIdentityFields: ProfessionalIdentityField

ProfessionalIdentityFields

ProfessionalIdentityField
firstName: string

FirstName

lastName: string

LastName

id: string

Id

title: string

Title

data: object

Data

type: string REGULAR, MANAGER

Type

address: Address

Address

created: string (date-time)

Created

status: string INVITED, ACTIVE, LOCKED

Status

language: string

Language

name: string

Name

specialTypes: string[]

Special User Types

string NOTARY
hasDelegates: boolean

Has Delegates

Example
{
  "signature": {
    "textual": {
      "font": "string",
      "color": "string"
    },
    "handdrawn": "string"
  },
  "account": {
    "updated": "string (date-time)",
    "timezoneId": "string",
    "company": {
      "id": "string",
      "data": "object",
      "address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "country": "string",
        "zipcode": "string",
        "state": "string"
      },
      "name": "string"
    },
    "created": "string (date-time)",
    "customFields": [
      {
        "id": "string",
        "data": "object",
        "translations": [
          {
            "id": "string",
            "data": "object",
            "description": "string",
            "language": "string",
            "name": "string"
          }
        ],
        "required": "boolean",
        "value": "string",
        "name": "string"
      }
    ],
    "logoAltTextKey": "string",
    "logoUrl": "string",
    "id": "string",
    "licenses": [
      {
        "created": "string (date-time)",
        "paidUntil": "string (date-time)",
        "transactions": [
          {
            "created": "string (date-time)",
            "creditCard": {
              "cvv": "string",
              "number": "string",
              "type": "string",
              "expiration": {
                "month": "integer (int32)",
                "year": "integer (int32)"
              },
              "name": "string"
            },
            "price": {
              "amount": "integer (int32)",
              "currency": {
                "id": "string",
                "data": "object",
                "name": "string"
              }
            }
          }
        ],
        "plan": {
          "group": "string",
          "id": "string",
          "freeCycles": {
            "count": "integer (int32)",
            "cycle": "string"
          },
          "quotas": [
            {
              "scope": "string",
              "cycle": "string",
              "limit": "integer (int32)",
              "target": "string"
            }
          ],
          "cycle": "string",
          "contract": "string",
          "data": "object",
          "price": {
            "amount": "integer (int32)",
            "currency": {
              "id": "string",
              "data": "object",
              "name": "string"
            }
          },
          "original": "string",
          "features": "object"
        }
      }
    ]
  }
}

SignatureStyle: object

textual: TextualSignatureStyle

Textual

handdrawn: string

Handdrawn

Example
{
  "textual": {
    "font": "string",
    "color": "string"
  },
  "handdrawn": "string"
}

TextualSignatureStyle: object

font: string

Font

color: string

Color

Example
{
  "font": "string",
  "color": "string"
}

Approval: object

id: string

Id

role: string

Role

data: object

Data

accepted: string (date-time)

Accepted

enforceCaptureSignature: boolean

EnforceCaptureSignature

signed: string (date-time)

Signed

optional: boolean

Optional

fields: Field

Fields

Field
name: string

Name

Example
{
  "id": "string",
  "role": "string",
  "data": "object",
  "accepted": "string (date-time)",
  "enforceCaptureSignature": "boolean",
  "signed": "string (date-time)",
  "optional": "boolean",
  "fields": [
    {
      "page": "integer (int32)",
      "binding": "string",
      "top": "number (double)",
      "id": "string",
      "subtype": "string",
      "data": "object",
      "extract": "boolean",
      "width": "number (double)",
      "height": "number (double)",
      "left": "number (double)",
      "extractAnchor": {
        "width": "integer (int32)",
        "height": "integer (int32)",
        "anchorPoint": "string",
        "characterIndex": "integer (int32)",
        "leftOffset": "integer (int32)",
        "topOffset": "integer (int32)",
        "index": "integer (int32)",
        "text": "string"
      },
      "validation": {
        "errorCode": "integer (int32)",
        "maxLength": "integer (int32)",
        "minLength": "integer (int32)",
        "errorMessage": "string",
        "enum": [
          "string"
        ],
        "required": "boolean",
        "pattern": "string"
      },
      "type": "string",
      "value": "string",
      "name": "string"
    }
  ],
  "name": "string"
}

Document: object

status: string
external: External

External

id: string

Id

signedHash: string

SignedHash

data: object

Data

signerVerificationToken: string

SignerVerificationToken

approvals: Approval

Approvals

Approval
extract: boolean

Extract

extractionTypes: string[]

ExtractionTypes

string
tagged: boolean

Tagged

pages: Page

Pages

Page
fields: Field

Fields

Field
index: integer (int32)

Index

description: string

Description

name: string

Name

size: integer (int32)

Size

Example
{
  "status": "string",
  "external": {
    "id": "string",
    "providerName": "string",
    "provider": "string",
    "data": "object"
  },
  "id": "string",
  "signedHash": "string",
  "data": "object",
  "signerVerificationToken": "string",
  "approvals": [
    {
      "id": "string",
      "role": "string",
      "data": "object",
      "accepted": "string (date-time)",
      "enforceCaptureSignature": "boolean",
      "signed": "string (date-time)",
      "optional": "boolean",
      "fields": [
        {
          "page": "integer (int32)",
          "binding": "string",
          "top": "number (double)",
          "id": "string",
          "subtype": "string",
          "data": "object",
          "extract": "boolean",
          "width": "number (double)",
          "height": "number (double)",
          "left": "number (double)",
          "extractAnchor": {
            "width": "integer (int32)",
            "height": "integer (int32)",
            "anchorPoint": "string",
            "characterIndex": "integer (int32)",
            "leftOffset": "integer (int32)",
            "topOffset": "integer (int32)",
            "index": "integer (int32)",
            "text": "string"
          },
          "validation": {
            "errorCode": "integer (int32)",
            "maxLength": "integer (int32)",
            "minLength": "integer (int32)",
            "errorMessage": "string",
            "enum": [
              "string"
            ],
            "required": "boolean",
            "pattern": "string"
          },
          "type": "string",
          "value": "string",
          "name": "string"
        }
      ],
      "name": "string"
    }
  ],
  "extract": "boolean",
  "extractionTypes": [
    "string"
  ],
  "tagged": "boolean",
  "pages": [
    {
      "top": "number (double)",
      "id": "string",
      "width": "number (double)",
      "height": "number (double)",
      "left": "number (double)",
      "version": "integer (int32)",
      "index": "integer (int32)"
    }
  ],
  "fields": [
    {
      "page": "integer (int32)",
      "binding": "string",
      "top": "number (double)",
      "id": "string",
      "subtype": "string",
      "data": "object",
      "extract": "boolean",
      "width": "number (double)",
      "height": "number (double)",
      "left": "number (double)",
      "extractAnchor": {
        "width": "integer (int32)",
        "height": "integer (int32)",
        "anchorPoint": "string",
        "characterIndex": "integer (int32)",
        "leftOffset": "integer (int32)",
        "topOffset": "integer (int32)",
        "index": "integer (int32)",
        "text": "string"
      },
      "validation": {
        "errorCode": "integer (int32)",
        "maxLength": "integer (int32)"
      }
    }
  ]
}

Page: object

top: number (double)

Top

id: string

Id

width: number (double)

Width

height: number (double)

Height

left: number (double)

Left

version: integer (int32)

Version

index: integer (int32)

Index

Example
{
  "top": "number (double)",
  "id": "string",
  "width": "number (double)",
  "height": "number (double)",
  "left": "number (double)",
  "version": "integer (int32)",
  "index": "integer (int32)"
}

BodyPart: object

entity: object
headers: object
mediaType: MediaType
parent: MultiPart
providers: Providers
parameterizedHeaders: object
contentDisposition: ContentDisposition
Example
{
  "entity": "object",
  "headers": "object",
  "mediaType": {
    "type": "string",
    "subtype": "string",
    "parameters": "object",
    "wildcardType": "boolean",
    "wildcardSubtype": "boolean"
  },
  "parent": {
    "entity": "object",
    "headers": "object",
    "mediaType": {
      "type": "string",
      "subtype": "string",
      "parameters": "object",
      "wildcardType": "boolean",
      "wildcardSubtype": "boolean"
    },
    "parent": {
      "entity": "object",
      "headers": "object",
      "mediaType": {
        "type": "string",
        "subtype": "string",
        "parameters": "object",
        "wildcardType": "boolean",
        "wildcardSubtype": "boolean"
      },
      "parent": {
        "entity": "object",
        "headers": "object",
        "mediaType": {
          "type": "string",
          "subtype": "string",
          "parameters": "object",
          "wildcardType": "boolean",
          "wildcardSubtype": "boolean"
        },
        "parent": {
          "entity": "object",
          "headers": "object",
          "mediaType": {
            "type": "string",
            "subtype": "string",
            "parameters": "object",
            "wildcardType": "boolean",
            "wildcardSubtype": "boolean"
          },
          "parent": {
            "entity": "object",
            "headers": "object",
            "mediaType": {
              "type": "string",
              "subtype": "string",
              "parameters": "object",
              "wildcardType": "boolean",
              "wildcardSubtype": "boolean"
            },
            "parent": {
              "entity": "object",
              "headers": "object",
              "mediaType": {
                "type": "string",
                "subtype": "string",
                "parameters": "object",
                "wildcardType": "boolean",
                "wildcardSubtype": "boolean"
              },
              "parent": {
                "entity": "object",
                "headers": "object",
                "mediaType": {
                  "type": "string",
                  "subtype": "string",
                  "parameters": "object",
                  "wildcardType": "boolean",
                  "wildcardSubtype": "boolean"
                },
                "parent": {
                  "entity": "object",
                  "headers": "object",
                  "mediaType": {
                    "type": "string",
                    "subtype": "string",
                    "parameters": "object",
                    "wildcardType": "boolean",
                    "wildcardSubtype": "boolean"
                  },
                  "parent": {}
                }
              }
            }
          }
        }
      }
    }
  }
}

ContentDisposition: object

type: string
parameters: object
fileName: string
creationDate: string (date-time)
modificationDate: string (date-time)
readDate: string (date-time)
size: integer (int64)
Example
{
  "type": "string",
  "parameters": "object",
  "fileName": "string",
  "creationDate": "string (date-time)",
  "modificationDate": "string (date-time)",
  "readDate": "string (date-time)",
  "size": "integer (int64)"
}

FormDataBodyPart: object

entity: object
headers: object
mediaType: MediaType
parent: MultiPart
providers: Providers
simple: boolean
formDataContentDisposition: FormDataContentDisposition
contentDisposition: ContentDisposition
name: string
value: string
parameterizedHeaders: object
Example
{
  "entity": "object",
  "headers": "object",
  "mediaType": {
    "type": "string",
    "subtype": "string",
    "parameters": "object",
    "wildcardType": "boolean",
    "wildcardSubtype": "boolean"
  },
  "parent": {
    "entity": "object",
    "headers": "object",
    "mediaType": {
      "type": "string",
      "subtype": "string",
      "parameters": "object",
      "wildcardType": "boolean",
      "wildcardSubtype": "boolean"
    },
    "parent": {
      "entity": "object",
      "headers": "object",
      "mediaType": {
        "type": "string",
        "subtype": "string",
        "parameters": "object",
        "wildcardType": "boolean",
        "wildcardSubtype": "boolean"
      },
      "parent": {
        "entity": "object",
        "headers": "object",
        "mediaType": {
          "type": "string",
          "subtype": "string",
          "parameters": "object",
          "wildcardType": "boolean",
          "wildcardSubtype": "boolean"
        },
        "parent": {
          "entity": "object",
          "headers": "object",
          "mediaType": {
            "type": "string",
            "subtype": "string",
            "parameters": "object",
            "wildcardType": "boolean",
            "wildcardSubtype": "boolean"
          },
          "parent": {
            "entity": "object",
            "headers": "object",
            "mediaType": {
              "type": "string",
              "subtype": "string",
              "parameters": "object",
              "wildcardType": "boolean",
              "wildcardSubtype": "boolean"
            },
            "parent": {
              "entity": "object",
              "headers": "object",
              "mediaType": {
                "type": "string",
                "subtype": "string",
                "parameters": "object",
                "wildcardType": "boolean",
                "wildcardSubtype": "boolean"
              },
              "parent": {
                "entity": "object",
                "headers": "object",
                "mediaType": {
                  "type": "string",
                  "subtype": "string",
                  "parameters": "object",
                  "wildcardType": "boolean",
                  "wildcardSubtype": "boolean"
                },
                "parent": {
                  "entity": "object",
                  "headers": "object",
                  "mediaType": {
                    "type": "string",
                    "subtype": "string",
                    "parameters": "object",
                    "wildcardType": "boolean",
                    "wildcardSubtype": "boolean"
                  },
                  "parent": {}
                }
              }
            }
          }
        }
      }
    }
  }
}

FormDataContentDisposition: object

type: string
parameters: object
fileName: string
creationDate: string (date-time)
modificationDate: string (date-time)
readDate: string (date-time)
size: integer (int64)
name: string
Example
{
  "type": "string",
  "parameters": "object",
  "fileName": "string",
  "creationDate": "string (date-time)",
  "modificationDate": "string (date-time)",
  "readDate": "string (date-time)",
  "size": "integer (int64)",
  "name": "string"
}

FormDataMultiPart: object

entity: object
headers: object
mediaType: MediaType
parent: MultiPart
providers: Providers
bodyParts: BodyPart
BodyPart
fields: object
parameterizedHeaders: object
contentDisposition: ContentDisposition
Example
{
  "entity": "object",
  "headers": "object",
  "mediaType": {
    "type": "string",
    "subtype": "string",
    "parameters": "object",
    "wildcardType": "boolean",
    "wildcardSubtype": "boolean"
  },
  "parent": {
    "entity": "object",
    "headers": "object",
    "mediaType": {
      "type": "string",
      "subtype": "string",
      "parameters": "object",
      "wildcardType": "boolean",
      "wildcardSubtype": "boolean"
    },
    "parent": {
      "entity": "object",
      "headers": "object",
      "mediaType": {
        "type": "string",
        "subtype": "string",
        "parameters": "object",
        "wildcardType": "boolean",
        "wildcardSubtype": "boolean"
      },
      "parent": {
        "entity": "object",
        "headers": "object",
        "mediaType": {
          "type": "string",
          "subtype": "string",
          "parameters": "object",
          "wildcardType": "boolean",
          "wildcardSubtype": "boolean"
        },
        "parent": {
          "entity": "object",
          "headers": "object",
          "mediaType": {
            "type": "string",
            "subtype": "string",
            "parameters": "object",
            "wildcardType": "boolean",
            "wildcardSubtype": "boolean"
          },
          "parent": {
            "entity": "object",
            "headers": "object",
            "mediaType": {
              "type": "string",
              "subtype": "string",
              "parameters": "object",
              "wildcardType": "boolean",
              "wildcardSubtype": "boolean"
            },
            "parent": {
              "entity": "object",
              "headers": "object",
              "mediaType": {
                "type": "string",
                "subtype": "string",
                "parameters": "object",
                "wildcardType": "boolean",
                "wildcardSubtype": "boolean"
              },
              "parent": {
                "entity": "object",
                "headers": "object",
                "mediaType": {
                  "type": "string",
                  "subtype": "string",
                  "parameters": "object",
                  "wildcardType": "boolean",
                  "wildcardSubtype": "boolean"
                },
                "parent": {
                  "entity": "object",
                  "headers": "object",
                  "mediaType": {
                    "type": "string",
                    "subtype": "string",
                    "parameters": "object",
                    "wildcardType": "boolean",
                    "wildcardSubtype": "boolean"
                  },
                  "parent": {}
                }
              }
            }
          }
        }
      }
    }
  }
}

MediaType: object

type: string
subtype: string
parameters: object
wildcardType: boolean
wildcardSubtype: boolean
Example
{
  "type": "string",
  "subtype": "string",
  "parameters": "object",
  "wildcardType": "boolean",
  "wildcardSubtype": "boolean"
}

MultiPart: object

entity: object
headers: object
mediaType: MediaType
parent: MultiPart
providers: Providers
bodyParts: BodyPart
BodyPart
parameterizedHeaders: object
contentDisposition: ContentDisposition
Example
{
  "entity": "object",
  "headers": "object",
  "mediaType": {
    "type": "string",
    "subtype": "string",
    "parameters": "object",
    "wildcardType": "boolean",
    "wildcardSubtype": "boolean"
  },
  "parent": {
    "entity": "object",
    "headers": "object",
    "mediaType": {
      "type": "string",
      "subtype": "string",
      "parameters": "object",
      "wildcardType": "boolean",
      "wildcardSubtype": "boolean"
    },
    "parent": {
      "entity": "object",
      "headers": "object",
      "mediaType": {
        "type": "string",
        "subtype": "string",
        "parameters": "object",
        "wildcardType": "boolean",
        "wildcardSubtype": "boolean"
      },
      "parent": {
        "entity": "object",
        "headers": "object",
        "mediaType": {
          "type": "string",
          "subtype": "string",
          "parameters": "object",
          "wildcardType": "boolean",
          "wildcardSubtype": "boolean"
        },
        "parent": {
          "entity": "object",
          "headers": "object",
          "mediaType": {
            "type": "string",
            "subtype": "string",
            "parameters": "object",
            "wildcardType": "boolean",
            "wildcardSubtype": "boolean"
          },
          "parent": {
            "entity": "object",
            "headers": "object",
            "mediaType": {
              "type": "string",
              "subtype": "string",
              "parameters": "object",
              "wildcardType": "boolean",
              "wildcardSubtype": "boolean"
            },
            "parent": {
              "entity": "object",
              "headers": "object",
              "mediaType": {
                "type": "string",
                "subtype": "string",
                "parameters": "object",
                "wildcardType": "boolean",
                "wildcardSubtype": "boolean"
              },
              "parent": {
                "entity": "object",
                "headers": "object",
                "mediaType": {
                  "type": "string",
                  "subtype": "string",
                  "parameters": "object",
                  "wildcardType": "boolean",
                  "wildcardSubtype": "boolean"
                },
                "parent": {
                  "entity": "object",
                  "headers": "object",
                  "mediaType": {
                    "type": "string",
                    "subtype": "string",
                    "parameters": "object",
                    "wildcardType": "boolean",
                    "wildcardSubtype": "boolean"
                  },
                  "parent": {}
                }
              }
            }
          }
        }
      }
    }
  }
}

ParameterizedHeader: object

value: string
parameters: object
Example
{
  "value": "string",
  "parameters": "object"
}

Providers: object

Example
"object"

FastTrackRole: object

id: string
name: string
signers: FastTrackSigner
FastTrackSigner
Example
{
  "id": "string",
  "name": "string",
  "signers": [
    {
      "id": "string",
      "email": "string",
      "firstName": "string",
      "lastName": "string"
    }
  ]
}

FastTrackSigner: object

id: string
email: string
firstName: string
lastName: string
Example
{
  "id": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string"
}

Group: object

account: Account

Account

updated: string (date-time)

Updated

created: string (date-time)

Created

email: string

Email

id: string

Id

emailMembers: boolean

EmailMembers

reciprocalDelegation: boolean

Reciprocal Delegation

data: object

Data

members: GroupMember

Members

GroupMember
name: string

Name

Example
{
  "account": {
    "updated": "string (date-time)",
    "timezoneId": "string",
    "company": {
      "id": "string",
      "data": "object",
      "address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "country": "string",
        "zipcode": "string",
        "state": "string"
      },
      "name": "string"
    },
    "created": "string (date-time)",
    "customFields": [
      {
        "id": "string",
        "data": "object",
        "translations": [
          {
            "id": "string",
            "data": "object",
            "description": "string",
            "language": "string",
            "name": "string"
          }
        ],
        "required": "boolean",
        "value": "string",
        "name": "string"
      }
    ],
    "logoAltTextKey": "string",
    "logoUrl": "string",
    "id": "string",
    "licenses": [
      {
        "created": "string (date-time)",
        "paidUntil": "string (date-time)",
        "transactions": [
          {
            "created": "string (date-time)",
            "creditCard": {
              "cvv": "string",
              "number": "string",
              "type": "string",
              "expiration": {
                "month": "integer (int32)",
                "year": "integer (int32)"
              },
              "name": "string"
            },
            "price": {
              "amount": "integer (int32)",
              "currency": {
                "id": "string",
                "data": "object",
                "name": "string"
              }
            }
          }
        ],
        "plan": {
          "group": "string",
          "id": "string",
          "freeCycles": {
            "count": "integer (int32)",
            "cycle": "string"
          },
          "quotas": [
            {
              "scope": "string",
              "cycle": "string",
              "limit": "integer (int32)",
              "target": "string"
            }
          ],
          "cycle": "string",
          "contract": "string",
          "data": "object",
          "price": {
            "amount": "integer (int32)",
            "currency": {
              "id": "string",
              "data": "object",
              "name": "string"
            }
          },
          "original": "string",
          "features": "object",
          "description": "string",
          "name": "string"
        },
        "status": "string"
      }
    ],
    "data": "object",
    "providers": {
      "documents": [
        null
      ]
    }
  }
}

GroupMember: object

userId: string

UserId

email: string

Email

firstName: string

FirstName

lastName: string

LastName

memberType: string REGULAR, MANAGER

MemberType

pending: boolean

Pending

Example
{
  "userId": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "memberType": "string",
  "pending": "boolean"
}

Entity: object

email: string

Email

id: string

Id

data: object

Data

name: string

Name

Example
{
  "email": "string",
  "id": "string",
  "data": "object",
  "name": "string"
}

AttachmentRequirement: object

id: string

Id

status: string INCOMPLETE, REJECTED, COMPLETE

Status

description: string

Description

required: boolean

Required

comment: string

Comment

name: string

Name

data: object

Data

Example
{
  "id": "string",
  "status": "string",
  "description": "string",
  "required": "boolean",
  "comment": "string",
  "name": "string",
  "data": "object"
}

Auth: object

challenges: AuthChallenge

Challenges

AuthChallenge
scheme: string NONE, PROVIDER, CHALLENGE, SMS, SSO, KBA

Scheme

Example
{
  "challenges": [
    {
      "answer": "string",
      "question": "string",
      "maskInput": "boolean"
    }
  ],
  "scheme": "string"
}

AuthChallenge: object

answer: string

Answer

question: string

Question

maskInput: boolean

MaskInput

Example
{
  "answer": "string",
  "question": "string",
  "maskInput": "boolean"
}

BaseMessage: object

content: string

Content

Example
{
  "content": "string"
}

BrandingBarOptions: object

logo: Image

Logo

Example
{
  "logo": {
    "src": "string",
    "logoAltTextKey": "string",
    "link": "string"
  }
}

CeremonyEventComplete: object

redirect: string

Redirect

dialog: boolean

Dialog

Example
{
  "redirect": "string",
  "dialog": "boolean"
}

CeremonyEvents: object

complete: CeremonyEventComplete

Complete

Example
{
  "complete": {
    "redirect": "string",
    "dialog": "boolean"
  }
}

CeremonySettings: object

extractTextTags: boolean

ExtractTextTags

extractAcroFields: boolean

ExtractAcroFields

inPerson: boolean

InPerson

ada: boolean

Ada

style: LayoutStyle

Style

layout: LayoutOptions

Layout

maxAuthFailsAllowed: integer (int32)

MaxAuthFailsAllowed

handOver: Link

HandOver

enforceCaptureSignature: boolean

EnforceCaptureSignature

declineButton: boolean

DeclineButton

declineReasons: string[]

DeclineReasons

string
disableDeclineOther: boolean

DisableDeclineOther

disableDownloadForUncompletedPackage: boolean

DisableDownloadForUncompletedPackage

disableFirstInPersonAffidavit: boolean

DisableFirstInPersonAffidavit

disableInPersonAffidavit: boolean

DisableInPersonAffidavit

disableOptOutOther: boolean

DisableOptOutOther

disableSecondInPersonAffidavit: boolean

DisableSecondInPersonAffidavit

documentToolbarOptions: DocumentToolbarOptions

DocumentToolbarOptions

events: CeremonyEvents

Events

hideCaptureText: boolean

HideCaptureText

hideLanguageDropdown: boolean

HideLanguageDropdown

hidePackageOwnerInPerson: boolean

HidePackageOwnerInPerson

hideWatermark: boolean

HideWatermark

optOutButton: boolean

OptOutButton

optOutReasons: string[]

OptOutReasons

string
Example
{
  "extractTextTags": "boolean",
  "extractAcroFields": "boolean",
  "inPerson": "boolean",
  "ada": "boolean",
  "style": {
    "brandingBar": {
      "src": "string",
      "logoAltTextKey": "string",
      "link": "string"
    },
    "dialog": {
      "color": "string",
      "backgroundColor": "string"
    },
    "toolbar": {
      "color": "string",
      "backgroundColor": "string"
    },
    "titleBar": {
      "color": "string",
      "backgroundColor": "string"
    }
  },
  "layout": {
    "footer": "object",
    "iframe": "boolean",
    "brandingBar": {
      "logo": {
        "src": "string",
        "logoAltTextKey": "string",
        "link": "string"
      }
    },
    "navigator": "boolean",
    "header": {
      "feedback": "boolean",
      "globalActions": {
        "confirm": "boolean",
        "hideEvidenceSummary": "boolean",
        "saveAsLayout": "boolean",
        "download": "boolean"
      },
      "globalNavigation": "boolean",
      "sessionBar": "boolean",
      "titleBar": {
        "progressBar": "boolean",
        "title": "boolean"
      },
      "breadcrumbs": "boolean"
    }
  },
  "maxAuthFailsAllowed": "integer (int32)",
  "handOver": {
    "title": "string",
    "href": "string",
    "text": "string"
  },
  "enforceCaptureSignature": "boolean",
  "declineButton": "boolean",
  "declineReasons": [
    "string"
  ],
  "disableDeclineOther": "boolean",
  "disableDownloadForUncompletedPackage": "boolean",
  "disableFirstInPersonAffidavit": "boolean",
  "disableInPersonAffidavit": "boolean",
  "disableOptOutOther": "boolean",
  "disableSecondInPersonAffidavit": "boolean",
  "documentToolbarOptions": {
    "downloadButton": "boolean"
  },
  "events": {
    "complete": {
      "redirect": "string",
      "dialog": "boolean"
    }
  },
  "hideCaptureText": "boolean",
  "hideLanguageDropdown": "boolean",
  "hidePackageOwnerInPerson": "boolean",
  "hideWatermark": "boolean",
  "optOutButton": "boolean",
  "optOutReasons": [
    "string"
  ]
}

Delivery: object

email: boolean

Email

provider: boolean

Provider

download: boolean

Download

Example
{
  "email": "boolean",
  "provider": "boolean",
  "download": "boolean"
}

DocumentToolbarOptions: object

downloadButton: boolean

DownloadButton

Example
{
  "downloadButton": "boolean"
}

FooterOptions: object

Example
"object"

GlobalActionsOptions: object

confirm: boolean

Confirm

hideEvidenceSummary: boolean

HideEvidenceSummary

saveAsLayout: boolean

SaveAsLayout

download: boolean

Download

Example
{
  "confirm": "boolean",
  "hideEvidenceSummary": "boolean",
  "saveAsLayout": "boolean",
  "download": "boolean"
}

HeaderOptions: object

feedback: boolean

Feedback

globalActions: GlobalActionsOptions

GlobalActions

globalNavigation: boolean

GlobalNavigation

sessionBar: boolean

SessionBar

titleBar: TitleBarOptions

TitleBar

breadcrumbs: boolean

Breadcrumbs

Example
{
  "feedback": "boolean",
  "globalActions": {
    "confirm": "boolean",
    "hideEvidenceSummary": "boolean",
    "saveAsLayout": "boolean",
    "download": "boolean"
  },
  "globalNavigation": "boolean",
  "sessionBar": "boolean",
  "titleBar": {
    "progressBar": "boolean",
    "title": "boolean"
  },
  "breadcrumbs": "boolean"
}

Image: object

src: string

Src

logoAltTextKey: string

LogoAltTextKey

link: string

Link

Example
{
  "src": "string",
  "logoAltTextKey": "string",
  "link": "string"
}

KnowledgeBasedAuthentication: object

knowledgeBasedAuthenticationStatus: string NOT_YET_ATTEMPTED, PASSED, FAILED, INVALID_SIGNER, UPDATED

SignerInformationForEquifaxCanada

signerInformationForEquifaxCanada: SignerInformationForEquifaxCanada

SignerInformationForEquifaxCanada

signerInformationForEquifaxUSA: SignerInformationForEquifaxUSA

SignerInformationForEquifaxUSA

equifaxCanada: boolean
equifaxUSA: boolean
Example
{
  "knowledgeBasedAuthenticationStatus": "string",
  "signerInformationForEquifaxCanada": {
    "firstName": "string",
    "lastName": "string",
    "city": "string",
    "dateOfBirth": "string (date-time)",
    "streetAddress": "string",
    "timeAtAddress": "integer (int32)",
    "province": "string",
    "postalCode": "string",
    "socialInsuranceNumber": "string",
    "homePhoneNumber": "string",
    "driversLicenseNumber": "string"
  },
  "signerInformationForEquifaxUSA": {
    "firstName": "string",
    "lastName": "string",
    "zip": "string",
    "city": "string",
    "dateOfBirth": "string (date-time)",
    "streetAddress": "string",
    "timeAtAddress": "integer (int32)",
    "socialSecurityNumber": "string",
    "homePhoneNumber": "string",
    "driversLicenseNumber": "string",
    "state": "string",
    "valid": "boolean"
  },
  "equifaxCanada": "boolean",
  "equifaxUSA": "boolean"
}

LayoutOptions: object

footer: FooterOptions

Footer

iframe: boolean

Iframe

brandingBar: BrandingBarOptions

BrandingBar

navigator: boolean

Navigator

header: HeaderOptions

Header

Example
{
  "footer": "object",
  "iframe": "boolean",
  "brandingBar": {
    "logo": {
      "src": "string",
      "logoAltTextKey": "string",
      "link": "string"
    }
  },
  "navigator": "boolean",
  "header": {
    "feedback": "boolean",
    "globalActions": {
      "confirm": "boolean",
      "hideEvidenceSummary": "boolean",
      "saveAsLayout": "boolean",
      "download": "boolean"
    },
    "globalNavigation": "boolean",
    "sessionBar": "boolean",
    "titleBar": {
      "progressBar": "boolean",
      "title": "boolean"
    },
    "breadcrumbs": "boolean"
  }
}

LayoutStyle: object

brandingBar: Image

BrandingBar

dialog: Style

Dialog

toolbar: Style

Toolbar

titleBar: Style

TitleBar

Example
{
  "brandingBar": {
    "src": "string",
    "logoAltTextKey": "string",
    "link": "string"
  },
  "dialog": {
    "color": "string",
    "backgroundColor": "string"
  },
  "toolbar": {
    "color": "string",
    "backgroundColor": "string"
  },
  "titleBar": {
    "color": "string",
    "backgroundColor": "string"
  }
}

Message: object

content: string

Content

created: string (date-time)

Created

to: User

To

User
documents: Document

Documents

Document
status: string NEW, READ, TRASHED

Status

from: User

From

Example
{
  "content": "string",
  "created": "string (date-time)",
  "to": [
    {
      "signature": {
        "textual": {
          "font": "string",
          "color": "string"
        },
        "handdrawn": "string"
      },
      "updated": "string (date-time)",
      "timezoneId": "string",
      "userCustomFields": [
        {
          "id": "string",
          "data": "object",
          "translations": [
            {
              "id": "string",
              "data": "object",
              "description": "string",
              "language": "string",
              "name": "string"
            }
          ],
          "value": "string",
          "name": "string"
        }
      ],
      "company": "string",
      "external": {
        "id": "string",
        "providerName": "string",
        "provider": "string",
        "data": "object"
      },
      "phone": "string",
      "professionalIdentityFields": [
        {
          "id": "string",
          "category": "string",
          "data": "object",
          "translations": [
            {
              "id": "string",
              "data": "object",
              "description": "string",
              "language": "string",
              "name": "string"
            }
          ],
          "type": "string",
          "value": "string",
          "name": "string"
        }
      ],
      "specialTypes": [
        "string"
      ],
      "created": "string (date-time)",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "id": "string",
      "title": "string",
      "data": "object",
      "address": {
        "address1": "string",
        "address2": "string",
        "city": "string",
        "country": "string",
        "zipcode": "string",
        "state": "string"
      },
      "language": "string",
      "name": "string"
    }
  ],
  "documents": [
    {
      "status": "string",
      "external": {
        "id": "string",
        "providerName": "string",
        "provider": "string",
        "data": "object"
      },
      "id": "string",
      "signedHash": "string",
      "data": "object",
      "signerVerificationToken": "string",
      "approvals": [
        {
          "id": "string",
          "role": "string",
          "data": "object",
          "accepted": "string (date-time)",
          "enforceCaptureSignature": "boolean",
          "signed": "string (date-time)",
          "optional": "boolean",
          "fields": [
            null
          ]
        }
      ]
    }
  ]
}

Package: object

updated: string (date-time)

Updated

timezoneId: string

TimezoneId

id: string

Id

trashed: boolean

Trashed

notaryRoleId: string

Notary Role

data: object

Data

autocomplete: boolean

Autocomplete

visibility: string ACCOUNT, SENDER

Visibility

sender: Sender

Sender

documents: Document

Documents

Document
consent: string

Consent

settings: PackageSettings

Settings

due: string (date-time)

Due

notarized: boolean

Notarized

emailMessage: string

EmailMessage

completed: string (date-time)

Completed

signedDocumentDelivery: SignedDocumentDelivery

SignedDocumentDelivery

limits: PackageArtifactsLimits

Limits

roles: Role

Roles

Role
type: string PACKAGE, TEMPLATE, LAYOUT

Type

created: string (date-time)

Created

messages: Message

Messages

Message
status: string DRAFT, SENT, COMPLETED, ARCHIVED, DECLINED, OPTED_OUT, EXPIRED

Status

description: string

Description

language: string

Language

name: string

Name

bulkSendable: boolean

BulkSendable

Example
{
  "updated": "string (date-time)",
  "timezoneId": "string",
  "id": "string",
  "trashed": "boolean",
  "notaryRoleId": "string",
  "data": "object",
  "autocomplete": "boolean",
  "visibility": "string",
  "sender": {
    "signature": {
      "textual": {
        "font": "string",
        "color": "string"
      },
      "handdrawn": "string"
    },
    "account": {
      "updated": "string (date-time)",
      "timezoneId": "string",
      "company": {
        "id": "string",
        "data": "object",
        "address": {
          "address1": "string",
          "address2": "string",
          "city": "string",
          "country": "string",
          "zipcode": "string",
          "state": "string"
        },
        "name": "string"
      },
      "created": "string (date-time)",
      "customFields": [
        {
          "id": "string",
          "data": "object",
          "translations": [
            {
              "id": "string",
              "data": "object",
              "description": "string",
              "language": "string",
              "name": "string"
            }
          ],
          "required": "boolean",
          "value": "string",
          "name": "string"
        }
      ],
      "logoAltTextKey": "string",
      "logoUrl": "string",
      "id": "string",
      "licenses": [
        {
          "created": "string (date-time)",
          "paidUntil": "string (date-time)",
          "transactions": [
            {
              "created": "string (date-time)",
              "creditCard": {
                "cvv": "string",
                "number": "string",
                "type": "string",
                "expiration": {
                  "month": "integer (int32)",
                  "year": "integer (int32)"
                },
                "name": "string"
              },
              "price": {
                "amount": "integer (int32)",
                "currency": {
                  "id": "string",
                  "data": "object",
                  "name": "string"
                }
              }
            }
          ],
          "plan": {
            "group": "string",
            "id": "string",
            "freeCycles": {
              "count": "integer (int32)",
              "cycle": "string"
            },
            "quotas": [
              {
                "scope": "string",
                "cycle": "string",
                "limit": "integer (int32)",
                "target": "string"
              }
            ],
            "cycle": "string",
            "contract": "string",
            "data": "object"
          }
        }
      ]
    }
  }
}

PackageArtifactsLimits: object

documents: integer (int32)

Documents

roles: integer (int32)

Roles

Example
{
  "documents": "integer (int32)",
  "roles": "integer (int32)"
}

PackageSettings: object

ceremony: CeremonySettings

Ceremony

Example
{
  "ceremony": {
    "extractTextTags": "boolean",
    "extractAcroFields": "boolean",
    "inPerson": "boolean",
    "ada": "boolean",
    "style": {
      "brandingBar": {
        "src": "string",
        "logoAltTextKey": "string",
        "link": "string"
      },
      "dialog": {
        "color": "string",
        "backgroundColor": "string"
      },
      "toolbar": {
        "color": "string",
        "backgroundColor": "string"
      },
      "titleBar": {
        "color": "string",
        "backgroundColor": "string"
      }
    },
    "layout": {
      "footer": "object",
      "iframe": "boolean",
      "brandingBar": {
        "logo": {
          "src": "string",
          "logoAltTextKey": "string",
          "link": "string"
        }
      },
      "navigator": "boolean",
      "header": {
        "feedback": "boolean",
        "globalActions": {
          "confirm": "boolean",
          "hideEvidenceSummary": "boolean",
          "saveAsLayout": "boolean",
          "download": "boolean"
        },
        "globalNavigation": "boolean",
        "sessionBar": "boolean",
        "titleBar": {
          "progressBar": "boolean",
          "title": "boolean"
        },
        "breadcrumbs": "boolean"
      }
    },
    "maxAuthFailsAllowed": "integer (int32)",
    "handOver": {
      "title": "string",
      "href": "string",
      "text": "string"
    },
    "enforceCaptureSignature": "boolean",
    "declineButton": "boolean",
    "declineReasons": [
      "string"
    ],
    "disableDeclineOther": "boolean",
    "disableDownloadForUncompletedPackage": "boolean",
    "disableFirstInPersonAffidavit": "boolean",
    "disableInPersonAffidavit": "boolean",
    "disableOptOutOther": "boolean",
    "disableSecondInPersonAffidavit": "boolean",
    "documentToolbarOptions": {
      "downloadButton": "boolean"
    },
    "events": {
      "complete": {
        "redirect": "string",
        "dialog": "boolean"
      }
    },
    "hideCaptureText": "boolean",
    "hideLanguageDropdown": "boolean",
    "hidePackageOwnerInPerson": "boolean",
    "hideWatermark": "boolean",
    "optOutButton": "boolean",
    "optOutReasons": [
      "string"
    ]
  }
}

Role: object

specialTypes: string[]

Special Signer Types

string NOTARY
locked: boolean

Locked

id: string

Id

data: object

Data

emailMessage: BaseMessage

EmailMessage

reassign: boolean

Reassign

attachmentRequirements: AttachmentRequirement

AttachmentRequirements

AttachmentRequirement
type: string SIGNER, SENDER

Type

index: integer (int32)

Index

signers: Signer

Signers

Signer
name: string

Name

Example
{
  "specialTypes": [
    "string"
  ],
  "locked": "boolean",
  "id": "string",
  "data": "object",
  "emailMessage": {
    "content": "string"
  },
  "reassign": "boolean",
  "attachmentRequirements": [
    {
      "id": "string",
      "status": "string",
      "description": "string",
      "required": "boolean",
      "comment": "string",
      "name": "string",
      "data": "object"
    }
  ],
  "type": "string",
  "index": "integer (int32)",
  "signers": [
    {
      "signature": {
        "textual": {
          "font": "string",
          "color": "string"
        },
        "handdrawn": "string"
      },
      "auth": {
        "challenges": [
          {
            "answer": "string",
            "question": "string",
            "maskInput": "boolean"
          }
        ],
        "scheme": "string"
      },
      "knowledgeBasedAuthentication": {
        "knowledgeBasedAuthenticationStatus": "string",
        "signerInformationForEquifaxCanada": {
          "firstName": "string",
          "lastName": "string",
          "city": "string",
          "dateOfBirth": "string (date-time)",
          "streetAddress": "string",
          "timeAtAddress": "integer (int32)",
          "province": "string",
          "postalCode": "string",
          "socialInsuranceNumber": "string",
          "homePhoneNumber": "string",
          "driversLicenseNumber": "string"
        },
        "signerInformationForEquifaxUSA": {
          "firstName": "string",
          "lastName": "string",
          "zip": "string",
          "city": "string",
          "dateOfBirth": "string (date-time)",
          "streetAddress": "string",
          "timeAtAddress": "integer (int32)",
          "socialSecurityNumber": "string",
          "homePhoneNumber": "string",
          "driversLicenseNumber": "string",
          "state": "string",
          "valid": "boolean"
        },
        "equifaxCanada": "boolean",
        "equifaxUSA": "boolean"
      },
      "delivery": {
        "email": "boolean",
        "provider": "boolean",
        "download": "boolean"
      },
      "signerType": "string",
      "group": {
        "account": {
          "updated": "string (date-time)",
          "timezoneId": "string",
          "company": {
            "id": "string",
            "data": "object",
            "address": {
              "address1": "string",
              "address2": "string",
              "city": "string",
              "country": "string",
              "zipcode": "string",
              "state": "string"
            },
            "name": "string"
          },
          "created": "string (date-time)",
          "customFields": [
            null
          ]
        }
      }
    }
  ]
}

SignedDocumentDelivery: object

destinations: External

Destinations

External
excludedDocuments: Document

ExcludedDocuments

Document
filePrefix: string

FilePrefix

fileSuffix: string

FileSuffix

Example
{
  "destinations": [
    {
      "id": "string",
      "providerName": "string",
      "provider": "string",
      "data": "object"
    }
  ],
  "excludedDocuments": [
    {
      "status": "string",
      "external": {
        "id": "string",
        "providerName": "string",
        "provider": "string",
        "data": "object"
      },
      "id": "string",
      "signedHash": "string",
      "data": "object",
      "signerVerificationToken": "string",
      "approvals": [
        {
          "id": "string",
          "role": "string",
          "data": "object",
          "accepted": "string (date-time)",
          "enforceCaptureSignature": "boolean",
          "signed": "string (date-time)",
          "optional": "boolean",
          "fields": [
            {
              "page": "integer (int32)",
              "binding": "string",
              "top": "number (double)",
              "id": "string",
              "subtype": "string",
              "data": "object",
              "extract": "boolean",
              "width": "number (double)",
              "height": "number (double)",
              "left": "number (double)",
              "extractAnchor": {
                "width": "integer (int32)",
                "height": "integer (int32)",
                "anchorPoint": "string",
                "characterIndex": "integer (int32)",
                "leftOffset": "integer (int32)",
                "topOffset": "integer (int32)",
                "index": "integer (int32)",
                "text": "string"
              },
              "validation": {
                "errorCode": "integer (int32)",
                "maxLength": "integer (int32)",
                "minLength": "integer (int32)",
                "errorMessage": "string",
                "enum": [
                  "string"
                ],
                "required": "boolean",
                "pattern": "string"
              },
              "type": "string",
              "value": "string",
              "name": "string"
            }
          ],
          "name": "string"
        }
      ],
      "extract": "boolean",
      "extractionTypes": [
        "string"
      ],
      "tagged": "boolean",
      "pages": [
        {
          "top": "number (double)",
          "id": "string",
          "width": "number (double)",
          "height": "number (double)",
          "left": "number (double)",
          "version": "integer (int32)",
          "index": "integer (int32)"
        }
      ],
      "fields": [
        {
          "page": "integer (int32)",
          "binding": "string",
          "top": "number (double)",
          "id": "string",
          "subtype": "string",
          "data": "object",
          "extract": "boolean",
          "width": "number (double)",
          "height": "number (double)",
          "left": "number (double)",
          "extractAnchor": {
            "width": "integer (int32)",
            "height": "integer (int32)"
          }
        }
      ]
    }
  ]
}

Signer: object

signature: SignatureStyle

Signature

auth: Auth

Auth

knowledgeBasedAuthentication: KnowledgeBasedAuthentication

KnowledgeBasedAuthentication

delivery: Delivery

Delivery

signerType: string ACCOUNT_SENDER, EXTERNAL_SENDER, EXTERNAL_SIGNER, GROUP_SIGNER

SignerType

group: Group

Group

updated: string (date-time)

Updated

userCustomFields: UserCustomField

UserCustomFields

UserCustomField
email: string

Email

company: string

Company

external: External

External

phone: string

Phone

professionalIdentityFields: ProfessionalIdentityField

ProfessionalIdentityFields

ProfessionalIdentityField
firstName: string

FirstName

lastName: string

LastName

id: string

Id

title: string

Title

data: object

Data

address: Address

Address

created: string (date-time)

Created

language: string

Language

name: string

Name

timezoneId: string

TimezoneId

specialTypes: string[]

Special User Types

string NOTARY
Example
{
  "signature": {
    "textual": {
      "font": "string",
      "color": "string"
    },
    "handdrawn": "string"
  },
  "auth": {
    "challenges": [
      {
        "answer": "string",
        "question": "string",
        "maskInput": "boolean"
      }
    ],
    "scheme": "string"
  },
  "knowledgeBasedAuthentication": {
    "knowledgeBasedAuthenticationStatus": "string",
    "signerInformationForEquifaxCanada": {
      "firstName": "string",
      "lastName": "string",
      "city": "string",
      "dateOfBirth": "string (date-time)",
      "streetAddress": "string",
      "timeAtAddress": "integer (int32)",
      "province": "string",
      "postalCode": "string",
      "socialInsuranceNumber": "string",
      "homePhoneNumber": "string",
      "driversLicenseNumber": "string"
    },
    "signerInformationForEquifaxUSA": {
      "firstName": "string",
      "lastName": "string",
      "zip": "string",
      "city": "string",
      "dateOfBirth": "string (date-time)",
      "streetAddress": "string",
      "timeAtAddress": "integer (int32)",
      "socialSecurityNumber": "string",
      "homePhoneNumber": "string",
      "driversLicenseNumber": "string",
      "state": "string",
      "valid": "boolean"
    },
    "equifaxCanada": "boolean",
    "equifaxUSA": "boolean"
  },
  "delivery": {
    "email": "boolean",
    "provider": "boolean",
    "download": "boolean"
  },
  "signerType": "string",
  "group": {
    "account": {
      "updated": "string (date-time)",
      "timezoneId": "string",
      "company": {
        "id": "string",
        "data": "object",
        "address": {
          "address1": "string",
          "address2": "string",
          "city": "string",
          "country": "string",
          "zipcode": "string",
          "state": "string"
        },
        "name": "string"
      },
      "created": "string (date-time)",
      "customFields": [
        {
          "id": "string",
          "data": "object",
          "translations": [
            {
              "id": "string",
              "data": "object",
              "description": "string",
              "language": "string",
              "name": "string"
            }
          ],
          "required": "boolean",
          "value": "string",
          "name": "string"
        }
      ],
      "logoAltTextKey": "string",
      "logoUrl": "string",
      "id": "string",
      "licenses": [
        {
          "created": "string (date-time)",
          "paidUntil": "string (date-time)",
          "transactions": [
            null
          ]
        }
      ]
    }
  }
}

SignerInformationForEquifaxCanada: object

firstName: string

FirstName

lastName: string

LastName

city: string

City

dateOfBirth: string (date-time)

DateOfBirth

streetAddress: string

StreetAddress

timeAtAddress: integer (int32)

TimeAtAddress

province: string

Province

postalCode: string

PostalCode

socialInsuranceNumber: string

SocialInsuranceNumber

homePhoneNumber: string

HomePhoneNumber

driversLicenseNumber: string

DriversLicenseNumber

Example
{
  "firstName": "string",
  "lastName": "string",
  "city": "string",
  "dateOfBirth": "string (date-time)",
  "streetAddress": "string",
  "timeAtAddress": "integer (int32)",
  "province": "string",
  "postalCode": "string",
  "socialInsuranceNumber": "string",
  "homePhoneNumber": "string",
  "driversLicenseNumber": "string"
}

SignerInformationForEquifaxUSA: object

firstName: string

FirstName

lastName: string

LastName

zip: string

Zip

city: string

City

dateOfBirth: string (date-time)

DateOfBirth

streetAddress: string

StreetAddress

timeAtAddress: integer (int32)

TimeAtAddress

socialSecurityNumber: string

SocialSecurityNumber

homePhoneNumber: string

HomePhoneNumber

driversLicenseNumber: string

DriversLicenseNumber

state: string

State

valid: boolean
Example
{
  "firstName": "string",
  "lastName": "string",
  "zip": "string",
  "city": "string",
  "dateOfBirth": "string (date-time)",
  "streetAddress": "string",
  "timeAtAddress": "integer (int32)",
  "socialSecurityNumber": "string",
  "homePhoneNumber": "string",
  "driversLicenseNumber": "string",
  "state": "string",
  "valid": "boolean"
}

Style: object

color: string

Color

backgroundColor: string

BackgroundColor

Example
{
  "color": "string",
  "backgroundColor": "string"
}

TitleBarOptions: object

progressBar: boolean

ProgressBar

title: boolean

Title

Example
{
  "progressBar": "boolean",
  "title": "boolean"
}

User: object

signature: SignatureStyle

Signature

updated: string (date-time)

Updated

timezoneId: string

TimezoneId

userCustomFields: UserCustomField

UserCustomFields

UserCustomField
company: string

Company

external: External

External

phone: string

Phone

professionalIdentityFields: ProfessionalIdentityField

ProfessionalIdentityFields

ProfessionalIdentityField
specialTypes: string[]

Special User Types

string NOTARY
created: string (date-time)

Created

email: string

Email

firstName: string

FirstName

lastName: string

LastName

id: string

Id

title: string

Title

data: object

Data

address: Address

Address

language: string

Language

name: string

Name

Example
{
  "signature": {
    "textual": {
      "font": "string",
      "color": "string"
    },
    "handdrawn": "string"
  },
  "updated": "string (date-time)",
  "timezoneId": "string",
  "userCustomFields": [
    {
      "id": "string",
      "data": "object",
      "translations": [
        {
          "id": "string",
          "data": "object",
          "description": "string",
          "language": "string",
          "name": "string"
        }
      ],
      "value": "string",
      "name": "string"
    }
  ],
  "company": "string",
  "external": {
    "id": "string",
    "providerName": "string",
    "provider": "string",
    "data": "object"
  },
  "phone": "string",
  "professionalIdentityFields": [
    {
      "id": "string",
      "category": "string",
      "data": "object",
      "translations": [
        {
          "id": "string",
          "data": "object",
          "description": "string",
          "language": "string",
          "name": "string"
        }
      ],
      "type": "string",
      "value": "string",
      "name": "string"
    }
  ],
  "specialTypes": [
    "string"
  ],
  "created": "string (date-time)",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "id": "string",
  "title": "string",
  "data": "object",
  "address": {
    "address1": "string",
    "address2": "string",
    "city": "string",
    "country": "string",
    "zipcode": "string",
    "state": "string"
  },
  "language": "string",
  "name": "string"
}

Layout: object

updated: string (date-time)

Updated

id: string

Id

data: object

Data

autocomplete: boolean

Autocomplete

visibility: string ACCOUNT, SENDER

Visibility

sender: Sender

Sender

documents: Document

Documents

Document
consent: string

Consent

settings: PackageSettings

Settings

due: string (date-time)

Due

notarized: boolean

Notarized

emailMessage: string

EmailMessage

signedDocumentDelivery: SignedDocumentDelivery

SignedDocumentDelivery

limits: PackageArtifactsLimits

Limits

roles: Role

Roles

Role
type: string PACKAGE, TEMPLATE, LAYOUT

Type

created: string (date-time)

Created

messages: Message

Messages

Message
status: string DRAFT, SENT, COMPLETED, ARCHIVED, DECLINED, OPTED_OUT, EXPIRED

Status

description: string

Description

language: string

Language

name: string

Name

timezoneId: string

TimezoneId

notaryRoleId: string

Notary Role

bulkSendable: boolean

BulkSendable

Example
{
  "updated": "string (date-time)",
  "id": "string",
  "data": "object",
  "autocomplete": "boolean",
  "visibility": "string",
  "sender": {
    "signature": {
      "textual": {
        "font": "string",
        "color": "string"
      },
      "handdrawn": "string"
    },
    "account": {
      "updated": "string (date-time)",
      "timezoneId": "string",
      "company": {
        "id": "string",
        "data": "object",
        "address": {
          "address1": "string",
          "address2": "string",
          "city": "string",
          "country": "string",
          "zipcode": "string",
          "state": "string"
        },
        "name": "string"
      },
      "created": "string (date-time)",
      "customFields": [
        {
          "id": "string",
          "data": "object",
          "translations": [
            {
              "id": "string",
              "data": "object",
              "description": "string",
              "language": "string",
              "name": "string"
            }
          ],
          "required": "boolean",
          "value": "string",
          "name": "string"
        }
      ],
      "logoAltTextKey": "string",
      "logoUrl": "string",
      "id": "string",
      "licenses": [
        {
          "created": "string (date-time)",
          "paidUntil": "string (date-time)",
          "transactions": [
            {
              "created": "string (date-time)",
              "creditCard": {
                "cvv": "string",
                "number": "string",
                "type": "string",
                "expiration": {
                  "month": "integer (int32)",
                  "year": "integer (int32)"
                },
                "name": "string"
              },
              "price": {
                "amount": "integer (int32)",
                "currency": {
                  "id": "string",
                  "data": "object",
                  "name": "string"
                }
              }
            }
          ],
          "plan": {
            "group": "string",
            "id": "string",
            "freeCycles": {
              "count": "integer (int32)",
              "cycle": "string"
            },
            "quotas": [
              {
                "scope": "string",
                "cycle": "string",
                "limit": "integer (int32)",
                "target": "string"
              }
            ],
            "cycle": "string",
            "contract": "string",
            "data": "object",
            "price": {
              "amount": "integer (int32)"
            }
          }
        }
      ]
    }
  }
}

NotaryJournalEntry: object

sequenceNumber: integer (int32)

Sequence Number

creationDate: string (date-time)

Date

documentType: string

Document Type

documentName: string

Document Name

signerName: string

Signer Name

signatureType: string

Signature Type

idType: string

Identification Type

idValue: string

Identification Value

jurisdiction: string

Jurisdiction

comment: string

Comment

Example
{
  "sequenceNumber": "integer (int32)",
  "creationDate": "string (date-time)",
  "documentType": "string",
  "documentName": "string",
  "signerName": "string",
  "signatureType": "string",
  "idType": "string",
  "idValue": "string",
  "jurisdiction": "string",
  "comment": "string"
}

PackageReminder: object

sentDate: string (date-time)

SentDate

date: string (date-time)

Date

Example
{
  "sentDate": "string (date-time)",
  "date": "string (date-time)"
}

PackageReminderSchedule: object

packageId: string

PackageId

startInDaysDelay: integer (int32)

StartInDaysDelay

repetitionsCount: integer (int32)

RepetitionsCount

intervalInDays: integer (int32)

IntervalInDays

reminders: PackageReminder

Reminders

PackageReminder
Example
{
  "packageId": "string",
  "startInDaysDelay": "integer (int32)",
  "repetitionsCount": "integer (int32)",
  "intervalInDays": "integer (int32)",
  "reminders": [
    {
      "sentDate": "string (date-time)",
      "date": "string (date-time)"
    }
  ]
}

Error: object

Example
"object"

Errors: object

errors: Error
Error
messageKeys: string[]
string
firstError: Error
Example
{
  "errors": [
    "object"
  ],
  "messageKeys": [
    "string"
  ],
  "firstError": "object"
}

PackageFeature: object

attachmentRequirements: boolean
changeSigner: boolean
groupSigning: boolean
notarized: boolean
optOut: boolean
handOverUrl: boolean
certificateSigning: boolean
externalVerification: boolean
inPerson: boolean
decline: boolean
ada: boolean
clickToSign: boolean
clickToInitial: boolean
captureSignature: boolean
mobileCaptureSignature: boolean
sendToMobile: boolean
signingDate: boolean
signerName: boolean
signerTitle: boolean
signerCompany: boolean
text: boolean
textArea: boolean
checkbox: boolean
customField: boolean
notaryField: boolean
radio: boolean
list: boolean
date: boolean
Example
{
  "attachmentRequirements": "boolean",
  "changeSigner": "boolean",
  "groupSigning": "boolean",
  "notarized": "boolean",
  "optOut": "boolean",
  "handOverUrl": "boolean",
  "certificateSigning": "boolean",
  "externalVerification": "boolean",
  "inPerson": "boolean",
  "decline": "boolean",
  "ada": "boolean",
  "clickToSign": "boolean",
  "clickToInitial": "boolean",
  "captureSignature": "boolean",
  "mobileCaptureSignature": "boolean",
  "sendToMobile": "boolean",
  "signingDate": "boolean",
  "signerName": "boolean",
  "signerTitle": "boolean",
  "signerCompany": "boolean",
  "text": "boolean",
  "textArea": "boolean",
  "checkbox": "boolean",
  "customField": "boolean",
  "notaryField": "boolean",
  "radio": "boolean",
  "list": "boolean",
  "date": "boolean"
}

Verification: object

payload: string

Payload

typeId: string

TypeId

Example
{
  "payload": "string",
  "typeId": "string"
}

VerificationUrl: object

callbackUrl: string

callbackUrl

url: string

url

documentId: string

DocumentId

Example
{
  "callbackUrl": "string",
  "url": "string",
  "documentId": "string"
}