Skip to main content

User

A user linked to the account

idstring<uuid>

Unique identifier of the user

idpIdstring<uuid>

Identity provider ID

emailAddressstring

Email address of the user

phoneNumberstring

Phone number of the user

displayNamestring

Display name of the user

blockedStatusstring

Blocked status of the user

Possible values: [BLOCKED, NOT_BLOCKED]

rolestring

User role within the account.

  • OWNER: Full account access. Can manage users, accept terms and conditions, and approve own transactions.
  • ADMIN: Full operational access. Can approve own transactions but cannot manage users.
  • EXECUTOR: Can create and approve payments and transfers. Cannot approve own transactions (segregation of duties).
  • PREPARER: Can draft payments and manage beneficiaries. Cannot execute or approve transactions.
  • VIEWER: Read-only access.

Possible values: [OWNER, ADMIN, EXECUTOR, PREPARER, VIEWER]

accountIdstring<uuid>

Account ID the user is linked to

User
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "idpId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "emailAddress": "string",
  "phoneNumber": "string",
  "displayName": "string",
  "blockedStatus": "BLOCKED",
  "role": "OWNER",
  "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}