People

Enrich a person

Changed on

Find a person from identity clues and return their profile with a match score. Available on all plans; free or disposable email addresses return 422.

post/people/enrich

Request

  • Base URL: https://api.context.dev/v1
  • URL: https://api.context.dev/v1/people/enrich
  • Auth: HTTP bearer

Request body

social_urlsstring[]

Public profile URLs for the person. A person-profile URL can identify the person without a name.

emailstring email

Email address of the person to find.

zdr'enabled' | 'disabled'

enabled turns on zero data retention. Returns 403 ZDR_NOT_ENABLED unless your organization has ZDR.

tagsstring[]

Labels for filtering usage in the dashboard.

Example request

{
  "tags": [
    "production",
    "team-alpha"
  ]
}

Response

The highest-scoring candidate, including weak matches, or a not-found result when no usable candidate exists.

partialboolean

True when the timeout ended processing and this response contains the usable data completed so far. Unfinished fields are omitted.

request_idstring uuid required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example response

{
  "request_id": "3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"
}

Changes

  • 61627728926bRevision changes
    • warning

      added the new NO_PUBLISHED_MARKDOWN enum value to the response property for the response status

    • warning

      added the new NO_PUBLISHED_MARKDOWN enum value to the response property for the response status

    • warning

      added the new NO_PUBLISHED_MARKDOWN enum value to the response property for the response status

    • warning

      added the new NO_PUBLISHED_MARKDOWN enum value to the response property for the response status

    • warning

      added the new NO_PUBLISHED_MARKDOWN enum value to the response property for the response status

    • warning

      added the new NO_PUBLISHED_MARKDOWN enum value to the response property for the response status

  • 4ddcf49b9fe5Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status