Create a user

POST/v1/users

API key requiredSupports Idempotency-Key

Creates an end user attached to your project and to the environment of the key. In sandbox, a simulated wallet is created and the phone number is considered verified. In live, verified is false until you verify the phone number (POST /v1/users/{id}/verification) and the wallet is created right after the user (wallet_status: ready, or pending while it is being created or retried: it never blocks this call); when live wallets are not enabled for your project, no wallet is created at this step. Optional profile fields (email, first_name, last_name, birth_date, country, referral_code, terms_acceptance, tagname) are validated against the signup flow you published (GET /v1/signup-config): once a flow is published, fields of disabled modules are rejected and required modules must be provided. Profile data is personal data: it is only returned by GET /v1/users/{id}. Emits the user.created event. Accepts Idempotency-Key.

Authentication#

Send a secret API key as Authorization: Bearer <key>. Both tp_test_… and tp_live_… keys work; the key decides which environment you read and write. See Authentication.

Parameters#

Headers

Header parameters
Name	Type	Description
`Idempotency-Key`	string	Idempotency key (1 to 255 characters, UUID v4 recommended). Responses are replayed for 24 h.

See Idempotency.

Request body#

phonestringrequired
Phone number in E.164 format, for example +33612345678.
pattern: ^\+[1-9]\d{6,14}$
Example "+33612345678"
external_idstring
Your own identifier for this user (unique per project and environment).
min length: 1 · max length: 128
Example "cust_8f2a"
emailstring
Email address. Module email of your signup flow.
max length: 254
Example "[email protected]"
first_namestring
First name. Module first_name.
min length: 1 · max length: 100
Example "Ada"
last_namestring
Last name. Module last_name.
min length: 1 · max length: 100
Example "Lovelace"
birth_datestring
Date of birth, YYYY-MM-DD. Module birth_date; the min_age option of your signup flow is enforced.
pattern: ^\d{4}-\d{2}-\d{2}$
Example "1990-12-10"
countrystring
Country, ISO 3166-1 alpha-2. Module country; the allowed_countries option of your signup flow is enforced.
pattern: ^[A-Za-z]{2}$
Example "FR"
referral_codestring
Referral code entered at signup. Stored as given; module referral_code.
pattern: ^[A-Za-z0-9_-]{3,32}$
Example "ADA2026"
terms_acceptanceobject
Acceptance of your terms. Module terms_acceptance.
- versionstringrequired
  Version of the terms accepted.
  min length: 1 · max length: 64
  Example "2026-10"
- accepted_atstringrequired
  When the user accepted them (ISO 8601, not in the future).
  format: date-time
  Example "2026-10-08T09:29:00.000Z"
tagnamestring
Username chosen by the user (unique per project and environment, case-insensitive). Module tagname.
pattern: ^[A-Za-z0-9_.-]{3,30}$
Example "ada_l"

Example request body

{
  "phone": "+33612345678",
  "external_id": "cust_8f2a",
  "email": "[email protected]",
  "first_name": "Ada",
  "last_name": "Lovelace",
  "country": "FR"
}

Responses#

201User created.

Headers

X-Request-Id Request identifier.
X-RateLimit-Limit Quota of the current window.
X-RateLimit-Remaining Requests remaining in the window.
X-RateLimit-Reset Seconds before the quota renews.

Body

idstringrequired
Opaque identifier.
Example "4821"
objectstringrequired
always "user"
Example "user"
phonestringrequired
Phone number in E.164 format.
Example "+33612345678"
external_idstring | nullrequired
Your own identifier for this user.
Example "cust_8f2a"
verifiedbooleanrequired
The phone number has been verified.
Example true
kyc_statusstringrequired
Identity verification (KYC) status.
One ofnonependingapprovedrejected
Example "approved"
suspendedbooleanrequired
The user is suspended and can no longer transact.
Example false
livemodebooleanrequired
true for a live key, false for a sandbox key.
Example false
wallet_statusstringrequired
State of the user’s wallet. ready: the wallet exists. pending: its creation is in progress or being retried (never blocks the user; poll GET /v1/users/{id}/wallets). failed: creation was abandoned after repeated errors (contact support). none: no wallet is created at this step.
One ofnonependingreadyfailed
Example "ready"
created_atstringrequired
Creation date.
format: date-time
Example "2026-10-08T09:30:00.000Z"
last_login_atstring | nullrequired
Last sign-in.
format: date-time
Example "2026-10-08T09:30:00.000Z"

Example 201 response

{
  "id": "4821",
  "object": "user",
  "phone": "+33612345678",
  "external_id": "cust_8f2a",
  "verified": true,
  "kyc_status": "approved",
  "suspended": false,
  "livemode": false,
  "created_at": "2026-10-08T09:30:00.000Z",
  "wallet_status": "ready",
  "last_login_at": null
}

400Invalid request (malformed JSON, unknown cursor, invalid Idempotency-Key header).

Example: invalid_cursor

Example 400 response

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_cursor",
    "message": "starting_after: unknown cursor",
    "request_id": "0b2c8f6e-41f9-4c0a-8d55-6f6a3c1d9e21"
  }
}

401Missing, invalid or revoked API key.

Example: missing_api_key

Example 401 response

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "Provide your API key as \"Authorization: Bearer <key>\"",
    "request_id": "0b2c8f6e-41f9-4c0a-8d55-6f6a3c1d9e21"
  }
}

Example: invalid_api_key

Example 401 response

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_api_key",
    "message": "The API key is invalid",
    "request_id": "0b2c8f6e-41f9-4c0a-8d55-6f6a3c1d9e21"
  }
}

Example: api_key_revoked

Example 401 response

{
  "error": {
    "type": "authentication_error",
    "code": "api_key_revoked",
    "message": "This API key has been revoked",
    "request_id": "0b2c8f6e-41f9-4c0a-8d55-6f6a3c1d9e21"
  }
}

403Organization suspended, live access not enabled, or sandbox-only route.

Example: organization_suspended

Example 403 response

{
  "error": {
    "type": "permission_error",
    "code": "organization_suspended",
    "message": "Your organization is suspended. Contact Tilt Pay support.",
    "request_id": "0b2c8f6e-41f9-4c0a-8d55-6f6a3c1d9e21"
  }
}

Example: live_not_enabled

Example 403 response

{
  "error": {
    "type": "permission_error",
    "code": "live_not_enabled",
    "message": "Live access has not been enabled for your organization yet",
    "request_id": "0b2c8f6e-41f9-4c0a-8d55-6f6a3c1d9e21"
  }
}

Example: sandbox_only

Example 403 response

{
  "error": {
    "type": "permission_error",
    "code": "sandbox_only",
    "message": "This route is only available with a sandbox API key",
    "request_id": "0b2c8f6e-41f9-4c0a-8d55-6f6a3c1d9e21"
  }
}

409Conflict with the state of the resource, or the original idempotent request is still in progress.

Example: user_already_exists

Example 409 response

{
  "error": {
    "type": "invalid_request_error",
    "code": "user_already_exists",
    "message": "A user with this phone number already exists",
    "request_id": "0b2c8f6e-41f9-4c0a-8d55-6f6a3c1d9e21"
  }
}

422Invalid parameter, or Idempotency-Key reused with a different body.

Example: validation_error

Example 422 response

{
  "error": {
    "type": "invalid_request_error",
    "code": "validation_error",
    "message": "phone: has an invalid format",
    "request_id": "0b2c8f6e-41f9-4c0a-8d55-6f6a3c1d9e21"
  }
}

Example: idempotency_key_reuse

Example 422 response

{
  "error": {
    "type": "idempotency_error",
    "code": "idempotency_key_reuse",
    "message": "This Idempotency-Key was already used with a different request",
    "request_id": "0b2c8f6e-41f9-4c0a-8d55-6f6a3c1d9e21"
  }
}

429Rate limit exceeded. Retry after the Retry-After delay (seconds).

Example: rate_limit_exceeded

Example 429 response

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Slow down and retry after the delay in Retry-After.",
    "request_id": "0b2c8f6e-41f9-4c0a-8d55-6f6a3c1d9e21"
  }
}

500Internal error. Retry; give request_id to support if it persists.

Example: internal_error

Example 500 response

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Internal server error",
    "request_id": "0b2c8f6e-41f9-4c0a-8d55-6f6a3c1d9e21"
  }
}

Headers on every response

X-Request-Id Identifier of the request, also present in error bodies. Give it to support.
X-API-Version Version of the API that answered.
X-RateLimit-Limit / -Remaining / -Reset Quota of your key for the current window. See Rate limits.

Errors#

Errors share one format, described in Errors. Branch your code on error.code.

Errors this route can return
Status	Code	Meaning
400	`invalid_cursor`	Invalid request (malformed JSON, unknown cursor, invalid `Idempotency-Key` header).
401	`missing_api_key`	Missing, invalid or revoked API key.
401	`invalid_api_key`	Missing, invalid or revoked API key.
401	`api_key_revoked`	Missing, invalid or revoked API key.
403	`organization_suspended`	Organization suspended, live access not enabled, or sandbox-only route.
403	`live_not_enabled`	Organization suspended, live access not enabled, or sandbox-only route.
403	`sandbox_only`	Organization suspended, live access not enabled, or sandbox-only route.
409	`user_already_exists`	This phone number or `external_id` already exists in the project.
409	`tagname_already_taken`	This `tagname` is already used by another user of the project.
422	`validation_error`	Invalid field, field not enabled in the published signup flow, or required module missing (`param` names the field).
422	`idempotency_key_reuse`	Invalid parameter, or `Idempotency-Key` reused with a different body.
429	`rate_limit_exceeded`	Rate limit exceeded. Retry after the `Retry-After` delay (seconds).
500	`internal_error`	Internal error. Retry; give `request_id` to support if it persists.

Code examples#

curl -X POST "https://sdk.tilt-pay.com/v1/users" \
  -H "Authorization: Bearer $TILT_PAY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 7b1c0d36-5f0e-4d2a-9a43-0b8c6e2f1a90" \
  -d '{
    "phone": "+33612345678",
    "external_id": "cust_8f2a",
    "email": "[email protected]",
    "first_name": "Ada",
    "last_name": "Lovelace",
    "country": "FR"
  }'

Try it#

Sends a real request to the API with a sandbox key. No real data is touched.

Sandbox key

The playground sends real requests to the API with a sandbox key. Live keys are refused.

Request body (JSON)

Idempotency-Key (header)

Send the same key twice to see an idempotent replay (header Idempotent-Replayed: true).

Request

Exactly what is sent (key masked)

POST https://api-hub.tilt-pay.com/v1/users
Accept: application/json
Authorization: Bearer <your sandbox key>
Content-Type: application/json
Idempotency-Key: 7b1c0d36-5f0e-4d2a-9a43-0b8c6e2f1a90

{
  "phone": "+33612345678",
  "external_id": "cust_8f2a",
  "email": "[email protected]",
  "first_name": "Ada",
  "last_name": "Lovelace",
  "country": "FR"
}

Add a sandbox key to send.