Submit a new parent-org registration

POST

/v1/orgs/create

curl --request POST \
  --url https://aggregator.example.com/v1/orgs/create \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "example", "state": "example", "owner": { "name": "example", "email": "hello@example.com", "phone": "example" }, "consent": { "value": true, "given_at": "example", "valid_till": "example" }, "website": "https://example.com", "aggregator_type": [ "seeker" ], "organisation_type": "example", "organisation_sub_type_educational": "example", "organisation_sub_type_non_educational": "example", "management_type": "private", "address": { "streetAddress": "example", "addressLocality": "example", "addressDistrict": "example", "addressRegion": "example", "postalCode": "example", "addressCountry": "example" } }'

• Your deployment's public host (set per instance)
• Local development

Creates a pending org (system of record) + mirrored Keycloak group + disabled org-owner user, and emails the network admin a signed review link. Only registered when ORG_HIERARCHY_ENABLED=true.

Request Body^required

Media typeapplication/json

object

display_name

required

string

>= 1 characters <= 200 characters

state

string

<= 200 characters

owner

required

object

name

required

string

>= 1 characters <= 200 characters

email

required

string format: email

phone

required

string

>= 1 characters

consent

required

object

value

required

boolean

given_at

required

string

valid_till

required

string

website

string format: uri

<= 2048 characters

aggregator_type

Array<string>

Allowed values: seeker provider service_provider

organisation_type

string

<= 100 characters

organisation_sub_type_educational

string

<= 100 characters

organisation_sub_type_non_educational

string

<= 100 characters

management_type

string

Allowed values: private government ngo other

address

object

streetAddress

string

<= 300 characters

addressLocality

string

<= 200 characters

addressDistrict

string

<= 200 characters

addressRegion

string

<= 200 characters

postalCode

string

<= 20 characters

addressCountry

string

<= 100 characters

Responses

201

Default Response

Media typeapplication/json

object

org_id

required

string

slug

required

string

status

required

string

message

required

string

key

additional properties

any

Example^generated

{
  "org_id": "example",
  "slug": "example",
  "status": "example",
  "message": "example"
}

400

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

title

required

string

detail

required

string

docs

string

fields

object

key

additional properties

requestId

required

string

timestamp

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

401

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

title

required

string

detail

required

string

docs

string

fields

object

key

additional properties

requestId

required

string

timestamp

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

409

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

title

required

string

detail

required

string

docs

string

fields

object

key

additional properties

requestId

required

string

timestamp

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

500

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

title

required

string

detail

required

string

docs

string

fields

object

key

additional properties

requestId

required

string

timestamp

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}

503

Default Response

Media typeapplication/json

object

error

required

object

code

required

string

title

required

string

detail

required

string

docs

string

fields

object

key

additional properties

requestId

required

string

timestamp

required

string

key

additional properties

any

key

additional properties

any

Example^generated

{
  "error": {
    "code": "example",
    "title": "example",
    "detail": "example",
    "docs": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "requestId": "example",
    "timestamp": "example"
  }
}