# RIBM API quickstart

Base URL: https://ribm.uk

RIBM is a pre-production sandbox designed for UK DVS certification readiness. It is not certified. NFC evidence is not configured.

## Create a verification

Send a server-side request to `POST /api/v2/verify/initialize` with `X-API-Key`, `Idempotency-Key`, and a JSON body containing a UUID `user_id`. A successful response includes a short-lived `verification_url`.

Never place an API key in a URL, browser bundle, local storage or client log.

## Hosted flow

Redirect the test subject to the returned `verification_url`. The URL uses a one-hour, verification-scoped session token. The hosted journey collects document evidence and, for supported profiles, live capture.

## Status

Retrieve the verification status using the verification identifier and the documented server-side authentication method. Treat `manual_review`, technical errors and failed checks as distinct states.

## Webhooks

Configure webhooks in the authenticated customer workspace. Verify signatures over the raw request body, reject stale timestamps and deduplicate delivery identifiers.

## Errors

Use HTTP status, stable error information and the correlation reference. Retry only transient rate-limit and server responses with bounded backoff and the same idempotency key.

Full interactive quickstart: https://ribm.uk/docs