GET
/
witness
curl --request GET \
  --url https://api.plumaa.id/rest/v1/witness \
  --header 'Authorization: Bearer <token>'
{
  "id": "<any>",
  "hash": "<any>",
  "algorithm": "SHA256",
  "initialOwner": {
    "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": {
      "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": {},
        "invites": [
          {}
        ],
        "signed": "<any>",
        "pending": "<any>",
        "rejected": "<any>",
        "rejectedAt": "<any>",
        "createdAt": "<any>",
        "updatedAt": "<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": {},
      "status": "PENDING",
      "rejectedAt": "<any>",
      "signedAt": "<any>",
      "createdAt": "<any>",
      "updatedAt": "<any>"
    },
    "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": {}
          }
        ],
        "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": {}
    }
  },
  "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": {
      "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": {},
    "invites": [
      {}
    ],
    "signed": "<any>",
    "pending": "<any>",
    "rejected": "<any>",
    "rejectedAt": "<any>",
    "createdAt": "<any>",
    "updatedAt": "<any>"
  },
  "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": {},
    "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": {}
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
hash
any
required
​
witness_endorsable_endorsable_owner_owner_endorsables_where
object
​
witness_endorsable_endorsable_owner_owner_endorsables_orderBy
string
​
witness_endorsable_endorsable_owner_owner_endorsables_orderDirection
string
​
witness_endorsable_endorsable_owner_owner_endorsables_before
string
​
witness_endorsable_endorsable_owner_owner_endorsables_after
string
​
witness_endorsable_endorsable_owner_owner_endorsables_limit
integer
​
witness_endorsable_endorsable_owner_owner_endorseFromEvents_where
object
​
witness_endorsable_endorsable_owner_owner_endorseFromEvents_orderBy
string
​
witness_endorsable_endorsable_owner_owner_endorseFromEvents_orderDirection
string
​
witness_endorsable_endorsable_owner_owner_endorseFromEvents_before
string
​
witness_endorsable_endorsable_owner_owner_endorseFromEvents_after
string
​
witness_endorsable_endorsable_owner_owner_endorseFromEvents_limit
integer
​
witness_endorsable_endorsable_owner_owner_endorseToEvents_where
object
​
witness_endorsable_endorsable_owner_owner_endorseToEvents_orderBy
string
​
witness_endorsable_endorsable_owner_owner_endorseToEvents_orderDirection
string
​
witness_endorsable_endorsable_owner_owner_endorseToEvents_before
string
​
witness_endorsable_endorsable_owner_owner_endorseToEvents_after
string
​
witness_endorsable_endorsable_owner_owner_endorseToEvents_limit
integer
​
witness_endorsable_endorsable_endorseEvents_where
object
​
witness_endorsable_endorsable_endorseEvents_orderBy
string
​
witness_endorsable_endorsable_endorseEvents_orderDirection
string
​
witness_endorsable_endorsable_endorseEvents_before
string
​
witness_endorsable_endorsable_endorseEvents_after
string
​
witness_endorsable_endorsable_endorseEvents_limit
integer
​
witness_endorsable_endorsable_endorseEvents_endorseEvents_items_items_from_from_endorsables_where
object
​
witness_endorsable_endorsable_endorseEvents_endorseEvents_items_items_from_from_endorsables_orderBy
string
​
witness_endorsable_endorsable_endorseEvents_endorseEvents_items_items_from_from_endorsables_orderDirection
string
​
witness_endorsable_endorsable_endorseEvents_endorseEvents_items_items_from_from_endorsables_before
string
​
witness_endorsable_endorsable_endorseEvents_endorseEvents_items_items_from_from_endorsables_after
string
​
witness_endorsable_endorsable_endorseEvents_endorseEvents_items_items_from_from_endorsables_limit
integer
​
witness_endorsable_endorsable_endorseEvents_endorseEvents_items_items_to_to_endorsables_where
object
​
witness_endorsable_endorsable_endorseEvents_endorseEvents_items_items_to_to_endorsables_orderBy
string
​
witness_endorsable_endorsable_endorseEvents_endorseEvents_items_items_to_to_endorsables_orderDirection
string
​
witness_endorsable_endorsable_endorseEvents_endorseEvents_items_items_to_to_endorsables_before
string
​
witness_endorsable_endorsable_endorseEvents_endorseEvents_items_items_to_to_endorsables_after
string
​
witness_endorsable_endorsable_endorseEvents_endorseEvents_items_items_to_to_endorsables_limit
integer

Response

200 - application/json

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.