Skip to main content
Create or update user
curl --request POST \
  --url https://backend.identifai.net/api/partner/user \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-Api-Key: <api-key>' \
  --form id=123 \
  --form 'name=<string>' \
  --form email=jsmith@example.com \
  --form 'heuristic=<string>' \
  --form pricing_id=123 \
  --form 'password=<string>' \
  --form readonly=true \
  --form newsletter=true \
  --form save_files=true
import requests

url = "https://backend.identifai.net/api/partner/user"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\njsmith@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"heuristic\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pricing_id\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"password\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"readonly\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"newsletter\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"save_files\"\r\n\r\ntrue\r\n-----011000010111000001101001--"
headers = {
    "X-Api-Key": "<api-key>",
    "Content-Type": "multipart/form-data"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)
const form = new FormData();
form.append('id', '123');
form.append('name', '<string>');
form.append('email', 'jsmith@example.com');
form.append('heuristic', '<string>');
form.append('pricing_id', '123');
form.append('password', '<string>');
form.append('readonly', 'true');
form.append('newsletter', 'true');
form.append('save_files', 'true');

const options = {method: 'POST', headers: {'X-Api-Key': '<api-key>'}};

options.body = form;

fetch('https://backend.identifai.net/api/partner/user', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://backend.identifai.net/api/partner/user",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\njsmith@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"heuristic\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pricing_id\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"password\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"readonly\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"newsletter\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"save_files\"\r\n\r\ntrue\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://backend.identifai.net/api/partner/user"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\njsmith@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"heuristic\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pricing_id\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"password\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"readonly\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"newsletter\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"save_files\"\r\n\r\ntrue\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://backend.identifai.net/api/partner/user")
  .header("X-Api-Key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\njsmith@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"heuristic\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pricing_id\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"password\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"readonly\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"newsletter\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"save_files\"\r\n\r\ntrue\r\n-----011000010111000001101001--")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://backend.identifai.net/api/partner/user")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"id\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"name\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"email\"\r\n\r\njsmith@example.com\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"heuristic\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pricing_id\"\r\n\r\n123\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"password\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"readonly\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"newsletter\"\r\n\r\ntrue\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"save_files\"\r\n\r\ntrue\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body
{
  "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
    }
  }
}
{
  "message": "Too Many Attempts."
}

Authorizations

​
X-Api-Key
string
header
required

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

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.