Skip to main content
GET
/
endorsable
/
{id}
cURL
curl --request GET \
  --url https://api.plumaa.id/rest/v1/endorsable/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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": {
      "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": "<any>"
              }
            },
            "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": "<any>"
                }
              },
              "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": {},
        "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": "<any>"
              }
            },
            "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>"
      },
      "pushNotificationToken": "<string>",
      "EVMAddress": "<any>",
      "createdAt": "<any>",
      "updatedAt": "<any>",
      "wallet": {}
    }
  },
  "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": "<any>"
        }
      },
      "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": {}
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
any
required

Query Parameters

​
endorsable_owner_owner_endorsables_where
object
​
endorsable_owner_owner_endorsables_orderBy
string
​
endorsable_owner_owner_endorsables_orderDirection
string
​
endorsable_owner_owner_endorsables_before
string
​
endorsable_owner_owner_endorsables_after
string
​
endorsable_owner_owner_endorsables_limit
integer
​
endorsable_owner_owner_endorseFromEvents_where
object
​
endorsable_owner_owner_endorseFromEvents_orderBy
string
​
endorsable_owner_owner_endorseFromEvents_orderDirection
string
​
endorsable_owner_owner_endorseFromEvents_before
string
​
endorsable_owner_owner_endorseFromEvents_after
string
​
endorsable_owner_owner_endorseFromEvents_limit
integer
​
endorsable_owner_owner_endorseToEvents_where
object
​
endorsable_owner_owner_endorseToEvents_orderBy
string
​
endorsable_owner_owner_endorseToEvents_orderDirection
string
​
endorsable_owner_owner_endorseToEvents_before
string
​
endorsable_owner_owner_endorseToEvents_after
string
​
endorsable_owner_owner_endorseToEvents_limit
integer
​
endorsable_endorseEvents_where
object
​
endorsable_endorseEvents_orderBy
string
​
endorsable_endorseEvents_orderDirection
string
​
endorsable_endorseEvents_before
string
​
endorsable_endorseEvents_after
string
​
endorsable_endorseEvents_limit
integer
​
endorsable_endorseEvents_endorseEvents_items_items_from_from_endorsables_where
object
​
endorsable_endorseEvents_endorseEvents_items_items_from_from_endorsables_orderBy
string
​
endorsable_endorseEvents_endorseEvents_items_items_from_from_endorsables_orderDirection
string
​
endorsable_endorseEvents_endorseEvents_items_items_from_from_endorsables_before
string
​
endorsable_endorseEvents_endorseEvents_items_items_from_from_endorsables_after
string
​
endorsable_endorseEvents_endorseEvents_items_items_from_from_endorsables_limit
integer
​
endorsable_endorseEvents_endorseEvents_items_items_to_to_endorsables_where
object
​
endorsable_endorseEvents_endorseEvents_items_items_to_to_endorsables_orderBy
string
​
endorsable_endorseEvents_endorseEvents_items_items_to_to_endorsables_orderDirection
string
​
endorsable_endorseEvents_endorseEvents_items_items_to_to_endorsables_before
string
​
endorsable_endorseEvents_endorseEvents_items_items_to_to_endorsables_after
string
​
endorsable_endorseEvents_endorseEvents_items_items_to_to_endorsables_limit
integer

Response

200 - application/json
​
id
any
required

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

​
ownerId
string
required
​
timestamp
integer
required
​
network
integer
required
​
owner
object
required
​
endorseEvents
object
​
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.