< back to index
HTTP request
GET https://api.wevoteusa.org/apis/v1/appleSignInSave (Jump to "Try It Now")
Required Parameters
| Parameter name |
Value |
Description |
| voter_device_id |
string |
An 88 character unique identifier linked to a voter record on the server |
| api_key |
string (from post, cookie, or get (in that order)) |
The unique key provided to any organization using the WeVoteServer APIs |
| email |
string |
The email address used to establish an Apple ID, can be an alias (aliases complicate matching) |
| first_name |
string |
The first name (given name) of the Apple ID user. |
| middle_name |
string |
The middle name of the Apple ID user. This field can be an empty string |
| last_name |
string |
The last name (family name) of the Apple ID user. |
| user_code |
string |
The hash that Sign in with Apple returns for a successful sign in for a given Apple ID |
Optional Parameters
| Parameter name |
Value |
Description |
| apple_platform |
string |
iOS, or iPadOS |
| apple_os_version |
string |
13.5 for example |
| apple_model |
string |
"iPhone12,3" is an "iPhone 11 Pro" for example |
| voter_we_vote_id |
string |
The unique identifier for the voter. It would be unusual to know this in advance. |
Response
{
"status": string,
"success": boolean,
"voter_device_id": string (88 characters long),
}
Response Status Codes
| Code |
Description |
| APPLE_USER_ID_RECORD_CREATED_OR_UPDATED |
Success. Mormal operation. |
| VALID_VOTER_DEVICE_ID_MISSING |
Cannot proceed. A valid voter_device_id parameter was not included. |
| ERROR_APPLE_USER_NOT_CREATED_OR_NOT_UPDATED |
Cannot proceed. The record was not created or updated, due to a bug or a system issue. |
Try It Now: API Variables
Save the Apple 'user' code, returned by the Sign In With Apple api response for a given Apple ID -- the Apple ID is phone owner's email address and password used to sign into iCloud.
WeVote code never 'sees' the Apple ID password, only the 'user' code returned by the API and the user's email address (which unfortunately can be an Apple aliased email address).