ReferenceREST API

REST API

Base URL, authentication, versioning and the OpenAPI document every page here is generated from.

View as Markdown
Base URLhttps://api.okyc.stream/v1
AuthenticationAuthorization: Bearer sk_test_… or sk_live_…
Content typeapplication/json
VersioningThe current version is shown on each endpoint page. The OKYC-Version header is reserved for pinning a version; today every request uses the current version.
ErrorsOne JSON shape; every code is in the error reference.
RetriesSend an Idempotency-Key on POST.

The endpoint pages are generated from openapi.json (OpenAPI 3.1), which is itself generated from the API's route definitions — so they always match the running API. Import it into Postman, Insomnia or a code generator.

Resource
SessionsCreate, list, retrieve, decide, cancel sessions; evidence; erasure.
ChecksDirect checks without a hosted flow.
Reference dataCountry capabilities and document types.
WorkflowsPublished workflows (read-only).
WebhooksWebhook endpoints and events.
SchemasShared objects.