Create a User

POST

https://{{env}}-lb.simplifipay.com/v1/user

User

The Create a User endpoint creates a new user. In the SimpliFi platform, it is mandatory
for the user to be a part of a card program instead of being a standalone entity.
Following are the properties of this endpoint.

Webhook Success

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Body

🟠400

🟠401UnauthorizedError

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://uat-lb.simplifipay.com/v1/user' \
--header 'Authorization;' \
--header 'requestUuid;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "john.smith",
    "firstName": "John",
    "middleName": "M",
    "lastName": "Smith",
    "gender": "MALE",
    "userDetail": {
        "dob": "2025-02-28 13:31:00",
        "position": "Employee",
        "roleName": "CUSTOMER",
        "cardProgramUuid": "a0f07d6c-d6e8-4bda-9dcc-f64fb3a720f6"
    },
    "contacts": [
        {
            "contactType": "PHONE",
            "contactValue": "+971123456789, john.smit@simplifipay.com"
        }
    ]
}'

Response Example

200 - Example 1

{
    "username": "john.smith",
    "firstName": "John",
    "middleName": "M",
    "lastName": "Smith",
    "gender": "MALE",
    "userDetail": {
        "dob": "2025-02-28 13:31:00",
        "position": "Employee",
        "roleName": "CUSTOMER",
        "cardProgramUuid": "a0f07d6c-d6e8-4bda-9dcc-f64fb3a720f6"
    },
    "contacts": [
        {
            "contactType": "PHONE",
            "contactValue": "+971123456789, john.smit@simplifipay.com"
        }
    ]
}

Modified at 2026-03-24 11:35:31

List all Users

Retrieve a User