Welcome to the Registration API documentation! This endpoint allows users to create new accounts or register for services. Below are the details you need to use it effectively.
📌 Endpoint Overview
- Path:
/api/registration
- Method:
POST
- Description: Handles user registration requests.
🧾 Request Parameters
Provide the following data in the request body:
username
(string) 🔐email
(string) ✉️password
(string) 🔒consent
(boolean) 📝 Required for policy acceptance
📌 Note: All fields are mandatory. For more details on consent requirements, see Policy Guidelines.
📊 Response Examples
Success:
{
"status": "success",
"message": "User registered successfully",
"user_id": "12345"
}
Error:
{
"status": "error",
"message": "Email already exists"
}
⚠️ Error Codes
Code | Description |
---|---|
400 | Bad Request (missing fields) |
409 | Conflict (duplicate email) |
500 | Internal Server Error |
🌐 Security Tips
- Always use
HTTPS
for secure data transmission. - Never expose sensitive data in logs or responses.
For advanced usage or troubleshooting, check the Authentication API for related operations. Let me know if you need further assistance! 😊