< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/voterEmailAddressSignIn (Jump to "Try It Now")

Required Parameters

Parameter name Value Description
api_key string (from post, cookie, or get (in that order)) The unique key provided to any organization using the WeVoteServer APIs
voter_device_id string An 88 character unique identifier linked to a voter record on the server
email_secret_key string We can pass in the secret key as an identifier.

Response

{
  "status": string,
  "success": boolean,
  "voter_device_id": string (88 characters long),
  "email_ownership_is_verified": boolean,
  "email_secret_key_belongs_to_this_voter": boolean,
  "email_address_found": boolean,
}

Response Status Codes

Code Description
VALID_VOTER_DEVICE_ID_MISSING Cannot proceed. A valid voter_device_id parameter was not included.
MISSING_VOTER_ID_OR_ADDRESS_TYPE Cannot proceed. Missing variables voter_id or address_type while trying to save.

Try It Now: API Variables

Sign in based on an email_secret_key that get's emailed to voter.

Parameter name Value  
voter_device_id:
email_secret_key:

(opens in new window)