Skip to content

Register a new account

POST
/api/v1/auth/register
curl --request POST \
--url https://api.deploybase.eu/api/v1/api/v1/auth/register \
--header 'Content-Type: application/json' \
--data '{ "email": "sam@example.eu", "name": "Sam Verhoeven", "password": "example", "pow_solution": "example" }'

Creates a Zitadel organization and its owner user, then emails a confirmation code (DEP-666: Zitadel returns the code, we send the mail). No authentication required. An address that already has an account gets the same 201 and body as a new one (no account enumeration); its owner is emailed instead, at most once per 24 hours. An INVALID_INPUT error carries details.field (email, name or password) naming the input the message is about.

Registration details

Media type application/json
object
email
string

Example

sam@example.eu
name

Name is the registrant’s name as they write it. The service derives the given and family names Zitadel needs from it.

string

Example

Sam Verhoeven
password
string
pow_solution

PoWSolution is the base64 proof-of-work payload from the form’s hidden field (DEP-298). Named for what it is rather than for the vendor that produces it: the API contract should outlive the library, and DEP-335 exists because that library’s protocol is already on its second major.

Empty is a valid body. The service classifies an absent solution; the handler does not pre-judge it, and neither does the SvelteKit proxy.

string

Created

Media type application/json
object
data
meta
object
request_id
string
timestamp
string
trace_id
string
data
object
email
string

Example generated

{
"data": {
"email": "example"
},
"meta": {
"request_id": "example",
"timestamp": "example",
"trace_id": "example"
}
}

Validation failed (INVALID_INPUT, with details.field), refused by the abuse gate, or missing or expired proof of work

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string
details
object
field
string
Allowed values: email name password

Example

{
"details": {
"field": "email"
}
}

Registration is temporarily unavailable

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string

Example generated

{
"code": "example",
"details": "example",
"error": "example",
"meta": {
"request_id": "example",
"timestamp": "example",
"trace_id": "example"
}
}

Signups are temporarily closed

Media type application/json
object
code
string
details
error
string
meta
object
request_id
string
timestamp
string
trace_id
string

Example generated

{
"code": "example",
"details": "example",
"error": "example",
"meta": {
"request_id": "example",
"timestamp": "example",
"trace_id": "example"
}
}

Live 174db30c built