Create user

POST

/v1/users

Creates a new end user under the authenticated partner.

Request

Authorization

API Key

Add parameter in header

X-API-KEY

Example:

X-API-KEY: ********************

API Key

Add parameter in header

X-API-SECRET

Example:

X-API-SECRET: ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

User created

Body

🟠400BadRequest

🟠401Unauthorized

🟠409Conflict

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://devapi.immigraflow.com/v1/users' \
--header 'X-API-KEY: <api-key>' \
--header 'X-API-SECRET: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "user@example.com",
    "name": "string",
    "phone": "string",
    "notify_by_email": true,
    "notify_by_whatsapp": false
}'

Response Example

201 - Success

{
    "success": true,
    "verification_required": true,
    "message": "User created. Email verification is required before case registration.",
    "verification_delivery": {
        "channel": "ntfy",
        "sent": true
    },
    "user": {
        "id": 1,
        "email": "user@example.com",
        "name": "John Doe",
        "phone": "+1-555-123-4567",
        "email_verified_at": null,
        "notify_by_email": true,
        "notify_by_whatsapp": false,
        "status": "inactive",
        "created_at": "2026-04-20 14:21:57",
        "updated_at": "2026-04-20 14:21:57",
        "preferred_language": "en"
    }
}

Modified at 2026-04-20 16:32:57

List users

Get user