API ReferenceAuthentication
Register a new user
POST
/v1/auth/registerTypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/auth/register" \ -H "Content-Type: application/json" \ -d '{ "email": "user@example.com", "password": "SecurePassword123!", "inviteCode": "123456", "inviteToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "organisationName": "Acme Corporation", "organisationPhone": "+2348012345678", "address": "123 Main St, Lagos, Nigeria" }'{ "success": true, "statusCode": 200, "message": "Request processed successfully", "timestamp": "2025-10-20T16:30:00.000Z", "path": "/v1/auth/register", "data": { "id": "123e4567-e89b-12d3-a456-426614174000", "email": "user@example.com", "status": "PENDING", "createdAt": "2025-10-20T16:00:00.000Z", "organisation": { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Acme Corporation", "logo": "https://example.com/logo.png", "accessLevelId": "cm2ipl8te0000xtnrnfnqbrcn" }, "wallet": { "id": "123e4567-e89b-12d3-a456-426614174000", "balance": "100", "currency": "NGN" } }}{ "success": false, "statusCode": 400, "message": "Validation failed", "errors": [ { "field": "email", "message": "Email must be a valid email address" } ], "timestamp": "2025-10-20T16:30:00.000Z", "path": "/v1/auth/register"}{ "success": false, "statusCode": 400, "message": "Validation failed", "errors": [ { "field": "email", "message": "Email must be a valid email address" } ], "timestamp": "2025-10-20T16:30:00.000Z", "path": "/v1/auth/register"}