Skip to main content
POST
/
api
/
v1
/
auth
/
register
Register
curl --request POST \
  --url https://api.bunship.com/api/v1/auth/register \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "password": "<string>",
  "fullName": "<string>"
}
'
{
  "message": "Registration successful. Please check your email to verify your account.",
  "userId": "usr_cld2abc123def456"
}

Documentation Index

Fetch the complete documentation index at: https://docs.bunship.com/llms.txt

Use this file to discover all available pages before exploring further.

Creates a new user account and sends a verification email to confirm the email address. The account cannot be used to log in until the email is verified.

​
Auth

None required.

​
Rate Limit

20 requests per minute per IP.

​
Request Body

​
email
string
required
User email address. Must be a valid email format, between 5 and 255 characters.
​
password
string
required
Account password. Minimum 8 characters, maximum 128 characters.
​
fullName
string
required
User’s full display name. Between 1 and 255 characters.

​
Response

​
message
string
Confirmation message.
​
userId
string
The newly created user’s ID.
{
  "message": "Registration successful. Please check your email to verify your account.",
  "userId": "usr_cld2abc123def456"
}

​
Errors

StatusCodeDescription
400VALIDATION_ERRORInvalid email format, password too short, or missing required fields
409CONFLICTAn account with this email address already exists
{
  "success": false,
  "error": {
    "code": "CONFLICT",
    "message": "Email address already in use"
  }
}

​
Example

curl -X POST https://api.bunship.com/api/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "SecureP@ssw0rd",
    "fullName": "John Doe"
  }'