---
title: "Add User"
method: POST
path: "/v1/users"
---

# Add User

`POST /v1/users`

## Headers

- `Accept` string, required
- `Content-Type` string, required

## Request body

- object
  - `email` string, required — The email address of the user.
  - `name` string, required — The names of the user ex: "John Smith"
  - `password` string, required — A password must be between 8 to 300 characters and must contain one uppercase, one lowercase and one numeric character.
  - `username` string, required — The username of the user ex: "john.smith2"
  - `roles_ids` string[], required — The roles ids that should be assigned to the User, taken from the Get Roles API

## Response `200`

200

- object
  - `data` object
    - `object` string
    - `id` string
    - `real_id` integer
    - `name` string
    - `email` string
    - `confirmed` unknown
    - `notification_phone_number` unknown
    - `created_at` integer
    - `updated_at` integer
    - `readable_created_at` string
    - `readable_updated_at` string
    - `response_content` boolean
    - `username` string
    - `role` object
      - `id` integer
      - `team_id` unknown
      - `name` string
      - `guard_name` string
      - `display_name` string
      - `description` string
      - `created_at` string
      - `updated_at` string
      - `level` integer
      - `role_type` unknown
      - `account_id` integer
      - `merchant_id` unknown
      - `allow_sensitive_data` integer
      - `name_export` string
      - `display_name_export` string
      - `created_at_export` string
      - `role_id_export` string
      - `description_export` string
      - `pivot` object
        - `model_id` integer
        - `role_id` integer
        - `model_type` string
  - `meta` object
    - `include` string[]
    - `custom` unknown[]
      - unknown

## Other responses

- `422` — 422

---

[API](https://skmtc.net/payarc/apis/payarc-sandbox.md) · [All operations](https://skmtc.net/payarc/apis/payarc-sandbox/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payarc/payarc-sandbox/versions/face82bdd778/schema)