---
title: "Make an ID check link for a person (ID and Right to Rent together for a tenant in England)."
method: POST
path: "/v1/transactions/{id}/digital-id"
---

# Make an ID check link for a person (ID and Right to Rent together for a tenant in England).

`POST /v1/transactions/{id}/digital-id`

## Request

- Base URL: `https://api.stratumapis.com`
- URL: `https://api.stratumapis.com/v1/transactions/{id}/digital-id`
- Auth: API key in header `X-Stratum-Key`

The person must be a named individual set to be checked by link (`idMethods`: `{ "idv": "link" }` with `idv` ticked, or for a tenant `{ "rightToRent": "link" }` or `{ "rightToRent": "self", "tenantId": "link" }`). Charged from credit when the link is made: £1.99 an ID check, £3.49 ID and Right to Rent; given back if it ends with nothing checked. Send `startUrl` to the person yourself: we do not email them. It names your firm (set it with `PUT /v1/transactions/firm`), then hands over to the identity service. A second call for the same person while a link is waiting returns that link (`already: true`) and charges nothing. A test key uses the identity service's sandbox: nothing charged, the link stays waiting.

## Path parameters

- `id` string, required

## Response `201`

The link is made.

## Other responses

- `400`: Not a named individual, no email, or not set to be checked by link.
- `402`: Not enough credit: nothing was made or charged.
- `404`: No such transaction (or check) on your account.
- `409`: No firm name yet; or the identity service cannot check this person by link (`blocked`), or their email already has a check waiting (`already_open`). Nothing charged.

---

[API](https://skmtc.dev/stratumapis/apis/stratum-transactions-api.md) · [All operations](https://skmtc.dev/stratumapis/apis/stratum-transactions-api/llms.txt) · [OpenAPI document](https://skmtc.dev/stratumapis/apis/stratum-transactions-api/revisions/4f59bdd5c909?raw)