/people/findByPhone

Changed on

Use this endpoint to get the record of an individual if there is exactly one match to the given phone number.

If no matching phone number is found, an HTTP 404 Not Found response is returned. This same response is also returned if more than one matching phone number is found. A successful response is only generated when the phone number is found on exactly one contact record.

Successful requests will return an HTTP 200 response with a JSON body containing information on the matching record.

post/people/findByPhone

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/people/findByPhone
  • Auth
    HTTP basic

Request body

phoneNumberstring

A valid phone number as an integer or string

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