Verify a document
Check a verified document (certificate, ID card, event badge) by the id in its QR code or verify link (`/verify/{publicId}`). No authentication. Returns the document's status — `valid`, `expired` (past `expiresAt`), `revoked` (by the issuer, with the reason they gave), `replaced` (a newer document of the same holder, see `replacedBy`) or `suspended` (bannx suspended the issuer; fields are withheld) — with the public fields the issuer chose to show, frozen when it was issued, and who issued it. `issuer.verifiedDomain` is set only while the issuer has proved control of that domain over DNS. Unknown ids get the same 404 as deleted ones. Responses may be cached for 30 seconds.
Verify a document
Check a verified document (certificate, ID card, event badge) by the id in its QR code or verify link (`/verify/{publicId}`). No authentication. Returns the document's status — `valid`, `expired` (past `expiresAt`), `revoked` (by the issuer, with the reason they gave), `replaced` (a newer document of the same holder, see `replacedBy`) or `suspended` (bannx suspended the issuer; fields are withheld) — with the public fields the issuer chose to show, frozen when it was issued, and who issued it. `issuer.verifiedDomain` is set only while the issuer has proved control of that domain over DNS. Unknown ids get the same 404 as deleted ones. Responses may be cached for 30 seconds.
/api/v1/credentials/:publicIdQuery / Path parameters
| Name | In | Required | Description |
|---|---|---|---|
| publicId | path | Yes | The document's public id: 22 letters and digits, as printed in its verify link. |
Responses
The document's public view.
No such document (CREDENTIAL_NOT_FOUND) — the same answer for unknown, mistyped and deleted ids.
Too many lookups from this address (RATE_LIMITED).
curl -X GET "https://bannx.com/api/v1/credentials/:publicId" \
-H "Authorization: Bearer YOUR_API_TOKEN"// The document's public view.
{
"success": true,
"data": { ... }
}