< back to index

HTTP request

GET https://api.wevoteusa.org/apis/v1/voterVerifySecretCode (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.
secret_code string The six digit code to verify.

Optional Parameters

Parameter name Value Description
code_sent_to_sms_phone_number boolean If true, process this verification for an SMS phone number. If false, process for email.


  "status": string (description of what happened),
  "success": boolean (True as long as no db errors),
  "incorrect_secret_code_entered": boolean,
  "number_of_tries_remaining_for_this_code": integer,
  "secret_code_verified": boolean,
  "voter_must_request_new_code": boolean,
  "secret_code_system_locked_for_this_voter_device_id": string,

Try It Now: API Variables

Voter submits this six digit code to verify that they received an SMS message or email.

Parameter name Value  
code_sent_to_sms_phone_number: True

(opens in new window)