Seamless integration with our GDPR compliant background check API

# 1. Authenticate: OAuth2 client credentials
curl -X POST https://api.pescheck.io/api/o/token/ \
  -d grant_type=client_credentials \
  -d client_id=YOUR_CLIENT_ID \
  -d client_secret=YOUR_CLIENT_SECRET
# -> {"access_token": "YOUR_ACCESS_TOKEN", "token_type": "Bearer", "expires_in": 3600, ...}

# 2. Find the profile (set of checks) to screen with
curl https://api.pescheck.io/api/v2/profiles/ \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

# 3. Create a screening request
curl -X POST https://api.pescheck.io/api/v2/screenings/ \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "profile_id": "YOUR_PROFILE_ID",
    "candidate": {
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "[email protected]"
    }
  }'
# -> {"id": "SCREENING_ID", "status": "...", "candidate_wizard_url": "...", "dashboard_url": "...", ...}

# 4. Fetch the status and result
curl https://api.pescheck.io/api/v2/screenings/SCREENING_ID/ \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

# 5. Register a webhook for status changes
curl -X POST https://api.pescheck.io/api/v2/webhooks/ \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Screening updates",
    "url": "https://example.com/pescheck-webhook",
    "events": ["screening.status_changed"]
  }'

# 6. Confirm you own the webhook URL
curl -X POST https://api.pescheck.io/api/v2/webhooks/WEBHOOK_ID/verify/ \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"verification_code": "CODE_SENT_TO_YOUR_WEBHOOK_URL"}'

// Node.js 18+ (built-in fetch)
const BASE = "https://api.pescheck.io";

// 1. Authenticate: OAuth2 client credentials
const tokenRes = await fetch(`${BASE}/api/o/token/`, {
  method: "POST",
  body: new URLSearchParams({
    grant_type: "client_credentials",
    client_id: "YOUR_CLIENT_ID",
    client_secret: "YOUR_CLIENT_SECRET",
  }),
});
const { access_token } = await tokenRes.json();

const headers = {
  Authorization: `Bearer ${access_token}`,
  "Content-Type": "application/json",
};

// 2. Find the profile (set of checks) to screen with
const profiles = await (await fetch(`${BASE}/api/v2/profiles/`, { headers })).json();
const profileId = profiles.results[0].id;

// 3. Create a screening request
const createRes = await fetch(`${BASE}/api/v2/screenings/`, {
  method: "POST",
  headers,
  body: JSON.stringify({
    profile_id: profileId,
    candidate: {
      first_name: "Jane",
      last_name: "Doe",
      email: "[email protected]",
    },
  }),
});
const screening = await createRes.json();

// 4. Fetch the status and result
const statusRes = await fetch(`${BASE}/api/v2/screenings/${screening.id}/`, { headers });
const { status, checks } = await statusRes.json();
console.log(status, checks);

// 5. Register a webhook for status changes
const hookRes = await fetch(`${BASE}/api/v2/webhooks/`, {
  method: "POST",
  headers,
  body: JSON.stringify({
    name: "Screening updates",
    url: "https://example.com/pescheck-webhook",
    events: ["screening.status_changed"],
  }),
});
const webhook = await hookRes.json();

// 6. Confirm you own the webhook URL
await fetch(`${BASE}/api/v2/webhooks/${webhook.id}/verify/`, {
  method: "POST",
  headers,
  body: JSON.stringify({ verification_code: "CODE_SENT_TO_YOUR_WEBHOOK_URL" }),
});

# pip install requests
import requests

BASE = "https://api.pescheck.io"

# 1. Authenticate: OAuth2 client credentials
token = requests.post(
    f"{BASE}/api/o/token/",
    data={
        "grant_type": "client_credentials",
        "client_id": "YOUR_CLIENT_ID",
        "client_secret": "YOUR_CLIENT_SECRET",
    },
).json()["access_token"]

headers = {"Authorization": f"Bearer {token}"}

# 2. Find the profile (set of checks) to screen with
profiles = requests.get(f"{BASE}/api/v2/profiles/", headers=headers).json()
profile_id = profiles["results"][0]["id"]

# 3. Create a screening request
screening = requests.post(
    f"{BASE}/api/v2/screenings/",
    headers=headers,
    json={
        "profile_id": profile_id,
        "candidate": {
            "first_name": "Jane",
            "last_name": "Doe",
            "email": "[email protected]",
        },
    },
).json()

# 4. Fetch the status and result
result = requests.get(f"{BASE}/api/v2/screenings/{screening['id']}/", headers=headers).json()
print(result["status"], result["checks"])

# 5. Register a webhook for status changes
webhook = requests.post(
    f"{BASE}/api/v2/webhooks/",
    headers=headers,
    json={
        "name": "Screening updates",
        "url": "https://example.com/pescheck-webhook",
        "events": ["screening.status_changed"],
    },
).json()

# 6. Confirm you own the webhook URL
requests.post(
    f"{BASE}/api/v2/webhooks/{webhook['id']}/verify/",
    headers=headers,
    json={"verification_code": "CODE_SENT_TO_YOUR_WEBHOOK_URL"},
)