Skip to content
Blue Dots EconomyBlue Dots EconomyDocumentation
aggregator-profile

Read the caller aggregator profile

GET
/v1/aggregators/profile/me
curl --request GET \
  --url https://aggregator.example.com/v1/aggregators/profile/me \
  --header 'Authorization: Bearer <token>'

Returns the full aggregator row + brand + contact + status for the aggregator bound to the Bearer token claim.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
aggregator_id
required
string
org_slug
required
string
actor_type
required
string
type
required
string
nullable
url
required
string
nullable
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
required
Array<object>
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
status
required
string
contact_name
required
string
nullable
personas
required
Array<object>
object
id
required
string
>= 1 characters
name
required
string
>= 1 characters
services
required
Array<object>
object
id
required
string
>= 1 characters
name
required
string
>= 1 characters
verified_certificate
required
Array<object>
object
key_id
required
string
>= 1 characters
public_key
required
string
>= 1 characters
algorithm
required
string
>= 1 characters
valid_till
required
string format: date-time
revoked_at
string format: date-time
profile_completed_at
required
string
nullable
is_complete
required
boolean
updated_at
required
string
org_name
required
string
identity
required
object
first_name
required
string
nullable
last_name
required
string
nullable
email
required
string
nullable
email_verified
required
boolean
phone
required
string
nullable
phone_verified
required
boolean
active
required
boolean
key
additional properties
any
created_at
required
string
key
additional properties
any
Example
{
  "locations": [
    {
      "geo": {
        "type": "Point"
      }
    }
  ]
}

401

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

403

Section titled “403”

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"
  }
}

404

Section titled “404”

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"
  }
}

503

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