Skip to main content
Use this endpoint to register a new user account. After a successful signup, a 6-digit OTP is sent to the provided email address. You must verify your email before you can log in.

​
Endpoint

POST https://api.hyparrow.com/api/v1/auth/signup

​
Request body

​
firstName
string
required
The user’s first name. Must contain only valid name characters.
​
lastName
string
required
The user’s last name. Must contain only valid name characters.
​
email
string
required
A valid email address. Must be unique — accounts with duplicate emails are rejected.
​
password
string
required
The account password. Must be at least 8 characters long.
​
country
string
required
ISO 3166-1 alpha-2 country code (exactly 2 uppercase characters). Example: NG, US, GB.
​
accountType
string
required
The type of account to create. Accepted values: personal, business.

​
Response

​
success
boolean
true when the account is created successfully.
​
data
object

​
Examples

curl -X POST https://api.hyparrow.com/api/v1/auth/signup \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Ada",
    "lastName": "Okafor",
    "email": "ada.okafor@example.com",
    "password": "SecurePass123",
    "country": "NG",
    "accountType": "business"
  }'

​
Success response

{
  "success": true,
  "data": {
    "message": "User created successfully. Please verify your email.",
    "userId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

​
Error response

{
  "success": false,
  "error": "email already registered"
}
After signup, check your inbox for a 6-digit OTP. The code expires in 10 minutes. Use the Verify Email endpoint to confirm your address before logging in.