Downloads
| What | Link | Use it for |
|---|---|---|
| OpenAPI 3.1 specification | /docs/openapi.yaml | Generating clients, mock servers, contract tests |
| Postman collection | /docs/postman.json | Trying every endpoint without writing code |
| kyc.js (web SDK) | https://kyc.goxost.net/sdk/kyc.js |
Embedding the flow into a web page — see Web SDK |
| Flutter SDK | kyc_flutter.zip | Android and iOS apps — see Flutter SDK |
| WordPress plugin | goxost-kyc-wordpress.zip | WordPress and WooCommerce — see WordPress plugin |
Load kyc.js from https://kyc.goxost.net/sdk/kyc.js on every page load — do not copy it to your server, so you always get fixes.
Postman
The collection covers the whole public API: Applicants, Sessions, Verifications, AML, Flows, Webhooks, Usage and Documents. It is built from the OpenAPI specification, so it always matches the API reference. The Direct API is not in the collection.
- In Postman click Import and paste the link
https://kyc.goxost.net/docs/postman.json(or drop the downloaded file). - Open the collection → Variables and set the values:
| Variable | Value |
|---|---|
baseUrl |
https://kyc.goxost.net/api/v1 (already set) |
api_key |
Your sk_test_… key from the panel |
- Send Create an applicant, then Create a verification session, and open the
urlfrom the response in a browser to go through the flow.
All requests use Bearer authentication with {{api_key}} from the collection. Keep api_key in the Current value column so it is not synced to a shared workspace. To switch to live, create a Postman environment with its own api_key = sk_live_….
Start in sandbox: verifications there are free, simulated and do not use your monthly limit. See Sandbox.
OpenAPI
openapi.yaml is the source of truth for the public REST API (info.version: v1). Every endpoint has an operationId — the same anchors as in the API reference, for example createApplicant or getVerification.
Generate a typed client with any OpenAPI 3.1 tool, for example:
curl -o openapi.yaml https://kyc.goxost.net/docs/openapi.yaml
npx @openapitools/openapi-generator-cli generate -i openapi.yaml -g typescript-fetch -o ./kyc-client
For signature checking code and the Direct API, use the Webhooks and Direct API chapters.
Versioning and changes
- The API version is part of the path:
/api/v1. Withinv1changes are additive only — new endpoints, optional request fields, response fields, event types, reject labels and error codes may be added; existing ones are not renamed or removed. - Ignore fields you do not know and handle unknown values gracefully — for example, treat an unknown reject label like
ON_HOLD. A breaking change would come as a new version (/api/v2). See Versioning. - The Postman collection is rebuilt from the specification on every download, so import it again (or download
openapi.yamlagain) to pick up new endpoints and fields.