New to Corsair? See API access, authentication, and error handling.
Account
credits
account.credits
Read the workspace ACU balance and API key budget state
Risk: read
data full type
data full type
meta full type
meta full type
usage
account.usage
Read workspace ACU usage plus the calling key id and active key count
Risk: read
data full type
data full type
meta full type
meta full type
Contacts
enrich
contacts.enrich
Resolve contact fields (work_email 1, personal_email 3, phone 10 ACU per hit) from a person_id, LinkedIn URL, email, or name plus company domain
Risk: write
identifier full type
identifier full type
data full type
data full type
meta full type
meta full type
Person
cancelRun
person.cancelRun
Cancel a queued or running person research run
Risk: destructive
Output
data full type
data full type
meta full type
meta full type
get
person.get
Fetch a reviewed deep person profile (25 ACU first profile) or start a durable research run (202)
Risk: write
identifier full type
identifier full type
object
Output full type
Output full type
getRun
person.getRun
Poll a person research run by id; returns run state or, once finished, the reviewed profile. 404 unknown, 410 expired
Risk: read
Output:
object
Output full type
Output full type
resolve
person.resolve
Identify one person from a name plus a clue and return the permanent person_id; 2 ACU when found, free when not
Risk: write
Output
data full type
data full type
meta full type
meta full type
Search
candidates
search.candidates
Find candidate identities in the people index for 1 ACU, including zero matches
Risk: write
Output
data full type
data full type
meta full type
meta full type
search
search.search
Search people by semantic query and hard filters; synchronous, at most 150 results
Risk: write
filters full type
filters full type
freshness full type
freshness full type
contents full type
contents full type
object
Output full type
Output full type