POST/v3/live/contact-info

Request contact information

Submit a batch of contact info requests. Each item identifies its subject by exactly one of aggkPersonId or aggkHcpId. An aggkPersonId item is enriched asynchronously: any contact data already on file is returned immediately in the response items, and you poll GET /contact-info/{id} for the remaining fields as they are enriched. Phone numbers are withheld for people resident in Colorado: enrichPhone is ignored for those items, which complete with no phone and no error, and no phone enrichment is billed. An aggkHcpId item is answered from the emails already held for that healthcare professional and is complete in this response; it is never sent for enrichment, so an HCP with no email on file returns no emails rather than being enriched. Only enrichWorkEmail applies to an aggkHcpId item: enrichPersonalEmail and enrichPhone are rejected, because the source holds neither a phone number nor a work/personal split.

Version
v3Open on v2
Rate limit
Tier 3 · 10–200 rps by plan
Billing
Personal Email or Phone or Work Email or Healthcare contact · Request contact information

Request body

  • namestringOptional
    Optional label for the batch, up to 255 characters. Stored with the batch; omit it and the batch is unnamed. The batch status response does not return it.
  • requestsobject[]Optional
    • aggkHcpIdstringOptional
      AggKnowledge HCP ID. Mutually exclusive with aggkPersonId; emails come from the healthcare professional's record and are never enriched. Only enrichWorkEmail applies
    • aggkPersonIdstringOptional
      AggKnowledge Person ID
    • enrichPersonalEmailbooleanOptional
      Whether to return the personal email. Omitted means false. Rejected with a 400 on an aggkHcpId item
    • enrichPhonebooleanOptional
      Whether to return the phone number. Omitted means false. Rejected with a 400 on an aggkHcpId item
    • enrichWorkEmailbooleanOptional
      Whether to return the work email. Omitted means false
    • metadataobjectOptional
      Optional metadata to associate with the request. Will be returned in the response.
Headers
x-api-key Required · API key for authentication

Response

  • batchIdstring
    Batch UUID for tracking the request
  • itemCountinteger (int32)
    Number of items in the request
  • itemsobject[]
    Contact data available immediately. An aggkHcpId item is always included, with status completed or failed. An aggkPersonId item is included only when at least one requested field is already on file, and only those fields are populated; the batch enriches the rest asynchronously. Always empty in the test environment.
  • messagestring
    Status message

Status codes