Signature Request Definition

{
  "id": "<any>",
  "draft": true,
  "finalized": true,
  "name": "<string>",
  "content": {
    "id": "<any>",
    "raw": "<any>"
  },
  "anonymousKey": "<string>",
  "organization": {
    "id": "<any>",
    "name": "<string>",
    "logo": "<any>",
    "emailAddress": "<any>",
    "quota": {},
    "policies": {},
    "createdAt": "<any>",
    "updatedAt": "<any>"
  },
  "witness": {
    "id": "<any>",
    "hash": "<any>",
    "algorithm": "SHA256",
    "initialOwner": {
      "id": "<any>",
      "commonName": "<string>",
      "serialNumber": "<string>",
      "country": "<any>",
      "RFC": "<string>",
      "emailAddress": "<any>",
      "certificate": {},
      "termsInvite": {},
      "pushNotificationToken": "<string>",
      "EVMAddress": "<any>",
      "createdAt": "<any>",
      "updatedAt": "<any>",
      "wallet": {}
    },
    "claiming": {
      "id": "<any>",
      "authorizer": "<any>",
      "signature": "<any>",
      "claimer": "<any>",
      "network": "<any>",
      "createdAt": "<any>",
      "updatedAt": "<any>"
    },
    "claimed": true,
    "signatureRequest": {
      "id": "<any>",
      "draft": true,
      "finalized": true,
      "name": "<string>",
      "content": {},
      "anonymousKey": "<string>",
      "organization": {},
      "witness": {},
      "invites": [
        "<any>"
      ],
      "signed": "<any>",
      "pending": "<any>",
      "rejected": "<any>",
      "rejectedAt": "<any>",
      "createdAt": "<any>",
      "updatedAt": "<any>"
    },
    "organization": {
      "id": "<any>",
      "name": "<string>",
      "logo": "<any>",
      "emailAddress": "<any>",
      "quota": {},
      "policies": {},
      "createdAt": "<any>",
      "updatedAt": "<any>"
    },
    "nom151": {
      "provider": "CINCEL",
      "createdAt": "<any>",
      "updatedAt": "<any>"
    },
    "merkleized": {
      "txHash": "<any>",
      "network": "<any>",
      "merkleProof": [
        "<any>"
      ],
      "merkleRoot": "<any>",
      "nom151Provider": "CINCEL",
      "algorithm": "SHA256",
      "createdAt": "<any>",
      "updatedAt": "<any>"
    },
    "witnessCo": {
      "timestamp": "<any>",
      "leafIndex": "<any>",
      "leftHashes": [
        "<any>"
      ],
      "rightHashes": [
        "<any>"
      ],
      "targetRootHash": "<any>",
      "createdAt": "<any>",
      "updatedAt": "<any>"
    },
    "timestampedAt": "<any>",
    "createdAt": "<any>",
    "updatedAt": "<any>",
    "endorsable": {
      "id": "<any>",
      "ownerId": "<string>",
      "timestamp": 123,
      "network": 123,
      "owner": {},
      "endorseEvents": {},
      "witness": {}
    }
  },
  "invites": [
    {
      "id": "<any>",
      "signatureRequest": {
        "id": "<any>",
        "draft": true,
        "finalized": true,
        "name": "<string>",
        "content": {
          "id": "<any>",
          "raw": "<any>"
        },
        "anonymousKey": "<string>",
        "organization": {},
        "witness": {},
        "invites": [
          {}
        ],
        "signed": "<any>",
        "pending": "<any>",
        "rejected": "<any>",
        "rejectedAt": "<any>",
        "createdAt": "<any>",
        "updatedAt": "<any>"
      },
      "subject": {
        "id": "<any>",
        "commonName": "<string>",
        "serialNumber": "<string>",
        "country": "<any>",
        "RFC": "<string>",
        "emailAddress": "<any>",
        "certificate": {
          "id": "<any>",
          "serialNumber": "<any>",
          "issuer": {},
          "notBefore": "<any>",
          "notAfter": "<any>",
          "subject": {},
          "publicKey": {},
          "version": "<any>",
          "hash": "<any>",
          "certificatePem": "<string>",
          "revoked": true,
          "createdAt": "<any>",
          "updatedAt": "<any>"
        },
        "termsInvite": {
          "id": "<any>",
          "signatureRequest": {},
          "subject": {},
          "certificate": {},
          "signature": "<any>",
          "ocspResponse": "<any>",
          "witness": {},
          "status": "PENDING",
          "rejectedAt": "<any>",
          "signedAt": "<any>",
          "createdAt": "<any>",
          "updatedAt": "<any>"
        },
        "pushNotificationToken": "<string>",
        "EVMAddress": "<any>",
        "createdAt": "<any>",
        "updatedAt": "<any>",
        "wallet": {}
      },
      "certificate": {
        "id": "<any>",
        "serialNumber": "<any>",
        "issuer": {
          "id": "<any>",
          "RFC": "<string>",
          "hash": "<any>",
          "commonName": "<string>",
          "organization": "<string>",
          "organizationalUnitName": "<string>",
          "emailAddress": "<any>",
          "streetAddress": "<string>",
          "postalCode": 123,
          "country": "<any>",
          "stateOrProvinceName": "<string>",
          "localityName": "<string>",
          "publicKey": {},
          "certificatePem": "<string>",
          "createdAt": "<any>",
          "updatedAt": "<any>"
        },
        "notBefore": "<any>",
        "notAfter": "<any>",
        "subject": {
          "id": "<any>",
          "commonName": "<string>",
          "serialNumber": "<string>",
          "country": "<any>",
          "RFC": "<string>",
          "emailAddress": "<any>",
          "certificate": {},
          "termsInvite": {},
          "pushNotificationToken": "<string>",
          "EVMAddress": "<any>",
          "createdAt": "<any>",
          "updatedAt": "<any>",
          "wallet": {}
        },
        "publicKey": {
          "exponent": "<any>",
          "modulus": "<any>"
        },
        "version": "<any>",
        "hash": "<any>",
        "certificatePem": "<string>",
        "revoked": true,
        "createdAt": "<any>",
        "updatedAt": "<any>"
      },
      "signature": "<any>",
      "ocspResponse": "<any>",
      "witness": {
        "id": "<any>",
        "hash": "<any>",
        "algorithm": "SHA256",
        "initialOwner": {
          "id": "<any>",
          "commonName": "<string>",
          "serialNumber": "<string>",
          "country": "<any>",
          "RFC": "<string>",
          "emailAddress": "<any>",
          "certificate": {},
          "termsInvite": {},
          "pushNotificationToken": "<string>",
          "EVMAddress": "<any>",
          "createdAt": "<any>",
          "updatedAt": "<any>",
          "wallet": {}
        },
        "claiming": {
          "id": "<any>",
          "authorizer": "<any>",
          "signature": "<any>",
          "claimer": "<any>",
          "network": "<any>",
          "createdAt": "<any>",
          "updatedAt": "<any>"
        },
        "claimed": true,
        "signatureRequest": {
          "id": "<any>",
          "draft": true,
          "finalized": true,
          "name": "<string>",
          "content": {},
          "anonymousKey": "<string>",
          "organization": {},
          "witness": {},
          "invites": [
            "<any>"
          ],
          "signed": "<any>",
          "pending": "<any>",
          "rejected": "<any>",
          "rejectedAt": "<any>",
          "createdAt": "<any>",
          "updatedAt": "<any>"
        },
        "organization": {
          "id": "<any>",
          "name": "<string>",
          "logo": "<any>",
          "emailAddress": "<any>",
          "quota": {},
          "policies": {},
          "createdAt": "<any>",
          "updatedAt": "<any>"
        },
        "nom151": {
          "provider": "CINCEL",
          "createdAt": "<any>",
          "updatedAt": "<any>"
        },
        "merkleized": {
          "txHash": "<any>",
          "network": "<any>",
          "merkleProof": [
            "<any>"
          ],
          "merkleRoot": "<any>",
          "nom151Provider": "CINCEL",
          "algorithm": "SHA256",
          "createdAt": "<any>",
          "updatedAt": "<any>"
        },
        "witnessCo": {
          "timestamp": "<any>",
          "leafIndex": "<any>",
          "leftHashes": [
            "<any>"
          ],
          "rightHashes": [
            "<any>"
          ],
          "targetRootHash": "<any>",
          "createdAt": "<any>",
          "updatedAt": "<any>"
        },
        "timestampedAt": "<any>",
        "createdAt": "<any>",
        "updatedAt": "<any>",
        "endorsable": {
          "id": "<any>",
          "ownerId": "<string>",
          "timestamp": 123,
          "network": 123,
          "owner": {},
          "endorseEvents": {},
          "witness": {}
        }
      },
      "status": "PENDING",
      "rejectedAt": "<any>",
      "signedAt": "<any>",
      "createdAt": "<any>",
      "updatedAt": "<any>"
    }
  ],
  "signed": "<any>",
  "pending": "<any>",
  "rejected": "<any>",
  "rejectedAt": "<any>",
  "createdAt": "<any>",
  "updatedAt": "<any>"
}

A signature request is a request for a signature on a document. The documents can be in:

Raw text format
PDF format
IOU format (a transferrable signed promise to pay)
JSON format (a structured data format)

A signature request is an entity that represents a piece of data that needs to be signed by a user.

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

draft

boolean

required

Whether the document is a draft or not. A draft signature request won't allow invites to sign and will skip processing notifications.

finalized

boolean

required

Whether the document is finalized or not. A finalized request won't allow new invites and won't process any new notifications.

name

string

required

Custom name for the signature request.

content

object

required

The content data to be signed. Raw content is a string that can be signed.

Show child attributes

anonymousKey

string

required

Key for sharing the sharing the signature request. Can be used to access the signature request without authentication.

organization

object

required

The organization requesting the signature.

Show child attributes

witness

object

required

Witness that attest the content using a merkle proof

Show child attributes

invites

object[]

required

Invites to sign the content.

Show child attributes

signed

any

required

Amount of invites that have signed the content.

pending

any

required

Amount of invites that have not signed the content.

rejected

any

required

Amount of invites that have rejected the content.

createdAt

any

required

A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

updatedAt

any

required

rejectedAt

any

Date when the signature request was rejected. Only present if rejected.

Create a Signature Request Invite List Signature Requests

Introduction

Certificate

Issuer

Organization

Signature Request Invite

Signature Request

Subject

Witness

Wallet

Endorsable

Endorse Event

API Key

Organization Link

Organization Member

Timeseries

Price Oracle

Other

Signature Request Definition