HomeGuidesAPI Reference
API Reference

/api/v1/users/user

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Create a new user.


Endpoint

POST https://demo-api.edfapay.com/api/v1/users/user


Request Body

FieldTypeRequiredDescription
emailStringYesUser email
businessUnitIdUUIDYesBusiness unit
rolesArrayYesRoles
permissionsArrayNoPermissions
userTypeStringYesUSER / SUPER_ADMIN
phoneNumberStringYesPhone

Request Example

curl --location 'https://demo-api.edfapay.com/api/v1/users/user' \
--header 'X-API-KEY: <Your API Key>' \
--header 'Content-Type: application/json' \
--data '{
  "email": "[email protected]",
  "businessUnitId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "roles": ["Admin"],
  "permissions": [],
  "userType": "USER",
  "phoneNumber": "+966-500000000"
}'

Response Body

FieldTypeDescription
codeIntegerResponse code
messageStringStatus
data.idUUIDCreated user ID
data.usernameStringEmail
data.phoneNumberStringPhone
data.userTypeStringType

Response Example

{
  "code": 200,
  "message": "Success",
  "data": {
    "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "username": "[email protected]",
    "phoneNumber": "+966-500000000",
    "userType": "USER"
  }
}
Response
200
Language
Credentials
Header
URL
LoadingLoading…