CLI Tool

Manage background checks from your terminal.

Installation

pip install gonos-cli

Setup

export GONOS_API_KEY=your-api-key
export GONOS_BASE_URL=https://api.gonos.co

Usage

# Create a candidate
gonos candidates create \
  --first-name Jane --last-name Doe --email jane@example.com

# Create and submit a check
gonos checks create --candidate-id <id> --package standard --purpose employment
gonos checks submit <check-id>

# Check status
gonos checks get <check-id>

# View report
gonos reports get <check-id>

# Adverse action flow
gonos adverse create --check-id <id> --report-id <id> --reason "Criminal record found"
gonos adverse finalize <action-id> --decision deny

# JSON output (for scripting and AI agents)
gonos --json checks list

Commands

JSON output

Use the --json flag to get machine-readable output. This is useful for scripting and piping to other tools.

# Get check as JSON
gonos --json checks get <check-id>

# Pipe to jq
gonos --json checks list | jq '.items[].status'