Skip to content

Mint a capture-widget session token for a KYC check

POST/v1/kyc/checks/{id}/capture-session

Requires an API client bearer token.

Returns a 15-minute bearer token valid for repeated captures until expiry or the check leaves `collecting`. Use `capture_url` as the iframe `src` — it embeds the token in the URL fragment, which must not be logged. Hand the session only to the hosted capture widget — never your own OAuth client credentials — so the widget can post captured document images to the vision service on your behalf. Only mintable while the check is collecting.

Parameters

Path parameters

NameRequiredDescription
idrequired

Example

curl -X POST https://api.rigid.fi/v1/kyc/checks/{id}/capture-session \
  -H "Authorization: Bearer $RIGID_API_TOKEN"

Responses

200

A capture session token and ready-made iframe URL.

tokenstringrequired
expires_atstring (date-time)required
session_idstringrequired
capture_urlstring (uri)required
400

Validation error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
401

Authentication required

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
403

Forbidden

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
404

KYC check not found

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring