Concepts
Terminology
Key terms used across pasby APIs and documentation.
| Term | Definition |
|---|---|
| Identity | A pasby user identified by a national identification number (NIN) |
| Consumer | An organisation registered on pasby that builds integrations |
| App | A registered application under a consumer; holds API key, secret, and scopes |
| Claim | A piece of identity data (e.g. naming.given) shared with user consent |
| Action | User activity requested: login, signup, link, sign, or confirm |
| Scope | Permission granted to an app controlling which API capabilities it may use |
| Flow | A stateful user journey tracked by a request / flow identifier |
| Payload | Opaque string your app provides for context; echoed through the lifecycle |
| Webhook | Your HTTPS endpoint for asynchronous signature notifications |
Scopes (typical)
| Action | Typical scopes |
|---|---|
login, signup, link | identification:same, identification:another, identification:wildcard |
sign | signing:same, signing:another, signing:wildcard, document:sign |
confirm | signing:same, signing:another, signing:wildcard |
Scope provisioning is managed in Console. Request only what your product needs.