Developer Documentation
Everything you need to integrate Gonos into your platform.
terminal
$ pip install gonos-sdk
$ export GONOS_API_KEY=your-api-key
$ python
>>> from gonos_sdk import GonosClient
>>> client = GonosClient(api_key="your-api-key")
>>> candidate = client.candidates.create(
... first_name="Jane", last_name="Doe",
... email="jane@example.com"
... )
>>> check = client.checks.create(
... candidate_id=candidate.id,
... package="standard",
... permissible_purpose="employment"
... )
>>> print(check.status)
'pending'Guides & Resources
Quickstart
Run your first background check in 5 minutes.
Python SDK
Typed client library with Pydantic models and error handling.
CLI Tool
Manage checks, candidates, and reports from your terminal.
MCP Server
21 tools for AI agents via Model Context Protocol. Works with Claude, GPT, and more.
Interactive API Docs
Try API requests in your browser with Swagger UI.
Authentication
API keys, JWT tokens, SSO, magic links, and rate limits.
OpenAPI Spec
Download the full API specification for code generation.
ReDoc
Clean, readable API reference documentation.
API Reference
Full API specification available in multiple formats. Use the OpenAPI spec with code generators to auto-create clients in any language.
API at a Glance
POST
/api/v1/candidatesCreate a candidatePOST
/api/v1/consent/initiateCapture consentPOST
/api/v1/checksSubmit a background checkGET
/api/v1/reports?check_id=...Get the reportPOST
/api/v1/adverse-actionsInitiate adverse actionPOST
/api/v1/webhooks/endpointsRegister a webhook