Create an account and its organisation.

POST

/v1/auth/signup

curl --request POST \
  --url https://api.opdns.io/v1/auth/signup \
  --header 'Content-Type: application/json' \
  --data '{ "email": "[email protected]", "password": "example", "invite_code": "example" }'

In closed mode, returns 403 signup_closed. In invite mode, requires a valid invite_code or an email/exact-domain allowlist match; every missing, invalid, expired, revoked or exhausted code returns the same 403 invite_required. Open mode requires neither. There is no account cap. Eligible requests answer 202 with the same body whether or not the email is already registered. A new account gets a verification email with a link to <dashboard>/verify-email?token=ver_... (24 h, single use); an existing address gets an “account exists” email instead (at most one a minute). Mail goes through the mailer role’s queue.

Request Body^required

Media typeapplication/json

object

email

required

string format: email

password

required

12 to 128 characters (Unicode code points), no composition rules.

string

>= 12 characters <= 128 characters

invite_code

Optional opaque invitation code, required in invite mode unless allowlisted.

string

Example^generated

{
  "email": "[email protected]",
  "password": "example",
  "invite_code": "example"
}

Responses

202

Accepted; verification sent.

Media typeapplication/json

object

status

required

string

Allowed value: verification_sent

Example

{
  "status": "verification_sent"
}

400

Malformed request.

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

Stable machine code.

string

Allowed values: bad_request body_too_large bad_if_match unauthenticated invalid_credentials signup_closed invite_required waitlist_unavailable invalid_token token_expired token_used session_required insufficient_scope csrf_rejected not_found version_mismatch ip_conflict unknown_list too_many_rules validation_failed rate_limited internal node_revoked node_offline node_busy node_timeout node_error result_too_large shape_unsupported node_token_superseded relay_unavailable not_implemented query_timeout query_too_expensive range_too_large too_many_queries second_factor_required invalid_second_factor mfa_enrolment_required mfa_required reauth_required no_second_factor totp_already_enabled totp_not_enabled last_credential passkey_exists passkey_invalid passkeys_unavailable ceremony_invalid account_pending_deletion credential_required deletion_pending no_deletion_pending deletion_started organisation_has_members export_in_progress export_not_ready block_exists invalid_recovery_code profile_not_empty invalid_cursor bad_idempotency_key idempotency_key_reused idempotency_in_progress too_many_streams too_many_reports password_too_short password_too_long profile_suspended

detail

string

errors

Array<object>

object

field

required

string

message

required

string

request_id

string

retry_after

Seconds, repeating the Retry-After header (rate limits, offline nodes).

integer

Example

{
  "type": "https://opdns.io/problems/bad_request",
  "title": "Bad Request",
  "status": 400,
  "code": "bad_request",
  "detail": "invalid JSON body",
  "request_id": "5f2c9a0e7b1d4c38"
}

403

Signup is closed, or the request lacks a valid invitation.

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

Stable machine code.

string

Allowed values: bad_request body_too_large bad_if_match unauthenticated invalid_credentials signup_closed invite_required waitlist_unavailable invalid_token token_expired token_used session_required insufficient_scope csrf_rejected not_found version_mismatch ip_conflict unknown_list too_many_rules validation_failed rate_limited internal node_revoked node_offline node_busy node_timeout node_error result_too_large shape_unsupported node_token_superseded relay_unavailable not_implemented query_timeout query_too_expensive range_too_large too_many_queries second_factor_required invalid_second_factor mfa_enrolment_required mfa_required reauth_required no_second_factor totp_already_enabled totp_not_enabled last_credential passkey_exists passkey_invalid passkeys_unavailable ceremony_invalid account_pending_deletion credential_required deletion_pending no_deletion_pending deletion_started organisation_has_members export_in_progress export_not_ready block_exists invalid_recovery_code profile_not_empty invalid_cursor bad_idempotency_key idempotency_key_reused idempotency_in_progress too_many_streams too_many_reports password_too_short password_too_long profile_suspended

detail

string

errors

Array<object>

object

field

required

string

message

required

string

request_id

string

retry_after

Seconds, repeating the Retry-After header (rate limits, offline nodes).

integer

Examples

{
  "type": "https://opdns.io/problems/signup_closed",
  "title": "Forbidden",
  "status": 403,
  "code": "signup_closed",
  "detail": "signup is closed"
}

{
  "type": "https://opdns.io/problems/invite_required",
  "title": "Forbidden",
  "status": 403,
  "code": "invite_required",
  "detail": "a valid invitation is required"
}

422

The request failed validation (validation_failed), or the new password was refused: password_too_short (under 12 characters), password_too_long (over 128). Length is counted in Unicode code points and the password is used as sent (no normalisation). A password problem alongside other invalid fields is validation_failed listing them all. errors names the password field.

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

Stable machine code.

string

Allowed values: bad_request body_too_large bad_if_match unauthenticated invalid_credentials signup_closed invite_required waitlist_unavailable invalid_token token_expired token_used session_required insufficient_scope csrf_rejected not_found version_mismatch ip_conflict unknown_list too_many_rules validation_failed rate_limited internal node_revoked node_offline node_busy node_timeout node_error result_too_large shape_unsupported node_token_superseded relay_unavailable not_implemented query_timeout query_too_expensive range_too_large too_many_queries second_factor_required invalid_second_factor mfa_enrolment_required mfa_required reauth_required no_second_factor totp_already_enabled totp_not_enabled last_credential passkey_exists passkey_invalid passkeys_unavailable ceremony_invalid account_pending_deletion credential_required deletion_pending no_deletion_pending deletion_started organisation_has_members export_in_progress export_not_ready block_exists invalid_recovery_code profile_not_empty invalid_cursor bad_idempotency_key idempotency_key_reused idempotency_in_progress too_many_streams too_many_reports password_too_short password_too_long profile_suspended

detail

string

errors

Array<object>

object

field

required

string

message

required

string

request_id

string

retry_after

Seconds, repeating the Retry-After header (rate limits, offline nodes).

integer

Example

{
  "type": "https://opdns.io/problems/password_too_short",
  "title": "Unprocessable Content",
  "status": 422,
  "code": "password_too_short",
  "detail": "the password must be at least 12 characters",
  "errors": [
    {
      "field": "password",
      "message": "at least 12 characters"
    }
  ],
  "request_id": "5f2c9a0e7b1d4c38"
}

429

Rate limited (rate_limited).

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

Stable machine code.

string

Allowed values: bad_request body_too_large bad_if_match unauthenticated invalid_credentials signup_closed invite_required waitlist_unavailable invalid_token token_expired token_used session_required insufficient_scope csrf_rejected not_found version_mismatch ip_conflict unknown_list too_many_rules validation_failed rate_limited internal node_revoked node_offline node_busy node_timeout node_error result_too_large shape_unsupported node_token_superseded relay_unavailable not_implemented query_timeout query_too_expensive range_too_large too_many_queries second_factor_required invalid_second_factor mfa_enrolment_required mfa_required reauth_required no_second_factor totp_already_enabled totp_not_enabled last_credential passkey_exists passkey_invalid passkeys_unavailable ceremony_invalid account_pending_deletion credential_required deletion_pending no_deletion_pending deletion_started organisation_has_members export_in_progress export_not_ready block_exists invalid_recovery_code profile_not_empty invalid_cursor bad_idempotency_key idempotency_key_reused idempotency_in_progress too_many_streams too_many_reports password_too_short password_too_long profile_suspended

detail

string

errors

Array<object>

object

field

required

string

message

required

string

request_id

string

retry_after

Seconds, repeating the Retry-After header (rate limits, offline nodes).

integer

Example

{
  "type": "https://opdns.io/problems/rate_limited",
  "title": "Too Many Requests",
  "status": 429,
  "code": "rate_limited",
  "detail": "too many requests",
  "request_id": "5f2c9a0e7b1d4c38",
  "retry_after": 6
}

Headers

Retry-After

integer