/v1/signup/begin

POST

/v1/signup/begin

curl --request POST \
  --url https://api.reindeer.example.tr/v1/signup/begin \
  --header 'Content-Type: application/json' \
  --data '{ "organization": "example", "name": "example", "email": "example", "data_source": "example", "accept_terms": "example", "data_rights": true }'

Platform only. Checks the signup form and starts the passkey creation for the founder; nothing is stored. accept_terms must equal the platform’s terms_version from /v1/meta. Signups pause (503 signups_paused) while limits.pending_signups organisations wait for activation; one network (an IPv4 /24 or an IPv6 /48) may have limits.pending_per_source of them waiting (429 signup_source); and one address (an IPv4 address or an IPv6 /48) may sign up limits.signup_burst times, then once per limits.signup_interval (429 signup_rate).

Request Body^required

Media typeapplication/json

object

organization

required

2 to 128 letters, digits, spaces or .,&’()/+_-

string

name

required

string

email

required

string

<= 254 characters

data_source

required

Source and licence of the data

string

>= 20 characters <= 2000 characters

accept_terms

required

The terms version from /v1/meta

string

data_rights

required

boolean

Responses

200

WebAuthn options and a ceremony handle valid five minutes

Media typeapplication/json

object

ceremony

string

options

object

Example ^generated

{
  "ceremony": "example",
  "options": {}
}

400

Bad_json, media_type

422

Organization, name, email, data_source, terms or data_rights

429

Signup_rate or signup_source

503

Signups_paused