GET
/
signature-request-invite
/
{id}
cURL
curl --request GET \
  --url https://api.plumaa.id/rest/v1/signature-request-invite/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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": {},
      "policies": {},
      "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": {},
        "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": {}
    },
    "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": [
          "<any>"
        ],
        "pageInfo": {
          "hasNextPage": "<any>",
          "hasPreviousPage": "<any>",
          "startCursor": "<any>",
          "endCursor": "<any>"
        }
      },
      "endorseFromEvents": {
        "items": [
          "<any>"
        ],
        "pageInfo": {
          "hasNextPage": "<any>",
          "hasPreviousPage": "<any>",
          "startCursor": "<any>",
          "endCursor": "<any>"
        }
      },
      "endorseToEvents": {
        "items": [
          "<any>"
        ],
        "pageInfo": {
          "hasNextPage": "<any>",
          "hasPreviousPage": "<any>",
          "startCursor": "<any>",
          "endCursor": "<any>"
        }
      },
      "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": {},
      "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": {}
  },
  "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.

Path Parameters

​
id
any
required

Response

200 - application/json

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.

​
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

​
signatureRequest
object
required

The signature request this invite is linked to.

​
subject
object
required

The subject this invite is linked to.

​
status
enum<string>
required

The status of the signature request invite.

Available options:
PENDING,
SIGNED,
WITNESSED,
REJECTED
​
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

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.

​
certificate
object

The certificate this invite was signed with.

​
signature
any

The signature from the certificate as a hexadecimal string.

​
ocspResponse
any

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

​
witness
object

Witness that attest the signature using a merkle proof

​
rejectedAt
any

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

​
signedAt
any

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