Check a phone verification code

POST/v1/users/{id}/verification/check

API key requiredSupports Idempotency-Key

Checks the code received by the user. On success the user is marked verified. A code is invalidated after 5 incorrect attempts or 10 minutes: request a new one. In sandbox the code is always 123456. 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#

Path

Path parameters
Name	Type	Description
`id`required	string	Identifier of the user.Pattern ^\d{1,9}$

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#

codestringrequired
The code typed by the user.
pattern: ^\d{4,10}$
Example "123456"

Example request body

{
  "code": "123456"
}

Responses#

200Phone number verified.

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

objectstringrequired
always "verification"
Example "verification"
user_idstringrequired
User concerned.
Example "4821"
statusstringrequired
pending: a code was sent. approved: the phone number is verified.
One ofpendingapproved
Example "pending"
expires_atstring | nullrequired
When the code expires.
format: date-time
Example "2026-10-08T09:30:00.000Z"
resend_available_atstring | nullrequired
Earliest time a new code can be requested.
format: date-time
Example "2026-10-08T09:30:00.000Z"
livemodebooleanrequired
true for a live key, false for a sandbox key.
Example false

Example 200 response

{
  "object": "verification",
  "user_id": "4821",
  "status": "pending",
  "expires_at": "2026-10-08T09:40:00.000Z",
  "resend_available_at": "2026-10-08T09:31:00.000Z",
  "livemode": true
}

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"
  }
}

404Resource not found (or belonging to another project or environment).

Example: user_not_found

Example 404 response

{
  "error": {
    "type": "invalid_request_error",
    "code": "user_not_found",
    "message": "User not found",
    "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.
403	`live_feature_unavailable`	Phone verification is not enabled for live keys.
404	`user_not_found`	Unknown user (or belonging to another project or environment).
409	`user_already_exists`	Conflict with the state of the resource, or the original idempotent request is still in progress.
409	`no_pending_verification`	No code is pending: call `POST /v1/users/{id}/verification` first.
409	`user_suspended`	The user is suspended.
422	`validation_error`	Invalid parameter, or `Idempotency-Key` reused with a different body.
422	`idempotency_key_reuse`	Invalid parameter, or `Idempotency-Key` reused with a different body.
422	`invalid_verification_code`	Incorrect code (the message tells how many attempts remain).
422	`verification_expired`	The code has expired: request a new one.
422	`verification_attempts_exceeded`	Too many incorrect attempts: request a new code.
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/4821/verification/check" \
  -H "Authorization: Bearer $TILT_PAY_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 7b1c0d36-5f0e-4d2a-9a43-0b8c6e2f1a90" \
  -d '{
    "code": "123456"
  }'

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.

id (path, required)

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/4821/verification/check
Accept: application/json
Authorization: Bearer <your sandbox key>
Content-Type: application/json
Idempotency-Key: 7b1c0d36-5f0e-4d2a-9a43-0b8c6e2f1a90

{
  "code": "123456"
}

Add a sandbox key to send.