Skip to main content

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'

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 candidate
POST/api/v1/consent/initiateCapture consent
POST/api/v1/checksSubmit a background check
GET/api/v1/reports?check_id=...Get the report
POST/api/v1/adverse-actionsInitiate adverse action
POST/api/v1/webhooks/endpointsRegister a webhook

Ready to integrate?

Start with the sandbox — no API key needed for read-only endpoints.