API Reference

People Lookup Status API

Check Person Lookup Status

Check the status of a person lookup request. Get complete, failed, waiting, searching, or in progress as a result.

Changing to Webhook Usage

Moving forward, we would like to encourage our API users to work with webhooks instead of the checkStatus endpoint. This way, you will no longer need to poll this endpoint repeatedly, and we can send you the data as it becomes available.

Checking the Status of Active Lookups

The /person/checkStatus API call is used, primarily, to poll the status of active lookups initiated by the /person/lookup endpoint. When you make a call to /person/lookup, the response can contain one of the following 5 values:

status:"complete"  //The search for contact information finished successfully
status:"failed"    //Search is complete, but there were errors.
status:"waiting"   //The request is waiting in an internal queue.
status:"searching" //The search for contact information is in progress.
status:"progress"  //In progress, and partial data may be available.

Example Usage

Assume that you made a call to lookup contact info for 'Mark Benioff' and the response was

 [
    {
        "id": 5244,
        "status": "searching",
        "name": "Mark Benioff",
        "current_employer": "Salesforce",
        "current_title": "CEO"
    }
 ]

You can now poll the status for this profile by calling:

curl --request 'POST' --location 'https://api.rocketreach.co/v2/api/search'
	--header 'Api-Key: <YOUR API KEY>'
	--header 'Content-Type: application/json'
	--data '{"query":{"name":["Marc Benioff"]}}'

Which in turn will initially return:

 [
    {
        "id": 5244,
        "status": "searching"
    }
 ]

And after a while... will return status:"complete", along with the complete data.

[
    {
        "id": 5244,
        "status": "complete",
        "profile_pic": "https://images.com/profile_images/....jpeg",
        "name": "Mark Benioff",
        "links": [
        "..."
        ]
    }
]
Language
Credentials
Header
Click Try It! to start a request and see the response here!