Ga naar de hoofdinhoud
Inloggen Contact
API

Naadloze integratie met onze achtergrondcontrole API

Nauwkeurig, Verantwoordelijk, Veilig - Effectieve software voor achtergrondchecks voor veiligheid en naleving.

STROOMLIJN ONBOARDING PROCESSEN

Voordelen van het integreren van de API van Pescheck

De background check API van Pescheck stelt bedrijven in staat hun platformen snel operationeel te krijgen, terwijl het ook de efficiëntie verbetert, compliance en veiligheid beheert, en een sterke merkervaring ondersteunt.

  • Implementeer sneller - Zodra je eigen Pescheck-gehoste workflow actief is, heb je alleen nog de naam en het e-mailadres van een kandidaat nodig om het proces op te starten
  • Een naadloze ervaring - Een diepere integratie maakt het screeningproces een natuurlijke uitbreiding van je eigen product of flow
  • Bespaar tijd en resources - De API van Pescheck helpt je bij het ontwerpen van soepele en efficiënte onboarding-ervaringen voor kandidaten, gig-medewerkers, klanten en andere gebruikers
feature

API-documentatie en codevoorbeelden

Authenticeer met OAuth2, maak een screeningsaanvraag aan, haal de status en het resultaat op en ontvang updates via een webhook. De endpoints hieronder komen uit ons openbare OpenAPI-schema; vervang de YOUR_-placeholders door je eigen waarden.

Swagger-documentatie ReDoc-documentatie Officiële SDK's op GitHub

curl

# 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

// 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" }),
});

Python

# 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"},
)

Webhookmeldingen worden naar je URL gestuurd zodra de gekozen gebeurtenissen plaatsvinden. Haal de screening op met het GET-verzoek hierboven om de actuele status en resultaten te lezen. Zie de Swagger-documentatie voor alle gebeurtenissen en velden.

Some of our API connections

Our team of (API) experts is constantly working on developing new integrations. Below you'll find a selection of the possibilities. If the system you are using is not listed (yet), no worries. Feel free to contact us, and we can explore the options together for creating a new integration.

Why use Pescheck's background check API?

1

Dedicated Support

Easily build with our RESTful API with JSON responses.

2

High-security standards

99.99% uptime and real-time, 24/7 access to data.

3

Easy-to-use software

Detailed and organized results with clear and concise labeling.

4

Use your platform

Use Pescheck's hosted background check application or embed the process into your own flow.

5

Pay as you go

Receive detailed status updates via webhooks or response calls.

6

Fast turnaround times

Simple and clear developer documentation, with support from our team.

Available screenings with Pescheck's API

Pescheck makes it easy to order [API] screenings and view results through the webhooks.

  • International PEP and Sanctions List Check
  • Credit Check
  • Criminal Record / Letter of Conduct
  • CV Check - Work-/reference
  • Qualification check
  • Adverse Media check
  • ID Check
  • Integrity Statement
  • VOG (Certificate of Good Conduct) Profile (NL)
POST /api/v2/screenings/
{
"profile_id": "prf_8f2a",
"candidate": {
}
}
201screening.completed
2.5X

Sneller Remote Werk Proces

10+

Jaar Ervaring

7+

Uren Bespaard Per Maand

"Voor Beldoo was het integreren van de API van Pescheck via Zapier een opmerkelijk efficiënt proces. Het kostte ons minder dan twee uur om alles op te zetten en volledig te integreren, wat onze workflow aanzienlijk heeft gestroomlijnd. Deze naadloze verbinding heeft onze operationele efficiëntie verbeterd en bewijst een waardevolle aanwinst te zijn voor ons aanbod van diensten. Zeer aanbevolen voor elk bedrijf dat op zoek is naar betrouwbare en snelle integratieoplossingen."
Beldoo

Simon

beldoo.nl

Governance & Veiligheid:

FAQ

Vragen & Antwoorden

Kun je niet vinden wat je zoekt? Wij helpen je graag.Neem contact op met het API-team →