Create Lookup

Generate a comprehensive report about a person. Reports typically complete within 3-5 minutes.

POST https://api.whitebridge.ai/lookups

Request Parameters

Parameter	Type	Required	Description
candidateId	string	Yes*	The unique identifier for the candidate (from search results).
candidate	object	Yes*	Candidate details object (see structure below).
sections	string[]	Yes	Sections to include in the report (see available sections below).
webhookUrl	string	No	URL to notify when lookup completes.
preview	boolean	No	If true, only performs a basic pre-check with minimal information. Set to false to create a full lookup that deducts credit.
metadata	object	No	Additional metadata as key-value pairs.

*Either candidateId OR candidate is required, not both.

Candidate Object

Field	Type	Required	Description
fullName	string	Yes	The full name of the candidate.
avatarUrl	string	No	URL to the candidate's profile picture.
email	string	No	The candidate's email address.
sources	string[]	No	URLs containing information about the person (social media profiles, personal websites, etc.).

Available Sections

Section	Description
overview	Overview
selling	Behavior & Interaction Insights
career	Career
leisure	Leisure & Hobbies
events	Events & Media
adverseMedia	Negative Media
gallery	Photos
socialMedia	Social Media
onlinePresence	Online Presence
dataBreaches	Data Breaches

Examples

Using Candidate ID

{
  "candidateId": "li-joe-doe-example",
  "sections": ["overview", "selling", "career"],
  "webhookUrl": "https://example.com/webhook",
  "preview": false
}

Using Candidate Details

{
  "candidate": {
    "fullName": "Joe Doe",
    "email": "joe.doe@example.com",
    "sources": ["https://linkedin.com/in/joedoe"]
  },
  "sections": ["overview", "selling", "career"],
  "preview": false
}

Response

{
  "lookupId": "48abcc2b-f0c6-4a6b-b203-be14ab3a80da"
}

Accessing Reports

Once created, access your report in three formats:

• HTML: https://search.whitebridge.ai/{lookupId} - For viewing in browser
• JSON: https://api.whitebridge.ai/lookups/{lookupId} - For API integration
• PDF: See Download PDF documentation