GET
/
witness

Authorizations

Authorization
string
headerrequired

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

hash
any
required

Hash of the document to witness.

algorithm
enum<string>
required

The algorithm used for hashing the document.

Available options:
SHA256
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.

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.

claimed
boolean

If the witness has been claimed by the initial owner.

signatureRequest
object

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

organization
object
required

Organization that created the witness.

nom151
object

Individual NOM151 conservation strategy.

merkleized
object

Combined merkleized conservation strategy.

witnessCo
object

Witness conservation strategy.

timestampedAt
any

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

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.

endorsable
object