The User object

A user is an end-user (or agent identity) associated with a company. Users hold identity fields (name, email, walletAddress, externalId, clerkUserId) and traits. They are normally created automatically through identify() and the Events API — the explicit REST surface below is provided for management and reconciliation.

User object

{
  "id": "us_abc123",
  "name": "Jane Doe",
  "email": "[email protected]",
  "walletAddress": "0xabc...",
  "clerkUserId": "user_2xyz",
  "externalId": "user_123",
  "companyId": "cm_abc123",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "lastSeenAt": "2026-09-17T10:00:00.000Z"
}

List users

GET /api/v1/users Auth: legacy api_… key or dashboard session.

Query	Type	Description
`limit`	number	Results per page, max 200, default 50
`cursor`	string	Pagination cursor (previous `nextCursor`)
`companyId`	string	Filter users for a company
`search`	string	Case-insensitive search across name, email, wallet, and company name

curl -X GET "https://api.arcenpay.com/api/v1/users?limit=50&search=acme" \
  -H "Authorization: Bearer api_xxxxxxxx"

{
  "data": [ { "id": "us_abc123", "name": "Jane Doe", "email": "[email protected]", "walletAddress": "0xabc...", "companyId": "cm_abc123", "createdAt": "…", "lastSeenAt": "…" } ],
  "count": 1,
  "nextCursor": null
}

Create a user

POST /api/v1/users Auth: legacy api_… key or dashboard session.

string

required

The company to attach the user to (cm_…). Must already exist in your team and environment.

string

Your system’s external user ID (max 64 chars). Stored as externalId.

string

User wallet address.

string

Optional Clerk user ID.

string

Display name (max 128 chars).

string

Email address (validated).

object

Arbitrary key-value metadata.

{
  "companyId": "cm_abc123",
  "id": "user_456",
  "wallet": "0xabc...",
  "email": "[email protected]",
  "name": "Jane Doe"
}

Returns 201 with the created user. A duplicate match returns 409 with the existing userId.

Prefer identify() over direct user creation. POST /api/v1/access-tokens (the Node SDK’s identify()) upserts both company and user in one call and returns the embed token your frontend needs. The direct users endpoint is for bulk imports and reconciliation.

Create an access token — identify() creates users implicitly
The Event object — identify events upsert users
The Company object — the parent entity

Last modified on September 19, 2026

Get started

Credentials

Companies

Users

Events

Access control

Features

Subscriptions

Checkout sessions

Payment links

Autonomous agents

Escrow

Mandates

Coupons

zkTLS proofs

Public specs

User object

List users

Create a user

​User object

​List users

​Create a user

​Related

User object

List users

Create a user

Related