Nyne.ai API Login
Person APIs

Social Media Lookup API

Resolve a matching profile on a target site from a known social_media_url or email. The request is queued and returns a request_id; poll the status endpoint or supply a callback_url.

POST https://api.nyne.ai/person/social-lookup API key

Manual credentials take precedence over your account key.

Try it needs this required parameter:

Overview

Social Lookup resolves a person on a target social platform from another identifier, helping applications bridge contact records and public social profiles.

Best for

  • Finding a target-platform profile
  • Connecting contact records to social profiles
  • Resolving cross-platform identity

Returns

  • Target social profile
  • Match status
  • Resolved person context

Parameters

site string required
Target platform to resolve to (canonical site name, not a URL). Many common social media sites are supported.
social_media_url string optional
Known profile URL to resolve from. Must be a valid HTTP/HTTPS URL. Wins when both this and email are supplied.
email string optional
Email to resolve from when no URL is supplied. One of social_media_url or email is required.
callback_url string optional
If set, the completed result is POSTed here when the job finishes. Must be a valid HTTP(S) URL on an allowed host when a callback allow-list is configured.

Retrieving the result

This endpoint is asynchronous. A successful submit returns a request_id while the job runs in the background. Poll the same path with a GET request - same authentication headers - passing the request_id as a query parameter:

Loading your API credentials...

Each poll returns the job's current status; once it is completed the payload carries the result shown under Responses. Polling an unknown or expired request_id returns 404 request_not_found.

Status Meaning
queued · processing · pending The job is still running - keep polling.
completed The job finished; the payload carries the result and completed: true.
failed Terminal - the job could not complete; the error field explains why.

Poll every few seconds at first, backing off for long-running jobs. Polling is free - status checks never burn credits.

Prefer push delivery?
Supply the optional callback_url parameter and the completed payload is POSTed to your endpoint when the job finishes - no polling required. Delivery is retried up to 5 times with exponential backoff (1s, 5s, 15s, 1m, 5m) and a 30-second timeout per attempt; respond with a 2xx status to acknowledge receipt.

Credit usage

Credits are charged based on the matched configuration. The listed cost is the per-result unit price.

Feature Credits Notes
Single Social Lookup - Charged on a resolved profile
No match 0 Empty results never burn credits
Heads up
Empty results do not burn credits.

Responses

200 Status poll result - returns the current request status and result/error fields when available
202 Request queued - poll the status endpoint (or wait for the callback) with the returned request_id
400 Malformed JSON, missing required parameters, or an invalid field
401 Missing or invalid API credentials
402 insufficient_credits - not enough credits to complete the request
403 subscription_required or ip_not_allowed
404 request_not_found - no matching request is available for this API key
429 rate_limit_exceeded
503 service_unavailable - the API is temporarily unavailable
500 internal_error - unexpected failure while resolving the profile

A successful response wraps the payload in the { success, data, timestamp } envelope (also shown live in the panel on the right):

{
  "success": true,
  "data": {
    "request_id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4_1717000000_4271",
    "status": "completed",
    "target_site": "twitter",
    "result": {
      "url": "https://x.com/janedoe",
      "found": true
    }
  },
  "timestamp": "2026-01-01T00:00:00"
}