WorkPair API Documentation

v1 — Verified Professional Data API

Overview

The WorkPair API provides programmatic access to verified professional identity data. All data access is consent-gated — members must explicitly grant your organization permission before you can retrieve their data.

The API uses Bearer token authentication via API keys. Register for a key at Settings > API.

Authentication

Bearer token via Authorization header

Rate Limit

100 calls/day per API key

Pricing

Verify: free. Profile/Credentials: $10. Background check: $5–$15

Background Check Tiers

Tier	Cost	Data Included
BASIC	$5	Name, employment history
STANDARD	$10	+ Education, all credentials
PREMIUM	$15	+ Verified institutions, endorsements, references

Error Codes

Code	Meaning
401	Invalid or missing API key
402	Insufficient wallet balance
403	Member has not granted consent
404	WID not found
429	Daily rate limit exceeded
500	Internal server error

Endpoints

POST/api/v1/verify/{wid}

Verify WID

Check if a WorkPair ID exists and is verified. Free — no wallet charge.

Free

Request

curl -X POST https://workpair.io/api/v1/verify/WP-XXXXXXXX \
  -H "Authorization: Bearer wp_your_api_key" \
  -H "Content-Type: application/json"

Response

{
  "success": true,
  "data": {
    "wid": "WP-XXXXXXXX",
    "exists": true,
    "isVerified": true
  }
}

GET/api/v1/profile/{wid}

Get Profile

Retrieve a member's public profile data including verified institutions. Requires member consent.

$10/callConsent required

Request

curl https://workpair.io/api/v1/profile/WP-XXXXXXXX \
  -H "Authorization: Bearer wp_your_api_key"

Response

{
  "success": true,
  "data": {
    "wid": "WP-XXXXXXXX",
    "name": "Jane Smith",
    "headline": "Software Engineer",
    "location": "San Francisco, CA",
    "website": "https://janesmith.dev",
    "bio": "...",
    "memberSince": "2025-06-15T00:00:00.000Z",
    "verifiedInstitutions": [
      {
        "name": "Stanford University",
        "type": "UNIVERSITY",
        "country": "United States",
        "verifiedAt": "2025-07-01T00:00:00.000Z"
      }
    ]
  }
}

GET/api/v1/credentials/{wid}

Get Credentials

Retrieve a member's verified credentials (education, employment, certifications). Requires member consent.

$10/callConsent required

Request

curl https://workpair.io/api/v1/credentials/WP-XXXXXXXX \
  -H "Authorization: Bearer wp_your_api_key"

Response

{
  "success": true,
  "data": {
    "wid": "WP-XXXXXXXX",
    "name": "Jane Smith",
    "credentials": [
      {
        "type": "DEGREE",
        "title": "B.S. Computer Science",
        "issuer": "Stanford University",
        "issuedDate": "2024-06-15T00:00:00.000Z",
        "verified": true
      },
      {
        "type": "EMPLOYMENT",
        "title": "Senior Software Engineer",
        "issuer": "Acme Corp",
        "issuedDate": "2024-08-01T00:00:00.000Z",
        "verified": true
      }
    ]
  }
}

POST/api/v1/background-check/{wid}

Background Check

B2B background check with tiered data access. Requires member consent. Designed for HireRight, Checkr, Sterling integrations.

$5–$15/callConsent required

Request

curl -X POST https://workpair.io/api/v1/background-check/WP-XXXXXXXX \
  -H "Authorization: Bearer wp_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"tier": "STANDARD"}'

Response

{
  "success": true,
  "data": {
    "wid": "WP-XXXXXXXX",
    "name": "Jane Smith",
    "tier": "STANDARD",
    "employment": [...],
    "education": [...],
    "credentials": [...]
  }
}