People research

Find people by name, phone, email, or username.

Submit an identifier and stream back ranked candidate matches (PersonHit objects) drawn from public sources. Each candidate carries a confidence score and descriptive tags so you can disambiguate before requesting a full dossier.

post/api/v1/search

Request

  • Base URL: https://deepsearch.app
  • URL: https://deepsearch.app/api/v1/search
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

For format=json, safely retries the same request and replays the completed JSON response. For SSE, it protects wallet spend but does not replay the stream.

X-Request-Idstring

Optional correlation id echoed in response headers and usage logs.

X-DeepSearch-Sandbox'true' | '1'

Run against deterministic sandbox fixtures, unmetered. Equivalent to sandbox: true in the body.

X-DeepSearch-Clientstring

Optional name/version naming the calling client. Self-reported and used only for aggregate analytics: it never affects authentication, rate limits, billing or the response. The official SDKs and CLI send it; any other name is counted as a custom client.

Request body

querystring required
type'name' | 'phone' | 'email' | 'username'
format'sse' | 'json'
sandboxboolean

Response

Success. With format=json a single object is returned; otherwise events stream as text/event-stream.

request_idstring required
status'partial'
warningstring
object'search_result' required

Changes

No recorded changes to this operation across all 1 revision of this API.