NGngpvan

/people/{personIdType}:{personId}

Changed on

Retrieve a person record and associated contact information. For example /people/DWID:12345 would retrieve a person whose DWID is 12345.

get/people/{personIdType}:{personId}

Request

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

Path parameters

personIdTypestring required

Required; a known person identifier type available in the current context

personIdstring required

Required; an external identifier, URL encoded

Query parameters

$expandstring

Optional; comma-delimited list of expansion properties: phones, emails, addresses, customFields

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