Developers › API reference

Entitlements API

Per-account permissions: view, propose, trade, approve.

Objects

An entitlement is one user's permissions on one account: view, propose, trade, approve. The user's role caps them: a grant beyond the role has no effect. Admin, Compliance and Operations see every account without a grant.

Notes

PUT /entitlements/{userId}/{accountId} sets the four flags; omitted flags are unchanged. Every change is in the event log and appears in the next access review.

Endpoints

CallWhat it doesScope
GET/entitlementsPer-account permissions of every userentitlements:read
PUT/entitlements/{userId}/{accountId}Set one user's permissions on one accountentitlements:write