Skip to main content
Requires authentication

​
Endpoint

POST /users

​
Request Body

FieldTypeRequiredDescription
fullnamestringYesUser’s full name
phoneNumberstringYesPrimary phone number
secondPhoneNumberstringNoSecondary phone number
profilePhotostringNoURL to profile photo
nationalitystringNoUser’s nationality
maritalStatusstringNoSINGLE, MARRIED, DIVORCED, WIDOWED, SEPARATED, OTHER
genderstringNoMALE or FEMALE
occupationstringNoUser’s occupation
employerstringNoUser’s employer
relationshipstringNoFATHER, MOTHER, SON, DAUGHTER, BROTHER, SISTER, OTHER
residentTypestringNoSINGLE, FAMILY, SHARED (default: SINGLE)
ownerIdUUIDNoOwner ID for family members
ageintegerNoUser’s age
birthdatestringNoUser’s birth date (ISO string)
documentsUUID[]NoArray of document IDs
isActivebooleanNoDefault: true

​
Example

{
  "fullname": "John Doe",
  "phoneNumber": "07518202480",
  "maritalStatus": "SINGLE",
  "nationality": "Syrian",
  "gender": "MALE",
  "age": 23,
  "occupation": "Engineer",
  "employer": "Tech Corp",
  "residentType": "SINGLE",
  "documents": ["doc-uuid-1", "doc-uuid-2"]
}

​
Response

{
  "success": true,
  "data": {
    "id": "uuid",
    "fullname": "John Doe",
    ...
  }
}