Skip to main content
POST
/
users
Create a new user
curl --request POST \
  --url https://api.platform.dakota.xyz/users \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "first_name": "John",
  "last_name": "Doe",
  "email": "john@example.com",
  "role": "admin"
}
'
{
  "id": "1NFHrqBHb3cTfLVkFSGmHZqdDPi",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john@example.com",
  "role": "admin",
  "created_at": 1234567890,
  "is_super_admin": true,
  "swift_enabled": true
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-idempotency-key
string<uuid>
required

Unique key to ensure request idempotency. If the same key is used within a certain time window, the original response will be returned instead of executing the request again.

Body

application/json

user details

Request body for creating a new client user

​
first_name
string
required

Given name of the user

Minimum string length: 1
Example:

"John"

​
last_name
string
required

Surname of the user

Minimum string length: 1
Example:

"Doe"

​
email
string<email>
required

Email address of the user

Example:

"john@example.com"

​
role
enum<string>
required

Role that can be assigned to a client user

Available options:
admin,
viewer
Example:

"admin"

Response

User created successfully

User object representing a user in the system, including all clients they can access.

​
id
string
required

KSUID is a 27-character globally unique ID that combines a timestamp with a random component. Used for all entity identifiers in the Dakota platform.

Required string length: 27
Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

​
first_name
string
required

Given name of the user.

Example:

"John"

​
last_name
string
required

Surname of the user.

Example:

"Doe"

​
email
string
required

Email address of the user.

Example:

"john@example.com"

​
role
enum<string>
required

Role that can be assigned to a client user

Available options:
admin,
viewer
Example:

"admin"

​
created_at
integer
required

Timestamp of when the user was created.

Example:

1234567890

​
is_super_admin
boolean

Whether the user is a super admin. Only populated if true.

​
swift_enabled
boolean

Whether the client has SWIFT payments enabled.