NGngpvan

/people/{vanId}

Changed on

Retrieve a person record and associated contact information.

Note the following with regards to expand parameter values:

  • The addresses value will provide best known Home and Mailing address, if available.
  • The recordedAddresses value will provide all available address history, but requires special permissions.
  • The preferences value is required to retrieve the following properties: nickname, website, contactMethodPreferenceCode, and jobTitle.

If no Person with the indicated vanId is available, this endpoint will return an error with HTTP Status Code 404 Not Found.

get/people/{vanId}

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/people/{vanId}
  • Auth
    HTTP basic

Path parameters

vanIdstring required

Unique person identifier available in the current context

Query parameters

$expandstring

Optional; comma-delimited list of expansion properties: phones, emails, addresses, customFields, externalIds, recordedAddresses, preferences, suppressions, reportedDemographics, disclosureFieldValues

Response

200

vanIdinteger
firstNamestring
lastNamestring
middleNamestring
partystring
employerstring
occupationstring
sexstring
dateOfBirthstring

Example response

{
  "vanId": 100476252,
  "firstName": "James",
  "lastName": "Gordon",
  "middleName": "Worthington",
  "party": "D",
  "employer": "Acme Medical Group",
  "occupation": "Physician",
  "sex": "M",
  "dateOfBirth": "1976-07-04T00:00:00Z"
}

Changes