ZapAPI Docs
Get StartedConceptsAI GatewayGuidesPayment GatewaySDKAPI ReferenceResources
ApiAuth

Register a new user

POST
/api/v1/auth/register

Creates a new user account and sends email verification link. Rate limited to 5 requests per minute.

Header Parameters

X-API-Version?string

API version for header-based versioning

Default"1"
Value in"1""2"

Request Body

application/json
  1. body
email*string

User email address

firstName*string

User first name

Length2 <= length <= 50
lastName*string

User last name

Length2 <= length <= 50
password*string

User password (min 8 chars, must include uppercase, lowercase, number, and special character)

Length8 <= length <= 100

Response Body

User registered successfully

response?unknownapplication/json
Example Request
curl -X POST 'http://localhost:3001/api/v1/auth/register' \  -H 'Content-Type: application/json' \  -d '{  "email": "john.doe@example.com",  "firstName": "John",  "lastName": "Doe",  "password": "SecurePass123!"}'
Example Response
{  "status": "success",  "statusCode": 201,  "message": "Registration successful. Please check your email to verify your account.",  "data": {    "user": {      "id": "123e4567-e89b-12d3-a456-426614174000",      "email": "john.doe@example.com",      "firstName": "John",      "lastName": "Doe",      "isActive": true,      "isEmailVerified": false,      "createdAt": "2026-01-31T10:00:00.000Z",      "updatedAt": "2026-01-31T10:00:00.000Z"    },    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",    "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."  },  "meta": {    "user_id": "123e4567-e89b-12d3-a456-426614174000",    "created_at": "2026-01-31T10:00:00.000Z",    "email_verification_required": true  },  "timestamp": "2026-01-31T10:00:00.000Z",  "path": "/api/v1/auth/register"}