---
title: "Poll a recovery handshake"
method: GET
path: "/v1/me/recovery/handshakes/{handshake}"
tags: ["Disaster Recovery"]
---

# Poll a recovery handshake

`GET /v1/me/recovery/handshakes/{handshake}`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/me/recovery/handshakes/{handshake}`
- Auth: HTTP bearer

`status` moves from `pending` to `completed` when an account taps, with `detected_display_name` and `detected_identity_id` filled; `expired` when the code ran out or was cancelled; `consumed` once confirmed.

## Path parameters

- `handshake` string, uuid, required

## Response `200`

200 with the handshake.

- object
  - `data` RecoveryHandshakeResource, required: An identity handshake: the code and link the creator completes from the account to detect, and, once an account has tapped, who that was in neutral terms.
    - `id` string, required: The handshake's id, the value the poll, cancel and confirm endpoints take.
    - `kind` string, required: `relink` (move the sign-in to a new account) or `backup` (register a backup account).
    - `kind_label` 'Replace my connected account' | 'Register a backup account', required: The kind in the creator's language.
    - `status` string, required: `pending` until an account taps, `completed` when one has, `expired` when the code ran out or was cancelled, `consumed` once confirmed.
    - `status_label` 'Waiting on the connector' | 'Account detected' | 'Linked' | 'Expired', required: The status in the creator's language.
    - `code` string, required: The eight-character code to type into the bot.
    - `start_link` string, nullable, required: The link that opens the bot on the code; null when the creator cannot be reached on the connector.
    - `connector` string, nullable, required: The connector the handshake runs on, by key.
    - `detected_display_name` string, nullable, required: The account that tapped, as the connector reported it; null while pending.
    - `detected_identity_id` string, nullable, required: The neutral identity id of the account that tapped, never the connector's own account identifier; null while pending.
    - `expires_at` string, required: When the code stops working, fifteen minutes after minting, ISO 8601.
    - `completed_at` string, nullable, required: When an account tapped, ISO 8601; null while pending.
    - `created_at` string, nullable, required: When the handshake was opened, ISO 8601.

## Other responses

- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description.
- `404`: `RESOURCE_NOT_FOUND`: an id in the path names nothing the token can see. `TENANT_MISMATCH`: the project sits outside the token's `scope:project:` allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/7b538e472e9a?raw)