The IPQS Postback API allows you to alter previous Email Verification API requests to our API based on new or additional data to receive a new fraud score. You can also update aspects of an email request after it happens, such as confirming the conversion date and conversion status.
You can make requests to this API via POST or GET. Parameters passed to the API wrapped as an update[] array will update the original request. The API will use any parameters outside of the update[] array to look up the request.
While we recommend using the original request_id for all postback requests, we understand that not every caller can store the ID for each request. As a result, the API allows you to use custom variables instead. For the postback update to succeed, you must establish any custom tracking variables in your account settings before passing them with your initial request.
Below is your base postback URL:
JSON
XML
Using the request_id to update the transactionID
Assume a request had a request_id of DWwJ and you wanted to update the transactionID associated with that request to be 100
. You would make the following request to the API:
Using custom variables to update the transactionID
Assume you wanted to update the transactionID associated with a request to be 100, but you don't know the request_id of that request. You can instead look up the request using a custom variable.
Note: When using custom variables, the type variable is required. See the additional request parameters table below for accepted values. |
Parameter Name | Descriptions | Expected Values | Update Example |
ConversionStatus | Allows you to flag a request as having led to a conversion. | Boolean, string true or string false | update[ConversionStatus]=true |
ConversionDate | Allows you to set a date the request was made a conversion. | Date formatted yyyy-mm-dd or yyyy-mm-dd hh-mm-ss | update[ConversionDate]=2017-01-01 |
ClickDate | Allows you to alter the first date seen for an email address. | Date formatted yyyy-mm-dd or yyyy-mm-dd hh-mm-ss | update[ClickDate]=2017-01-01 |
request_id | A unique ID is provided for each request. You can use this ID for lookups. | String | request_id=DWwJ |
type | Required for request lookups when you don't provide a "request_id". Fetches a request of this type. | String (proxy, email or devicetracker) | type=email |
newest | Defaults to "false". When set to "true", the API chooses the most recent request if there is more than one request with your specified parameters. | Boolean (true/false) | newest=true |