Skip to content
Back to Steward

Accounts

An account is your compliance workspace. It carries the configuration that governs how applications are scored and verified, and it owns the users who can access the API.

GET /account returns your account, including its risk scoring strategy and identity-verification provider. An admin changes the account’s settings in the Steward app; the API reads them.

Field Values
riskScoreStrategy CUMULATIVE or MAXIMUM (governs how risk scores map to bands; see the Risk Scoring guide)
idvProvider ONFIDO or TRULIOO (the identity-verification provider)

Risk factor configuration is readable at GET /account/{accountId}/risk-settings.

A user can belong to more than one account; GET /account/users lists the members of this account. Listing excludes internal Steward staff. Inviting, changing and removing users is done in the Steward app by an admin.

Operation Endpoint Notes
List GET /account/users Members of this account, each with their accessLevel here

A user’s status is one of PENDING, ACTIVE, or INACTIVE.

Each user holds one accessLevel in your account, and each level includes the one below it:

accessLevel What it allows
ADMIN Everything below, plus user management and account configuration (including risk settings)
MEMBER Works the queue: review, resolve, escalate
COMMENT_ONLY Reads everything and adds notes; changes nothing else
READ_ONLY Reads everything; changes nothing, not even a note

A request the caller’s level does not allow returns 403. Your API key acts as a MEMBER of your account: it can work the queue, but it cannot manage users or change the account’s configuration.

Terminal window
# Fetch your account
curl https://api.getsteward.ai/api/v1/account \
-H "Authorization: Bearer stw_live_your_api_key_here"
# List the users in your account, with each one's access level
curl https://api.getsteward.ai/api/v1/account/users \
-H "Authorization: Bearer stw_live_your_api_key_here"