Skip to content

Read the known values for a hosted workflow capture session

POST/v1/vision/level-known

Authenticates with client credentials — no bearer token required.

Returns the KYC level a workflow-mode capture session is on and the values its conditions read — the answers the case already holds — from identity-kyc's internal level-known read. The hosted capture widget calls it once a level page has loaded, so a field shown only when an earlier answer matches is shown correctly; the values never travel in the capture page itself, which is served on a session id rather than the token. `level` is null and `known` empty when the session is not collecting a workflow level. No OAuth bearer token: `capture_session_token` in the body is the entire authorization, verified downstream. The 200 carries `Cache-Control: no-store`. Served by the vision host — the hosted capture widget's own surface, not the primary API host (see this operation's `servers` entry), same as detailsSubmit. Rate-limited per-source-IP (fixed 60s window); a 429 carries a `Retry-After` header.

Request body

capture_session_tokenstringrequired

Example

curl -X POST https://vision.dev.rigid.fi/v1/vision/level-known \
  -H "Authorization: Bearer $RIGID_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "capture_session_token": "string"
}'

Responses

200

The level the session is on and the values its conditions read.

levelstring | nullrequired
knownobjectrequired
+ show properties

No properties.

400

Validation error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
404

Capture session not found or expired

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
429

Too many level reads from this address — retry shortly

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring