API Request
Partners can select either JavaScript integration or S2S API call based on their requirements and technology stack when opting to incorporate Intent IQ ID resolution online. In both cases, intent IQ will provide a JSON response containing the relevant data and parameters for the partner.
HTTP GET - API Call Template:
URL Glossary
| Parameter | Mandatory | Data Type | Description |
|---|---|---|---|
at | Numeric | Action type represent the end point in IIQ server (static param) | |
mi | Numeric | Internal IIQ param to indicate environment (static param) | |
pt | Numeric | Partner attribute type (static param) | |
srvrReq | Boolean | Indicates if this request originated from a server | |
dpi | Numeric | Partner ID, Provided by IntentIQ team | |
dpn | Numeric | Category ID provided by Intent IQ for statistics and traffic reports | |
ip | String | Source IP | |
ipv6 | String | Source IPv6 (if exists) | |
uas | String | UTF-8 URL encoded user agent of the original client | |
pcid* | String | User ID provided by the partner, for example, IDFV, 3rd-party cookie, MAID/ AAID. indicated by idtype parameter. | |
ref | Srting | UTF-8 URL encoded Domain or App name | |
idtype | Numeric | indicator of the ID type of the pcid parameter value: 0 - Partner's 3rd party cookie 1 - IDFV 4 - MAID/ AAID 8 - CTV IDs (e.g Roko, Samsung , LG) | |
pai | String | Partner Advertiser ID | |
iiqidtype** | Numeric | 1st party ID (idtype=2) | |
iiqpcid** | String | IIQ 1st ID (or other 1st party ID like the SharedID) | |
iiqpciddate** | Numeric | The IIQ 1st party ID creation timestamp, if not available then the current time timestamp. | |
iiquid | String | The IIQ Universal ID is represented as an SHA-256 hash and is provided within the eids array of bid requests. It can be utilized to ascertain user identity and address proxy IP issues. If available, it is highly recommended to make use of it. | |
3rdpcid | String | Represents a specific SSP/DSP ID that the partner can input into the BE API. The BE API can use this ID to find the corresponding user in the IIQ graph. If the partner has multiple SSP/DSP IDs to send, they can include this parameter along with the 3rddpi parameter. These two parameters work together as a pair, and their order is crucial. This means that each 3rdpcid and 3rddpi should match in their order in the URL. The first 3rdpcid and the first 3rddpi are considered a pair, and so on. | |
3rddpi | Numeric | This parameter is paired with the 3rdpcid. For further details, please refer to the description of the 3rdpcid. The value of the 3rddpi, representing the SSP/DSP, will be supplied to you by your professional service IIQ personnel.. |
*For IDFV's uppercase letters only, for IDFA's not case-sensitive
**The parameters iiqpcid, iiqidtype, and iiqpciddate need to be submitted simultaneously
Bid Enhancement API Call Examples:
Basic Call:
Request with IDFV (for example: 3166a190-32b9-4dd7-a9aa-9e431d8026b4) no 1st party ID:
No 1st party ID :
Intent IQ Universal ID:
3rd Party SSP/DSP IDs Provided By Partner:
Last updated