Users

Get a consent link for an existing Layout account

Returns a link to the Layout consent screen for someone who already has a Layout account. Nothing is attached until they approve.

post/users/{userId}/connect

Request

  • Base URL: https://api.layout.link/v1
  • URL: https://api.layout.link/v1/users/{userId}/connect
  • 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.

Request body

returnUrlstring uri

https only. Where to send the person after they decide.

connectDelivery'developer'

Return the link instead of Layout texting it to the person.

Response

A consent link, or already connected.

next'connect' | 'awaiting_user_approval'
connectUrlstring uri

Present when next is connect. Open it in the person's browser.

expiresInSecinteger
connectedtrue

Already connected to this person; no link is issued.

idstring
statusstring

Example response

{
  "id": "usr_4b8e9a01c2d3"
}

Changes

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