API reference

Passports

The Evidence Passport is the document-side record issued per order. Its share link opens the released record on verify.veritura.co for whoever holds the link: see the passport record page.

Issue a passport#

Identify the lot by lot_id or by supplier + product + lot_number, and the order by order_id (or customer_ref). The response carries the passport record including its public share path (/verify/<share> on verify.veritura.co).

The release policy#

Issuance enforces the same release rules as the workspace, on the server. A Passport issues only from a lot that:

• is cleared, and carries no hold (a person's, ClearGate's or a recall's) and no recall signal;
• has had a certificate read against it, when it is a purchased lot, and has been reviewed by a named person;
• rests on a qualified supplier, or on the pharmacy itself with its identity declared;
• meets anything your release policy adds, such as a ClearGate Allow before a Passport.

For a purchased lot dispensed as purchased, send as_purchased: true (alias asPurchased); otherwise record the preparation made from it and issue for that. Where your substance screen finds the order is essentially a copy of a marketed drug, send copy_determined: true once the prescriber's determination is in your copy file. Refusals answer with the release refusal codes, and each names its fix. The full flow, including the pharmacist release for a pharmacy's own preparation, is in the integration guide.

Each Passport released sends one signed passport.issued event, whichever path released it.

Idempotency#

• Re-issuing the same order returns the existing record with reused: true rather than a duplicate.
• A row that contradicts a record a patient may already hold is refused as an evidence conflict: the record a patient holds is never silently rewritten.