Developer Documentation

Calling this web service will queue submitted information for processing and enrichment.

A synchronous response will give the status of the service call. An asynchronous response will be sent to the callback url that is included as a mandatory parameter within a few minutes.

/Record/Enhance

Http Method: POST

Endpoint: https://www.voterlabs.com/public/client/api/v1/record/enhance

FieldDescription
api_keyrequired - customer's unique, secure API credential
cust_source_typerequired - describes the record source type and dictates the enhancement processing type
values:
E=email address
S=standard (i.e. input name, address)
O=standard, same as above, but return only results containing an email match
* customer source type identifier is case sensitive, i.e. upper case
cust_idunique customer identifier
trans_idunique transaction identifier
cust_sales_dateyyyymmdd
first_namerequired if cust_source_type=s
last_namerequired if cust_source_type=s
address1required if cust_source_type=s
must contain street number, street name
should not include "address2" values (apt, suite, floor, etc.)
address2use for apartment, suite, floor, etc.
cityrequired if cust_source_type=s
staterequired if cust_source_type=s
zipcoderequired if cust_source_type=s
numeric - 5 digits max.
email_addressrequired if cust_source_type=e
valid email format only (localpart@domainpart.tld)
callback_urlstandard url encoding; json or xml format


Callback Fields

FieldOutputDescription
record_idunique system record identifier, VoterLabs defined
status_code1 = found, enhanced
-1 = error
record status
cust_source_typeE = email address
S = standard (i.e. name, address)
O = standard, records with email match only
record source / enhancement processing type
data enhancement fields*varies by data package - contact for more details*

Sample Output

Sample VoterLabs API Callback Output TWO 2.17.16



/Record/Retrieve/

Http Method: POST

Endpoint: https://www.voterlabs.com/public/client/api/v1/record/retrieve

FieldDescription
api_keyrequired - customer's unique, secure API credential
record_idunique system record identifier, VoterLabs definied
data enhancement fields
varies by data package
*contact for more info*

Sample Output

VoterLabs Sample Data Integration API Output

Copyright © 2012-2016 VoterLabs, Inc. All rights reserved.
VoterLabs, Mirrored Populations, Mobile ID Sync, and TargetMatch are trademarks of VoterLabs, Inc.
U.S. Patent No. 9,177,067 and U.S. and International Patents Pending