Skip to main content
POST
Submit research request

Authorizations

Authorization
string
header
required

API key with rapi_live_ prefix

Body

application/json
contact_data
object
required

Contact identifiers. At least one of: email, linkedin_url, or full_name + company.

prospect_id
string

Your internal ID for this prospect (echoed back in responses and webhooks)

callback_url
string<uri>

URL to receive a webhook POST when research completes

callback_secret
string

Bearer token sent in the Authorization header of webhook callbacks

is_test
boolean
default:false

If true, returns a dummy completed response immediately without using credits. Useful for testing your integration.

Response

Research request accepted

task_id
string<uuid>

Unique task ID for polling

prospect_id
string | null

Your prospect_id if provided

status
enum<string>

Initial status is always 'pending'

Available options:
pending