Skip to content
Blue Dots EconomyBlue Dots EconomyDocumentation
public-registration

Probe an identity before opening the registration form

GET
/public/v1/aggregators/{orgSlug}/lookup
curl --request GET \
  --url 'https://aggregator.example.com/public/v1/aggregators/example/lookup?network=example&domain=example'

Anonymous identity probe used by the public registration form. Classifies the supplied email/phone as new (user_exists=false), an own user with optional lifecycle summary, or owned by another aggregator (owned_elsewhere=true). Requires at least one of email or phone_number, plus the network and domain to scope the signalstack probe.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
orgSlug
required
string
>= 1 characters

Aggregator organisation slug.

Query Parameters

Section titled “Query Parameters”
email
string format: email
phone_number
string
>= 1 characters
network
required
string
>= 1 characters
domain
required
string
>= 1 characters

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
user_exists
required
boolean
owned_elsewhere
required
boolean
lifecycle_summary
required
object
primary_item
required
object
item_id
required
string
lifecycle_status
required
string
Allowed values: draft live paused
key
additional properties
any
key
additional properties
any
key
additional properties
any
Example
{
  "lifecycle_summary": {
    "primary_item": {
      "lifecycle_status": "draft"
    }
  }
}

400

Section titled “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
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"
  }
}

429

Section titled “429”

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

502

Section titled “502”

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