Create a new user

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    metadata: {
      external_id: 'user_789_in_my_system',
      customer_tier: 'standard',
      signup_source: 'web'
    },
    display_name: 'John Doe',
    vault: {
      'identity.first_name': 'John',
      'identity.last_name': 'Doe',
      'identity.email': 'john.doe@example.com',
      'identity.date_of_birth': '1990-01-15'
    }
  })
};

fetch('https://api.getpalm.com/v1/user', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.getpalm.com/v1/user"

payload = {
    "metadata": {
        "external_id": "user_789_in_my_system",
        "customer_tier": "standard",
        "signup_source": "web"
    },
    "display_name": "John Doe",
    "vault": {
        "identity.first_name": "John",
        "identity.last_name": "Doe",
        "identity.email": "john.doe@example.com",
        "identity.date_of_birth": "1990-01-15"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

curl --request POST \
  --url https://api.getpalm.com/v1/user \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "external_id": "user_789_in_my_system",
    "customer_tier": "standard",
    "signup_source": "web"
  },
  "display_name": "John Doe",
  "vault": {
    "identity.first_name": "John",
    "identity.last_name": "Doe",
    "identity.email": "john.doe@example.com",
    "identity.date_of_birth": "1990-01-15"
  }
}
'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "object": "user",
  "mode": "live",
  "created_at": "2025-10-24T10:30:00Z",
  "updated_at": "2025-10-24T15:45:00Z",
  "metadata": {
    "external_id": "user_123_in_my_system",
    "customer_tier": "premium",
    "signup_source": "mobile_app"
  },
  "status": "active",
  "verification": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "risk_level": "low",
    "workflow": {
      "name": "KYC Verification",
      "version": 1
    },
    "executed_at": "2024-01-15T10:30:00.000Z"
  },
  "display_name": "John Doe",
  "email_fingerprint": "f7c3bc1d808e04732adf679965ccc34ca7ae3441",
  "phone_fingerprint": "a8d4bc2e919f15843beg890076ddd45db8bf4552",
  "vault": {
    "identity.first_name": "John",
    "identity.last_name": "Doe"
  }
}

POST

user

Create a new user

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    metadata: {
      external_id: 'user_789_in_my_system',
      customer_tier: 'standard',
      signup_source: 'web'
    },
    display_name: 'John Doe',
    vault: {
      'identity.first_name': 'John',
      'identity.last_name': 'Doe',
      'identity.email': 'john.doe@example.com',
      'identity.date_of_birth': '1990-01-15'
    }
  })
};

fetch('https://api.getpalm.com/v1/user', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.getpalm.com/v1/user"

payload = {
    "metadata": {
        "external_id": "user_789_in_my_system",
        "customer_tier": "standard",
        "signup_source": "web"
    },
    "display_name": "John Doe",
    "vault": {
        "identity.first_name": "John",
        "identity.last_name": "Doe",
        "identity.email": "john.doe@example.com",
        "identity.date_of_birth": "1990-01-15"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

curl --request POST \
  --url https://api.getpalm.com/v1/user \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "external_id": "user_789_in_my_system",
    "customer_tier": "standard",
    "signup_source": "web"
  },
  "display_name": "John Doe",
  "vault": {
    "identity.first_name": "John",
    "identity.last_name": "Doe",
    "identity.email": "john.doe@example.com",
    "identity.date_of_birth": "1990-01-15"
  }
}
'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "object": "user",
  "mode": "live",
  "created_at": "2025-10-24T10:30:00Z",
  "updated_at": "2025-10-24T15:45:00Z",
  "metadata": {
    "external_id": "user_123_in_my_system",
    "customer_tier": "premium",
    "signup_source": "mobile_app"
  },
  "status": "active",
  "verification": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "risk_level": "low",
    "workflow": {
      "name": "KYC Verification",
      "version": 1
    },
    "executed_at": "2024-01-15T10:30:00.000Z"
  },
  "display_name": "John Doe",
  "email_fingerprint": "f7c3bc1d808e04732adf679965ccc34ca7ae3441",
  "phone_fingerprint": "a8d4bc2e919f15843beg890076ddd45db8bf4552",
  "vault": {
    "identity.first_name": "John",
    "identity.last_name": "Doe"
  }
}

Authorizations

Authorization

string

header

required

Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx

Body

application/json

metadata

object

Store up to 50 custom key-value pairs for application-specific data. Useful for storing references to external systems, feature flags, or other custom attributes.

Show child attributes

Example:

{
  "external_id": "user_789_in_my_system",
  "customer_tier": "standard",
  "signup_source": "web"
}

display_name

string

Display name for the user

Example:

"John Doe"

vault

object

User data to store in the vault. Use vault field IDs as keys (e.g., "identity.email", "identity.first_name"). See UserVaultFields for the complete list of available fields.

Show child attributes

Example:

{
  "identity.first_name": "John",
  "identity.last_name": "Doe",
  "identity.email": "john.doe@example.com",
  "identity.date_of_birth": "1990-01-15"
}

Response

User created successfully

string<uuid>

required

Unique identifier for the resource

Example:

"123e4567-e89b-12d3-a456-426614174000"

object

enum<string>

required

Object type identifier, always "user"

Available options:

user

Example:

"user"

mode

enum<string>

required

Whether this resource was created with test or live credentials. Test and live data are fully isolated — a test resource never appears in live results and vice versa.

Available options:

test,

live

Example:

"live"

created_at

string<date-time>

required

ISO 8601 timestamp of when the resource was created

Example:

"2025-10-24T10:30:00Z"

updated_at

string<date-time>

required

ISO 8601 timestamp of when the resource was last updated

Example:

"2025-10-24T15:45:00Z"

metadata

object

required

Store up to 50 custom key-value pairs for application-specific data. Useful for storing references to external systems, feature flags, or other custom attributes.

Show child attributes

Example:

{
  "external_id": "user_123_in_my_system",
  "customer_tier": "premium",
  "signup_source": "mobile_app"
}

status

enum<string>

required

Current status of the user

Available options:

active,

suspended,

deleted

Example:

"active"

verification

object | null

required

Most recent verification information. Null if user has never been verified.

Show child attributes

display_name

string | null

required

Display name for the user

Example:

"John Doe"

email_fingerprint

string | null

required

SHA-256 fingerprint of the user's email address. Used for duplicate detection and search without exposing the actual email. Automatically generated when email is stored in vault.

Example:

"f7c3bc1d808e04732adf679965ccc34ca7ae3441"

phone_fingerprint

string | null

required

SHA-256 fingerprint of the user's phone number. Used for duplicate detection and search without exposing the actual phone. Automatically generated when phone is stored in vault.

Example:

"a8d4bc2e919f15843beg890076ddd45db8bf4552"

vault

object | null

required

Cached vault field values for non-encrypted fields. Keys are full field IDs (e.g., "identity.first_name"). Only includes fields where encrypted=false in vault_field_definition.

Example:

{
  "identity.first_name": "John",
  "identity.last_name": "Doe"
}

Delete a document

Verify existing user

⌘I