---
title: "Identity verification as the register shows it (secret key or token, Starter and above)"
method: GET
path: "/elements/v1/id-verification/{number}"
tags: ["Website components"]
---

# Identity verification as the register shows it (secret key or token, Starter and above)

`GET /elements/v1/id-verification/{number}`

## Request

- Base URL: `https://api.companystack.co.uk`
- URL: `https://api.companystack.co.uk/elements/v1/id-verification/{number}`
- Auth: HTTP bearer

Each current director and individual PSC with what the register shows about their identity verification: names, roles and dates only, and each person's own date (`deadline`, with `deadline_basis` saying whether Companies House shows it or it was worked out from the rules and the company's confirmation statement). There is no single national deadline: each date depends on the role, the appointment and the company. Names people, so it needs a secret key from your server (proxy mode) or a token your server minted with the `identity` scope; a publishable key gets 403. Counts one request per company per key per UTC day.

## Path parameters

- `number` string, required

## Query parameters

- `token` string

## Response `200`

The people and the summary

- object

## Other responses

- `400`: Missing or malformed session, or an invalid company number
- `401`: No key, or an invalid or revoked key
- `403`: A publishable key or token from a website it does not list (`origin_not_allowed`: no Access-Control-Allow-Origin, so the page cannot read the answer and nothing is counted), a secret key sent from a browser (`secret_key_in_browser`), an endpoint a publishable key cannot reach (`secret_key_required`), or a scope or company a token does not cover (`scope_not_allowed`, `company_not_allowed`)
- `404`: Not found, or not available yet
- `429`: A per-visitor or per-key limit (`rate_limited`), the end of a session (`session_exhausted`: start a new one), the key's daily cap (`key_daily_cap`) or the account's quota (`quota_exceeded`). Retry-After says when to try again.

---

[API](https://skmtc.dev/companystack/apis/companystack-api.md) · [All operations](https://skmtc.dev/companystack/apis/companystack-api/llms.txt) · [OpenAPI document](https://skmtc.dev/companystack/apis/companystack-api/revisions/8f3234237d2d?raw)
