Quick Summary: Every request carries
Authorization: Bearer sdb_live_.... Keys are created by administrators, scoped per resource, bound to an acting person, rotated with an overlap window, and revoked instantly.The key
A key looks likesdb_live_ followed by 32 random characters. The prefix identifies the environment that issued the key — production uses sdb_live_, and another environment may issue its own. Only the secret’s length and opacity are guaranteed, so never hard-code or validate the prefix in your client. Send the key on every request:
Scopes and the acting person
A key carries scopes inresource:action form — careers:read, careers:write, and so on. :write never implies :read. Independently, every key is bound to an acting person: the API’s effective permission is always the intersection of the key scopes and what that person may do in the app. A 403 tells you which of the two blocked the call by its type: insufficient-scope means grant the key a scope; insufficient-permissions means the acting person cannot do this in the app, and no scope will help.
Scope changes take effect on the very next request — nothing is cached.
How people are identified: the person identifier on this API is the email address — in bodies, query filters, and
/people/{id}-style path slots (which also accept the opaque id from any response). Every lookup is bounded by the key’s company, and an email held by another company answers exactly like one that does not exist, so the API never confirms an address elsewhere. In a path slot such as /people/{id} that is a 404; in a body or query field it is a 400 with code unknown_person on the named field. Duplicate case-variants of one address in your own data answer 409 instead of a silent pick — see Getting Started.Scope reference
Every endpoint’s reference page states the scope it needs on its Requires scope line./ping is the one scope-free endpoint — any valid key can call it. Remember the intersection rule above: a scope grants nothing the acting person cannot already do in the app — it only ever narrows.