Introduction

What this documentation covers, who it is for, and where to start.

Nomi is credential infrastructure. An organisation defines a credential once, issues it to a person, and Nomi keeps that credential in step with the organisation's own records for as long as it is valid — including on the phone it was delivered to.

This documentation is written for the people who connect Nomi to something: developers, integrators, IT teams and platform administrators at universities, employers and businesses. It assumes you can make an HTTP request and that the system holding your members, staff or students is the one you want to keep as the source of truth.

What is here

• Concepts — the six objects the whole platform is made of, and how they relate.
• Credentials — creating, issuing, updating, revoking and verifying, with the real request and response shapes.
• Distribution — how a credential reaches a person: Apple Wallet, Google Wallet, a link, a QR code or an email.
• API — the reference for each family of endpoints, plus authentication and errors.
• Integrations — the connectors that exist today, and the ones that do not.
• Security — keys, webhook signatures, data protection, and the practices that keep an integration safe.

Conventions

Every sample runs against https://api.nomi-tech.com. Nothing in these pages is a real value. Keys, identifiers, names, addresses and hostnames are placeholders on reserved domains — nomi_sk_live_EXAMPLE for a key, cred_… and sub_… for identifiers, alex@example.com for a person, https://your-app.example for your own service — and none of them will work against anything. Anything marked Coming soon is not built yet and must not be planned against.