Hi-Send Docs

Register

https://core.hisend.hunnovate.com/api/v1/projects/{project_identifier}/auth/sign-up?api_key={api_key}

Register a new user


Path Parameters

project_identifier string required

The identifier or id of the project, for example project_name or 01jtk9f6xtp5bqycmj8x68040f, you can get it from the projects page on your dashboard

Query Params

api_key string required

The api key from your dashboard

Body Parameters

first_name string required

First Name of the user

last_name string required

Last Name of the user

phone string required

Phone Number of the user

email string required

Email Address of the user

password string required

Password of the user

password_confirmation string required

The password should match with password field

any_other_field string optional

You can add any other field here

Payload Example


{
    "first_name": "John",
    "last_name": "Doe",
    "phone": 0123456789,
    "address": "123 Main St",
    "state": "Lagos",
    "email": "example@hunnovate.com",
    "password": "@f.7esdfg_1G",
    "password_confirmation": "@f.7esdfg_1G",
}

200 Success Response Example


{
    "data": {
        "token": "jVm1T68Lc84QajRORk7KS2iKm0cGzigL",
        "user": {
            "id": "01JTGJN6XCVKAWTT7XF7PRQV4A",
            "email": "example@hunnovate.com",
            "phone": 0123456789,
            "last_name": "Doe",
            "first_name": "John",
            "created_at": "2025-05-05T15:57:26.000000Z",
            "updated_at": "2025-05-07T14:42:41.000000Z",
            "email_verified_at": "2025-05-05T16:02:15.000000Z",
            "phone_verified_at": "2025-05-05T16:03:43.000000Z",
            "full_name": "John Doe",
        },
    },
    "message": "Signup successful",
}