Skip to main content
POST
/
api
/
v1
/
organisation
create entity
curl --request POST \
  --url https://api.example.com/api/v1/organisation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "parent": "ADGM",
  "tenantId": 123,
  "icon": "<string>",
  "logoLight": "<string>",
  "darkLogo": "<string>"
}
'
{
  "name": "<string>",
  "parent": "ADGM",
  "id": 1,
  "createdAt": 123,
  "updatedAt": 123,
  "icon": "<string>",
  "logoLight": "<string>",
  "darkLogo": "<string>",
  "tenantId": 123
}

Authorizations

​
Authorization
string
header
required

Authentication

Body

application/json
​
name
string
required

Regulator Organisation name

​
parent
string
required

Regulator Organisation parent

Example:

"ADGM"

​
tenantId
integer<int64>
required

Tenant ID corresponding to this organisation

​
status
enum<string>

Status of the entity. Default: 'ACTIVE'

Available options:
ACTIVE,
DISABLED,
DELETED
​
icon
string

Regulator Organisation icon

​
logoLight
string

Regulator Organisation light logo

Pattern: ^https?.*

Regulator Organisation dark logo

Pattern: \s*|^https?.*

Response

200 - application/json

OK

​
name
string
required

Regulator Organisation name

​
parent
string
required

Regulator Organisation parent

Example:

"ADGM"

​
id
integer<int64>

Unique identifier of the entity

Example:

1

​
createdAt
integer<int64>

Time when entity was created

​
updatedAt
integer<int64>

Time when entity was updated

​
status
enum<string>

Status of the entity. Default: 'ACTIVE'

Available options:
ACTIVE,
DISABLED,
DELETED
​
icon
string

Regulator Organisation icon

​
logoLight
string

Regulator Organisation light logo

Regulator Organisation dark logo

​
tenantId
integer<int64>

Tenant ID corresponding to this organisation