1st Party Privacy Guardian API
- 23 Sep 2024
- 7 Minutes to read
- DarkLight
1st Party Privacy Guardian API
- Updated on 23 Sep 2024
- 7 Minutes to read
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Introduction
1st Party Privacy Guardian is a REST API call that relies on a unique LeadiD token that is generated by our javascript snippet to witness the consumer's experience as they move through a lead funnel. The responses in this request are derived data insights gathered from the lead event.
Example Request Structure (GET method)
https://api.leadid.com/SingleQuery?lac={ACCOUNTCODE}&id={LEADIDTOKEN}&lak={AUDITKEY}&lpc={PROVIDERCODE}&data={DATA}
Parameter Definitions
| Name | Value | Required | Description |
| URL | https://api.leadid.com/SingleQuery? | Yes | The URL to be used for the query |
| Method | GET or POST | Yes | The HTTPS method to be used. |
| lac | xxxxxxxx-xxxx-xxxx-xxxx | Yes | Your Jornaya Account Code. |
| id | 36 Character LeadiD | Yes | The LeadiD token. |
| lak | xxxxxxxx-xxxx-xxxx-xxxx | Yes | The Audit Key for this query. |
| lpc | Alphanumeric string | Yes | A value that identifies the Provider from whom you received this lead. |
| data | Pipe | Separated Data with field data labels delimited by semicolons. e.g., email;joe@smith.com|f_name;joe | Yes | The data for which you want to determine Data Integrity. Note: a list of Data Integrity Field Data Labels can be found at the end of this document. |
| recordid | Integer or string | When applicable | This is the Lead Management System’s or destination system’s unique identifier for the specific lead record. |
| format | json, xml | No | The format in which you would like the data returned. The default value is JSON. |
| agency | xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx | When applicable | The agency parameter allows a company that is an AOR or LMS for a client to perform queries on behalf of that client and identify itself accordingly by passing in their own Account Code. |
Security for Usage
The usage of HTTPS/TLS is highly recommended when implementing the Jornaya TCPA Guardian (3rd Party) API. This ensures data transmitted between your networks and Jornaya’s systems is securely encrypted and protected. Jornaya supports the usage and configuration of TLS 1.2, and the following TLS cipher suites:
| ECDHE-ECDSA-AES128-GCM-SHA256 | ECDHE-RSA-AES256-SHA384 |
| ECDHE-RSA-AES128-GCM-SHA256 | ECDHE-RSA-AES256-SHA |
| ECDHE-ECDSA-AES128-SHA256 | ECDHE-ECDSA-AES256-SHA |
| ECDHE-RSA-AES128-SHA256 | AES128-GCM-SHA256 |
| ECDHE-ECDSA-AES128-SHA | AES128-SHA256 |
| ECDHE-RSA-AES128-SHA | AES128-SHA |
| ECDHE-ECDSA-AES256-GCM-SHA384 | AES256-GCM-SHA384 |
| ECDHE-RSA-AES256-GCM-SHA384 | AES256-SHA256 |
| ECDHE-ECDSA-AES256-SHA384 |
Revisions
At any future time, Jornaya may revise the list of supported TLS protocols and cipher suites as required by industry security best practices. You will be notified in advance of such changes to ensure continued successful operations of your integrations with Jornaya’s services.
Example Response Structure
The sample output listed below shows an instance when the TCPA disclosure found on the web form matched the disclosure text entered in the audit profile ('disclosure' = 1).
| JSON | XML |
|---|---|
| audit: { | <audit> |
| "authentic": 1, | <authentic>1</authentic> |
| "reg_rule": 1, | <reg_rule>1</reg_rule> |
| "data_integrity_failed": [ | <data_integrity_failed>123</data_integrity_failed> |
| "123", | <data_integrity_failed>TEST.COM</data_integrity_failed> |
| "TEST.COM", | <data_integrity_failed>123@TEST.COM</data_integrity_failed> |
| "123@TEST.COM" | <data_integrity>0</data_integrity> |
| ], | <data_integrity_rule>2</data_integrity_rule> |
| "data_integrity": 0, | <fields> |
| "data_integrity_rule": 2, | <f_name>0</f_name> |
| "fields": { | <l_name>0</l_name> |
| "f_name": 0, | <phone1>0</phone1> |
| "l_name": 0, | <email>0</email> |
| "phone1": 0, | </fields> |
| "email": 0 | <market> |
| }, | <leadid> |
| "market": { | <tcpafirst> |
| "leadid": { | <disclosure>1</disclosure> |
| "tcpafirst": { | <raw_response> |
| "disclosure": 1, | <disclosures> |
| "raw_response": { | <disclosure_id>3</disclosure_id> |
| "disclosures": [ | <label>Disclosure Text 1</label> |
| { | <interaction>2</interaction> |
| "disclosure_id": 3, | </disclosures> |
| "label": Disclosure Text 1", | </raw_response> |
| "interaction": 2 | <disclosure_rule>1</disclosure_rule> |
| } | <capture>1</capture> |
| ] | <capture_rule>1</capture_rule> |
| }, | <stored>1</stored> |
| "disclosure_rule": 1, | <stored_rule>1</stored_rule> |
| "capture": 1, | <result>1</result> |
| "capture_rule": 1, | </tcpafirst> |
| "stored": 1, | <result>1</result> |
| "stored_rule": 1, | </leadid> |
| "result": 1 | <result>1</result> |
| }, | </market> |
| "result": 1 | <result>2</result> |
| }, | <token>{LeadiD Token}</token> |
| "result": 1 | </audit> |
| }, | |
| "result": 2, | |
| "token": "{LeadiD Token}" | |
| } |
Data Responses
The following sections list the responses (and associated values) received when employing Jornaya's TCPA Guardian (1st Party) during a lead audit. When the TCPA disclosure on the web form matches a disclosure text in the audit profile, all of the TCPA audit responses will be returned.
Alternatively, if (a) Jornaya is not able to identify a TCPA disclosure on the web form, or (b) the TCPA disclosure on the web form does not match any disclosure text in the audit profile, some responses - denoted with an asterisk (*) - cannot be determined and will not be included in the response.
LeadID Authenticity
| Data Point | Value | Description |
| authentic | 0 | One or more of the conditions have been met below and no additional data will be returned for this LeadiD token:
|
| 1 | Authentic LeadiD |
TCPA Disclosures Captured
| Data Point | Value | Description |
| disclosure | 0 | No matching TCPA disclosures were captured during the lead event. |
| 1 | A single matching TCPA disclosure was captured during the event. | |
| 2 | Multiple matching TCPA disclosures were captured during the event. | |
| disclosure_rule | # | Returned flag color for 'disclosure': 1 - 'Green'; 2 - 'Yellow'; 3 - 'Red' |
TCPA Raw Response Values
| Data Point | Value | Description |
| disclosures | string | The list of matching disclosures found during the lead event (labeled 0, 1, 2, 3, etc.) |
| interaction | 0 | No interaction is required for the disclosure. |
| 1 | Consumer Interaction with the disclosure was captured. | |
| 2 | No Consumer Interaction with the disclosure was captured | |
| label | string | Text of the matching disclosure with its associated interaction response. |
Visual Documentation
| Data Point | Value | Description |
| capture | 1 | The Visual Playback has been captured. |
| 2 | The Visual Playback has been partially captured. | |
| 0 | The Visual Playback has not been captured. | |
| capture_rule | # | Returned flag color for 'disclosure': 1 - 'Green'; 2 - 'Yellow'; 3 - 'Red' |
| stored | 1 | The Visual Playback has been stored. |
| 0 | The Visual Playback has not been stored. | |
| stored_rule | # | Returned flag color for 'disclosure': 1 - 'Green'; 2 - 'Yellow'; 3 - 'Red' |
TCPA First Result
| Data Point | Value | Description |
| result | # | Overall 'rule' value returned as per flag settings in the Jornaya portal. The 'result' contains the highest number returned in a '_rule' data element, and corresponds to the overall flag color returned in the TCPA section:
|
Data Integrity
| Data Point | Value | Description |
| data_integrity | 0 | Mismatch. The value provided was not matched to any data witnessed by Jornaya during the lead event. |
| 1 | Match: The value of the data you submitted IS what was actually entered on the lead form. | |
| 2 | Mismatch With Disclosure: The value of the data you submitted is NOT what was actually entered but may have been changed by the generator. | |
| 3 | Default Value: The data sent was the default field value. | |
| fields | array | Elements, where the key is the field name and the value, is the data_integrity value/outcome (see above). NOTE: email integrity is checked in 3 parts. The complete email is checked. In the event that there is not a match on the complete email address, the data_integrity results for each of these components are also returned in the response. |
| data_integrity_failed | array | Array list of data submitted that failed data integrity. |
| data_integrity_passed | array | Array list of data submitted that passed data integrity. |
| data_integrity_default | array | Array list of data submitted that was the default values. |
Consumer Origin
| Data Point | Value | Description |
| call_center | 1 | Information was entered by a 3rd party. This Data Point is only returned when the campaign that created the LeadiD token was identified as a call center. |
Audit Result
| Data Point | Value | Description |
| result | # | Overall 'rule' value from the query response, as per flag settings in the Jornaya portal for the Call center and Data Integrity responses:
|
Field Data Labels
| Label | Description |
| Note: Data field values are restricted to 250 characters max per value. | |
| f_name | First Name |
| l_name | Last Name |
| phone1 | Phone1 |
| phone2 | Phone2 |
| address1 | Address1 |
| address2 | Address2 |
| city | City |
| state | State |
| zip | Zip |
Error Codes
| Value | Description |
| 100 | Internal Error Retry Jornaya side error. Initiate retry logic. |
| 1000 | Leadid not set The LeadiD value has not been provided or the HTTPS method (GET or POST) is not in the correct format for the LeadiD value to be set. |
| 1001 | Malformed LeadiD The LeadiD value is either malformed or blank. |
| 2000 | Account code not set The Account code value has not been provided. |
| 2001 | Malformed account code The Account code value is either malformed or blank. |
| 4001 | Malformed Audit Key The audit key is malformed or blank. |
| 5000 | Invalid Entry Code The entity code provided is not valid. |
| 6000 | Invalid Account Code and/or Audit Key Either the account code or audit key provided is invalid. |
| 7000 | Testing not enabled for account The account is not set up for testing. Please contact support@jornaya.com to have this enabled. |
Response Data Types and Lengths
| Data Point | Type | Max Length |
| disclosure | Int | 1 |
| disclosure_rule | Int | 1 |
| disclosures | string | |
| interaction | Int | 1 |
| label | string | |
| capture | Int | 1 |
| capture_rule | Int | 1 |
| stored | Int | 1 |
| stored_rule | Int | 1 |
| result | Int | 1 |
Was this article helpful?
