ReferenceREST API

Checks

Run a single check server-to-server, without a hosted session, and fetch its result.

View as Markdown

Guide: direct checks.

Base URL https://api.okyc.stream/v1 · API version 2026-10-01 · authenticate with Authorization: Bearer sk_test_….

POST /v1/checks/{key}

Run a check without a hosted session.

Country key (in.pan.verify) or generic key with country (tax_id.verify + IN). ?async=true returns 202 and sends check.completed.

Parameters

NameInTypeRequiredNotes
keypathstringyese.g. in.pan.verify
asyncquerytrue | false—

Request body (DirectCheckInput, required)

FieldTypeRequiredNotes
countrystringlength 2

Responses

StatusDescriptionBody
200Completedobject (map)
202Acceptedobject (map)
400ErrorError

GET /v1/checks/{id}

Retrieve a check.

Parameters

NameInTypeRequiredNotes
idpathstringyese.g. ses_in_01j…

Responses

StatusDescriptionBody
200OKobject (map)
404ErrorError

On this page