POST
/
api
/
partner
/
user
Create or update user
curl --request POST \
  --url https://backend.identifai.net/api/partner/user \
  --header 'Content-Type: multipart/form-data' \
  --form id=123 \
  --form 'name=<string>' \
  --form email=jsmith@example.com \
  --form 'password=<string>' \
  --form 'heuristic=<string>' \
  --form pricing_id=123 \
  --form readonly=true \
  --form newsletter=true \
  --form save_files=true
{
  "data": {
    "id": 233,
    "name": "UserName",
    "email": "UserName@mail.com",
    "email_verified_at": "2025-03-12T11:30:25.000000Z",
    "address": null,
    "zip": null,
    "city": null,
    "country": null,
    "phone": null,
    "contact": null,
    "vat": null,
    "created_at": "2025-03-12T11:30:25.000000Z",
    "updated_at": "2025-03-12T11:30:25.000000Z",
    "balance": null,
    "heuristic": "AverageExcludeObsolete",
    "readonly": null,
    "pricing": {
      "id": 1,
      "name": "TestB",
      "sku": "testB"
    },
    "partner": {
      "id": 221,
      "name": "PartnerName",
      "email": "PartnerName@mail.com",
      "email_verified_at": "2025-03-03T11:22:49.000000Z",
      "address": null,
      "zip": null,
      "city": null,
      "country": null,
      "phone": null,
      "contact": null,
      "vat": null,
      "created_at": "2025-03-03T11:22:49.000000Z",
      "updated_at": "2025-03-03T13:27:06.000000Z",
      "balance": 0,
      "heuristic": "Average",
      "readonly": false,
      "pricing": {
        "id": 2,
        "name": "TestAC",
        "sku": "testAC"
      },
      "partner": null
    }
  }
}

Body

multipart/form-data
id
integer | null
required

The ID of the user (required only for updates, null for creation).

name
string
required

The full name of the user.

email
string<email>
required

The email address of the user.

heuristic
string
required

The euristic assigned to the user.

pricing_id
integer
required

The pricing tier ID for the user.

password
string<password>

The password for the user.

readonly
boolean

Indicates whether the user has read-only permissions.

newsletter
boolean

True if the user has opted in for the newsletter.

save_files
boolean

True if the user can store submitted files.

Response

200 - application/json

Created or updated user

id
integer

Unique identifier of the user.

name
string

Full name of the user.

email
string<email>

Email address of the user.

email_verified_at
string<date-time>

Timestamp when the email was verified.

address
string | null

User's address.

zip
string | null

Postal code of the user.

city
string | null

City of the user.

country
string | null

Country of the user.

phone
string | null

Phone number of the user.

contact
string | null

Alternative contact information.

vat
string | null

VAT number of the user, if applicable.

created_at
string<date-time>

Creation timestamp of the user.

updated_at
string<date-time>

Last update timestamp of the user.

balance
number

The user credits balance.

heuristic
string

User's heuristic setting.

readonly
boolean

User can only view classification results.

pricing
object

User pricing plan.

partner
object

User partner.