GET
/
signature-request-invites
curl --request GET \
  --url https://api.plumaa.id/rest/v1/signature-request-invites \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "info": {
    "id": "<string>",
    "count": "<any>",
    "pages": "<any>",
    "next": "<any>",
    "prev": "<any>"
  },
  "results": [
    {
      "id": "<any>",
      "signatureRequest": {
        "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": {}
        },
        "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": {
            "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>"
        },
        "termsInvite": {},
        "pushNotificationToken": "<string>",
        "EVMAddress": "<any>",
        "createdAt": "<any>",
        "updatedAt": "<any>",
        "wallet": {
          "id": "<string>",
          "endorsables": {
            "items": [
              {
                "id": "<any>",
                "ownerId": "<string>",
                "timestamp": 123,
                "network": 123,
                "owner": {},
                "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": {
                  "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": {}
                }
              }
            ],
            "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": {}
        }
      },
      "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": {}
      },
      "status": "PENDING",
      "rejectedAt": "<any>",
      "signedAt": "<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.

signatureRequest
object

ObjectID matching arguments.

certificate
object

ObjectID matching arguments.

subject
object

ObjectID matching arguments.

rejectedAt
object

Date range arguments.

signedAt
object

Date range arguments.

createdAt
object

Date range arguments.

updatedAt
object

Date range arguments.

sort
object

Sort arguments for SignatureRequestInvites query.

pagination
object

Pagination arguments.

accessScope
enum<string>
Available options:
Organization,
Subject

Response

200 - application/json

Results of an SignatureRequestInvites query.

id
string
required
info
object
required

Pagination info.

results
object[]
required

List of SignatureRequestInvites.

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.