Skip to main content

​
First API Call

This page gets you from zero to a working API call in under 2 minutes. You need your staging API key and project hash.
Prerequisites: You need a staging API key and a project hash before proceeding. See Authentication for how to obtain these credentials.
1

Screen an entity

AML screening is the simplest call. It takes a name, runs it against PEP/sanctions/adverse media databases, and returns structured match results synchronously.
curl -X POST \
  "https://instance.staging.onboardapp.io/api/gateway/execute/{project_hash}/api" \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: your-staging-api-key" \
  -H "X-SYNC-TIMEOUT: 15000" \
  -d '{
    "name": "Jane Smith",
    "date_of_birth": "1990-06-15",
    "country": "GB",
    "entity_type": "person",
    "categories": ["pep", "sanctions", "adverse_media"]
  }'
2

Check the response

A clean screening result looks like this:
{
  "pep_status": "No Hit",
  "sanctions_status": "No Hit",
  "adverse_media_status": "No Hit",
  "screening_provider": "WorldCheck",
  "screening_completed_at": "2026-01-15T14:30:00Z",
  "matches": []
}
All status fields show "No Hit" and the matches array is empty. The entity does not appear in any screening database.If there are matches, each entry in the matches array includes a matchScore (0-100), primaryName, category, and provider-specific detail fields.
3

Try a Company Verification

Submit a company for verification. This runs registry checks and screening in a single call.
curl -X POST \
  "https://instance.staging.onboardapp.io/api/gateway/execute/{project_hash}/api" \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: your-staging-api-key" \
  -H "X-SYNC-TIMEOUT: 30000" \
  -d '{
    "company_name": "Acme Holdings Ltd",
    "registration_number": "12345678",
    "country": "GB",
    "external_reference": "test-001"
  }'
The response includes company verification data, screening results, risk assessment, and a checks summary. See the Company Verification Quickstart for the full response structure.

​
What’s next

Authentication

API key management and webhook signatures

Company Verification Quickstart

Full company verification walkthrough

Person Verification Quickstart

Individual identity verification with document capture

Screening Quickstart

Standalone PEP/sanctions screening