List all Users

GET

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

User

The List all Users endpoint retrieves all the existing users, grouped under a company.
Following are the properties of this endpoint.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://uat-lb.simplifipay.com/v1/user' \
--header 'requestUuid;'

Response Example

[
    {
        "uuid": "f242acc1-bcbf-11eb-8529-c070bc3a2323",
        "username": "johnsmith",
        "firstName": "John",
        "middleName": "M",
        "lastName": "Smith",
        "gender": "MALE",
        "userStatus": "ACTIVE",
        "kycStatus": "NOT_SUBMITTED",
        "createdAt": "2025-02-28 13:31:00",
        "createdBy": "a49d6f6e-c98b-47db-9d6f-6ec98b77dbf9",
        "userDetail": {
            "cardProgramUuid": "a0f07d6c-d6e8-4bda-9dcc-f64fb3a720f6",
            "dob": "2025-02-28 13:31:00",
            "roleName": "CUSTOMER",
            "position": "Employee"
        },
        "address": {
            "addressType": "PRIMARY",
            "streetAddress": "string",
            "address2": "string",
            "cityCode": "string",
            "stateCode": "string",
            "countryCode": "string",
            "postalCode": "string"
        },
        "contacts": [
            {
                "contactType": "PHONE",
                "contactValue": "+971123456789, john.smit@simplifipay.com"
            }
        ]
    }
]

Request

Authorization

JWT

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Query Params

startDate

string <date>

optional

Represents the start date of the user's registration with the SimpliFi system. Note All the
dates in the SimpliFi system are stored and displayed in the following format yyyy-mm-dd hh:mm:ss

Example:

2025-02-28

endDate

string <date>

optional

Represents the end date of the user's registration with the SimpliFi system. Note All the
dates in the SimpliFi system are stored and displayed in the following format yyyy-mm-dd hh:mm:ss

Example:

2025-02-28

Header Params

requestUuid

string

required

A unique id is required to be passed as part of the header whenever a SimpliFi API is called from your
system. This would help us in debugging in case of a discrepancy in the expected behavior of the API.

Example:

00d366f2-a6e9-4714-b172-02c4e58c29d8

Responses

🟢200OK

application/json

Body

array of:

uuid

string

required

This is a system-generated unique identifier of the user.

Example:

f242acc1-bcbf-11eb-8529-c070bc3a2323

username

string

required

This is a unique identifier of the user in the system.

Example:

johnsmith

firstName

string

required

This is the first name of the user.

Example:

John

middleName

string

optional

This is the middle name of the user.

Example:

lastName

string

required

This is the last name of the user.

Example:

Smith

gender

enum<string>

required

This is the gender of the user.

Allowed values:

MALEFEMALE

Example:

MALE

userStatus

enum<string>

required

This is the current status of the user within the SimpliFi system

Allowed values:

ACTIVEINACTIVE

Example:

ACTIVE

kycStatus

enum<string>

optional

This is the current status of the KYC of this user.

Allowed values:

NOT_SUBMITTEDREADY_FOR_KYCAPPROVEDREJECTED

Example:

READY_FOR_KYC

createdAt

string <date-time>

required

This field contains the date and time when the user was created in the SimpliFi system.

Example:

2025-02-28 13:31:00

createdBy

string

optional

This field contains the UUID of the user who created this user in the SimpliFi system.

Example:

a49d6f6e-c98b-47db-9d6f-6ec98b77dbf9

userDetail

object (UserDetailModel)

required

cardProgramUuid

string

required

This field contains a unique identifier of the card program.

Example:

a0f07d6c-d6e8-4bda-9dcc-f64fb3a720f6

dob

string <date-time>

required

This field contains the Date of Birth of the user.

Example:

2025-02-28 13:31:00

roleName

enum<string>

required

This field contains a unique identifier showing the role of the user such as CUSTOMER

Allowed values:

CUSTOMERCLIENT_ADMINSUPPORT_SPECIALISTOPS_MANAGER

Example:

CUSTOMER

position

string

optional

This field contains the position (designation) of the user such as Employee

Example:

Employee

address

object (AddressModel)

required

addressType

enum<string>

required

This field contains the address type. PRIMARY address is set during user creation.

Allowed values:

PRIMARYDELIVERY

Example:

PRIMARY

streetAddress

string

optional

This field contains the street address of the user.

address2

string

optional

This field contains the second line of address of the user.

cityCode

string

optional

This field contains the city name of the user.

stateCode

string

optional

This field contains the state name of the user.

countryCode

string

required

This field contains the country code of the user.

postalCode

string

optional

This field contains the postal code of the user.

contacts

array[object (ContactModel) {2}]

required

contactType

enum<string>

required

This field contains the contact type

Allowed values:

PHONEWHATSAPPEMAIL

Example:

contactValue

string

required

This field contains the contact value of the user.

Example:

+971123456789, john.smit@simplifipay.com

🟠401Unauthorized

Modified at 2025-06-27 12:44:57

User

Create a User