Users

Text the person a verification code

Sends a six-digit code to the number you provisioned, good for three minutes from this send and for five tries. The person reads it back to you. A new send replaces the last one. A person already connected to this application gets a fresh code too, so a returning person on a new device can be recognised; the code only proves they hold the phone and never signs them in to Layout.

post/users/{userId}/verify/start

Request

  • Base URL: https://api.layout.link/v1
  • URL: https://api.layout.link/v1/users/{userId}/verify/start
  • Auth: HTTP bearer

Path parameters

userIdstring required

Headers

Layout-Version'2026-10-01'

The API version you code against. Optional; without it you get 2026-10-01, the current version. Layout answers with the version it used.

Idempotency-Keystring

Optional. Any 1 to 255 visible ASCII characters, unique per real intent. A retry with the same key and the same body gets the stored response for 24 hours, with Idempotent-Replayed: true, and is never run twice. The same key with a different body is 409 idempotency_conflict; while the first request is still running it is 409 in_progress with Retry-After. Only a success is stored: any error releases the key so it can be sent again. A 4xx ran nothing. A 5xx may have run, above all a confirm's 500, so read the resource before sending anything changed.

Response

Code sent.

oktrue required
idstring required
phoneHintstring

The masked number the code went to.

expiresInSecinteger
sandboxtrue

Sandbox texts nobody. The code is always 000000.

Example response

{
  "id": "usr_4b8e9a01c2d3"
}

Changes

No recorded changes to this operation across all 1 revision of this API.