Skip to main content
POST
Creates a new role in the caller's organization.

Authorizations

Authorization
string
header
required

Application (M2M) OAuth2 access token (client credentials).

Headers

X-Organization-ID
string<uuid>

ID of the organization to scope this operation to. When omitted, the role is created in the caller's own organization. Must be a valid non-empty UUID. Present but empty or malformed values return 400.

Body

Cancellation token.

key
string
required
name
string
required
appliesToOrgType
null | enum<string>

Org type the role applies to. Optional: derived from the target org's type when it holds a single ranked type, required when it holds several. Must be one of the target org's ranked types and at-or-below the caller's org type.

Available options:
BANK,
EMBEDDED,
PLATFORM,
TRANSACTOR,
VERTICAL_SOFTWARE_PROVIDER
description
null | string
sortOrdinal

Sort order among roles. Optional: defaults to 9000 when omitted. Must be at least 5000 for custom roles.

Response

Role created successfully.

id
string<uuid>
required
createdDateTime
string<date-time>
required
key
required
Available options:
bank:admin,
embedded:admin,
embedded:bookkeeper,
embedded:employee,
embedded:finance_admin,
platform:admin,
vsp:admin
name
string
required
sortOrdinal
required
status
string
required
updatedDateTime
string<date-time>
required
appliesToOrgType
null | string
description
null | string
icon
null | string
isSystemRole
boolean
organizationId
null | string<uuid>