List Signature Requests

GET

signature-requests

curl --request GET \
  --url https://api.plumaa.id/rest/v1/signature-requests \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "info": {
    "id": "<string>",
    "count": "<any>",
    "pages": "<any>",
    "next": "<any>",
    "prev": "<any>"
  },
  "results": [
    {
      "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": {
          "id": "<any>",
          "API": true,
          "groupedNOM151": 123,
          "nom151": 123
        },
        "policies": {
          "signatureRequest": {
            "conservation": "NOM151"
          }
        },
        "createdAt": "<any>",
        "updatedAt": "<any>"
      },
      "witness": {
        "id": "<any>",
        "hash": "<any>",
        "algorithm": "SHA256",
        "initialOwner": {},
        "claiming": {
          "id": "<any>",
          "authorizer": "<any>",
          "signature": "<any>",
          "claimer": "<any>",
          "network": "<any>",
          "createdAt": "<any>",
          "updatedAt": "<any>"
        },
        "claimed": true,
        "signatureRequest": {},
        "organization": {
          "id": "<any>",
          "name": "<string>",
          "logo": "<any>",
          "emailAddress": "<any>",
          "quota": {
            "id": "<any>",
            "API": true,
            "groupedNOM151": 123,
            "nom151": 123
          },
          "policies": {
            "signatureRequest": {
              "conservation": "NOM151"
            }
          },
          "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": {
            "id": "<string>",
            "endorsables": {
              "items": [
                {}
              ],
              "pageInfo": {
                "hasNextPage": true,
                "hasPreviousPage": true,
                "startCursor": "<string>",
                "endCursor": "<string>"
              }
            },
            "endorseFromEvents": {
              "items": [
                {
                  "id": "<string>",
                  "timestamp": 123,
                  "fromId": "<string>",
                  "toId": "<string>",
                  "digest": "<any>",
                  "network": 123,
                  "from": {},
                  "to": {},
                  "token": {}
                }
              ],
              "pageInfo": {
                "hasNextPage": true,
                "hasPreviousPage": true,
                "startCursor": "<string>",
                "endCursor": "<string>"
              }
            },
            "endorseToEvents": {
              "items": [
                {
                  "id": "<string>",
                  "timestamp": 123,
                  "fromId": "<string>",
                  "toId": "<string>",
                  "digest": "<any>",
                  "network": 123,
                  "from": {},
                  "to": {},
                  "token": {}
                }
              ],
              "pageInfo": {
                "hasNextPage": true,
                "hasPreviousPage": true,
                "startCursor": "<string>",
                "endCursor": "<string>"
              }
            },
            "subject": {}
          },
          "endorseEvents": {
            "items": [
              {
                "id": "<string>",
                "timestamp": 123,
                "fromId": "<string>",
                "toId": "<string>",
                "digest": "<any>",
                "network": 123,
                "from": {},
                "to": {},
                "token": {}
              }
            ],
            "pageInfo": {
              "hasNextPage": true,
              "hasPreviousPage": true,
              "startCursor": "<string>",
              "endCursor": "<string>"
            }
          },
          "witness": {}
        }
      },
      "invites": [
        {
          "id": "<any>",
          "signatureRequest": {},
          "subject": {},
          "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": {
                "exponent": "<any>",
                "modulus": "<any>"
              },
              "certificatePem": "<string>",
              "createdAt": "<any>",
              "updatedAt": "<any>"
            },
            "notBefore": "<any>",
            "notAfter": "<any>",
            "subject": {},
            "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": {},
            "claiming": {
              "id": "<any>",
              "authorizer": "<any>",
              "signature": "<any>",
              "claimer": "<any>",
              "network": "<any>",
              "createdAt": "<any>",
              "updatedAt": "<any>"
            },
            "claimed": true,
            "signatureRequest": {},
            "organization": {
              "id": "<any>",
              "name": "<string>",
              "logo": "<any>",
              "emailAddress": "<any>",
              "quota": {
                "id": "<any>",
                "API": true,
                "groupedNOM151": 123,
                "nom151": 123
              },
              "policies": {
                "signatureRequest": {
                  "conservation": "NOM151"
                }
              },
              "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": {
                "id": "<string>",
                "endorsables": {
                  "items": [
                    {}
                  ],
                  "pageInfo": {
                    "hasNextPage": true,
                    "hasPreviousPage": true,
                    "startCursor": "<string>",
                    "endCursor": "<string>"
                  }
                },
                "endorseFromEvents": {
                  "items": [
                    {
                      "id": "<string>",
                      "timestamp": 123,
                      "fromId": "<string>",
                      "toId": "<string>",
                      "digest": "<any>",
                      "network": 123,
                      "from": {},
                      "to": {},
                      "token": {}
                    }
                  ],
                  "pageInfo": {
                    "hasNextPage": true,
                    "hasPreviousPage": true,
                    "startCursor": "<string>",
                    "endCursor": "<string>"
                  }
                },
                "endorseToEvents": {
                  "items": [
                    {
                      "id": "<string>",
                      "timestamp": 123,
                      "fromId": "<string>",
                      "toId": "<string>",
                      "digest": "<any>",
                      "network": 123,
                      "from": {},
                      "to": {},
                      "token": {}
                    }
                  ],
                  "pageInfo": {
                    "hasNextPage": true,
                    "hasPreviousPage": true,
                    "startCursor": "<string>",
                    "endCursor": "<string>"
                  }
                },
                "subject": {}
              },
              "endorseEvents": {
                "items": [
                  {
                    "id": "<string>",
                    "timestamp": 123,
                    "fromId": "<string>",
                    "toId": "<string>",
                    "digest": "<any>",
                    "network": 123,
                    "from": {},
                    "to": {},
                    "token": {}
                  }
                ],
                "pageInfo": {
                  "hasNextPage": true,
                  "hasPreviousPage": true,
                  "startCursor": "<string>",
                  "endCursor": "<string>"
                }
              },
              "witness": {}
            }
          },
          "status": "PENDING",
          "rejectedAt": "<any>",
          "signedAt": "<any>",
          "createdAt": "<any>",
          "updatedAt": "<any>"
        }
      ],
      "signed": "<any>",
      "pending": "<any>",
      "rejected": "<any>",
      "rejectedAt": "<any>",
      "createdAt": "<any>",
      "updatedAt": "<any>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

_id

object

ObjectID matching arguments.

object

Search arguments for SignatureRequestss query.

type

object

ContentType matching arguments.

draft

boolean

finalized

boolean

organization

object

ObjectID matching arguments.

subject

object

ObjectID matching arguments.

createdAt

object

Date range arguments.

updatedAt

object

Date range arguments.

rejectedAt

object

Date range arguments.

signedAt

object

Date range arguments.

sort

object

Sort arguments for SignatureRequest query.

pagination

object

Pagination arguments.

accessScope

enum<string>

Available options:

Organization,

Subject

Response

200 - application/json

Results of an SignatureRequest query.

string

required

info

object

required

Pagination info.

results

object[]

required

List of SignatureRequest.

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

results.id

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

results.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.

results.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.

results.name

string

required

Custom name for the signature request.

results.content

object

required

The content data to be signed.

results.anonymousKey

string

required

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

results.organization

object

required

The organization requesting the signature.

results.organization.id

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

results.organization.name

string

required

The name of the Organization. This is the name that will be displayed to users when interacting with signature requests from this organization.

results.organization.logo

any

required

The logo of the Organization. This is the logo that will be displayed to users when interacting with signature requests from this organization.

results.organization.emailAddress

any

required

Email address of the organization. Updates and notifications will be sent to this address, as well as the billing information.

results.organization.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.

results.organization.updatedAt

any

required

results.organization.quota

object

Quotas of the Organization.

results.organization.policies

object

Policies of the Organization.

results.witness

object

required

Witness that attest the content using a merkle proof

results.witness.id

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

results.witness.hash

any

required

Hash of the document to witness.

results.witness.algorithm

enum<string>

required

The algorithm used for hashing the document.

Available options:

SHA256

results.witness.organization

object

required

Organization that created the witness.

results.witness.organization.id

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

results.witness.organization.name

string

required

The name of the Organization. This is the name that will be displayed to users when interacting with signature requests from this organization.

results.witness.organization.logo

any

required

The logo of the Organization. This is the logo that will be displayed to users when interacting with signature requests from this organization.

results.witness.organization.emailAddress

any

required

Email address of the organization. Updates and notifications will be sent to this address, as well as the billing information.

results.witness.organization.createdAt

any

required

results.witness.organization.updatedAt

any

required

results.witness.organization.quota

object

Quotas of the Organization.

results.witness.organization.policies

object

Policies of the Organization.

results.witness.createdAt

any

required

results.witness.updatedAt

any

required

results.witness.initialOwner

object

Subject designed as the first in the endorsement chain. Only a member of the operating organization can set this field. Once set, our on-chain relayer will submit a proof of endorsement to the Witness contract so that the corresponding token can be minted by the user later on the application.

results.witness.initialOwner.id

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

results.witness.initialOwner.commonName

string

required

Name of the subject.

results.witness.initialOwner.serialNumber

string

required

CURP of the subject. It is a unique identifier for people in Mexico.

results.witness.initialOwner.RFC

string

required

RFC of the subject. It is a unique identifier for persons and organizations in Mexico.

results.witness.initialOwner.EVMAddress

any

required

EVM address of the subject.

Each account is a smart account that includes a single signer contract deterministically created from a factory deployed through xdeployer so that every signer contract has the same address in all EVM networks. This signer contract is an implementation of a custom ERC-1271 interface that allows the RSA key to sign on-chain. Signers can be deployed trustlessly by anyone since they're controlled by the account owner.

The smart account is created from the Safe{Wallet} factory and includes a setup call to the RSA signer factory, deploying the signer contract who'll own the account. The account factory is already deployed on all networks with the same address so that the account can be created deterministically in all EVM networks too

This setup allows the following properties:

The signer contract factory can create the same signer contract in all EVM chains for the same RSA key
The account can be created deterministically in all EVM chains because it depends on the signer contract address and the RSA public key

In this way, the EVM address is completely abstracted from the EVM network, so we just need to keep a single address.

results.witness.initialOwner.createdAt

any

required

results.witness.initialOwner.updatedAt

any

required

results.witness.initialOwner.country

any

Country of the subject.

results.witness.initialOwner.emailAddress

any

Email address of the subject.

results.witness.initialOwner.certificate

object

Certificate of the subject.

results.witness.initialOwner.certificate.id

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

results.witness.initialOwner.certificate.serialNumber

any

required

The certificate's serial number, as a hexadecimal string. This is a unique identifier for the certificate, and is assigned by the issuer.

results.witness.initialOwner.certificate.issuer

object

required

The certificate's issuer. This is the entity that issued the certificate, and is a Certificate Authority certified by Banxico.

results.witness.initialOwner.certificate.notBefore

any

required

The earliest date at which the certificate is valid.

results.witness.initialOwner.certificate.notAfter

any

required

The latest date at which the certificate is valid.

results.witness.initialOwner.certificate.subject

object

required

The certificate's subject. This is the entity that the certificate is attesting to, and is typically a person or organization ("persona física o moral" in spanish).

results.witness.initialOwner.certificate.publicKey

object

required

The certificate's public key. This is the public key that identifies messages signed by its corresponding private key.

results.witness.initialOwner.certificate.version

any

required

The version of the X.509 standard that the certificate conforms to.

results.witness.initialOwner.certificate.hash

any

required

SHA256 message digest of the issuer's certificate.

results.witness.initialOwner.certificate.certificatePem

string

required

AWS S3 URI path to the certificate's PEM data.

results.witness.initialOwner.certificate.revoked

boolean

required

Whether the certificate has been revoked by the issuer.

results.witness.initialOwner.certificate.createdAt

any

required

results.witness.initialOwner.certificate.updatedAt

any

required

results.witness.initialOwner.termsInvite

object

Invite for the subject to sign Plumaa own terms and conditions.

results.witness.initialOwner.termsInvite.id

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

results.witness.initialOwner.termsInvite.signatureRequest

object

required

The signature request this invite is linked to.

results.witness.initialOwner.termsInvite.subject

object

required

The subject this invite is linked to.

results.witness.initialOwner.termsInvite.status

enum<string>

required

The status of the signature request invite.

Available options:

PENDING,

SIGNED,

WITNESSED,

REJECTED

results.witness.initialOwner.termsInvite.createdAt

any

required

results.witness.initialOwner.termsInvite.updatedAt

any

required

results.witness.initialOwner.termsInvite.certificate

object

The certificate this invite was signed with.

results.witness.initialOwner.termsInvite.signature

any

The signature from the certificate as a hexadecimal string.

results.witness.initialOwner.termsInvite.ocspResponse

any

The OCSP response from checking the certificate against the CA. ASN1 encoded as a hexadecimal string.

results.witness.initialOwner.termsInvite.witness

object

Witness that attest the signature using a merkle proof

results.witness.initialOwner.termsInvite.rejectedAt

any

Date at which the signature request invite was rejected. Only present if rejected.

results.witness.initialOwner.termsInvite.signedAt

any

Date at which the signature request invite was signed. Only present if signed.

results.witness.initialOwner.pushNotificationToken

string

The push notification token associated with the certificate. Used for sending notifications to the user.

results.witness.initialOwner.wallet

object

results.witness.claiming

object

Information required to claim a document in the Endorser contract. It is only present if the witness is processed and restricted to the initial owner.

results.witness.claimed

boolean

If the witness has been claimed by the initial owner.

results.witness.signatureRequest

object

Signature Request the witness is associated with. May not be present if the witness was via the API.

results.witness.signatureRequest.id

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

results.witness.signatureRequest.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.

results.witness.signatureRequest.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.

results.witness.signatureRequest.name

string

required

Custom name for the signature request.

results.witness.signatureRequest.content

object

required

The content data to be signed.

results.witness.signatureRequest.anonymousKey

string

required

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

results.witness.signatureRequest.organization

object

required

The organization requesting the signature.

results.witness.signatureRequest.witness

object

required

Witness that attest the content using a merkle proof

results.witness.signatureRequest.witness.id

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

results.witness.signatureRequest.witness.hash

any

required

Hash of the document to witness.

results.witness.signatureRequest.witness.algorithm

enum<string>

required

The algorithm used for hashing the document.

Available options:

SHA256

results.witness.signatureRequest.witness.organization

object

required

Organization that created the witness.

results.witness.signatureRequest.witness.createdAt

any

required

results.witness.signatureRequest.witness.updatedAt

any

required

results.witness.signatureRequest.witness.initialOwner

object

results.witness.signatureRequest.witness.claiming

object

Information required to claim a document in the Endorser contract. It is only present if the witness is processed and restricted to the initial owner.

results.witness.signatureRequest.witness.claimed

boolean

If the witness has been claimed by the initial owner.

results.witness.signatureRequest.witness.signatureRequest

object

Signature Request the witness is associated with. May not be present if the witness was via the API.

results.witness.signatureRequest.witness.nom151

object

Individual NOM151 conservation strategy.

results.witness.signatureRequest.witness.merkleized

object

Combined merkleized conservation strategy.

results.witness.signatureRequest.witness.witnessCo

object

Witness conservation strategy.

results.witness.signatureRequest.witness.timestampedAt

any

Earliest date when the hash was witnessed by any strategy. Unspecified if the witness is not processed.

results.witness.signatureRequest.witness.endorsable

object

results.witness.signatureRequest.invites

object[]

required

Invites to sign the content.

A signature request invite is an invite to sign a signature request. It links a signature request to a subject and it stores its corresponding signature and the link to the certificate that the signature belongs to.

results.witness.signatureRequest.invites.id

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

results.witness.signatureRequest.invites.signatureRequest

object

required

The signature request this invite is linked to.

results.witness.signatureRequest.invites.subject

object

required

The subject this invite is linked to.

results.witness.signatureRequest.invites.status

enum<string>

required

The status of the signature request invite.

Available options:

PENDING,

SIGNED,

WITNESSED,

REJECTED

results.witness.signatureRequest.invites.createdAt

any

required

results.witness.signatureRequest.invites.updatedAt

any

required

results.witness.signatureRequest.invites.certificate

object

The certificate this invite was signed with.

results.witness.signatureRequest.invites.signature

any

The signature from the certificate as a hexadecimal string.

results.witness.signatureRequest.invites.ocspResponse

any

The OCSP response from checking the certificate against the CA. ASN1 encoded as a hexadecimal string.

results.witness.signatureRequest.invites.witness

object

Witness that attest the signature using a merkle proof

results.witness.signatureRequest.invites.rejectedAt

any

Date at which the signature request invite was rejected. Only present if rejected.

results.witness.signatureRequest.invites.signedAt

any

Date at which the signature request invite was signed. Only present if signed.

results.witness.signatureRequest.signed

any

required

Amount of invites that have signed the content.

results.witness.signatureRequest.pending

any

required

Amount of invites that have not signed the content.

results.witness.signatureRequest.rejected

any

required

Amount of invites that have rejected the content.

results.witness.signatureRequest.createdAt

any

required

results.witness.signatureRequest.updatedAt

any

required

results.witness.signatureRequest.rejectedAt

any

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

results.witness.nom151

object

Individual NOM151 conservation strategy.

results.witness.merkleized

object

Combined merkleized conservation strategy.

results.witness.witnessCo

object

Witness conservation strategy.

results.witness.timestampedAt

any

Earliest date when the hash was witnessed by any strategy. Unspecified if the witness is not processed.

results.witness.endorsable

object

results.witness.endorsable.id

any

required

The BigInt scalar type represents non-fractional signed whole numeric values.

results.witness.endorsable.ownerId

string

required

results.witness.endorsable.timestamp

integer

required

results.witness.endorsable.network

integer

required

results.witness.endorsable.owner

object

required

results.witness.endorsable.endorseEvents

object

results.witness.endorsable.witness

object

A witness is an entity representing a proof that a document existed at the time. It is used to comply with the law requirement of data conservation.

results.witness.endorsable.witness.id

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

results.witness.endorsable.witness.hash

any

required

Hash of the document to witness.

results.witness.endorsable.witness.algorithm

enum<string>

required

The algorithm used for hashing the document.

Available options:

SHA256

results.witness.endorsable.witness.organization

object

required

Organization that created the witness.

results.witness.endorsable.witness.createdAt

any

required

results.witness.endorsable.witness.updatedAt

any

required

results.witness.endorsable.witness.initialOwner

object

results.witness.endorsable.witness.claiming

object

Information required to claim a document in the Endorser contract. It is only present if the witness is processed and restricted to the initial owner.

results.witness.endorsable.witness.claimed

boolean

If the witness has been claimed by the initial owner.

results.witness.endorsable.witness.signatureRequest

object

Signature Request the witness is associated with. May not be present if the witness was via the API.

results.witness.endorsable.witness.nom151

object

Individual NOM151 conservation strategy.

results.witness.endorsable.witness.merkleized

object

Combined merkleized conservation strategy.

results.witness.endorsable.witness.witnessCo

object

Witness conservation strategy.

results.witness.endorsable.witness.timestampedAt

any

Earliest date when the hash was witnessed by any strategy. Unspecified if the witness is not processed.

results.witness.endorsable.witness.endorsable

object

results.invites

object[]

required

Invites to sign the content.

results.invites.id

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

results.invites.signatureRequest

object

required

The signature request this invite is linked to.

results.invites.signatureRequest.id

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

results.invites.signatureRequest.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.

results.invites.signatureRequest.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.

results.invites.signatureRequest.name

string

required

Custom name for the signature request.

results.invites.signatureRequest.content

object

required

The content data to be signed.

results.invites.signatureRequest.anonymousKey

string

required

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

results.invites.signatureRequest.organization

object

required

The organization requesting the signature.

results.invites.signatureRequest.witness

object

required

Witness that attest the content using a merkle proof

results.invites.signatureRequest.witness.id

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

results.invites.signatureRequest.witness.hash

any

required

Hash of the document to witness.

results.invites.signatureRequest.witness.algorithm

enum<string>

required

The algorithm used for hashing the document.

Available options:

SHA256

results.invites.signatureRequest.witness.organization

object

required

Organization that created the witness.

results.invites.signatureRequest.witness.createdAt

any

required

results.invites.signatureRequest.witness.updatedAt

any

required

results.invites.signatureRequest.witness.initialOwner

object

results.invites.signatureRequest.witness.claiming

object

Information required to claim a document in the Endorser contract. It is only present if the witness is processed and restricted to the initial owner.

results.invites.signatureRequest.witness.claimed

boolean

If the witness has been claimed by the initial owner.

results.invites.signatureRequest.witness.signatureRequest

object

Signature Request the witness is associated with. May not be present if the witness was via the API.

results.invites.signatureRequest.witness.nom151

object

Individual NOM151 conservation strategy.

results.invites.signatureRequest.witness.merkleized

object

Combined merkleized conservation strategy.

results.invites.signatureRequest.witness.witnessCo

object

Witness conservation strategy.

results.invites.signatureRequest.witness.timestampedAt

any

Earliest date when the hash was witnessed by any strategy. Unspecified if the witness is not processed.

results.invites.signatureRequest.witness.endorsable

object

results.invites.signatureRequest.invites

object[]

required

Invites to sign the content.

results.invites.signatureRequest.invites.id

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

results.invites.signatureRequest.invites.signatureRequest

object

required

The signature request this invite is linked to.

results.invites.signatureRequest.invites.subject

object

required

The subject this invite is linked to.

results.invites.signatureRequest.invites.status

enum<string>

required

The status of the signature request invite.

Available options:

PENDING,

SIGNED,

WITNESSED,

REJECTED

results.invites.signatureRequest.invites.createdAt

any

required

results.invites.signatureRequest.invites.updatedAt

any

required

results.invites.signatureRequest.invites.certificate

object

The certificate this invite was signed with.

results.invites.signatureRequest.invites.signature

any

The signature from the certificate as a hexadecimal string.

results.invites.signatureRequest.invites.ocspResponse

any

The OCSP response from checking the certificate against the CA. ASN1 encoded as a hexadecimal string.

results.invites.signatureRequest.invites.witness

object

Witness that attest the signature using a merkle proof

results.invites.signatureRequest.invites.rejectedAt

any

Date at which the signature request invite was rejected. Only present if rejected.

results.invites.signatureRequest.invites.signedAt

any

Date at which the signature request invite was signed. Only present if signed.

results.invites.signatureRequest.signed

any

required

Amount of invites that have signed the content.

results.invites.signatureRequest.pending

any

required

Amount of invites that have not signed the content.

results.invites.signatureRequest.rejected

any

required

Amount of invites that have rejected the content.

results.invites.signatureRequest.createdAt

any

required

results.invites.signatureRequest.updatedAt

any

required

results.invites.signatureRequest.rejectedAt

any

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

results.invites.subject

object

required

The subject this invite is linked to.

results.invites.subject.id

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

results.invites.subject.commonName

string

required

Name of the subject.

results.invites.subject.serialNumber

string

required

CURP of the subject. It is a unique identifier for people in Mexico.

results.invites.subject.RFC

string

required

RFC of the subject. It is a unique identifier for persons and organizations in Mexico.

results.invites.subject.EVMAddress

any

required

EVM address of the subject.

This setup allows the following properties:

The signer contract factory can create the same signer contract in all EVM chains for the same RSA key
The account can be created deterministically in all EVM chains because it depends on the signer contract address and the RSA public key

In this way, the EVM address is completely abstracted from the EVM network, so we just need to keep a single address.

results.invites.subject.createdAt

any

required

results.invites.subject.updatedAt

any

required

results.invites.subject.country

any

Country of the subject.

results.invites.subject.emailAddress

any

Email address of the subject.

results.invites.subject.certificate

object

Certificate of the subject.

results.invites.subject.certificate.id

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

results.invites.subject.certificate.serialNumber

any

required

The certificate's serial number, as a hexadecimal string. This is a unique identifier for the certificate, and is assigned by the issuer.

results.invites.subject.certificate.issuer

object

required

The certificate's issuer. This is the entity that issued the certificate, and is a Certificate Authority certified by Banxico.

results.invites.subject.certificate.notBefore

any

required

The earliest date at which the certificate is valid.

results.invites.subject.certificate.notAfter

any

required

The latest date at which the certificate is valid.

results.invites.subject.certificate.subject

object

required

The certificate's subject. This is the entity that the certificate is attesting to, and is typically a person or organization ("persona física o moral" in spanish).

results.invites.subject.certificate.publicKey

object

required

The certificate's public key. This is the public key that identifies messages signed by its corresponding private key.

results.invites.subject.certificate.version

any

required

The version of the X.509 standard that the certificate conforms to.

results.invites.subject.certificate.hash

any

required

SHA256 message digest of the issuer's certificate.

results.invites.subject.certificate.certificatePem

string

required

AWS S3 URI path to the certificate's PEM data.

results.invites.subject.certificate.revoked

boolean

required

Whether the certificate has been revoked by the issuer.

results.invites.subject.certificate.createdAt

any

required

results.invites.subject.certificate.updatedAt

any

required

results.invites.subject.termsInvite

object

Invite for the subject to sign Plumaa own terms and conditions.

results.invites.subject.termsInvite.id

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

results.invites.subject.termsInvite.signatureRequest

object

required

The signature request this invite is linked to.

results.invites.subject.termsInvite.subject

object

required

The subject this invite is linked to.

results.invites.subject.termsInvite.status

enum<string>

required

The status of the signature request invite.

Available options:

PENDING,

SIGNED,

WITNESSED,

REJECTED

results.invites.subject.termsInvite.createdAt

any

required

results.invites.subject.termsInvite.updatedAt

any

required

results.invites.subject.termsInvite.certificate

object

The certificate this invite was signed with.

results.invites.subject.termsInvite.signature

any

The signature from the certificate as a hexadecimal string.

results.invites.subject.termsInvite.ocspResponse

any

The OCSP response from checking the certificate against the CA. ASN1 encoded as a hexadecimal string.

results.invites.subject.termsInvite.witness

object

Witness that attest the signature using a merkle proof

results.invites.subject.termsInvite.rejectedAt

any

Date at which the signature request invite was rejected. Only present if rejected.

results.invites.subject.termsInvite.signedAt

any

Date at which the signature request invite was signed. Only present if signed.

results.invites.subject.pushNotificationToken

string

The push notification token associated with the certificate. Used for sending notifications to the user.

results.invites.subject.wallet

object

results.invites.status

enum<string>

required

The status of the signature request invite.

Available options:

PENDING,

SIGNED,

WITNESSED,

REJECTED

results.invites.createdAt

any

required

results.invites.updatedAt

any

required

results.invites.certificate

object

The certificate this invite was signed with.

results.invites.certificate.id

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

results.invites.certificate.serialNumber

any

required

The certificate's serial number, as a hexadecimal string. This is a unique identifier for the certificate, and is assigned by the issuer.

results.invites.certificate.issuer

object

required

The certificate's issuer. This is the entity that issued the certificate, and is a Certificate Authority certified by Banxico.

results.invites.certificate.issuer.id

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

results.invites.certificate.issuer.hash

any

required

The hash of the issuer's certificate.

results.invites.certificate.issuer.commonName

string

required

The name of the certificate authority.

results.invites.certificate.issuer.publicKey

object

required

The issuer's certificate public key. This is the public key that identifies messages the issuer has signed a certificate for a subject.

results.invites.certificate.issuer.certificatePem

string

required

AWS S3 URI path to the issuer certificate's PEM data.

results.invites.certificate.issuer.createdAt

any

required

results.invites.certificate.issuer.updatedAt

any

required

results.invites.certificate.issuer.RFC

string

RFC of the issuer.

results.invites.certificate.issuer.organization

string

Name of the organization or company. "Razón Social" in Spanish.

results.invites.certificate.issuer.organizationalUnitName

string

Name of the unit within the organization. "Unidad Organizacional" in Spanish.

results.invites.certificate.issuer.emailAddress

any

Email address of the issuer.

results.invites.certificate.issuer.streetAddress

string

Street address of the issuer.

results.invites.certificate.issuer.postalCode

integer

Postal code of the issuer.

results.invites.certificate.issuer.country

any

"Country" of the issuer.

results.invites.certificate.issuer.stateOrProvinceName

string

"Entidad Federativa" of the issuer.

results.invites.certificate.issuer.localityName

string

"Municipio/Delegación" of the issuer.

results.invites.certificate.notBefore

any

required

The earliest date at which the certificate is valid.

results.invites.certificate.notAfter

any

required

The latest date at which the certificate is valid.

results.invites.certificate.subject

object

required

The certificate's subject. This is the entity that the certificate is attesting to, and is typically a person or organization ("persona física o moral" in spanish).

results.invites.certificate.subject.id

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

results.invites.certificate.subject.commonName

string

required

Name of the subject.

results.invites.certificate.subject.serialNumber

string

required

CURP of the subject. It is a unique identifier for people in Mexico.

results.invites.certificate.subject.RFC

string

required

RFC of the subject. It is a unique identifier for persons and organizations in Mexico.

results.invites.certificate.subject.EVMAddress

any

required

EVM address of the subject.

This setup allows the following properties:

The signer contract factory can create the same signer contract in all EVM chains for the same RSA key
The account can be created deterministically in all EVM chains because it depends on the signer contract address and the RSA public key

In this way, the EVM address is completely abstracted from the EVM network, so we just need to keep a single address.

results.invites.certificate.subject.createdAt

any

required

results.invites.certificate.subject.updatedAt

any

required

results.invites.certificate.subject.country

any

Country of the subject.

results.invites.certificate.subject.emailAddress

any

Email address of the subject.

results.invites.certificate.subject.certificate

object

Certificate of the subject.

results.invites.certificate.subject.termsInvite

object

Invite for the subject to sign Plumaa own terms and conditions.

results.invites.certificate.subject.pushNotificationToken

string

The push notification token associated with the certificate. Used for sending notifications to the user.

results.invites.certificate.subject.wallet

object

results.invites.certificate.publicKey

object

required

The certificate's public key. This is the public key that identifies messages signed by its corresponding private key.

results.invites.certificate.version

any

required

The version of the X.509 standard that the certificate conforms to.

results.invites.certificate.hash

any

required

SHA256 message digest of the issuer's certificate.

results.invites.certificate.certificatePem

string

required

AWS S3 URI path to the certificate's PEM data.

results.invites.certificate.revoked

boolean

required

Whether the certificate has been revoked by the issuer.

results.invites.certificate.createdAt

any

required

results.invites.certificate.updatedAt

any

required

results.invites.signature

any

The signature from the certificate as a hexadecimal string.

results.invites.ocspResponse

any

The OCSP response from checking the certificate against the CA. ASN1 encoded as a hexadecimal string.

results.invites.witness

object

Witness that attest the signature using a merkle proof

results.invites.witness.id

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

results.invites.witness.hash

any

required

Hash of the document to witness.

results.invites.witness.algorithm

enum<string>

required

The algorithm used for hashing the document.

Available options:

SHA256

results.invites.witness.organization

object

required

Organization that created the witness.

results.invites.witness.createdAt

any

required

results.invites.witness.updatedAt

any

required

results.invites.witness.initialOwner

object

results.invites.witness.initialOwner.id

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

results.invites.witness.initialOwner.commonName

string

required

Name of the subject.

results.invites.witness.initialOwner.serialNumber

string

required

CURP of the subject. It is a unique identifier for people in Mexico.

results.invites.witness.initialOwner.RFC

string

required

RFC of the subject. It is a unique identifier for persons and organizations in Mexico.

results.invites.witness.initialOwner.EVMAddress

any

required

EVM address of the subject.

This setup allows the following properties:

The signer contract factory can create the same signer contract in all EVM chains for the same RSA key
The account can be created deterministically in all EVM chains because it depends on the signer contract address and the RSA public key

In this way, the EVM address is completely abstracted from the EVM network, so we just need to keep a single address.

results.invites.witness.initialOwner.createdAt

any

required

results.invites.witness.initialOwner.updatedAt

any

required

results.invites.witness.initialOwner.country

any

Country of the subject.

results.invites.witness.initialOwner.emailAddress

any

Email address of the subject.

results.invites.witness.initialOwner.certificate

object

Certificate of the subject.

results.invites.witness.initialOwner.termsInvite

object

Invite for the subject to sign Plumaa own terms and conditions.

results.invites.witness.initialOwner.pushNotificationToken

string

The push notification token associated with the certificate. Used for sending notifications to the user.

results.invites.witness.initialOwner.wallet

object

results.invites.witness.claiming

object

Information required to claim a document in the Endorser contract. It is only present if the witness is processed and restricted to the initial owner.

results.invites.witness.claimed

boolean

If the witness has been claimed by the initial owner.

results.invites.witness.signatureRequest

object

Signature Request the witness is associated with. May not be present if the witness was via the API.

results.invites.witness.signatureRequest.id

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

results.invites.witness.signatureRequest.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.

results.invites.witness.signatureRequest.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.

results.invites.witness.signatureRequest.name

string

required

Custom name for the signature request.

results.invites.witness.signatureRequest.content

object

required

The content data to be signed.

results.invites.witness.signatureRequest.anonymousKey

string

required

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

results.invites.witness.signatureRequest.organization

object

required

The organization requesting the signature.

results.invites.witness.signatureRequest.witness

object

required

Witness that attest the content using a merkle proof

results.invites.witness.signatureRequest.invites

object[]

required

Invites to sign the content.

results.invites.witness.signatureRequest.signed

any

required

Amount of invites that have signed the content.

results.invites.witness.signatureRequest.pending

any

required

Amount of invites that have not signed the content.

results.invites.witness.signatureRequest.rejected

any

required

Amount of invites that have rejected the content.

results.invites.witness.signatureRequest.createdAt

any

required

results.invites.witness.signatureRequest.updatedAt

any

required

results.invites.witness.signatureRequest.rejectedAt

any

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

results.invites.witness.nom151

object

Individual NOM151 conservation strategy.

results.invites.witness.merkleized

object

Combined merkleized conservation strategy.

results.invites.witness.witnessCo

object

Witness conservation strategy.

results.invites.witness.timestampedAt

any

Earliest date when the hash was witnessed by any strategy. Unspecified if the witness is not processed.

results.invites.witness.endorsable

object

results.invites.rejectedAt

any

Date at which the signature request invite was rejected. Only present if rejected.

results.invites.signedAt

any

Date at which the signature request invite was signed. Only present if signed.

results.signed

any

required

Amount of invites that have signed the content.

results.pending

any

required

Amount of invites that have not signed the content.

results.rejected

any

required

Amount of invites that have rejected the content.

results.createdAt

any

required

results.updatedAt

any

required

results.rejectedAt

any

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

Signature Request Definition Get a Signature Request

curl --request GET \
  --url https://api.plumaa.id/rest/v1/signature-requests \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "info": {
    "id": "<string>",
    "count": "<any>",
    "pages": "<any>",
    "next": "<any>",
    "prev": "<any>"
  },
  "results": [
    {
      "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": {
          "id": "<any>",
          "API": true,
          "groupedNOM151": 123,
          "nom151": 123
        },
        "policies": {
          "signatureRequest": {
            "conservation": "NOM151"
          }
        },
        "createdAt": "<any>",
        "updatedAt": "<any>"
      },
      "witness": {
        "id": "<any>",
        "hash": "<any>",
        "algorithm": "SHA256",
        "initialOwner": {},
        "claiming": {
          "id": "<any>",
          "authorizer": "<any>",
          "signature": "<any>",
          "claimer": "<any>",
          "network": "<any>",
          "createdAt": "<any>",
          "updatedAt": "<any>"
        },
        "claimed": true,
        "signatureRequest": {},
        "organization": {
          "id": "<any>",
          "name": "<string>",
          "logo": "<any>",
          "emailAddress": "<any>",
          "quota": {
            "id": "<any>",
            "API": true,
            "groupedNOM151": 123,
            "nom151": 123
          },
          "policies": {
            "signatureRequest": {
              "conservation": "NOM151"
            }
          },
          "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": {
            "id": "<string>",
            "endorsables": {
              "items": [
                {}
              ],
              "pageInfo": {
                "hasNextPage": true,
                "hasPreviousPage": true,
                "startCursor": "<string>",
                "endCursor": "<string>"
              }
            },
            "endorseFromEvents": {
              "items": [
                {
                  "id": "<string>",
                  "timestamp": 123,
                  "fromId": "<string>",
                  "toId": "<string>",
                  "digest": "<any>",
                  "network": 123,
                  "from": {},
                  "to": {},
                  "token": {}
                }
              ],
              "pageInfo": {
                "hasNextPage": true,
                "hasPreviousPage": true,
                "startCursor": "<string>",
                "endCursor": "<string>"
              }
            },
            "endorseToEvents": {
              "items": [
                {
                  "id": "<string>",
                  "timestamp": 123,
                  "fromId": "<string>",
                  "toId": "<string>",
                  "digest": "<any>",
                  "network": 123,
                  "from": {},
                  "to": {},
                  "token": {}
                }
              ],
              "pageInfo": {
                "hasNextPage": true,
                "hasPreviousPage": true,
                "startCursor": "<string>",
                "endCursor": "<string>"
              }
            },
            "subject": {}
          },
          "endorseEvents": {
            "items": [
              {
                "id": "<string>",
                "timestamp": 123,
                "fromId": "<string>",
                "toId": "<string>",
                "digest": "<any>",
                "network": 123,
                "from": {},
                "to": {},
                "token": {}
              }
            ],
            "pageInfo": {
              "hasNextPage": true,
              "hasPreviousPage": true,
              "startCursor": "<string>",
              "endCursor": "<string>"
            }
          },
          "witness": {}
        }
      },
      "invites": [
        {
          "id": "<any>",
          "signatureRequest": {},
          "subject": {},
          "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": {
                "exponent": "<any>",
                "modulus": "<any>"
              },
              "certificatePem": "<string>",
              "createdAt": "<any>",
              "updatedAt": "<any>"
            },
            "notBefore": "<any>",
            "notAfter": "<any>",
            "subject": {},
            "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": {},
            "claiming": {
              "id": "<any>",
              "authorizer": "<any>",
              "signature": "<any>",
              "claimer": "<any>",
              "network": "<any>",
              "createdAt": "<any>",
              "updatedAt": "<any>"
            },
            "claimed": true,
            "signatureRequest": {},
            "organization": {
              "id": "<any>",
              "name": "<string>",
              "logo": "<any>",
              "emailAddress": "<any>",
              "quota": {
                "id": "<any>",
                "API": true,
                "groupedNOM151": 123,
                "nom151": 123
              },
              "policies": {
                "signatureRequest": {
                  "conservation": "NOM151"
                }
              },
              "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": {
                "id": "<string>",
                "endorsables": {
                  "items": [
                    {}
                  ],
                  "pageInfo": {
                    "hasNextPage": true,
                    "hasPreviousPage": true,
                    "startCursor": "<string>",
                    "endCursor": "<string>"
                  }
                },
                "endorseFromEvents": {
                  "items": [
                    {
                      "id": "<string>",
                      "timestamp": 123,
                      "fromId": "<string>",
                      "toId": "<string>",
                      "digest": "<any>",
                      "network": 123,
                      "from": {},
                      "to": {},
                      "token": {}
                    }
                  ],
                  "pageInfo": {
                    "hasNextPage": true,
                    "hasPreviousPage": true,
                    "startCursor": "<string>",
                    "endCursor": "<string>"
                  }
                },
                "endorseToEvents": {
                  "items": [
                    {
                      "id": "<string>",
                      "timestamp": 123,
                      "fromId": "<string>",
                      "toId": "<string>",
                      "digest": "<any>",
                      "network": 123,
                      "from": {},
                      "to": {},
                      "token": {}
                    }
                  ],
                  "pageInfo": {
                    "hasNextPage": true,
                    "hasPreviousPage": true,
                    "startCursor": "<string>",
                    "endCursor": "<string>"
                  }
                },
                "subject": {}
              },
              "endorseEvents": {
                "items": [
                  {
                    "id": "<string>",
                    "timestamp": 123,
                    "fromId": "<string>",
                    "toId": "<string>",
                    "digest": "<any>",
                    "network": 123,
                    "from": {},
                    "to": {},
                    "token": {}
                  }
                ],
                "pageInfo": {
                  "hasNextPage": true,
                  "hasPreviousPage": true,
                  "startCursor": "<string>",
                  "endCursor": "<string>"
                }
              },
              "witness": {}
            }
          },
          "status": "PENDING",
          "rejectedAt": "<any>",
          "signedAt": "<any>",
          "createdAt": "<any>",
          "updatedAt": "<any>"
        }
      ],
      "signed": "<any>",
      "pending": "<any>",
      "rejected": "<any>",
      "rejectedAt": "<any>",
      "createdAt": "<any>",
      "updatedAt": "<any>"
    }
  ]
}

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

List Signature Requests

Authorizations

Query Parameters

Response