Skip to content
aggregator-registrations

Submit a new aggregator registration

POST
/v1/aggregator-registrations/create
curl --request POST \
--url https://aggregator.example.com/v1/aggregator-registrations/create \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "type": "example", "url": "https://example.com", "contact": { "name": "example", "phone": "example", "email": "hello@example.com", "alternatePhone": "example", "company": "example", "gstNumber": "example" }, "locations": [], "consent": { "value": true, "given_at": "2026-04-15T12:00:00Z", "valid_till": "2026-04-15T12:00:00Z" }, "org_id": "example" }'

Validates submission against config/schemas/aggregator/registration.v1.json, creates a disabled user (login enabled on admin approval), and pushes the org to signalstack. Reached via a non-aggregator Bearer token from Keycloak.

Media typeapplication/json
object
name
required
string
>= 2 characters <= 200 characters
type
required
string
>= 1 characters
url
string format: uri
<= 2048 characters
contact
required
object
name
required
string
>= 1 characters <= 200 characters
phone
required
string
/^(\+?\d{10,15}|\d{10})$/
email
required
string format: email
<= 320 characters
alternatePhone
string
/^(\+?\d{10,15}|\d{10})$/
company
string
<= 200 characters
gstNumber
string
<= 32 characters
locations
Array<object>
default:
object
geo
required
object
type
required
string
Allowed values: Point LineString Polygon MultiPoint MultiLineString MultiPolygon GeometryCollection
coordinates
Array
geometries
Array
bbox
Array<number>
>= 4 items <= 4 items
address
object
streetAddress
string
extendedAddress
string
addressLocality
string
addressRegion
string
postalCode
string
addressCountry
string
consent
required
object
value
required
boolean
given_at
required
string format: date-time
valid_till
required
string format: date-time
org_id
string

Default Response

Media typeapplication/json
object
aggregator_id
required
string
org_slug
required
string
status
required
string
message
required
string
key
additional properties
any
Examplegenerated
{
"aggregator_id": "example",
"org_slug": "example",
"status": "example",
"message": "example"
}

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
Examplegenerated
{
"error": {
"code": "example",
"title": "example",
"detail": "example",
"docs": "example",
"fields": {
"additionalProperty": "example"
},
"requestId": "example",
"timestamp": "example"
}
}

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
Examplegenerated
{
"error": {
"code": "example",
"title": "example",
"detail": "example",
"docs": "example",
"fields": {
"additionalProperty": "example"
},
"requestId": "example",
"timestamp": "example"
}
}

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
Examplegenerated
{
"error": {
"code": "example",
"title": "example",
"detail": "example",
"docs": "example",
"fields": {
"additionalProperty": "example"
},
"requestId": "example",
"timestamp": "example"
}
}

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
Examplegenerated
{
"error": {
"code": "example",
"title": "example",
"detail": "example",
"docs": "example",
"fields": {
"additionalProperty": "example"
},
"requestId": "example",
"timestamp": "example"
}
}

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
Examplegenerated
{
"error": {
"code": "example",
"title": "example",
"detail": "example",
"docs": "example",
"fields": {
"additionalProperty": "example"
},
"requestId": "example",
"timestamp": "example"
}
}