SimpliFi
HomeContact Us
HomeContact Us
  1. User
  • Introduction
  • SimpliFi Architecture
  • Webhooks
  • Auth
    • Login to generate JWT token
      POST
  • Card Program
    • Create Card Program
      POST
    • Get Card Program
      GET
    • Change Card Program Status
      PATCH
    • Link Funding Source to Card Program
      POST
    • Get Balance of Funding Source
      GET
    • Transfer funds from one Card Program to other
      POST
    • Raise Funding Document Upload
      POST
    • Raise Funding
      POST
    • Funding Source Statement
      GET
  • Funding Source
    • Create Rule Group on Funding Account
      POST
    • Update Rule Group on Funding Account
      PUT
    • Delete Rule Group on Funding Account
      DELETE
    • Get Rule Groups on Funding Account
      GET
    • Appply Rule Group on Funding Account
      POST
    • Remove Rule Group on Funding Account
      DELETE
  • Card
    • List all Cards
      GET
    • Create a Card
      POST
    • Get Card Details
      GET
    • Retrieve Balance on the Card
      GET
    • Activate a Card
      POST
    • Manage Card Status
      POST
    • Load a Card
      POST
    • Unload a Card
      POST
    • Renewal of the Card
      POST
    • Request a Physical Card
      POST
    • Get Card Statement
      GET
    • Apply rule group on card
      POST
    • Remove rule group on card
      DELETE
  • User
    • List all Users
      GET
    • Create a User
      POST
    • Upload Document
      POST
    • Retrieve a User
      GET
    • Update a User
      PUT
    • Delete a User
      DELETE
  • Transaction
    • List All Transactions
  • Fee
    • Add fee configuration
    • Fetch fee config
    • Change the status of fee config
    • Add Fee event against card uuid in queue
    • Apply fee against card uuid present in queue
  • Webhook
    • Get all events
    • Create a webhook
    • Update a Webhook
    • Delete a Webhook
    • Updates the status of Webhook
  1. User

Update a User

PUT
https://{{env}}-lb.simplifipay.com/v1/user/{uuid}
The Update a User endpoint updates the details of an existing user.
Following are the properties of this endpoint.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request PUT 'https://uat-lb.simplifipay.com/v1/user/' \
--header 'requestUuid;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "john.smith",
    "firstName": "John",
    "middleName": "M",
    "lastName": "Smith",
    "gender": "MALE",
    "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"
        }
    ]
}'
Response Response Example
200 - Example 1
{
    "username": "john.smith",
    "firstName": "John",
    "middleName": "M",
    "lastName": "Smith",
    "gender": "MALE",
    "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，whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
or
Path Params
uuid
string 
required
This field contains a unique identifier of the user.
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
Body Params application/json
username
string 
required
This is a unique identifier of the user in the system. We recommend providing a unique name here.
Example:
john.smith
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:
M
lastName
string 
required
This is the last name of the user.
Example:
Smith
gender
enum<string> 
optional
This is the gender of the user.
Allowed values:
MALEFEMALE
Example:
MALE
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
This array of objects is a collection of contact fields,
possessing sub-fields explained in the rows below.
contactType
enum<string> 
required
This field contains the contact type
Allowed values:
PHONEWHATSAPPEMAIL
Example:
EMAIL
contactValue
string 
required
This field contains the contact value of the user.
Example:
+971123456789, john.smit@simplifipay.com
Examples

Responses

🟢200OK
application/json
OK
Body
username
string 
required
This is a unique identifier of the user in the system. We recommend providing a unique name here.
Example:
john.smith
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:
M
lastName
string 
required
This is the last name of the user.
Example:
Smith
gender
enum<string> 
optional
This is the gender of the user.
Allowed values:
MALEFEMALE
Example:
MALE
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
This array of objects is a collection of contact fields,
possessing sub-fields explained in the rows below.
contactType
enum<string> 
required
This field contains the contact type
Allowed values:
PHONEWHATSAPPEMAIL
Example:
EMAIL
contactValue
string 
required
This field contains the contact value of the user.
Example:
+971123456789, john.smit@simplifipay.com
🟠400Bad Request
🟠401Unauthorized
Modified at 2025-06-27 12:44:57
Previous
Retrieve a User
Next
Delete a User
Built with