Create user account
Creates a new user account and associated tenant in the system. Supports multiple authentication providers including email/password and OAuth. Includes advanced security features like CAPTCHA verification and risk assessment.
For OAuth providers (GitHub, Google), returns a redirect URL. For email/password signup, creates the tenant and returns a session ID.
Company or organization name
2 <= length
User's first name
1 <= length
User's last name (optional)
User's job title (optional)
Authentication provider to use
"default"
"default" | "github" | "google"
Email address (required for default provider)
email
Password (required for default provider)
password
8 <= length
Acceptance of terms of service (required for default provider)
CAPTCHA verification payload (optional but recommended)
User's timezone for verification (optional)
Response Body
const body = JSON.stringify({
"company_name": "Acme Corporation",
"first_name": "John",
"provider": "default"
})
fetch("https://app.orbiqhq.com/api/v1/signup", {
body
})
{
"success": true,
"sessionId": "session_abc123",
"redirectUrl": "/api/v1/admin/tenants/progress?session=session_abc123"
}
{
"errors": [
{
"field": "email",
"message": "Valid email required"
},
{
"field": "password",
"message": "Password must be at least 8 characters"
}
]
}
{
"errors": [
{
"field": "company_name",
"message": "A company with this name already exists"
}
]
}
{
"errors": [
{
"field": "form",
"message": "An unexpected error occurred. Please try again."
}
]
}
How is this guide?