< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/voterCreate (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

Optional Parameters

Parameter name Value Description
voter_device_id string An 88 character unique identifier linked to a voter record on the server. If you do not pass in a voter_device_id, generate one, link it to the newly created voter, and return it.

Response

{
  "success": boolean,
  "status": status string,
  "voter_device_id": string (88 characters long),
  "voter_id": integer,
  "voter_we_vote_id": string,
}

Response Status Codes

Code Description
VALID_VOTER_DEVICE_ID_MISSING A valid voter_device_id parameter was not included. Cannot proceed.
VOTER_ALREADY_EXISTS A voter account is already linked with that voter_device_id
VOTER_CREATED A voter account was successfully created
VOTER_NOT_CREATED A voter account could not be created

Try It Now: API Variables

Generate a voter account for this voter_device_id

Parameter name Value  
voter_device_id:

(opens in new window)