Skip to main content
GET
Check your API key

Authorizations

Authorization
string
header
required

Send your API key as a bearer token: Authorization: Bearer osa_live_…. Keys are opaque; each belongs to exactly one firm and one purpose. Keys starting with osa_test_ reach only test claims and test accounts. The scopes listed on each operation are the permissions the key needs; GET /v1/me shows the ones your key has.

Response

The key's firm, environment and permissions.

The calling key, its firm and its current permissions.

key
object
required

The API key making the request.

firm
object
required

The firm this key belongs to.

scopes
string[]
required

The permissions the key has now: claims:create, claims:read, claims:write, adjusters:read, adjusters:write. More will be added as the API grows.