Skip to main content
New to Corsair? See API access, authentication, and error handling.

Bulk

cancel

bulk.cancel Cancel undispatched bulk items Risk: write
Input Output

get

bulk.get Read bulk search progress Risk: read
Input Output

results

bulk.results Read bulk search results Risk: read
Input Output

submit

bulk.submit Submit a bulk search Risk: write
Input
Output

Enrich

batch

enrich.batch Enrich up to 20 profiles Risk: write
Input Output

get

enrich.get Poll an enrichment Risk: read
Input Output

read

enrich.read Read an enriched profile Risk: read
Input Output

start

enrich.start Enrich one profile Risk: write
Input Output

Faces

detect

faces.detect Detect faces in a photo Risk: write
Input Output

index

faces.index Search the face index Risk: write
Input Output

get

search.get Poll a people search Risk: read
Input Output

quotePopulation

search.quotePopulation Price a population search Risk: read
Input
Output

start

search.start Start a people search Risk: write
Input
Output

startPopulation

search.startPopulation Search everyone at a company or school Risk: write
Input
Output

Watchers

create

watchers.create Watch a profile Risk: write
Input Output

delete

watchers.delete Delete a watcher Risk: destructive
Input Output

get

watchers.get Get a watcher Risk: read
Input Output

list

watchers.list List watchers Risk: read
Input: empty object Output

runs

watchers.runs List watcher runs Risk: read
Input Output

update

watchers.update Update a watcher Risk: write
Input Output

Webhooks

create

webhooks.create Register a webhook endpoint Risk: write
Input Output

delete

webhooks.delete Delete a webhook endpoint Risk: destructive
Input Output

list

webhooks.list List webhook endpoints Risk: read
Input: empty object Output

test

webhooks.test Send a test webhook delivery Risk: write
Input Output