All endpoints
The complete list of the endpoints of the SealTrust API, group by group, with what each one returns.
On this page
This page gathers into a single list every endpoint described by the reference. You will find the verb, the path, and one sentence that says what the call returns. The table of contents on the right takes you straight to the group you care about.
Each entry leads to its reference page. That is where you read the exact parameters, the shape of the response and the error codes, with an example request and an example response.
Two things to read before this one if you are opening the API for the first time: the overview of the partner API, which gives the base address and authentication, and the errors of the API, which gives the shape common to every refusal response.
Create products
- Method POST/partner
/mint /batchSend a batch of product rows, in JSON or in CSV, up to 500 rows per call. Scope mint:batch. The products created by this path are identified by QR. - Method GET/partner
/mint /batch /status /{job_id}Reads the progress of a batch of products sent for minting, from the identifier returned at the moment of the submission.
Report a sale
Receive events
- Method POST/partner
/webhooksRegister an HTTPS address that will receive the events of your brand, and choose the event types sent to that address. Scope webhooks:write. - Method GET/partner
/webhooksList the notification subscriptions recorded in your brand's name, page by page. Requires the webhooks:read right. - Method GET/partner
/webhooks /{webhook_id}Read one notification subscription of your brand, with its address, its event types and its delivery health. Scope webhooks:read. - Method PUT/partner
/webhooks /{webhook_id}Modify a notification subscription: its destination URL, its event list, its signing secret, whether it is active. Scope webhooks:write. - Method DELETE/partner
/webhooks /{webhook_id}Permanently delete a notification subscription and the signing secret attached to it. Requires the webhooks:write scope, and mandatory confirmation with the URL of the subscription.
Service a product
- Method GET/partner-portal
/meRead your partner profile and the list of brands that have accredited you. Partner account session, no API key right. - Method GET/partner-portal
/products /{identifier}Find a product of a brand that has accredited you, from what is written on the object, and read its passport filtered on the only accreditations that brand has recognized for you. - Method POST/partner-portal
/interventionsRecord an intervention on a product from a repairer or recycler partner account. Partner session, no API key. - Method GET/partner-portal
/interventionsList the interventions your partner account has recorded, from the most recent to the oldest. Partner account session.
Verify a product
- Method GET/products
/{uid} /publicRead the public information of a product from its identifier: name, brand, image, token, transaction, state and theft report. No API key. - Method GET/resolve
/{identifier}Read in a single call everything a product page displays: identity, certificate, public passport, media, history and anchoring proofs. Public endpoint, no API key. - Method GET/qr
/verifyVerify an item from the signed parameters carried by a verification address of the old form. Public endpoint, no API key. - Method GET/verify
/merkle /{identifier}Retrieve the proof that an item belongs to the batch anchored on Base, with its leaf, its neighbor proof and the root written to the chain. Public endpoint. - Method GET/timeline
/{identifier}Read the public history of a product: its verifications and its changes of ownership, from the printed number, the token identifier or the chip hash. Public endpoint. - Method POST/originality
/read-sig /verifyCheck the NXP Read_Sig originality signature of a chip, from its serial number and the signature read on the chip. Public endpoint, no API key.
Deliver a certificate
- Method GET/certificate
/{identifier}Read a product's certificate of authenticity from its certificate number, its UID hash, its token id or its printed serial number. Public endpoint. - Method GET/certificate
/{identifier} /downloadDownload the certificate of authenticity of an item as a PDF, in your brand's colors. Public endpoint, no API key.
Read a passport
- Method GET/passport
/{identifier}Read a product's published digital passport from its printed number, its token identifier or its chip hash, at the requested access tier. Public endpoint. - Method GET/passport
/01 /{gtin}Read the digital passport published for a product model, from its GTIN. No API key for the public tier. - Method GET/passport
/{identifier} /verifyCheck the integrity of the published passport of an item: recorded hash, immutable public copy and version seal. Public endpoint. - Method GET/passport
/{identifier} /proofGather in one call every public proof of a passport: content hash, IPFS copy, anchor on Base, version seal and state of the signed credential. Public endpoint. - Method GET/passport
/01 /{gtin} /proofRetrieve the public proofs of the reference passport announced by a GTIN: hash of the content, verified IPFS copy, anchoring of the document on Base and status of the signed credential. Public endpoint.
Resolve a code
- Method GET/p
/{serial}Translate the serial number printed on an item into the address of its consumer page. Public endpoint, no API key, which answers with a redirect. - Method GET/01
/{gtin} /21 /{serial}Resolve a GS1 Digital Link (AI 01 + AI 21) to the item's public page. Public endpoint, no API key, which answers with a redirect. - Method GET/01
/{gtin}Resolve a GS1 Digital Link that carries only a GTIN, to the public page of the model's reference passport. 302 response, no API key.
Attest with a signature
- Method GET/passport
/{identifier} /vc /previewSee, without a signature and without recording anything, the verifiable credential envelope and the JSON-LD document that a given access tier would expose for a passport. - Method GET/passport
/{identifier} /vcRetrieve the signed credential of a passport, in SD-JWT-VC format, filtered to the access tier asked for. Public endpoint at the public and end_user tiers. - Method GET/passport
/{identifier} /vc /verifyCheck the signature of the digital passport delivered as a verifiable credential, and read the data revealed at the access tier requested. No session is required for the public and end_user tiers. - Method GET/brand
/{brand_id} /did.jsonRetrieve a brand's identity document: the list of its public signing keys, in did:web format. Public endpoint. - Method GET/.well-known
/did.jsonServe the decentralized identity document of a brand on its own domain name, in delegated mode. Public endpoint, resolved from the host name called.
Was this page helpful?
Your answer opens a pre-filled email in your mail app, addressed to contact@sealtrust.io. You read it over before sending it.