API reference · KayWhySee Docs

The KayWhySee API is a small REST API. It takes and returns JSON, uses standard HTTP methods and status codes, and authenticates with a bearer key.

link Base URL

Base URL

https://www.kaywhysee.com/api/v1

Every request must use HTTPS.

link Authentication

Send your secret key on every request:

Header

Authorization: Bearer kyc_live_...

Each endpoint needs a scope on the key, shown on its page. See Authentication for scopes, and for secret and publishable keys.

link Requests

Send bodies as JSON with Content-Type: application/json. Unknown fields are ignored.

link Responses

Successful requests return the resource itself as JSON: a session object for every session endpoint. Times are UTC, in ISO 8601, ending in Z.

Errors return a single error object with a stable code. See Errors.

link Versioning

The version is in the path: /api/v1. Within a version we only make changes that don't break existing code: we add endpoints, optional request fields and response fields, never remove or rename them. Build your code to ignore fields it doesn't know.

link Endpoints

add_circle Create a session POST /sessions search Retrieve a session GET /sessions/{session_id} cancel Cancel a session POST /sessions/{session_id}/cancel data_object The session object Field reference.