Scrive Document API

nl_idin `(object)`

onfido `(object)`

swisscom `(object)`

`view_archived` `(object)`

This setting forces signatories to authenticate using the supplied identification method to view the document once it has been signed and resides in the e-archive.

Will be overridden by authentication_method_to_view_archived property when both are present.

The view_archived object has the following properties:

`name` `(string, enum, required)`

The value of this property must be one of the following enum values:

"standard"
"sms_pin"
"dk_mitid"
"dk_mitid_erhverv"
"fi_tupas"
"freja"
"nl_idin"
"no_bankid"
"onfido"
"onfido_document_check"
"onfido_document_and_photo_check"
"se_bankid"
"verimi"

`settings`

Schema of this object depends on selected authentication name.

The value of this property must match exactly one of the following schemas:

freja `(object)`

nl_idin `(object)`

onfido `(object)`

`authentication_method_to_view` `(string, enum)`

This setting forces signatories to authenticate using the supplied identification method to view the document before signing.

Default: "standard"

The value of this property must be one of the following enum values:

"standard"
"sms_pin"
"dk_mitid"
"dk_mitid_erhverv"
"fi_tupas"
"freja"
"nl_idin"
"no_bankid"
"onfido"
"onfido_document_check"
"onfido_document_and_photo_check"
"se_bankid"
"verimi"

`authentication_method_to_view_archived` `(string, enum)`

This setting forces signatories to authenticate using the supplied identification method to view the document once it has been signed and resides in the e-archive.

Default: "standard"

The value of this property must be one of the following enum values:

"standard"
"sms_pin"
"dk_mitid"
"dk_mitid_erhverv"
"fi_tupas"
"freja"
"nl_idin"
"no_bankid"
"onfido"
"onfido_document_check"
"onfido_document_and_photo_check"
"se_bankid"
"verimi"

`authentication_method_to_sign` `(string, enum)`

This setting forces user to authenticate to sign.

Default: "standard"

The value of this property must be one of the following enum values:

"standard"
"sms_pin"
"sms_otp"
"dk_mitid"
"dk_mitid_erhverv"
"fi_tupas"
"freja"
"nl_idin"
"no_bankid"
"onfido"
"onfido_document_check"
"onfido_document_and_photo_check"
"se_bankid"
"swisscom_qes"
"swisscom_qes_with_srs"
"verimi_qes"
"itsme"
"itsme_qes"
"smart_id_qes"

`confirmation_delivery_method` `(string, enum)`

Deliver a confirmation message about the document signing status by:

email an email including a file attachment of the signed document
mobile a text message with a link to the signed document
email_mobile both of the two above
email_link an email with a link to the signed document
email_link_mobile an email and a text message with a link to the signed document
none no delivery at all

Default: "email"

The value of this property must be one of the following enum values:

"email"
"mobile"
"email_mobile"
"email_link"
"email_link_mobile"
"none"

`notification_delivery_method` `(string, enum)`

Deliver a confirmation notification that the party signed/approved the document by:

email an email including a link to the document
mobile a text message including a link to the document
email_mobile both of the two above
none no delivery at all

Default: "none"

The value of this property must be one of the following enum values:

"email"
"mobile"
"email_mobile"
"none"

`allows_highlighting` `(boolean)`

Whether the signatory can highlight pages of the PDF when viewing the signing page.

If any highlights are performed, the evidence log states that they were performed while the signatory was viewing the document.

The intention of this feature is not for the signatory to affect a contract via highlighting, but simply for a point-of-sale situation to assist contract review.

Default: false

`hide_personal_number` `(boolean)`

Whether the personal number should be hidden in the final PDF verification page and the Evidence Log.

This is to be used when the document will be distributed to a wider audience, and the personal number of the signatory should not be available in the final document.

If the signatory has a placed field for their personal number, it will be included in the final PDF. So this solution only works when the field does not have any placements.

Default: false

`can_forward` `(boolean)`

Whether the signatory can forward the signing process to someone else.

Default: false

`highlighted_pages` `(array, read only)`

A list of highlights performed by the signatory.

While a document is pending, highlights may be added, but will not appear in the document file PDF until after the document is closed.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`page` `(integer)`

The page number which is highlighted (starts from 1). Each signatory can only have one highlight per page.

`file_id` `(string)`

The file_id for an image of the highlights.

The image dimensions will fit the ratio of the PDF page, and will be of a fixed colour and transparency.

This will be integrated into the final PDF once the document is closed.

`attachments` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

A signatory attachment - an attachment requested from the signing party. Attachments requested from viewing only parties have no effect.

This object has the following properties:

`name` `(string)`

A name for the requested attachment. Will be visible to the signatory when signing the document.

`description` `(string)`

A description for the requested attachment. Will be visible to the signatory when signing the document alongside the attachment name.

`required` `(boolean)`

Whether the signatory must upload this attachment. If false, the signatory may choose not to upload this attachment when signing.

Default: true

`file_id` `(string)`

Will be present if and when the party uploads this attachment.

`file_name` `(string)`

Will be present if and when the party uploads this attachment.

`add_to_sealed_file` `(boolean)`

Should the file of this attachment be merged into the final sealed document?

Default: true

`api_delivery_url` `(string,null)`

If the delivery_method is set to api, then this field will hold the relative URL for the party.

Note that api delivery is referred to as "Link" delivery in the Scrive Web interface.

This will only be available after the signing process has been started, and will only be visible when accessing the document as the author.

`consent_module`

The value of this property must match exactly one of the following schemas:

`(null)`

`(object)`

If present, a section will be shown asking the signatory to answer some questions which must be answered by the signatory with either the positive or the negative option specified.

This object has the following properties:

`title` `(string)`

Section title.

`questions` `(array)`

All array elements must be of type:

`(object)`

This object has the following properties:

`title` `(string)`

Question text.

`positive_option` `(string)`

`negative_option` `(string)`

`response` `(boolean)`

Will be present when the party has answered the question. true when the signatory selected the positive response and false when the signatory selected the negative response.

`detailed_description` `(object)`

Optional additional information to show the signatory.

The detailed_description object has the following properties:

`title` `(string)`

Title of the section. Will be shown in a button.

`text` `(string)`

Explanation of the question. New lines are shown as is.

`is_visible` `(bool,null)`

Determines if an approver is visible on the verification page and in sign view.

This value is only used for approvers. It has to be null for viewer and signing_party signatories.

Default: "null"

`document_roles` `(array)`

List of "roles" this signatory has within the document.

The individual roles can be arbitrary texts (often in local language of the document). Those roles (if specified) will be part of the evidence log and also will be displayed in sign view (user signs/approves the document in the following roles).

Default:
[]

All array elements must be of type:

`(string)`

`experimental` `(object)`

⚠️ WARNING: EXPERIMENTAL ⚠️

Experimental properties are not part of public API. Therefore they're not supported and are subject to change without prior notice.

The experimental object has the following properties:

`signatory_status` `(string, enum, read only)`

The current status of the signatory in relation to the document.

The statuses document_problem, document_draft, document_canceled, document_timedout and document_rejected are reflecting the status field of the underlying document for convenience.

The value of this property must be one of the following enum values:

"document_problem"
"document_draft"
"document_canceled"
"document_timedout"
"document_rejected"
"waiting_for_prior_signatures"
"invitation_sent"
"invitation_delivery_problem"
"invitation_delivered"
"invitation_read"
"document_opened"
"document_deferred"
"document_signed"
"document_approved"
"confirmation_delivery_problem"

`file` `(object)`

A file that can be accessed using the API call to download related files.

The file object has the following properties:

`id` `(string, read only)`

`name` `(string, read only)`

`sealed_file`

The cryptographically sealed file.

Will only exist for documents that have been closed. This field may be null for a short period of time after a document has been signed by all parties, while the Scrive eSign system seals the document.

The value of this property must match exactly one of the following schemas:

`(null)`

File `(object)`

A file that can be accessed using the API call to download related files.

This object has the following properties:

`id` `(string, read only)`

`name` `(string, read only)`

`author_attachments` `(array, read only)`

List of author attachments.

These documents are to be reviewed by the signatory parties, and are uploaded by the author of the document. Can be updated during document preparation using the "set author attachments" (/{document_id}/setattachments) API call.

All array elements must be of type:

`(object)`

This object has the following properties:

`name` `(string, read only)`

`required` `(boolean, read only)`

`add_to_sealed_file` `(boolean, read only)`

`file_id` `(string)`

`ctime` `(string, read only)`

Time at which the document was created.

`mtime` `(string, read only)`

Latest time at which the document was modified.

`timeout_time` `(string,null, read only)`

Time after which the document will timeout if it has not been signed.

`auto_remind_time` `(string,null, read only)`

`status` `(string, enum)`

The current document status.

A document in "preparation" can be changed using the update call and the main file can also be set or changed.

Once the document signing process has begun, the document will be "pending". However if the document was started using bulk send feature, it will first transition into "awaiting_start", and shortly after that into "pending".

Documents in "awaiting_start" cannot be modified, trashed or canceled.

Once all parties have successfully signed the document is "closed" and cannot be changed.

The value of this property must be one of the following enum values:

"preparation"
"awaiting_start"
"pending"
"closed"
"canceled"
"timedout"
"rejected"
"document_error"

`days_to_sign` `(integer)`

Default: 90

`days_to_remind` `(integer,null)`

`display_options` `(object)`

The display_options object has the following properties:

`show_header` `(boolean)`

Whether to show the Scrive header on the signing page.

`show_pdf_download` `(boolean)`

Whether to show an option to download the PDF on the signing page.

`show_reject_option` `(boolean)`

Whether to allow signatories to reject a document.

`allow_reject_reason` `(boolean)`

Whether to allow signatories to enter a plain text reason for rejecting a document.

`show_footer` `(boolean)`

Whether to show the Scrive footer on the signing page.

`document_is_receipt` `(boolean)`

Whether the document is a receipt to be printed out, and thus should not have the verification footer added.

Note: This reduces the durability of evidence for a document signed through Scrive eSign, and should only be used when absolutely necessary.

`show_arrow` `(boolean)`

Whether to show the auto-scroll arrow on the signing page.

`show_form` `(boolean)`

Whether to show the fields as a form on the signing page.

`show_form_arrow` `(boolean)`

Whether to show the auto-scroll arrow on the form page.

`invitation_message` `(string)`

The invitation message to send to all parties at the start of the signing process when using email invitation.

Default is blank meaning that a default message will be used.

Default: ""

`sms_invitation_message` `(string)`

The invitation message to send to all parties at the start of the signing process when using SMS invitation.

Default is blank meaning that a default message will be used.

Default: ""

`confirmation_message` `(string)`

The confirmation message to send to all parties once the document has been signed.

Default is blank meaning that a default message will be used.

Default: ""

`sms_confirmation_message` `(string)`

The confirmation message to send to all parties once the document has been signed when using SMS confirmation.

Default is blank meaning that a default message will be used.

Default: ""

`lang` `(string, enum)`

Currently supported language codes

The value of this property must be one of the following enum values:

"cs"
"da"
"de"
"el"
"en"
"es"
"et"
"fi"
"fr"
"hu"
"is"
"it"
"lt"
"lv"
"nl"
"no"
"pl"
"pt"
"sv"

`api_callback_url` `(string,null)`

The URL to perform an API callback request.

Please see Callbacks for details.

`object_version` `(integer, read only)`

The document object version is auto-incremented by the Scrive eSign system each time an action is performed on it.

Therefore this can be used as a rudimentary synchronisation mechanism to ensure you are handling a document that has not changed.

It is not recommended to use this field unless you are building an application with offline capabilities.

Additional restrictions:

`access_token` `(string, read only)`

`timezone` `(string)`

`tags` `(array)`

User defined set of names and values.

See Document Tags for more details.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`name` `(string)`

`value` `(string)`

`is_template` `(boolean)`

`is_saved` `(boolean)`

A ‘saved’ document will appear in the E-archive.

`is_shared` `(boolean, read only)`

`is_trashed` `(boolean, read only)`

`is_deleted` `(boolean, read only)`

`viewer` `(object)`

The viewer object has the following properties:

`role` `(string, enum)`

The value of this property must be one of the following enum values:

"company_shared"
"company_admin"
"signatory"

`signatory_id` `(string)`

`experimental_features` `(object)`

⚠️ WARNING: EXPERIMENTAL ⚠️

Experimental properties are not part of public API. Therefore they're not supported and are subject to change without prior notice.

The experimental_features object has the following properties:

`signatory_status_summary` `(string, enum, read only)`

The document status in relation to its signatories.

The statuses document_template, document_problem, document_draft, document_signed, document_canceled, document_timedout and document_rejected are reflecting the status field of the underlying document for convenience.

A document with document_opened has been opened by all of its signatories.

A document with invitations_read has all of its signatories having read the invitations to sign or approve. Some might have opened the document as well, but not all.

A document with invitations_delivered has all the invitations delivered.

A document with invitation_delivery_problem has some invitation with a delivery problem.

A document with invitation_sent has all invitations sent but not all delivered neither opened or read.

When several signing stages (a.k.a. invitation orders) are defined for the document, only the signatories in the current and previous stages are taken into account to determine the status.

The value of this property must be one of the following enum values:

"document_template"
"document_problem"
"document_draft"
"invitations_sent"
"invitations_delivered"
"invitation_delivery_problem"
"invitations_read"
"document_opened"
"document_signed"
"document_canceled"
"document_timedout"
"document_rejected"

User group

The user group metadata as a JSON.

UserGroup

(object)

Example JSON: for "UserGroup"

{
  "id": "1",
  "parent_id": null,
  "name": "A Root Usergroup",
  "children": [
    {
      "id": "2",
      "name": "Some child user group"
    },
    {
      "id": "3",
      "name": "Yet another child user group"
    }
  ],
  "settings": {
    "inherited_from": null,
    "data_retention_policy": {
      "idle_doc_timeout_preparation": null,
      "idle_doc_timeout_closed": null,
      "idle_doc_timeout_canceled": 42,
      "idle_doc_timeout_timedout": null,
      "idle_doc_timeout_rejected": null,
      "idle_doc_timeout_error": null,
      "immediate_trash": false
    }
  },
  "contact_details": {
    "inherited_from": null,
    "address": {
      "company_number": "5568166804",
      "company_name": "Scrive",
      "address": "Grev Turegatan 11A",
      "zip": "114 46",
      "city": "Stockholm",
      "country": "Sweden"
    }
  },
  "tags": [
    {
      "name": "alignment",
      "value": "chaotic good"
    }
  ]
}

JSON representation of a User Group.

This object has the following properties:

`id` `(string)`

`parent_id` `(string)`

`name` `(string)`

`children` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`id` `(string)`

`name` `(string)`

`settings` `(object)`

JSON representation of a User Group's Settings.

The settings object has the following properties:

`inherited_from` `(string)`

`data_retention_policy` `(object)`

The data_retention_policy object has the following properties:

`idle_doc_timeout_preparation` `(integer)`

Number of days to retain the document after preparation

`idle_doc_timeout_closed` `(integer)`

Number of days to retain the document after closed

`idle_doc_timeout_canceled` `(integer)`

Number of days to retain the document after canceled

`idle_doc_timeout_timedout` `(integer)`

Number of days to retain the document after timedout

`idle_doc_timeout_rejected` `(integer)`

Number of days to retain the document after rejected

`idle_doc_timeout_error` `(integer)`

Number of days to retain the document after error

`immediate_trash` `(boolean)`

`contact_details` `(object)`

JSON representation of a User Group's Contact Details.

The contact_details object has the following properties:

`inherited_from` `(string)`

`address` `(object)`

The address object has the following properties:

`company_number` `(string)`

`company_name` `(string)`

`address` `(string)`

`zip` `(string)`

`city` `(string)`

`country` `(string)`

`tags` `(array)`

User defined set of name/value pairs.

Each tag must have {"name": "some-name", "value": "some-value"} format. In the responses value is always a string. In the requests you can also provide null value to delete a tag. Other value types lead to 400 Bad Request response.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`name` `(string)`

`value` `(string)`

User group with inheritable previews

The user group metadata as a JSON (with Inheritable Previews).

UserGroupWithInheritable

(object)

Example JSON: for "UserGroupWithInheritable"

{
  "id": "5",
  "parent_id": "1",
  "name": "A Child Usergroup",
  "children": [
    {
      "id": "2",
      "name": "Some child user group"
    },
    {
      "id": "3",
      "name": "Yet another child user group"
    }
  ],
  "settings": {
    "inherited_from": null,
    "data_retention_policy": {
      "idle_doc_timeout_preparation": null,
      "idle_doc_timeout_closed": null,
      "idle_doc_timeout_canceled": 42,
      "idle_doc_timeout_timedout": null,
      "idle_doc_timeout_rejected": null,
      "idle_doc_timeout_error": null,
      "immediate_trash": false
    },
    "inheritable_preview": {
      "inherited_from": "1",
      "data_retention_policy": {
        "idle_doc_timeout_preparation": null,
        "idle_doc_timeout_closed": null,
        "idle_doc_timeout_canceled": null,
        "idle_doc_timeout_timedout": null,
        "idle_doc_timeout_rejected": 23,
        "idle_doc_timeout_error": null,
        "immediate_trash": true
      }
    }
  },
  "contact_details": {
    "inherited_from": "1",
    "address": {
      "company_number": "5568166804",
      "company_name": "Scrive",
      "address": "Grev Turegatan 11A",
      "zip": "114 46",
      "city": "Stockholm",
      "country": "Sweden"
    },
    "inheritable_preview": {
      "inherited_from": "1",
      "address": {
        "company_number": "5568166804",
        "company_name": "Scrive",
        "address": "Grev Turegatan 11A",
        "zip": "114 46",
        "city": "Stockholm",
        "country": "Sweden"
      }
    }
  },
  "tags": [
    {
      "name": "home-planet",
      "value": "Earth"
    }
  ]
}

JSON representation of a User Group (with Inheritable Previews).

This object has the following properties:

`id` `(string)`

`parent_id` `(string)`

`name` `(string)`

`children` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`id` `(string)`

`name` `(string)`

`settings` `(object)`

JSON representation of a User Group's Settings (with Inheritable Preview).

The settings object has the following properties:

`inherited_from` `(string)`

`data_retention_policy` `(object)`

The data_retention_policy object has the following properties:

`idle_doc_timeout_preparation` `(integer)`

Number of days to retain the document after preparation

`idle_doc_timeout_closed` `(integer)`

Number of days to retain the document after closed

`idle_doc_timeout_canceled` `(integer)`

Number of days to retain the document after canceled

`idle_doc_timeout_timedout` `(integer)`

Number of days to retain the document after timedout

`idle_doc_timeout_rejected` `(integer)`

Number of days to retain the document after rejected

`idle_doc_timeout_error` `(integer)`

Number of days to retain the document after error

`immediate_trash` `(boolean)`

`inheritable_preview` `(object)`

The inheritable_preview object has the following properties:

`inherited_from` `(string)`

`data_retention_policy` `(object)`

The data_retention_policy object has the following properties:

`idle_doc_timeout_preparation` `(integer)`

Number of days to retain the document after preparation

`idle_doc_timeout_closed` `(integer)`

Number of days to retain the document after closed

`idle_doc_timeout_canceled` `(integer)`

Number of days to retain the document after canceled

`idle_doc_timeout_timedout` `(integer)`

Number of days to retain the document after timedout

`idle_doc_timeout_rejected` `(integer)`

Number of days to retain the document after rejected

`idle_doc_timeout_error` `(integer)`

Number of days to retain the document after error

`immediate_trash` `(boolean)`

`contact_details` `(object)`

JSON representation of a User Group's Contact Details (with Inheritable Preview).

The contact_details object has the following properties:

`inherited_from` `(string)`

`address` `(object)`

The address object has the following properties:

`company_number` `(string)`

`company_name` `(string)`

`address` `(string)`

`zip` `(string)`

`city` `(string)`

`country` `(string)`

`inheritable_preview` `(object)`

The inheritable_preview object has the following properties:

`inherited_from` `(string)`

`address` `(object)`

The address object has the following properties:

`company_number` `(string)`

`company_name` `(string)`

`address` `(string)`

`zip` `(string)`

`city` `(string)`

`country` `(string)`

`tags` `(array)`

User defined set of name/value pairs.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`name` `(string)`

`value` `(string)`

API error

The JSON structured errors returned by the API.

API Error

(object)

Example JSON: for "API Error"

{
  "error_type": "request_parameters_parse_error",
  "error_message": "The parameter 'document' could not be parsed. Please refer to our API documentation.",
  "http_code": 400,
  "error_detail": {
    "parameter": "document",
    "value": "{\n  title:  \"document\"\n}",
    "parse_error": [
      "Invalid JSON: Error in $: Failed reading: satisfy. Expecting object key at 'title:document'"
    ]
  }
}

The structure of errors returned by the Scrive Document API.

This object has the following properties:

`error_type` `(string, enum)`

The value of this property must be one of the following enum values:

"action_not_permitted"
"conflict_error"
"document_action_forbidden"
"document_object_version_mismatch"
"document_state_error"
"endpoint_not_found"
"insufficient_privileges"
"invalid_authorisation"
"obsolete"
"payload_too_large"
"rate_limited"
"request_failed"
"request_parameters_invalid"
"request_parameters_missing"
"request_parameters_parse_error"
"resource_gone"
"resource_not_found"
"server_error"
"signatory_state_error"

`error_message` `(string)`

`http_code` `(integer, enum)`

The value of this property must be one of the following enum values:

400
401
403
404
409
410
413
429
500
603

`error_detail` `(any)`

Arbitrary JSON value unless endpoint documentation specifies otherwise. This property is meant to to aid developers/API integrators to figure out what caused an error and it's not meant to be interpreted by API integration.

Bulk send descriptor

The bulk send data as a JSON.

Bulk send descriptor

(object)

Example JSON: for "Bulk send descriptor"

{
  "id": "314",
  "name": "Rent contract prolongation",
  "created_at": "2022-07-12T17:19:56.126709Z",
  "documents": [
    {
      "document_id": "7769",
      "status": "scheduled"
    },
    {
      "document_id": "7770",
      "status": "started"
    },
    {
      "document_id": "7770",
      "status": "cancelled"
    }
  ]
}

Details about bulk send and its progress.

This object has the following properties:

`id` `(string)`

Unique identifier of a bulk send.

Will not change over time, and cannot be changed.

`name` `(string)`

Label provided during bulk send call.

Usually, it will likely correlate with the name of the document.

`created_at` `(string)`

Date and time of bulk send creation.

`documents` `(array)`

List of related documents and their sendout status.

All array elements must be of type:

`(object)`

This object has the following properties:

`document_id` `(string)`

Unique identifier of a document.

`status` `(string)`

Sendout status of a document.

The value of this property must match exactly one of the following schemas:

`(string)`

Document is waiting to be started. Depending on the number of documents in the bulk send, this can take a few minutes.

Value: "scheduled"

`(string)`

Document signing process was successfully started.

Value: "started"

`(string)`

Document start was aborted due to unexpected errors.

For more information, please contact Scrive support and include the bulk send ID and the document ID.

Value: "cancelled"

Bulk send list descriptor

JSON array of recent bulk send calls.

Bulk send list descriptor

(array)

Example JSON: for "Bulk send list descriptor"

[
  {
    "id": "314",
    "name": "Rent contract prolongation",
    "created_at": "2022-07-12T17:19:56.126709Z"
  }
]

Lists basic information about recent bulk send calls.

All array elements must be of type:

`(object)`

This object has the following properties:

`id` `(string)`

Unique identifier of a bulk send.

Will not change over time, and cannot be changed.

`name` `(string)`

Label provided during bulk send call.

Usually, it will likely correlate with the name of the document.

`created_at` `(string)`

Date and time of bulk send creation.

Definitions

Document

(object)

Example JSON: for "Document"

{
  "id": "8222115557375075439",
  "title": "Contract for Magnus",
  "parties": [
    {
      "id": "189255",
      "user_id": "1404",
      "is_author": true,
      "is_signatory": false,
      "signatory_role": "viewer",
      "signatory_status": "invitation_sent",
      "fields": [
        {
          "type": "name",
          "order": 1,
          "value": "Gregory",
          "is_obligatory": true,
          "should_be_filled_by_sender": false,
          "placements": []
        },
        {
          "type": "name",
          "order": 2,
          "value": "Davids",
          "is_obligatory": true,
          "should_be_filled_by_sender": false,
          "placements": []
        },
        {
          "type": "email",
          "value": "noreply@scrive.com",
          "is_obligatory": false,
          "should_be_filled_by_sender": false,
          "placements": []
        },
        {
          "type": "company",
          "value": "Scrive",
          "is_obligatory": false,
          "should_be_filled_by_sender": false,
          "placements": []
        }
      ],
      "sign_order": 1,
      "sign_time": null,
      "seen_time": null,
      "read_invitation_time": null,
      "rejected_time": null,
      "rejection_reason": null,
      "sign_success_redirect_url": null,
      "reject_redirect_url": null,
      "email_delivery_status": "unknown",
      "mobile_delivery_status": "unknown",
      "has_authenticated_to_view": false,
      "csv": null,
      "delivery_method": "pad",
      "authentications": {
        "view": {
          "name": "standard"
        },
        "sign": {
          "name": "standard"
        },
        "view_archived": {
          "name": "standard"
        }
      },
      "authentication_method_to_view": "standard",
      "authentication_method_to_view_archived": "standard",
      "authentication_method_to_sign": "standard",
      "confirmation_delivery_method": "none",
      "notification_delivery_method": "none",
      "allows_highlighting": false,
      "attachments": [],
      "highlighted_pages": [],
      "api_delivery_url": null
    },
    {
      "id": "189256",
      "user_id": null,
      "is_author": false,
      "is_signatory": true,
      "signatory_role": "signing_party",
      "signatory_status": "invitation_sent",
      "fields": [
        {
          "type": "name",
          "order": 1,
          "value": "Magnus",
          "is_obligatory": true,
          "should_be_filled_by_sender": false,
          "placements": []
        },
        {
          "type": "name",
          "order": 2,
          "value": "Söderholm",
          "is_obligatory": true,
          "should_be_filled_by_sender": false,
          "placements": []
        },
        {
          "type": "email",
          "value": "noemail@scrive.com",
          "is_obligatory": false,
          "should_be_filled_by_sender": false,
          "placements": []
        },
        {
          "type": "mobile",
          "value": "",
          "is_obligatory": false,
          "should_be_filled_by_sender": false,
          "placements": []
        },
        {
          "type": "company",
          "value": "Scrive",
          "is_obligatory": false,
          "should_be_filled_by_sender": false,
          "placements": []
        },
        {
          "type": "company_number",
          "value": "",
          "is_obligatory": false,
          "should_be_filled_by_sender": false,
          "placements": []
        },
        {
          "type": "signature",
          "name": "Signature 1",
          "signature": "195174",
          "is_obligatory": true,
          "should_be_filled_by_sender": false,
          "placements": [
            {
              "xrel": 0.07894736842105263,
              "yrel": 0.09962825278810408,
              "wrel": 0.2736842105263158,
              "hrel": 0.0758364312267658,
              "fsrel": 0.0168,
              "page": 1,
              "tip": "right",
              "anchors": []
            }
          ]
        }
      ],
      "sign_order": 1,
      "sign_time": "2017-01-13T10:38:49.590815Z",
      "seen_time": "2017-01-13T10:38:33.1783Z",
      "read_invitation_time": null,
      "rejected_time": null,
      "rejection_reason": null,
      "sign_success_redirect_url": null,
      "reject_redirect_url": null,
      "email_delivery_status": "unknown",
      "mobile_delivery_status": "unknown",
      "has_authenticated_to_view": false,
      "csv": null,
      "delivery_method": "pad",
      "authentications": {
        "view": {
          "name": "standard"
        },
        "sign": {
          "name": "onfido",
          "settings": {
            "report": "document_only",
            "identity_document_types": [
              "id_card",
              "passport"
            ],
            "identity_document_countries": null,
            "ui_locale": "en-US",
            "force_mobile_document_capture": true
          }
        },
        "view_archived": {
          "name": "standard"
        }
      },
      "authentication_method_to_view": "standard",
      "authentication_method_to_view_archived": "standard",
      "authentication_method_to_sign": "onfido",
      "confirmation_delivery_method": "none",
      "notification_delivery_method": "none",
      "allows_highlighting": true,
      "attachments": [],
      "highlighted_pages": [
        {
          "page": 1,
          "file_id": "195173"
        }
      ],
      "api_delivery_url": null
    }
  ],
  "file": {
    "name": "contract.pdf",
    "id": "195124"
  },
  "sealed_file": {
    "name": "contract.pdf",
    "id": "195172"
  },
  "author_attachments": [],
  "ctime": "2017-01-13T10:38:17.916324Z",
  "mtime": "2017-01-13T10:38:49.590815Z",
  "timeout_time": "2017-04-13T22:59:59Z",
  "auto_remind_time": null,
  "status": "closed",
  "days_to_sign": 90,
  "days_to_remind": null,
  "display_options": {
    "show_header": true,
    "show_pdf_download": true,
    "show_reject_option": true,
    "allow_reject_reason": true,
    "show_footer": true,
    "document_is_receipt": false,
    "show_arrow": true
  },
  "invitation_message": "",
  "confirmation_message": "",
  "lang": "en",
  "api_callback_url": null,
  "object_version": 26,
  "access_token": "da675b76d876abda",
  "timezone": "Europe/London",
  "tags": [],
  "is_template": false,
  "is_saved": true,
  "is_shared": false,
  "is_trashed": false,
  "is_deleted": false,
  "viewer": {
    "signatory_id": "189255",
    "role": "signatory"
  },
  "experimental_features": {
    "signatory_status_summary": "invitations_sent"
  }
}

Defines the entire structure of a document to be signed, including the parties, the processes to follow, etc. It is a core data structure used throughout the Scrive Document API.

This object has the following properties:

`id` `(string, read only)`

Unique identifier for a document.

Will not change over time, and cannot be changed.

`title` `(string)`

The title of the document.

Can be modified while a document is in preparation. The title will be used in messages sent to the document’s parties.

`parties` `(array)`

List of signing and viewing parties.

Defines their details, how the document is delivered to them, what authentication method they must use, fields they must fill, fields placed on the PDF, etc.

All array elements must be of type:

Signatory `(object)`

A signatory defines the details and process for each signing or non-signing party to a document.

This object has the following properties:

`id` `(string, read only)`

Unique identifier for a party.

Will not change over time, and cannot be changed.

`user_id` `(string,null, read only)`

If this party has an account on the Scrive eSign system, it will be set here.

`is_author` `(boolean, read only)`

Whether this party is the author of the document.

`is_signatory` `(boolean)`

`signatory_role` `(string, enum)`

The value of this property must be one of the following enum values:

"viewer"
"signing_party"
"approver"

`fields` `(array)`

The signatory fields represent information requested from, or information about, the signatory. There are different types of fields, and the array can contain multiple instances of the same type.

Currently, Scrive supports the following field types:

SignatoryFieldName: First and last name of the signatory.
SignatoryFieldFullName: Computed combination of the above two.
SignatoryFieldEmailMobile: Email and mobile of the signatory.
SignatoryFieldSignature: A signature box placed on the document, for the signatory to draw their signature.
SignatoryFieldStandard: Company name and number, and personal number (AKA social security number).
SignatoryFieldCheckbox: Checkboxes of varying sizes.
SignatoryFieldRadiogroup: Radio buttons of varying sizes.
SignatoryFieldCustomText: A text field for any other information about, or requested, from the signatory.
SignatoryFieldDate: A date input field.
SignatoryFieldSignDate: The date of signing of this signatory.

Please read the detailed definition of each field type for more information. New field types may be added at any point to extend Scrive eSign features.

Fields can have placements, which define where on the document they will appear. Similarly, a single field can have multiple placements on the document.

Note: Some field types have no effect without at least one placement.

Each element of this array must match at least one of the following schemas:

SignatoryFieldName `(object)`

A signatory field for the name(s) of the party.

This object has the following properties:

`type` `(string, enum, required)`

Used to specify that this is a name field.

The value of this property must be one of the following enum values:

"name"

`order` `(integer, enum, required)`

Whether this is the first name (i.e. given name) or second name (i.e. last name or surname).

Please ensure that there is exacatly one first name and one second name field, otherwise the signatory may not be asked for their name on the signing page.

The value of this property must be one of the following enum values:

`value` `(string)`

Either a pre-filled value, or the value entered by the signatory.

Default: ""

`is_obligatory` `(boolean)`

Default: true

`should_be_filled_by_sender` `(boolean)`

Default: false

`placements` `(array)`

If set, where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field

SignatoryFieldFullName `(object)`

This object has the following properties:

`type` `(string, enum, required)`

Used to specify that this is a full name field.

The value of this property must be one of the following enum values:

"full_name"

`placements` `(array)`

If set, where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field.

SignatoryFieldEmailMobile `(object)`

A signatory field for email addresses and mobile numbers.

This object has the following properties:

`type` `(string, enum, required)`

Used to specify what type of field this is.

The value of this property must be one of the following enum values:

"email"
"mobile"

`value` `(string)`

Either a pre-filled value, or the value entered by the signatory.

For the author: the value will revert to that set in the account settings. Trying to set any other value will simply result in this field reverting back to information set in account settings.

Default: ""

`is_obligatory` `(boolean)`

Default: true

`should_be_filled_by_sender` `(boolean)`

Default: false

`editable_by_signatory` `(boolean)`

Default: false

`placements` `(array)`

If set, where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field

SignatoryFieldSignature `(object)`

A signatory field for placing signature boxes on the document.

This object has the following properties:

`type` `(string, enum, required)`

The value of this property must be one of the following enum values:

"signature"

`name` `(string, required)`

A name for the signature field.

The signatory will not see the name of the signature field, however it will be used in the Evidence Log as a reference.

`signature` `(read only)`

The value of this property must match at least one of the following schemas:

`(null)`

When the signatory has not yet drawn a signature.

`(string)`

The File ID of the signature drawn by the signatory.

`is_obligatory` `(boolean)`

Default: true

`should_be_filled_by_sender` `(boolean)`

Default: false

`placements` `(array)`

Needs to be set, otherwise the signatory will not be able to draw a signature.

Defines where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field

SignatoryFieldStandard `(object)`

A signatory field for placing a number of standard text fields on the document:

Company name
Company number
Personal number (AKA social security number)

This object has the following properties:

`type` `(string, enum, required)`

Used to specify what type of field this is.

The value of this property must be one of the following enum values:

"company"
"company_number"
"personal_number"

`value` `(string)`

Either a pre-filled value, or the value entered by the signatory.

For the author: the value will revert to that set in the account settings. Trying to set any other value will simply result in this field reverting back to information set in account settings.

Default: ""

`is_obligatory` `(boolean)`

Default: true

`should_be_filled_by_sender` `(boolean)`

Default: false

`placements` `(array)`

If set, where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field

SignatoryFieldCheckbox `(object)`

A signatory field for placing checkboxes on the document.

This object has the following properties:

`type` `(string, enum, required)`

Used to specify that this is a checkbox field.

The value of this property must be one of the following enum values:

"checkbox"

`name` `(string, required)`

A name for the checkbox.

The signatory will not see the name of the checkbox, however it will be used in the Evidence Log as a reference.

`is_checked` `(boolean)`

true when the checkbox is checked, false otherwise.

Setting this to true on a document in preparation has the effect of pre-checking the checkbox for the signatory.

Default: false

`is_obligatory` `(boolean)`

Whether the signatory is obliged to check this checkbox in order to sign the document.

Default: true

`should_be_filled_by_sender` `(boolean)`

Default: false

`placements` `(array)`

Needs to be set, otherwise there will be no checkbox visible to the signatory.

Defines where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number, required)`

Position on the x-axis, from 0 to 1.

`yrel` `(number, required)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, enum, required)`

Width of placement, as proportion of total width.

Checkboxes can only be three sizes. The numbers represent small, medium and large checkboxes.

The value of this property must be one of the following enum values:

0.011538
0.021153
0.0423076

`hrel` `(number, enum, required)`

Height of placement, not used for checkboxes, must be 0.

The value of this property must be one of the following enum values:

`fsrel` `(number, enum, required)`

Font size of placement, not used for checkboxes, must be 0.

The value of this property must be one of the following enum values:

`page` `(integer, required)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field

SignatoryFieldRadiogroup `(object)`

A signatory field for placing radio buttons on the document.

This object has the following properties:

`type` `(string, enum, required)`

Used to specify that this is a radio button group field.

The value of this property must be one of the following enum values:

"radiogroup"

`name` `(string, required)`

A name for the radiogroup.

The signatory will not see the name of the radiogroup, however it will be used in the Evidence Log as a reference.

`values` `(array, required)`

An array of radio button option values. The signatory will not see the name of the radio button values, however they will be used in the Evidence Log as a reference.

These must correspond one-to-one with the list of placements: that is the length of values must equal that of placements and vice-versa, otherwise an error is returned.

Must be equal in length to placements and have at least 2 items. Each item must be unique and not an empty string.

All array elements must be of type:

`(string)`

Empty strings are not allowed.

`placements` `(array, required)`

Defines where the individual radio buttons should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

These must correspond one-to-one with the list of values: that is the length of placements must equal that of vales and vice-versa, otherwise an error is returned.

Must be equal in length to values and have at least 2 items.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number, required)`

Position on the x-axis, from 0 to 1.

`yrel` `(number, required)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, enum, required)`

Width of placement, as proportion of total width.

Radio buttons can only be three sizes. The numbers represent small, medium and large radio buttons.

The value of this property must be one of the following enum values:

0.014736
0.021052
0.025263

`hrel` `(number, enum, required)`

Height of placement, not used for radio buttons, must be 0.

The value of this property must be one of the following enum values:

`fsrel` `(number, enum, required)`

Font size of placement, not used for radio buttons, must be 0.

The value of this property must be one of the following enum values:

`page` `(integer, required)`

The page number for this placement, starting from 1.

All radio buttons within the same group must be placed on the same page.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field

SignatoryFieldCustomText `(object)`

This object has the following properties:

`type` `(string, enum, required)`

Used to specify that this is a custom text field.

The value of this property must be one of the following enum values:

"text"

`name` `(string, required)`

A name for the custom field.

The name will be used as a placeholder value on the signing page, it will also be used in the Evidence Log as a reference.

`value` `(string)`

Either a pre-filled value, or the value entered by the signatory.

Default: ""

`is_obligatory` `(boolean)`

Default: true

`should_be_filled_by_sender` `(boolean)`

Default: false

`placements` `(array)`

Needs to be set, otherwise the signatory will not be asked or presented with this information.

Defines where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`custom_validation`

The value of this property must match exactly one of the following schemas:

`(null)`

SignatoryFieldCustomValidation `(object)`

Optional. Describes how to validate the input to this field using a custom regular expression.

This object has the following properties:

`pattern` `(string, required)`

Regular expression pattern for field validation.

`positive_example` `(string, required)`

Example of an input that matches the pattern.

`tooltip` `(string, required)`

Tooltip for the input text field.

`description` `(string,null)`

Description of this field

SignatoryFieldDate `(object)`

Signatory field for dates. Optionally can impose restrictions on start and/or end date (either absolute or relative to document view).

This object has the following properties:

`type` `(string, enum, required)`

Used to specify that this is a date field.

The value of this property must be one of the following enum values:

"date"

`name` `(string, required)`

A name for the date field.

The name will be used as a placeholder value on the signing page, it will also be used in the Evidence Log as a reference.

`value` `(string,null)`

Either a pre-filled value, or the value entered by the signatory. Must be specified as ISO8601 date.

Default: null

`is_obligatory` `(boolean)`

Default: true

`should_be_filled_by_sender` `(boolean)`

Default: false

`placements` `(array)`

Defines where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field.

`configuration` `(object, required)`

Definition of optional restriction imposed upon start and/or end date. Null means no restriction.

The configuration object has the following properties:

`start_date` `(required)`

The value of this property must match exactly one of the following schemas:

`(null)`

DateConfig `(object)`

Describes restriction imposed on start or end date of a signatory date field. The threshold is the document view date plus the number of days defined in value (which may be negative).

This object has the following properties:

`type` `(string, enum)`

The value of this property must be one of the following enum values:

"relative-to-doc-view"

`value` `(integer)`

DateConfig `(object)`

Describes restriction imposed on start or end date of a signatory date field. The threshold is the date specified by value.

This object has the following properties:

`type` `(string, enum)`

The value of this property must be one of the following enum values:

"absolute"

`value` `(string)`

Must be specified as ISO8601 date between 1900-01-01 and 2200-12-31.

`end_date` `(required)`

The value of this property must match exactly one of the following schemas:

`(null)`

DateConfig `(object)`

Describes restriction imposed on start or end date of a signatory date field. The threshold is the document view date plus the number of days defined in value (which may be negative).

This object has the following properties:

`type` `(string, enum)`

The value of this property must be one of the following enum values:

"relative-to-doc-view"

`value` `(integer)`

DateConfig `(object)`

Describes restriction imposed on start or end date of a signatory date field. The threshold is the date specified by value.

This object has the following properties:

`type` `(string, enum)`

The value of this property must be one of the following enum values:

"absolute"

`value` `(string)`

Must be specified as ISO8601 date between 1900-01-01 and 2200-12-31.

SignatoryFieldSignDate `(object)`

Signatory field displaying sign date of the respective signatory.

This object has the following properties:

`type` `(string, enum, required)`

Used to specify that this is a sign date field.

The value of this property must be one of the following enum values:

"sign_date"

`value` `(string,null)`

Date when the signatory has signed or null if not yet signed. Formatted as ISO8601 date. Read only.

Default: null

`placements` `(array)`

Defines where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field.

`sign_order` `(integer)`

Default: 1

`sign_time` `(string,null, read only)`

`seen_time` `(string,null, read only)`

`deferred_time` `(string,null, read only)`

`read_invitation_time` `(string,null, read only)`

`rejected_time` `(string,null, read only)`

`rejection_reason` `(string,null, read only)`

`sign_success_redirect_url` `(string,null)`

The URL to redirect this party after they have signed the document.

`reject_redirect_url` `(string,null)`

The URL to redirect this party if they reject the document.

`email_delivery_status` `(string, enum)`

The current delivery status.

The value of this property must be one of the following enum values:

"unknown"
"not_delivered"
"delivered"
"deferred"

`mobile_delivery_status` `(string, enum)`

The current delivery status.

The value of this property must be one of the following enum values:

"unknown"
"not_delivered"
"delivered"
"deferred"

`has_authenticated_to_view` `(boolean, read only)`

If a person has identified to view the document.

`csv` `(array,null)`

`delivery_method` `(string, enum)`

Note that api delivery is referred to as "Link" delivery in the Scrive Web interface. Furthermore, pad delivery is referred to as "In-person".

Default: "email"

The value of this property must be one of the following enum values:

"email"
"mobile"
"email_mobile"
"pad"
"api"

`authentications` `(object)`

The authentications object has the following properties:

`view` `(object)`

This setting forces signatories to authenticate using the supplied identification method to view the document before signing.

Will be overridden by authentication_method_to_view property when both are present.

The view object has the following properties:

`name` `(string, enum, required)`

The value of this property must be one of the following enum values:

"standard"
"sms_pin"
"dk_mitid"
"dk_mitid_erhverv"
"fi_tupas"
"freja"
"nl_idin"
"no_bankid"
"onfido"
"onfido_document_check"
"onfido_document_and_photo_check"
"se_bankid"
"verimi"

`settings`

Schema of this object depends on selected authentication name.

The value of this property must match exactly one of the following schemas:

freja `(object)`

nl_idin `(object)`

onfido `(object)`

`sign` `(object)`

This setting forces user to authenticate to sign.

Will be overridden by authentication_method_to_sign property when both are present.

The sign object has the following properties:

`name` `(string, enum, required)`

The value of this property must be one of the following enum values:

"standard"
"sms_pin"
"sms_otp"
"dk_mitid"
"dk_mitid_erhverv"
"fi_tupas"
"freja"
"nl_idin"
"no_bankid"
"onfido"
"onfido_document_check"
"onfido_document_and_photo_check"
"se_bankid"
"swisscom_qes"
"swisscom_qes_with_srs"
"verimi_qes"
"itsme"
"itsme_qes"
"smart_id_qes"

`settings` `(object,null)`

Schema of this object depends on selected authentication name.

The value of this property must match exactly one of the following schemas:

freja `(object)`

nl_idin `(object)`

onfido `(object)`

swisscom `(object)`

`view_archived` `(object)`

This setting forces signatories to authenticate using the supplied identification method to view the document once it has been signed and resides in the e-archive.

Will be overridden by authentication_method_to_view_archived property when both are present.

The view_archived object has the following properties:

`name` `(string, enum, required)`

The value of this property must be one of the following enum values:

"standard"
"sms_pin"
"dk_mitid"
"dk_mitid_erhverv"
"fi_tupas"
"freja"
"nl_idin"
"no_bankid"
"onfido"
"onfido_document_check"
"onfido_document_and_photo_check"
"se_bankid"
"verimi"

`settings`

Schema of this object depends on selected authentication name.

The value of this property must match exactly one of the following schemas:

freja `(object)`

nl_idin `(object)`

onfido `(object)`

`authentication_method_to_view` `(string, enum)`

This setting forces signatories to authenticate using the supplied identification method to view the document before signing.

Default: "standard"

The value of this property must be one of the following enum values:

"standard"
"sms_pin"
"dk_mitid"
"dk_mitid_erhverv"
"fi_tupas"
"freja"
"nl_idin"
"no_bankid"
"onfido"
"onfido_document_check"
"onfido_document_and_photo_check"
"se_bankid"
"verimi"

`authentication_method_to_view_archived` `(string, enum)`

This setting forces signatories to authenticate using the supplied identification method to view the document once it has been signed and resides in the e-archive.

Default: "standard"

The value of this property must be one of the following enum values:

"standard"
"sms_pin"
"dk_mitid"
"dk_mitid_erhverv"
"fi_tupas"
"freja"
"nl_idin"
"no_bankid"
"onfido"
"onfido_document_check"
"onfido_document_and_photo_check"
"se_bankid"
"verimi"

`authentication_method_to_sign` `(string, enum)`

This setting forces user to authenticate to sign.

Default: "standard"

The value of this property must be one of the following enum values:

"standard"
"sms_pin"
"sms_otp"
"dk_mitid"
"dk_mitid_erhverv"
"fi_tupas"
"freja"
"nl_idin"
"no_bankid"
"onfido"
"onfido_document_check"
"onfido_document_and_photo_check"
"se_bankid"
"swisscom_qes"
"swisscom_qes_with_srs"
"verimi_qes"
"itsme"
"itsme_qes"
"smart_id_qes"

`confirmation_delivery_method` `(string, enum)`

Deliver a confirmation message about the document signing status by:

email an email including a file attachment of the signed document
mobile a text message with a link to the signed document
email_mobile both of the two above
email_link an email with a link to the signed document
email_link_mobile an email and a text message with a link to the signed document
none no delivery at all

Default: "email"

The value of this property must be one of the following enum values:

"email"
"mobile"
"email_mobile"
"email_link"
"email_link_mobile"
"none"

`notification_delivery_method` `(string, enum)`

Deliver a confirmation notification that the party signed/approved the document by:

email an email including a link to the document
mobile a text message including a link to the document
email_mobile both of the two above
none no delivery at all

Default: "none"

The value of this property must be one of the following enum values:

"email"
"mobile"
"email_mobile"
"none"

`allows_highlighting` `(boolean)`

Whether the signatory can highlight pages of the PDF when viewing the signing page.

If any highlights are performed, the evidence log states that they were performed while the signatory was viewing the document.

The intention of this feature is not for the signatory to affect a contract via highlighting, but simply for a point-of-sale situation to assist contract review.

Default: false

`hide_personal_number` `(boolean)`

Whether the personal number should be hidden in the final PDF verification page and the Evidence Log.

This is to be used when the document will be distributed to a wider audience, and the personal number of the signatory should not be available in the final document.

If the signatory has a placed field for their personal number, it will be included in the final PDF. So this solution only works when the field does not have any placements.

Default: false

`can_forward` `(boolean)`

Whether the signatory can forward the signing process to someone else.

Default: false

`highlighted_pages` `(array, read only)`

A list of highlights performed by the signatory.

While a document is pending, highlights may be added, but will not appear in the document file PDF until after the document is closed.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`page` `(integer)`

The page number which is highlighted (starts from 1). Each signatory can only have one highlight per page.

`file_id` `(string)`

The file_id for an image of the highlights.

The image dimensions will fit the ratio of the PDF page, and will be of a fixed colour and transparency.

This will be integrated into the final PDF once the document is closed.

`attachments` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

A signatory attachment - an attachment requested from the signing party. Attachments requested from viewing only parties have no effect.

This object has the following properties:

`name` `(string)`

A name for the requested attachment. Will be visible to the signatory when signing the document.

`description` `(string)`

A description for the requested attachment. Will be visible to the signatory when signing the document alongside the attachment name.

`required` `(boolean)`

Whether the signatory must upload this attachment. If false, the signatory may choose not to upload this attachment when signing.

Default: true

`file_id` `(string)`

Will be present if and when the party uploads this attachment.

`file_name` `(string)`

Will be present if and when the party uploads this attachment.

`add_to_sealed_file` `(boolean)`

Should the file of this attachment be merged into the final sealed document?

Default: true

`api_delivery_url` `(string,null)`

If the delivery_method is set to api, then this field will hold the relative URL for the party.

Note that api delivery is referred to as "Link" delivery in the Scrive Web interface.

This will only be available after the signing process has been started, and will only be visible when accessing the document as the author.

`consent_module`

The value of this property must match exactly one of the following schemas:

`(null)`

`(object)`

If present, a section will be shown asking the signatory to answer some questions which must be answered by the signatory with either the positive or the negative option specified.

This object has the following properties:

`title` `(string)`

Section title.

`questions` `(array)`

All array elements must be of type:

`(object)`

This object has the following properties:

`title` `(string)`

Question text.

`positive_option` `(string)`

`negative_option` `(string)`

`response` `(boolean)`

Will be present when the party has answered the question. true when the signatory selected the positive response and false when the signatory selected the negative response.

`detailed_description` `(object)`

Optional additional information to show the signatory.

The detailed_description object has the following properties:

`title` `(string)`

Title of the section. Will be shown in a button.

`text` `(string)`

Explanation of the question. New lines are shown as is.

`is_visible` `(bool,null)`

Determines if an approver is visible on the verification page and in sign view.

This value is only used for approvers. It has to be null for viewer and signing_party signatories.

Default: "null"

`document_roles` `(array)`

List of "roles" this signatory has within the document.

Default:
[]

All array elements must be of type:

`(string)`

`experimental` `(object)`

⚠️ WARNING: EXPERIMENTAL ⚠️

Experimental properties are not part of public API. Therefore they're not supported and are subject to change without prior notice.

The experimental object has the following properties:

`signatory_status` `(string, enum, read only)`

The current status of the signatory in relation to the document.

The statuses document_problem, document_draft, document_canceled, document_timedout and document_rejected are reflecting the status field of the underlying document for convenience.

The value of this property must be one of the following enum values:

"document_problem"
"document_draft"
"document_canceled"
"document_timedout"
"document_rejected"
"waiting_for_prior_signatures"
"invitation_sent"
"invitation_delivery_problem"
"invitation_delivered"
"invitation_read"
"document_opened"
"document_deferred"
"document_signed"
"document_approved"
"confirmation_delivery_problem"

`file` `(object)`

A file that can be accessed using the API call to download related files.

The file object has the following properties:

`id` `(string, read only)`

`name` `(string, read only)`

`sealed_file`

The cryptographically sealed file.

The value of this property must match exactly one of the following schemas:

`(null)`

File `(object)`

A file that can be accessed using the API call to download related files.

This object has the following properties:

`id` `(string, read only)`

`name` `(string, read only)`

`author_attachments` `(array, read only)`

List of author attachments.

All array elements must be of type:

`(object)`

This object has the following properties:

`name` `(string, read only)`

`required` `(boolean, read only)`

`add_to_sealed_file` `(boolean, read only)`

`file_id` `(string)`

`ctime` `(string, read only)`

Time at which the document was created.

`mtime` `(string, read only)`

Latest time at which the document was modified.

`timeout_time` `(string,null, read only)`

Time after which the document will timeout if it has not been signed.

`auto_remind_time` `(string,null, read only)`

`status` `(string, enum)`

The current document status.

A document in "preparation" can be changed using the update call and the main file can also be set or changed.

Documents in "awaiting_start" cannot be modified, trashed or canceled.

Once all parties have successfully signed the document is "closed" and cannot be changed.

The value of this property must be one of the following enum values:

"preparation"
"awaiting_start"
"pending"
"closed"
"canceled"
"timedout"
"rejected"
"document_error"

`days_to_sign` `(integer)`

Default: 90

`days_to_remind` `(integer,null)`

`display_options` `(object)`

The display_options object has the following properties:

`show_header` `(boolean)`

Whether to show the Scrive header on the signing page.

`show_pdf_download` `(boolean)`

Whether to show an option to download the PDF on the signing page.

`show_reject_option` `(boolean)`

Whether to allow signatories to reject a document.

`allow_reject_reason` `(boolean)`

Whether to allow signatories to enter a plain text reason for rejecting a document.

`show_footer` `(boolean)`

Whether to show the Scrive footer on the signing page.

`document_is_receipt` `(boolean)`

Whether the document is a receipt to be printed out, and thus should not have the verification footer added.

Note: This reduces the durability of evidence for a document signed through Scrive eSign, and should only be used when absolutely necessary.

`show_arrow` `(boolean)`

Whether to show the auto-scroll arrow on the signing page.

`show_form` `(boolean)`

Whether to show the fields as a form on the signing page.

`show_form_arrow` `(boolean)`

Whether to show the auto-scroll arrow on the form page.

`invitation_message` `(string)`

The invitation message to send to all parties at the start of the signing process when using email invitation.

Default is blank meaning that a default message will be used.

Default: ""

`sms_invitation_message` `(string)`

The invitation message to send to all parties at the start of the signing process when using SMS invitation.

Default is blank meaning that a default message will be used.

Default: ""

`confirmation_message` `(string)`

The confirmation message to send to all parties once the document has been signed.

Default is blank meaning that a default message will be used.

Default: ""

`sms_confirmation_message` `(string)`

The confirmation message to send to all parties once the document has been signed when using SMS confirmation.

Default is blank meaning that a default message will be used.

Default: ""

`lang` `(string, enum)`

Currently supported language codes

The value of this property must be one of the following enum values:

"cs"
"da"
"de"
"el"
"en"
"es"
"et"
"fi"
"fr"
"hu"
"is"
"it"
"lt"
"lv"
"nl"
"no"
"pl"
"pt"
"sv"

`api_callback_url` `(string,null)`

The URL to perform an API callback request.

Please see Callbacks for details.

`object_version` `(integer, read only)`

The document object version is auto-incremented by the Scrive eSign system each time an action is performed on it.

Therefore this can be used as a rudimentary synchronisation mechanism to ensure you are handling a document that has not changed.

It is not recommended to use this field unless you are building an application with offline capabilities.

Additional restrictions:

`access_token` `(string, read only)`

`timezone` `(string)`

`tags` `(array)`

User defined set of names and values.

See Document Tags for more details.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`name` `(string)`

`value` `(string)`

`is_template` `(boolean)`

`is_saved` `(boolean)`

A ‘saved’ document will appear in the E-archive.

`is_shared` `(boolean, read only)`

`is_trashed` `(boolean, read only)`

`is_deleted` `(boolean, read only)`

`viewer` `(object)`

The viewer object has the following properties:

`role` `(string, enum)`

The value of this property must be one of the following enum values:

"company_shared"
"company_admin"
"signatory"

`signatory_id` `(string)`

`experimental_features` `(object)`

⚠️ WARNING: EXPERIMENTAL ⚠️

Experimental properties are not part of public API. Therefore they're not supported and are subject to change without prior notice.

The experimental_features object has the following properties:

`signatory_status_summary` `(string, enum, read only)`

The document status in relation to its signatories.

A document with document_opened has been opened by all of its signatories.

A document with invitations_read has all of its signatories having read the invitations to sign or approve. Some might have opened the document as well, but not all.

A document with invitations_delivered has all the invitations delivered.

A document with invitation_delivery_problem has some invitation with a delivery problem.

A document with invitation_sent has all invitations sent but not all delivered neither opened or read.

When several signing stages (a.k.a. invitation orders) are defined for the document, only the signatories in the current and previous stages are taken into account to determine the status.

The value of this property must be one of the following enum values:

"document_template"
"document_problem"
"document_draft"
"invitations_sent"
"invitations_delivered"
"invitation_delivery_problem"
"invitations_read"
"document_opened"
"document_signed"
"document_canceled"
"document_timedout"
"document_rejected"

Document Status

(string, enum)

The current document status.

A document in "preparation" can be changed using the update call and the main file can also be set or changed.

Documents in "awaiting_start" cannot be modified, trashed or canceled.

Once all parties have successfully signed the document is "closed" and cannot be changed.

The value of this property must be one of the following enum values:

"preparation"
"awaiting_start"
"pending"
"closed"
"canceled"
"timedout"
"rejected"
"document_error"

Document Tags

(array)

Example JSON: for "Document Tags"

[
  {
    "name": "scrive_clm:end_date",
    "value": "2025-07-25"
  },
  {
    "name": "scrive_clm:remind_days_before",
    "value": "7"
  }
]

User defined set of names and values.

Document tags can be used to manage categories of documents.

The list API call can filter based on document tags.

Document tags can also be used to schedule a contract expiry reminder. That is, an email reminder to be sent to the document's author and to every admin in the author's User Group when an agreement is about to expire. To specify such an expiry date, set the following document tags:

scrive_clm:end_date with value in the format "YYYY-MM-DD", and
scrive_clm:remind_days_before with a non-negative integer value (as string).

A contract expiry reminder is scheduled for the date specified in scrive_clm:end_date minus the value of scrive_clm:remind_days_before. It is only sent if the document is closed by that time and the tags adhere to the correct format with a scheduled day at most ten years in the future.

All array elements must be of type:

`(object)`

This object has the following properties:

`name` `(string)`

`value` `(string)`

Signatory

(object)

Example JSON: for "Signatory"

{
  "id": "189256",
  "user_id": null,
  "is_author": false,
  "is_signatory": true,
  "signatory_role": "signing_party",
  "fields": [
    {
      "type": "name",
      "order": 1,
      "value": "Magnus",
      "is_obligatory": true,
      "should_be_filled_by_sender": false,
      "placements": []
    },
    {
      "type": "name",
      "order": 2,
      "value": "Söderholm",
      "is_obligatory": true,
      "should_be_filled_by_sender": false,
      "placements": []
    },
    {
      "type": "full_name",
      "placements": []
    },
    {
      "type": "email",
      "value": "noemail@scrive.com",
      "is_obligatory": false,
      "should_be_filled_by_sender": false,
      "editable_by_signatory": false,
      "placements": []
    },
    {
      "type": "mobile",
      "value": "",
      "is_obligatory": false,
      "should_be_filled_by_sender": false,
      "placements": []
    },
    {
      "type": "company",
      "value": "Scrive",
      "is_obligatory": false,
      "should_be_filled_by_sender": false,
      "placements": []
    },
    {
      "type": "company_number",
      "value": "",
      "is_obligatory": false,
      "should_be_filled_by_sender": false,
      "placements": []
    },
    {
      "type": "sign_date",
      "value": null,
      "placements": []
    },
    {
      "type": "signature",
      "name": "Signature 1",
      "signature": "195174",
      "is_obligatory": true,
      "should_be_filled_by_sender": false,
      "placements": [
        {
          "xrel": 0.07894736842105263,
          "yrel": 0.09962825278810408,
          "wrel": 0.2736842105263158,
          "hrel": 0.0758364312267658,
          "fsrel": 0.0168,
          "page": 1,
          "tip": "right",
          "anchors": []
        }
      ]
    }
  ],
  "sign_order": 1,
  "sign_time": "2017-01-13T10:38:49.590815Z",
  "seen_time": "2017-01-13T10:38:33.1783Z",
  "read_invitation_time": null,
  "rejected_time": null,
  "rejection_reason": null,
  "sign_success_redirect_url": null,
  "reject_redirect_url": null,
  "email_delivery_status": "unknown",
  "mobile_delivery_status": "unknown",
  "has_authenticated_to_view": false,
  "csv": null,
  "delivery_method": "pad",
  "authentications": {
    "view": {
      "name": "standard"
    },
    "sign": {
      "name": "onfido",
      "settings": {
        "report": "document_only",
        "identity_document_types": [
          "id_card",
          "passport"
        ],
        "identity_document_countries": null,
        "ui_locale": "en-US",
        "force_mobile_document_capture": true
      }
    },
    "view_archived": {
      "name": "standard"
    }
  },
  "authentication_method_to_view": "standard",
  "authentication_method_to_view_archived": "standard",
  "authentication_method_to_sign": "onfido",
  "confirmation_delivery_method": "none",
  "notification_delivery_method": "none",
  "allows_highlighting": true,
  "hide_personal_number": false,
  "attachments": [
    {
      "name": "Driving licence",
      "description": "A picture of driving licence",
      "required": true,
      "add_to_sealed_file": true
    }
  ],
  "highlighted_pages": [
    {
      "page": 1,
      "file_id": "195173"
    }
  ],
  "api_delivery_url": null,
  "consent_module": {
    "title": "Handling of personal information",
    "questions": [
      {
        "title": "Do you agree for your information to be processed?",
        "positive_option": "Yes, I agree with the processing of my data.",
        "negative_option": "No, I do not agree with any processing of my data.",
        "response": null,
        "detailed_description": {
          "title": "More information",
          "text": "Long extra information regarding the question can go here, and can be separated using newlines.\n\nThis is useful for long terms and conditions that come along with a question."
        }
      }
    ]
  },
  "is_visible": null,
  "document_roles": [
    "Director",
    "Board Member"
  ]
}

A signatory defines the details and process for each signing or non-signing party to a document.

This object has the following properties:

`id` `(string, read only)`

Unique identifier for a party.

Will not change over time, and cannot be changed.

`user_id` `(string,null, read only)`

If this party has an account on the Scrive eSign system, it will be set here.

`is_author` `(boolean, read only)`

Whether this party is the author of the document.

`is_signatory` `(boolean)`

`signatory_role` `(string, enum)`

The value of this property must be one of the following enum values:

"viewer"
"signing_party"
"approver"

`fields` `(array)`

The signatory fields represent information requested from, or information about, the signatory. There are different types of fields, and the array can contain multiple instances of the same type.

Currently, Scrive supports the following field types:

SignatoryFieldName: First and last name of the signatory.
SignatoryFieldFullName: Computed combination of the above two.
SignatoryFieldEmailMobile: Email and mobile of the signatory.
SignatoryFieldSignature: A signature box placed on the document, for the signatory to draw their signature.
SignatoryFieldStandard: Company name and number, and personal number (AKA social security number).
SignatoryFieldCheckbox: Checkboxes of varying sizes.
SignatoryFieldRadiogroup: Radio buttons of varying sizes.
SignatoryFieldCustomText: A text field for any other information about, or requested, from the signatory.
SignatoryFieldDate: A date input field.
SignatoryFieldSignDate: The date of signing of this signatory.

Please read the detailed definition of each field type for more information. New field types may be added at any point to extend Scrive eSign features.

Fields can have placements, which define where on the document they will appear. Similarly, a single field can have multiple placements on the document.

Note: Some field types have no effect without at least one placement.

Each element of this array must match at least one of the following schemas:

SignatoryFieldName `(object)`

A signatory field for the name(s) of the party.

This object has the following properties:

`type` `(string, enum, required)`

Used to specify that this is a name field.

The value of this property must be one of the following enum values:

"name"

`order` `(integer, enum, required)`

Whether this is the first name (i.e. given name) or second name (i.e. last name or surname).

Please ensure that there is exacatly one first name and one second name field, otherwise the signatory may not be asked for their name on the signing page.

The value of this property must be one of the following enum values:

`value` `(string)`

Either a pre-filled value, or the value entered by the signatory.

Default: ""

`is_obligatory` `(boolean)`

Default: true

`should_be_filled_by_sender` `(boolean)`

Default: false

`placements` `(array)`

If set, where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field

SignatoryFieldFullName `(object)`

This object has the following properties:

`type` `(string, enum, required)`

Used to specify that this is a full name field.

The value of this property must be one of the following enum values:

"full_name"

`placements` `(array)`

If set, where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field.

SignatoryFieldEmailMobile `(object)`

A signatory field for email addresses and mobile numbers.

This object has the following properties:

`type` `(string, enum, required)`

Used to specify what type of field this is.

The value of this property must be one of the following enum values:

"email"
"mobile"

`value` `(string)`

Either a pre-filled value, or the value entered by the signatory.

For the author: the value will revert to that set in the account settings. Trying to set any other value will simply result in this field reverting back to information set in account settings.

Default: ""

`is_obligatory` `(boolean)`

Default: true

`should_be_filled_by_sender` `(boolean)`

Default: false

`editable_by_signatory` `(boolean)`

Default: false

`placements` `(array)`

If set, where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field

SignatoryFieldSignature `(object)`

A signatory field for placing signature boxes on the document.

This object has the following properties:

`type` `(string, enum, required)`

The value of this property must be one of the following enum values:

"signature"

`name` `(string, required)`

A name for the signature field.

The signatory will not see the name of the signature field, however it will be used in the Evidence Log as a reference.

`signature` `(read only)`

The value of this property must match at least one of the following schemas:

`(null)`

When the signatory has not yet drawn a signature.

`(string)`

The File ID of the signature drawn by the signatory.

`is_obligatory` `(boolean)`

Default: true

`should_be_filled_by_sender` `(boolean)`

Default: false

`placements` `(array)`

Needs to be set, otherwise the signatory will not be able to draw a signature.

Defines where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field

SignatoryFieldStandard `(object)`

A signatory field for placing a number of standard text fields on the document:

Company name
Company number
Personal number (AKA social security number)

This object has the following properties:

`type` `(string, enum, required)`

Used to specify what type of field this is.

The value of this property must be one of the following enum values:

"company"
"company_number"
"personal_number"

`value` `(string)`

Either a pre-filled value, or the value entered by the signatory.

For the author: the value will revert to that set in the account settings. Trying to set any other value will simply result in this field reverting back to information set in account settings.

Default: ""

`is_obligatory` `(boolean)`

Default: true

`should_be_filled_by_sender` `(boolean)`

Default: false

`placements` `(array)`

If set, where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field

SignatoryFieldCheckbox `(object)`

A signatory field for placing checkboxes on the document.

This object has the following properties:

`type` `(string, enum, required)`

Used to specify that this is a checkbox field.

The value of this property must be one of the following enum values:

"checkbox"

`name` `(string, required)`

A name for the checkbox.

The signatory will not see the name of the checkbox, however it will be used in the Evidence Log as a reference.

`is_checked` `(boolean)`

true when the checkbox is checked, false otherwise.

Setting this to true on a document in preparation has the effect of pre-checking the checkbox for the signatory.

Default: false

`is_obligatory` `(boolean)`

Whether the signatory is obliged to check this checkbox in order to sign the document.

Default: true

`should_be_filled_by_sender` `(boolean)`

Default: false

`placements` `(array)`

Needs to be set, otherwise there will be no checkbox visible to the signatory.

Defines where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number, required)`

Position on the x-axis, from 0 to 1.

`yrel` `(number, required)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, enum, required)`

Width of placement, as proportion of total width.

Checkboxes can only be three sizes. The numbers represent small, medium and large checkboxes.

The value of this property must be one of the following enum values:

0.011538
0.021153
0.0423076

`hrel` `(number, enum, required)`

Height of placement, not used for checkboxes, must be 0.

The value of this property must be one of the following enum values:

`fsrel` `(number, enum, required)`

Font size of placement, not used for checkboxes, must be 0.

The value of this property must be one of the following enum values:

`page` `(integer, required)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field

SignatoryFieldRadiogroup `(object)`

A signatory field for placing radio buttons on the document.

This object has the following properties:

`type` `(string, enum, required)`

Used to specify that this is a radio button group field.

The value of this property must be one of the following enum values:

"radiogroup"

`name` `(string, required)`

A name for the radiogroup.

The signatory will not see the name of the radiogroup, however it will be used in the Evidence Log as a reference.

`values` `(array, required)`

An array of radio button option values. The signatory will not see the name of the radio button values, however they will be used in the Evidence Log as a reference.

These must correspond one-to-one with the list of placements: that is the length of values must equal that of placements and vice-versa, otherwise an error is returned.

Must be equal in length to placements and have at least 2 items. Each item must be unique and not an empty string.

All array elements must be of type:

`(string)`

Empty strings are not allowed.

`placements` `(array, required)`

Defines where the individual radio buttons should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

These must correspond one-to-one with the list of values: that is the length of placements must equal that of vales and vice-versa, otherwise an error is returned.

Must be equal in length to values and have at least 2 items.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number, required)`

Position on the x-axis, from 0 to 1.

`yrel` `(number, required)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, enum, required)`

Width of placement, as proportion of total width.

Radio buttons can only be three sizes. The numbers represent small, medium and large radio buttons.

The value of this property must be one of the following enum values:

0.014736
0.021052
0.025263

`hrel` `(number, enum, required)`

Height of placement, not used for radio buttons, must be 0.

The value of this property must be one of the following enum values:

`fsrel` `(number, enum, required)`

Font size of placement, not used for radio buttons, must be 0.

The value of this property must be one of the following enum values:

`page` `(integer, required)`

The page number for this placement, starting from 1.

All radio buttons within the same group must be placed on the same page.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field

SignatoryFieldCustomText `(object)`

This object has the following properties:

`type` `(string, enum, required)`

Used to specify that this is a custom text field.

The value of this property must be one of the following enum values:

"text"

`name` `(string, required)`

A name for the custom field.

The name will be used as a placeholder value on the signing page, it will also be used in the Evidence Log as a reference.

`value` `(string)`

Either a pre-filled value, or the value entered by the signatory.

Default: ""

`is_obligatory` `(boolean)`

Default: true

`should_be_filled_by_sender` `(boolean)`

Default: false

`placements` `(array)`

Needs to be set, otherwise the signatory will not be asked or presented with this information.

Defines where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`custom_validation`

The value of this property must match exactly one of the following schemas:

`(null)`

SignatoryFieldCustomValidation `(object)`

Optional. Describes how to validate the input to this field using a custom regular expression.

This object has the following properties:

`pattern` `(string, required)`

Regular expression pattern for field validation.

`positive_example` `(string, required)`

Example of an input that matches the pattern.

`tooltip` `(string, required)`

Tooltip for the input text field.

`description` `(string,null)`

Description of this field

SignatoryFieldDate `(object)`

Signatory field for dates. Optionally can impose restrictions on start and/or end date (either absolute or relative to document view).

This object has the following properties:

`type` `(string, enum, required)`

Used to specify that this is a date field.

The value of this property must be one of the following enum values:

"date"

`name` `(string, required)`

A name for the date field.

The name will be used as a placeholder value on the signing page, it will also be used in the Evidence Log as a reference.

`value` `(string,null)`

Either a pre-filled value, or the value entered by the signatory. Must be specified as ISO8601 date.

Default: null

`is_obligatory` `(boolean)`

Default: true

`should_be_filled_by_sender` `(boolean)`

Default: false

`placements` `(array)`

Defines where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field.

`configuration` `(object, required)`

Definition of optional restriction imposed upon start and/or end date. Null means no restriction.

The configuration object has the following properties:

`start_date` `(required)`

The value of this property must match exactly one of the following schemas:

`(null)`

DateConfig `(object)`

Describes restriction imposed on start or end date of a signatory date field. The threshold is the document view date plus the number of days defined in value (which may be negative).

This object has the following properties:

`type` `(string, enum)`

The value of this property must be one of the following enum values:

"relative-to-doc-view"

`value` `(integer)`

DateConfig `(object)`

Describes restriction imposed on start or end date of a signatory date field. The threshold is the date specified by value.

This object has the following properties:

`type` `(string, enum)`

The value of this property must be one of the following enum values:

"absolute"

`value` `(string)`

Must be specified as ISO8601 date between 1900-01-01 and 2200-12-31.

`end_date` `(required)`

The value of this property must match exactly one of the following schemas:

`(null)`

DateConfig `(object)`

Describes restriction imposed on start or end date of a signatory date field. The threshold is the document view date plus the number of days defined in value (which may be negative).

This object has the following properties:

`type` `(string, enum)`

The value of this property must be one of the following enum values:

"relative-to-doc-view"

`value` `(integer)`

DateConfig `(object)`

Describes restriction imposed on start or end date of a signatory date field. The threshold is the date specified by value.

This object has the following properties:

`type` `(string, enum)`

The value of this property must be one of the following enum values:

"absolute"

`value` `(string)`

Must be specified as ISO8601 date between 1900-01-01 and 2200-12-31.

SignatoryFieldSignDate `(object)`

Signatory field displaying sign date of the respective signatory.

This object has the following properties:

`type` `(string, enum, required)`

Used to specify that this is a sign date field.

The value of this property must be one of the following enum values:

"sign_date"

`value` `(string,null)`

Date when the signatory has signed or null if not yet signed. Formatted as ISO8601 date. Read only.

Default: null

`placements` `(array)`

Defines where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field.

`sign_order` `(integer)`

Default: 1

`sign_time` `(string,null, read only)`

`seen_time` `(string,null, read only)`

`deferred_time` `(string,null, read only)`

`read_invitation_time` `(string,null, read only)`

`rejected_time` `(string,null, read only)`

`rejection_reason` `(string,null, read only)`

`sign_success_redirect_url` `(string,null)`

The URL to redirect this party after they have signed the document.

`reject_redirect_url` `(string,null)`

The URL to redirect this party if they reject the document.

`email_delivery_status` `(string, enum)`

The current delivery status.

The value of this property must be one of the following enum values:

"unknown"
"not_delivered"
"delivered"
"deferred"

`mobile_delivery_status` `(string, enum)`

The current delivery status.

The value of this property must be one of the following enum values:

"unknown"
"not_delivered"
"delivered"
"deferred"

`has_authenticated_to_view` `(boolean, read only)`

If a person has identified to view the document.

`csv` `(array,null)`

`delivery_method` `(string, enum)`

Note that api delivery is referred to as "Link" delivery in the Scrive Web interface. Furthermore, pad delivery is referred to as "In-person".

Default: "email"

The value of this property must be one of the following enum values:

"email"
"mobile"
"email_mobile"
"pad"
"api"

`authentications` `(object)`

The authentications object has the following properties:

`view` `(object)`

This setting forces signatories to authenticate using the supplied identification method to view the document before signing.

Will be overridden by authentication_method_to_view property when both are present.

The view object has the following properties:

`name` `(string, enum, required)`

The value of this property must be one of the following enum values:

"standard"
"sms_pin"
"dk_mitid"
"dk_mitid_erhverv"
"fi_tupas"
"freja"
"nl_idin"
"no_bankid"
"onfido"
"onfido_document_check"
"onfido_document_and_photo_check"
"se_bankid"
"verimi"

`settings`

Schema of this object depends on selected authentication name.

The value of this property must match exactly one of the following schemas:

freja `(object)`

nl_idin `(object)`

onfido `(object)`

`sign` `(object)`

This setting forces user to authenticate to sign.

Will be overridden by authentication_method_to_sign property when both are present.

The sign object has the following properties:

`name` `(string, enum, required)`

The value of this property must be one of the following enum values:

"standard"
"sms_pin"
"sms_otp"
"dk_mitid"
"dk_mitid_erhverv"
"fi_tupas"
"freja"
"nl_idin"
"no_bankid"
"onfido"
"onfido_document_check"
"onfido_document_and_photo_check"
"se_bankid"
"swisscom_qes"
"swisscom_qes_with_srs"
"verimi_qes"
"itsme"
"itsme_qes"
"smart_id_qes"

`settings` `(object,null)`

Schema of this object depends on selected authentication name.

The value of this property must match exactly one of the following schemas:

freja `(object)`

nl_idin `(object)`

onfido `(object)`

swisscom `(object)`

`view_archived` `(object)`

This setting forces signatories to authenticate using the supplied identification method to view the document once it has been signed and resides in the e-archive.

Will be overridden by authentication_method_to_view_archived property when both are present.

The view_archived object has the following properties:

`name` `(string, enum, required)`

The value of this property must be one of the following enum values:

"standard"
"sms_pin"
"dk_mitid"
"dk_mitid_erhverv"
"fi_tupas"
"freja"
"nl_idin"
"no_bankid"
"onfido"
"onfido_document_check"
"onfido_document_and_photo_check"
"se_bankid"
"verimi"

`settings`

Schema of this object depends on selected authentication name.

The value of this property must match exactly one of the following schemas:

freja `(object)`

nl_idin `(object)`

onfido `(object)`

`authentication_method_to_view` `(string, enum)`

This setting forces signatories to authenticate using the supplied identification method to view the document before signing.

Default: "standard"

The value of this property must be one of the following enum values:

"standard"
"sms_pin"
"dk_mitid"
"dk_mitid_erhverv"
"fi_tupas"
"freja"
"nl_idin"
"no_bankid"
"onfido"
"onfido_document_check"
"onfido_document_and_photo_check"
"se_bankid"
"verimi"

`authentication_method_to_view_archived` `(string, enum)`

This setting forces signatories to authenticate using the supplied identification method to view the document once it has been signed and resides in the e-archive.

Default: "standard"

The value of this property must be one of the following enum values:

"standard"
"sms_pin"
"dk_mitid"
"dk_mitid_erhverv"
"fi_tupas"
"freja"
"nl_idin"
"no_bankid"
"onfido"
"onfido_document_check"
"onfido_document_and_photo_check"
"se_bankid"
"verimi"

`authentication_method_to_sign` `(string, enum)`

This setting forces user to authenticate to sign.

Default: "standard"

The value of this property must be one of the following enum values:

"standard"
"sms_pin"
"sms_otp"
"dk_mitid"
"dk_mitid_erhverv"
"fi_tupas"
"freja"
"nl_idin"
"no_bankid"
"onfido"
"onfido_document_check"
"onfido_document_and_photo_check"
"se_bankid"
"swisscom_qes"
"swisscom_qes_with_srs"
"verimi_qes"
"itsme"
"itsme_qes"
"smart_id_qes"

`confirmation_delivery_method` `(string, enum)`

Deliver a confirmation message about the document signing status by:

email an email including a file attachment of the signed document
mobile a text message with a link to the signed document
email_mobile both of the two above
email_link an email with a link to the signed document
email_link_mobile an email and a text message with a link to the signed document
none no delivery at all

Default: "email"

The value of this property must be one of the following enum values:

"email"
"mobile"
"email_mobile"
"email_link"
"email_link_mobile"
"none"

`notification_delivery_method` `(string, enum)`

Deliver a confirmation notification that the party signed/approved the document by:

email an email including a link to the document
mobile a text message including a link to the document
email_mobile both of the two above
none no delivery at all

Default: "none"

The value of this property must be one of the following enum values:

"email"
"mobile"
"email_mobile"
"none"

`allows_highlighting` `(boolean)`

Whether the signatory can highlight pages of the PDF when viewing the signing page.

If any highlights are performed, the evidence log states that they were performed while the signatory was viewing the document.

The intention of this feature is not for the signatory to affect a contract via highlighting, but simply for a point-of-sale situation to assist contract review.

Default: false

`hide_personal_number` `(boolean)`

Whether the personal number should be hidden in the final PDF verification page and the Evidence Log.

This is to be used when the document will be distributed to a wider audience, and the personal number of the signatory should not be available in the final document.

If the signatory has a placed field for their personal number, it will be included in the final PDF. So this solution only works when the field does not have any placements.

Default: false

`can_forward` `(boolean)`

Whether the signatory can forward the signing process to someone else.

Default: false

`highlighted_pages` `(array, read only)`

A list of highlights performed by the signatory.

While a document is pending, highlights may be added, but will not appear in the document file PDF until after the document is closed.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`page` `(integer)`

The page number which is highlighted (starts from 1). Each signatory can only have one highlight per page.

`file_id` `(string)`

The file_id for an image of the highlights.

The image dimensions will fit the ratio of the PDF page, and will be of a fixed colour and transparency.

This will be integrated into the final PDF once the document is closed.

`attachments` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

A signatory attachment - an attachment requested from the signing party. Attachments requested from viewing only parties have no effect.

This object has the following properties:

`name` `(string)`

A name for the requested attachment. Will be visible to the signatory when signing the document.

`description` `(string)`

A description for the requested attachment. Will be visible to the signatory when signing the document alongside the attachment name.

`required` `(boolean)`

Whether the signatory must upload this attachment. If false, the signatory may choose not to upload this attachment when signing.

Default: true

`file_id` `(string)`

Will be present if and when the party uploads this attachment.

`file_name` `(string)`

Will be present if and when the party uploads this attachment.

`add_to_sealed_file` `(boolean)`

Should the file of this attachment be merged into the final sealed document?

Default: true

`api_delivery_url` `(string,null)`

If the delivery_method is set to api, then this field will hold the relative URL for the party.

Note that api delivery is referred to as "Link" delivery in the Scrive Web interface.

This will only be available after the signing process has been started, and will only be visible when accessing the document as the author.

`consent_module`

The value of this property must match exactly one of the following schemas:

`(null)`

`(object)`

If present, a section will be shown asking the signatory to answer some questions which must be answered by the signatory with either the positive or the negative option specified.

This object has the following properties:

`title` `(string)`

Section title.

`questions` `(array)`

All array elements must be of type:

`(object)`

This object has the following properties:

`title` `(string)`

Question text.

`positive_option` `(string)`

`negative_option` `(string)`

`response` `(boolean)`

Will be present when the party has answered the question. true when the signatory selected the positive response and false when the signatory selected the negative response.

`detailed_description` `(object)`

Optional additional information to show the signatory.

The detailed_description object has the following properties:

`title` `(string)`

Title of the section. Will be shown in a button.

`text` `(string)`

Explanation of the question. New lines are shown as is.

`is_visible` `(bool,null)`

Determines if an approver is visible on the verification page and in sign view.

This value is only used for approvers. It has to be null for viewer and signing_party signatories.

Default: "null"

`document_roles` `(array)`

List of "roles" this signatory has within the document.

Default:
[]

All array elements must be of type:

`(string)`

`experimental` `(object)`

⚠️ WARNING: EXPERIMENTAL ⚠️

Experimental properties are not part of public API. Therefore they're not supported and are subject to change without prior notice.

The experimental object has the following properties:

`signatory_status` `(string, enum, read only)`

The current status of the signatory in relation to the document.

The statuses document_problem, document_draft, document_canceled, document_timedout and document_rejected are reflecting the status field of the underlying document for convenience.

The value of this property must be one of the following enum values:

"document_problem"
"document_draft"
"document_canceled"
"document_timedout"
"document_rejected"
"waiting_for_prior_signatures"
"invitation_sent"
"invitation_delivery_problem"
"invitation_delivered"
"invitation_read"
"document_opened"
"document_deferred"
"document_signed"
"document_approved"
"confirmation_delivery_problem"

SignatoryFieldName

(object)

Example JSON: for "SignatoryFieldName"

{
  "type": "name",
  "order": 1,
  "value": "John",
  "is_obligatory": true,
  "should_be_filled_by_sender": false,
  "placements": [
    {
      "xrel": 0.26105263157894737,
      "yrel": 0.0975609756097561,
      "wrel": 0.07894736842105263,
      "hrel": 0.024390243902439025,
      "fsrel": 0.01263157894736842,
      "page": 1,
      "tip": "right",
      "anchors": []
    }
  ],
  "description": "Name field"
}

A signatory field for the name(s) of the party.

This object has the following properties:

`type` `(string, enum, required)`

Used to specify that this is a name field.

The value of this property must be one of the following enum values:

"name"

`order` `(integer, enum, required)`

Whether this is the first name (i.e. given name) or second name (i.e. last name or surname).

Please ensure that there is exacatly one first name and one second name field, otherwise the signatory may not be asked for their name on the signing page.

The value of this property must be one of the following enum values:

`value` `(string)`

Either a pre-filled value, or the value entered by the signatory.

Default: ""

`is_obligatory` `(boolean)`

Default: true

`should_be_filled_by_sender` `(boolean)`

Default: false

`placements` `(array)`

If set, where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field

SignatoryFieldFullName

(object)

Example JSON: for "SignatoryFieldFullName"

{
  "type": "full_name",
  "placements": [
    {
      "xrel": 0.29368421052631577,
      "yrel": 0.3444940476190476,
      "wrel": 0.10842105263157895,
      "hrel": 0.025297619047619048,
      "fsrel": 0.016842105263157894,
      "page": 1,
      "tip": "right",
      "anchors": []
    }
  ]
}

This object has the following properties:

`type` `(string, enum, required)`

Used to specify that this is a full name field.

The value of this property must be one of the following enum values:

"full_name"

`placements` `(array)`

If set, where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field.

SignatoryFieldEmailMobile

(object)

Example JSON: for "SignatoryFieldEmailMobile"

{
  "type": "mobile",
  "value": "+461234567890",
  "is_obligatory": false,
  "should_be_filled_by_sender": false,
  "editable_by_signatory": false,
  "placements": [
    {
      "xrel": 0.09052631578947369,
      "yrel": 0.2700892857142857,
      "wrel": 0.09157894736842105,
      "hrel": 0.025297619047619048,
      "fsrel": 0.016842105263157894,
      "page": 1,
      "tip": "right",
      "anchors": []
    }
  ],
  "description": "Phone number field"
}

A signatory field for email addresses and mobile numbers.

This object has the following properties:

`type` `(string, enum, required)`

Used to specify what type of field this is.

The value of this property must be one of the following enum values:

"email"
"mobile"

`value` `(string)`

Either a pre-filled value, or the value entered by the signatory.

For the author: the value will revert to that set in the account settings. Trying to set any other value will simply result in this field reverting back to information set in account settings.

Default: ""

`is_obligatory` `(boolean)`

Default: true

`should_be_filled_by_sender` `(boolean)`

Default: false

`editable_by_signatory` `(boolean)`

Default: false

`placements` `(array)`

If set, where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field

SignatoryFieldSignature

(object)

Example JSON: for "SignatoryFieldSignature"

{
  "type": "signature",
  "name": "Signature 1",
  "signature": "9215148251416996589",
  "is_obligatory": true,
  "should_be_filled_by_sender": false,
  "placements": [
    {
      "xrel": 0.3510526315789474,
      "yrel": 0.1796747967479675,
      "wrel": 0.2736842105263158,
      "hrel": 0.08292682926829269,
      "fsrel": 0.0168,
      "page": 1,
      "tip": "right",
      "anchors": []
    }
  ],
  "description": "Signature field"
}

A signatory field for placing signature boxes on the document.

This object has the following properties:

`type` `(string, enum, required)`

The value of this property must be one of the following enum values:

"signature"

`name` `(string, required)`

A name for the signature field.

The signatory will not see the name of the signature field, however it will be used in the Evidence Log as a reference.

`signature` `(read only)`

The value of this property must match at least one of the following schemas:

`(null)`

When the signatory has not yet drawn a signature.

`(string)`

The File ID of the signature drawn by the signatory.

`is_obligatory` `(boolean)`

Default: true

`should_be_filled_by_sender` `(boolean)`

Default: false

`placements` `(array)`

Needs to be set, otherwise the signatory will not be able to draw a signature.

Defines where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field

SignatoryFieldStandard

(object)

Example JSON: for "SignatoryFieldStandard"

{
  "type": "company",
  "value": "Scrive AB",
  "is_obligatory": false,
  "should_be_filled_by_sender": false,
  "placements": [
    {
      "xrel": 0.09052631578947369,
      "yrel": 0.2700892857142857,
      "wrel": 0.09157894736842105,
      "hrel": 0.025297619047619048,
      "fsrel": 0.016842105263157894,
      "page": 1,
      "tip": "right",
      "anchors": []
    }
  ],
  "description": "Company field"
}

A signatory field for placing a number of standard text fields on the document:

Company name
Company number
Personal number (AKA social security number)

This object has the following properties:

`type` `(string, enum, required)`

Used to specify what type of field this is.

The value of this property must be one of the following enum values:

"company"
"company_number"
"personal_number"

`value` `(string)`

Either a pre-filled value, or the value entered by the signatory.

For the author: the value will revert to that set in the account settings. Trying to set any other value will simply result in this field reverting back to information set in account settings.

Default: ""

`is_obligatory` `(boolean)`

Default: true

`should_be_filled_by_sender` `(boolean)`

Default: false

`placements` `(array)`

If set, where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field

SignatoryFieldCheckbox

(object)

Example JSON: for "SignatoryFieldCheckbox"

{
  "type": "checkbox",
  "name": "Checkbox Name",
  "is_checked": true,
  "is_obligatory": true,
  "should_be_filled_by_sender": false,
  "placements": [
    {
      "xrel": 0.17526315789473684,
      "yrel": 0.3382113821138211,
      "wrel": 0.011538,
      "hrel": 0,
      "fsrel": 0,
      "page": 1,
      "tip": "left",
      "anchors": []
    }
  ],
  "description": "Checkbox field"
}

A signatory field for placing checkboxes on the document.

This object has the following properties:

`type` `(string, enum, required)`

Used to specify that this is a checkbox field.

The value of this property must be one of the following enum values:

"checkbox"

`name` `(string, required)`

A name for the checkbox.

The signatory will not see the name of the checkbox, however it will be used in the Evidence Log as a reference.

`is_checked` `(boolean)`

true when the checkbox is checked, false otherwise.

Setting this to true on a document in preparation has the effect of pre-checking the checkbox for the signatory.

Default: false

`is_obligatory` `(boolean)`

Whether the signatory is obliged to check this checkbox in order to sign the document.

Default: true

`should_be_filled_by_sender` `(boolean)`

Default: false

`placements` `(array)`

Needs to be set, otherwise there will be no checkbox visible to the signatory.

Defines where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number, required)`

Position on the x-axis, from 0 to 1.

`yrel` `(number, required)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, enum, required)`

Width of placement, as proportion of total width.

Checkboxes can only be three sizes. The numbers represent small, medium and large checkboxes.

The value of this property must be one of the following enum values:

0.011538
0.021153
0.0423076

`hrel` `(number, enum, required)`

Height of placement, not used for checkboxes, must be 0.

The value of this property must be one of the following enum values:

`fsrel` `(number, enum, required)`

Font size of placement, not used for checkboxes, must be 0.

The value of this property must be one of the following enum values:

`page` `(integer, required)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field

SignatoryFieldRadiogroup

(object)

Example JSON: for "SignatoryFieldRadiogroup"

{
  "type": "radiogroup",
  "name": "Large Radio buttons",
  "selected_value": "Radio button 2",
  "placements": [
    {
      "xrel": 0.7405263157894737,
      "yrel": 0.3796747967479675,
      "wrel": 0.025263,
      "hrel": 0,
      "fsrel": 0,
      "page": 1,
      "tip": "right",
      "anchors": []
    },
    {
      "xrel": 0.7405263157894737,
      "yrel": 0.4008130081300813,
      "wrel": 0.021052,
      "hrel": 0,
      "fsrel": 0,
      "page": 1,
      "tip": "right",
      "anchors": []
    },
    {
      "xrel": 0.7410526315789474,
      "yrel": 0.4211382113821138,
      "wrel": 0.014736,
      "hrel": 0,
      "fsrel": 0,
      "page": 1,
      "tip": "right",
      "anchors": []
    }
  ],
  "values": [
    "Radio button 1",
    "Radio button 2",
    "Radio button 3"
  ],
  "description": "Radio group field"
}

A signatory field for placing radio buttons on the document.

This object has the following properties:

`type` `(string, enum, required)`

Used to specify that this is a radio button group field.

The value of this property must be one of the following enum values:

"radiogroup"

`name` `(string, required)`

A name for the radiogroup.

The signatory will not see the name of the radiogroup, however it will be used in the Evidence Log as a reference.

`values` `(array, required)`

An array of radio button option values. The signatory will not see the name of the radio button values, however they will be used in the Evidence Log as a reference.

These must correspond one-to-one with the list of placements: that is the length of values must equal that of placements and vice-versa, otherwise an error is returned.

Must be equal in length to placements and have at least 2 items. Each item must be unique and not an empty string.

All array elements must be of type:

`(string)`

Empty strings are not allowed.

`placements` `(array, required)`

Defines where the individual radio buttons should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

These must correspond one-to-one with the list of values: that is the length of placements must equal that of vales and vice-versa, otherwise an error is returned.

Must be equal in length to values and have at least 2 items.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number, required)`

Position on the x-axis, from 0 to 1.

`yrel` `(number, required)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, enum, required)`

Width of placement, as proportion of total width.

Radio buttons can only be three sizes. The numbers represent small, medium and large radio buttons.

The value of this property must be one of the following enum values:

0.014736
0.021052
0.025263

`hrel` `(number, enum, required)`

Height of placement, not used for radio buttons, must be 0.

The value of this property must be one of the following enum values:

`fsrel` `(number, enum, required)`

Font size of placement, not used for radio buttons, must be 0.

The value of this property must be one of the following enum values:

`page` `(integer, required)`

The page number for this placement, starting from 1.

All radio buttons within the same group must be placed on the same page.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field

SignatoryFieldCustomText

(object)

Example JSON: for "SignatoryFieldCustomText"

{
  "type": "text",
  "name": "Custom Field Name",
  "value": "",
  "is_obligatory": true,
  "should_be_filled_by_sender": true,
  "placements": [
    {
      "xrel": 0.29368421052631577,
      "yrel": 0.3444940476190476,
      "wrel": 0.10842105263157895,
      "hrel": 0.025297619047619048,
      "fsrel": 0.016842105263157894,
      "page": 1,
      "tip": "right",
      "anchors": []
    }
  ],
  "custom_validation": {
    "pattern": "^foo|bar|baz$",
    "positive_example": "foo",
    "tooltip": "Must be either 'foo', 'bar', or 'baz'."
  },
  "description": "Custom name field"
}

This object has the following properties:

`type` `(string, enum, required)`

Used to specify that this is a custom text field.

The value of this property must be one of the following enum values:

"text"

`name` `(string, required)`

A name for the custom field.

The name will be used as a placeholder value on the signing page, it will also be used in the Evidence Log as a reference.

`value` `(string)`

Either a pre-filled value, or the value entered by the signatory.

Default: ""

`is_obligatory` `(boolean)`

Default: true

`should_be_filled_by_sender` `(boolean)`

Default: false

`placements` `(array)`

Needs to be set, otherwise the signatory will not be asked or presented with this information.

Defines where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`custom_validation`

The value of this property must match exactly one of the following schemas:

`(null)`

SignatoryFieldCustomValidation `(object)`

Optional. Describes how to validate the input to this field using a custom regular expression.

This object has the following properties:

`pattern` `(string, required)`

Regular expression pattern for field validation.

`positive_example` `(string, required)`

Example of an input that matches the pattern.

`tooltip` `(string, required)`

Tooltip for the input text field.

`description` `(string,null)`

Description of this field

SignatoryFieldDate

(object)

Example JSON: for "SignatoryFieldDate"

{
  "type": "date",
  "name": "Date field",
  "value": null,
  "is_obligatory": true,
  "should_be_filled_by_sender": true,
  "placements": [
    {
      "xrel": 0.29368421052631577,
      "yrel": 0.3444940476190476,
      "wrel": 0.10842105263157895,
      "hrel": 0.025297619047619048,
      "fsrel": 0.016842105263157894,
      "page": 1,
      "tip": "right",
      "anchors": []
    }
  ],
  "configuration": {
    "start_date": {
      "type": "relative-to-doc-view",
      "value": 5
    },
    "end_date": {
      "type": "absolute",
      "value": "2020-01-01"
    }
  }
}

Signatory field for dates. Optionally can impose restrictions on start and/or end date (either absolute or relative to document view).

This object has the following properties:

`type` `(string, enum, required)`

Used to specify that this is a date field.

The value of this property must be one of the following enum values:

"date"

`name` `(string, required)`

A name for the date field.

The name will be used as a placeholder value on the signing page, it will also be used in the Evidence Log as a reference.

`value` `(string,null)`

Either a pre-filled value, or the value entered by the signatory. Must be specified as ISO8601 date.

Default: null

`is_obligatory` `(boolean)`

Default: true

`should_be_filled_by_sender` `(boolean)`

Default: false

`placements` `(array)`

Defines where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field.

`configuration` `(object, required)`

Definition of optional restriction imposed upon start and/or end date. Null means no restriction.

The configuration object has the following properties:

`start_date` `(required)`

The value of this property must match exactly one of the following schemas:

`(null)`

DateConfig `(object)`

Describes restriction imposed on start or end date of a signatory date field. The threshold is the document view date plus the number of days defined in value (which may be negative).

This object has the following properties:

`type` `(string, enum)`

The value of this property must be one of the following enum values:

"relative-to-doc-view"

`value` `(integer)`

DateConfig `(object)`

Describes restriction imposed on start or end date of a signatory date field. The threshold is the date specified by value.

This object has the following properties:

`type` `(string, enum)`

The value of this property must be one of the following enum values:

"absolute"

`value` `(string)`

Must be specified as ISO8601 date between 1900-01-01 and 2200-12-31.

`end_date` `(required)`

The value of this property must match exactly one of the following schemas:

`(null)`

DateConfig `(object)`

Describes restriction imposed on start or end date of a signatory date field. The threshold is the document view date plus the number of days defined in value (which may be negative).

This object has the following properties:

`type` `(string, enum)`

The value of this property must be one of the following enum values:

"relative-to-doc-view"

`value` `(integer)`

DateConfig `(object)`

Describes restriction imposed on start or end date of a signatory date field. The threshold is the date specified by value.

This object has the following properties:

`type` `(string, enum)`

The value of this property must be one of the following enum values:

"absolute"

`value` `(string)`

Must be specified as ISO8601 date between 1900-01-01 and 2200-12-31.

SignatoryFieldSignDate

(object)

Example JSON: for "SignatoryFieldSignDate"

{
  "type": "sign_date",
  "value": "2021-10-03",
  "placements": [
    {
      "xrel": 0.29368421052631577,
      "yrel": 0.3444940476190476,
      "wrel": 0.10842105263157895,
      "hrel": 0.025297619047619048,
      "fsrel": 0.016842105263157894,
      "page": 1,
      "tip": "right",
      "anchors": []
    }
  ]
}

Signatory field displaying sign date of the respective signatory.

This object has the following properties:

`type` `(string, enum, required)`

Used to specify that this is a sign date field.

The value of this property must be one of the following enum values:

"sign_date"

`value` `(string,null)`

Date when the signatory has signed or null if not yet signed. Formatted as ISO8601 date. Read only.

Default: null

`placements` `(array)`

Defines where this field should be placed on the document. This is both for the signatory to fill out on the signing page, and for the final sealed PDF.

Note that this is an array, you can have multiple placements for the same field.

The easiest way to set the xrel, yrel, etc. values is to create a template in the document UI design view, and use those values.

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`xrel` `(number)`

Position on the x-axis, from 0 to 1.

`yrel` `(number)`

Position on the y-axis, from 0 to 1.

`wrel` `(number, required)`

Width of placement, as proportion of total width, from 0 to 1.

`hrel` `(number, required)`

Height of placement, as proportion of total height, from 0 to 1.

`fsrel` `(number, required)`

Font size of placement, as proportion of total width, from 0 to 1.

`page` `(integer)`

The page number for this placement, starting from 1.

`tip`

Default: null

The value of this property must match at least one of the following schemas:

`(string, enum)`

From which side the arrow on the signing page should point to the field.

The value of this property must be one of the following enum values:

"left"
"right"

`(null)`

Let the signing page default to either left or right depending on the field type.

`anchors` `(array)`

Default:
[]

All array elements must be of type:

`(object)`

This object has the following properties:

`text` `(string, required)`

`index` `(integer, required)`

`offset` `(object)`

The offset object has the following properties:

`x` `(number)`

Relative X offset from the anchored text position.

`y` `(number)`

Relative Y offset from the anchored text position.

`description` `(string,null)`

Description of this field.

Authentication to view with settings

(object)

This object has the following properties:

`name` `(string, enum, required)`

The value of this property must be one of the following enum values:

"standard"
"sms_pin"
"dk_mitid"
"dk_mitid_erhverv"
"fi_tupas"
"freja"
"nl_idin"
"no_bankid"
"onfido"
"onfido_document_check"
"onfido_document_and_photo_check"
"se_bankid"
"verimi"

`settings`

Schema of this object depends on selected authentication name.

The value of this property must match exactly one of the following schemas:

freja `(object)`

nl_idin `(object)`

onfido `(object)`

Authentication to sign with settings

(object)

This object has the following properties:

`name` `(string, enum, required)`

The value of this property must be one of the following enum values:

"standard"
"sms_pin"
"sms_otp"
"dk_mitid"
"dk_mitid_erhverv"
"fi_tupas"
"freja"
"nl_idin"
"no_bankid"
"onfido"
"onfido_document_check"
"onfido_document_and_photo_check"
"se_bankid"
"swisscom_qes"
"swisscom_qes_with_srs"
"verimi_qes"
"itsme"
"itsme_qes"
"smart_id_qes"

`settings` `(object,null)`

Schema of this object depends on selected authentication name.

The value of this property must match exactly one of the following schemas:

freja `(object)`

nl_idin `(object)`

onfido `(object)`

swisscom `(object)`