Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The name “Bearer authentication” can be understood as “give access to the bearer of this token.” The bearer token is a cryptic string, usually generated by the server in response to a login request. The client must send this token in the Authorization header when making requests to protected resources. Example
POST /ping HTTP/1.1
Authorization: Bearer lYyEtRnwZKuKxIxrFCAOVB
Content-Type: application/json; charset=utf-8
...
Security Scheme Type | HTTP |
---|---|
HTTP Authorization Scheme | bearer |
This document covers Version 2 of the Mastodon API. We use built-in HTTP features, like HTTP authentication, HTTP verbs (ie, POST) and standard response codes to simplify integrations into the API. JSON will be returned in all responses from the API, including errors.
Click Resource allows publishers to offer customer information and receive a click feed with tailored offers for that consumer.
The Ping resource is a secure way to offer up lead properties needed to match to our advertisers, but do not need to include contact or PII information for that customer.
This is used only to find demand for that consumer and return a bid or no match response.
No Match
responses should not be interpreted as errors or that anything was sent incorrectly in regards to structure or syntax.
The ping is considered the first of two parts that make up sale and should not be considered a complete transaction. Leads & Calls require a pingpost for a complete transaction. Clicks require a click from a user :-)
write:auctions
read:auctions
) Match Request
source_token required | string (Source Token) Given Source Token for your Traffic. |
required | object |
{- "source_token": "ecb41e5c-963d-4da3-bb31-a83b69682aa8",
- "data": {
- "zipcode": "92101",
- "ip_address": "68.139.206.214",
- "phone_suffix": 1234,
- "user_agent": "Mozilla/5.0 (X11; Ubuntu; Linux i686; rv:15.0) Gecko/20100101 Firefox/15.0.1",
- "utm_source": "google",
- "utm_campaign": "string",
- "utm_medium": "string",
- "utm_content": "logolink or textlink",
- "utm_term": "running+shoes",
- "external_id": "123456789",
- "tcpa_call_consent": true,
- "tcpa_sms_consent": true,
- "tcpa_disclosure": "By submitting your quote request, you represent that you are at least 18 and agree to our Privacy Policy and Terms of Use. You also authorize UE.co and/or its marketing partners to contact you for marketing/telemarketing purposes at the number and address provided above, including your wireless number, if provided, using live operators, automated telephone dialing systems, pre-recorded messages, text messages and/or emails. You are not required to consent as a condition of purchasing goods or services and may revoke consent at anytime.",
- "tcpa_url": "example.com",
- "source_url": "example.com",
- "trusted_form_certificate_id": "433cb911f1698abec3a8c3514fad789c2541e823",
- "universal_lead_id": "e8959414-ba71-400a-b5d7-5cd3abede139",
- "form_begin": "2019-03-18T09:23:43.000Z",
- "form_submit": "2019-03-18T09:23:43.000Z",
- "coreg": false,
- "sub_1": "string",
- "sub_2": "string",
- "sub_3": "string",
- "custom": {
- "property1": "string",
- "property2": "string"
}, - "currently_insured": false,
- "continuous_coverage": 48,
- "current_customer": 48,
- "current_policy_started": 90,
- "current_policy_expires": 30,
- "current_company": null,
- "bundle_insurance": true,
- "bi_per_incident": 20000,
- "bi_per_person": 10000,
- "coverage_type": "Standard Protection",
- "property_damage": 100000,
- "military_affiliation": false,
- "home_length": 121,
- "home_ownership": false,
- "home_garage": false,
- "current_employer": "string",
- "drivers": [
- {
- "sr_22": true,
- "relationship": "self",
- "primary_vehicle": 0,
- "occupation": "Administrative Clerical",
- "marital_status": "Married",
- "license_status": "Active",
- "license_state": "CA",
- "gender": "M",
- "first_licensed": 0,
- "education": "None",
- "last_name": "string",
- "first_name": "string",
- "credit_rating": "Excellent",
- "date_of_birth": "2019-08-24",
- "bankruptcy": false,
- "suspended_reason": "DUI",
- "years_employed": 2
}
], - "vehicles": [
- {
- "alarm": true,
- "annual_mileage": 12000,
- "auto_warranty": true,
- "commute_mileage": 24000,
- "current_mileage": 24000,
- "collision": 1000,
- "commute_days": 5,
- "comprehensive": 500,
- "make": "string",
- "model": "string",
- "ownership": "own",
- "primary_use": "Commute Work",
- "trim": "string",
- "vin": "SHHFC1E50HH000000",
- "year": 2017
}
], - "incidents": [
- {
- "amount_paid": 0,
- "description": "string",
- "driver": 0,
- "incident_date": "2019-08-24",
- "type": "ticket",
- "what_damaged": "not applicable",
- "liability_medical_paid": 0,
- "accident_at_fault": true,
- "claim_at_fault": true
}
]
}
}
{- "auction_id": "string",
- "visitor_id": "string",
- "bids": [
- {
- "bid_id": 1,
- "buyer_name": "Acme",
- "exclusive": true,
- "vendor_attributes": { },
- "bid_amount": "string",
- "transfer_number": "string"
}
], - "expires_at": "string",
- "payout": null,
- "sold": true,
- "matched": true,
- "bid_amount": null,
- "default_accepted_bid_ids": [ ],
- "time_ms": 0
}
Calls Resource allows publishers to offer customer information and receive a potential advertiser that is ready to receive an inbound call from the consumer.
You can either use our Auctions Resource or the Ping and Post Resources in order to find potential offers for consumers
In the response, you will receive a transfer number with expiration time that the number will be available to receive a call from that expected consumer.
The Ping resource is a secure way to offer up lead properties needed to match to our advertisers, but do not need to include contact or PII information for that customer.
This is used only to find demand for that consumer and return a bid or no match response.
No Match
responses should not be interpreted as errors or that anything was sent incorrectly in regards to structure or syntax.
The ping is considered the first of two parts that make up sale and should not be considered a complete transaction. Leads & Calls require a pingpost for a complete transaction. Clicks require a click from a user :-)
write:auctions
read:auctions
) Match Request
source_token required | string (Source Token) Given Source Token for your Traffic. |
required | object |
{- "source_token": "ecb41e5c-963d-4da3-bb31-a83b69682aa8",
- "data": {
- "zipcode": "92101",
- "ip_address": "68.139.206.214",
- "phone_suffix": 1234,
- "user_agent": "Mozilla/5.0 (X11; Ubuntu; Linux i686; rv:15.0) Gecko/20100101 Firefox/15.0.1",
- "utm_source": "google",
- "utm_campaign": "string",
- "utm_medium": "string",
- "utm_content": "logolink or textlink",
- "utm_term": "running+shoes",
- "external_id": "123456789",
- "tcpa_call_consent": true,
- "tcpa_sms_consent": true,
- "tcpa_disclosure": "By submitting your quote request, you represent that you are at least 18 and agree to our Privacy Policy and Terms of Use. You also authorize UE.co and/or its marketing partners to contact you for marketing/telemarketing purposes at the number and address provided above, including your wireless number, if provided, using live operators, automated telephone dialing systems, pre-recorded messages, text messages and/or emails. You are not required to consent as a condition of purchasing goods or services and may revoke consent at anytime.",
- "tcpa_url": "example.com",
- "source_url": "example.com",
- "trusted_form_certificate_id": "433cb911f1698abec3a8c3514fad789c2541e823",
- "universal_lead_id": "e8959414-ba71-400a-b5d7-5cd3abede139",
- "form_begin": "2019-03-18T09:23:43.000Z",
- "form_submit": "2019-03-18T09:23:43.000Z",
- "coreg": false,
- "sub_1": "string",
- "sub_2": "string",
- "sub_3": "string",
- "custom": {
- "property1": "string",
- "property2": "string"
}, - "currently_insured": false,
- "continuous_coverage": 48,
- "current_customer": 48,
- "current_policy_started": 90,
- "current_policy_expires": 30,
- "current_company": null,
- "bundle_insurance": true,
- "bi_per_incident": 20000,
- "bi_per_person": 10000,
- "coverage_type": "Standard Protection",
- "property_damage": 100000,
- "military_affiliation": false,
- "home_length": 121,
- "home_ownership": false,
- "home_garage": false,
- "current_employer": "string",
- "drivers": [
- {
- "sr_22": true,
- "relationship": "self",
- "primary_vehicle": 0,
- "occupation": "Administrative Clerical",
- "marital_status": "Married",
- "license_status": "Active",
- "license_state": "CA",
- "gender": "M",
- "first_licensed": 0,
- "education": "None",
- "last_name": "string",
- "first_name": "string",
- "credit_rating": "Excellent",
- "date_of_birth": "2019-08-24",
- "bankruptcy": false,
- "suspended_reason": "DUI",
- "years_employed": 2
}
], - "vehicles": [
- {
- "alarm": true,
- "annual_mileage": 12000,
- "auto_warranty": true,
- "commute_mileage": 24000,
- "current_mileage": 24000,
- "collision": 1000,
- "commute_days": 5,
- "comprehensive": 500,
- "make": "string",
- "model": "string",
- "ownership": "own",
- "primary_use": "Commute Work",
- "trim": "string",
- "vin": "SHHFC1E50HH000000",
- "year": 2017
}
], - "incidents": [
- {
- "amount_paid": 0,
- "description": "string",
- "driver": 0,
- "incident_date": "2019-08-24",
- "type": "ticket",
- "what_damaged": "not applicable",
- "liability_medical_paid": 0,
- "accident_at_fault": true,
- "claim_at_fault": true
}
]
}
}
{- "auction_id": "string",
- "visitor_id": "string",
- "bids": [
- {
- "bid_id": 1,
- "buyer_name": "Acme",
- "exclusive": true,
- "vendor_attributes": { },
- "bid_amount": "string",
- "transfer_number": "string"
}
], - "expires_at": "string",
- "payout": null,
- "sold": true,
- "matched": true,
- "bid_amount": null,
- "default_accepted_bid_ids": [ ],
- "time_ms": 0
}
A Ping Post is the completion and final agreement of the sale. Here you send the remaining Contact and/or PII information for a consumer. You should expect the information to be delivered to the end buyer in near realtime, but this is not always required.
write:pingpost
read:pingpost
) Product Matching Request
auction_id | string |
object | |
accepted_bid_ids | Array of integers |
{- "auction_id": "string",
- "data": {
- "first_name": "Clark",
- "last_name": "Kent",
- "address": "123 Main St",
- "address2": "Apt 4",
- "phone": "6195551212",
- "email": "clark.kent@fakemail.com"
}, - "accepted_bid_ids": [
- 0
]
}
{- "auction_id": "string",
- "bids": [
- {
- "bid_id": 0,
- "bid_amount": "string",
- "buyer_name": "string"
}
], - "expires_at": "string",
- "payout": "string",
- "sold": true,
- "matched": true,
- "bid_amount": "string",
- "default_accepted_bid_ids": [
- 0
], - "time_ms": 0,
- "data_issues": [ ]
}
A Post is sending a full lead to be sold immediately.
write:post
read:post
) Match Request
source_token required | string (Source Token) Given Source Token for your Traffic. |
required | object |
{- "source_token": "ecb41e5c-963d-4da3-bb31-a83b69682aa8",
- "data": {
- "first_name": "Clark",
- "last_name": "Kent",
- "address": "123 Main St",
- "address2": "Apt 4",
- "phone": "6195551212",
- "email": "clark.kent@fakemail.com",
- "zipcode": "92101",
- "ip_address": "68.139.206.214",
- "phone_suffix": 1234,
- "user_agent": "Mozilla/5.0 (X11; Ubuntu; Linux i686; rv:15.0) Gecko/20100101 Firefox/15.0.1",
- "utm_source": "google",
- "utm_campaign": "string",
- "utm_medium": "string",
- "utm_content": "logolink or textlink",
- "utm_term": "running+shoes",
- "external_id": "123456789",
- "tcpa_call_consent": true,
- "tcpa_sms_consent": true,
- "tcpa_disclosure": "By submitting your quote request, you represent that you are at least 18 and agree to our Privacy Policy and Terms of Use. You also authorize UE.co and/or its marketing partners to contact you for marketing/telemarketing purposes at the number and address provided above, including your wireless number, if provided, using live operators, automated telephone dialing systems, pre-recorded messages, text messages and/or emails. You are not required to consent as a condition of purchasing goods or services and may revoke consent at anytime.",
- "tcpa_url": "example.com",
- "source_url": "example.com",
- "trusted_form_certificate_id": "433cb911f1698abec3a8c3514fad789c2541e823",
- "universal_lead_id": "e8959414-ba71-400a-b5d7-5cd3abede139",
- "form_begin": "2019-03-18T09:23:43.000Z",
- "form_submit": "2019-03-18T09:23:43.000Z",
- "coreg": false,
- "sub_1": "string",
- "sub_2": "string",
- "sub_3": "string",
- "custom": {
- "property1": "string",
- "property2": "string"
}, - "currently_insured": false,
- "continuous_coverage": 48,
- "current_customer": 48,
- "current_policy_started": 90,
- "current_policy_expires": 30,
- "current_company": null,
- "bundle_insurance": true,
- "bi_per_incident": 20000,
- "bi_per_person": 10000,
- "coverage_type": "Standard Protection",
- "property_damage": 100000,
- "military_affiliation": false,
- "home_length": 121,
- "home_ownership": false,
- "home_garage": false,
- "current_employer": "string",
- "drivers": [
- {
- "sr_22": true,
- "relationship": "self",
- "primary_vehicle": 0,
- "occupation": "Administrative Clerical",
- "marital_status": "Married",
- "license_status": "Active",
- "license_state": "CA",
- "gender": "M",
- "first_licensed": 0,
- "education": "None",
- "last_name": "string",
- "first_name": "string",
- "credit_rating": "Excellent",
- "date_of_birth": "2019-08-24",
- "bankruptcy": false,
- "suspended_reason": "DUI",
- "years_employed": 2
}
], - "vehicles": [
- {
- "alarm": true,
- "annual_mileage": 12000,
- "auto_warranty": true,
- "commute_mileage": 24000,
- "current_mileage": 24000,
- "collision": 1000,
- "commute_days": 5,
- "comprehensive": 500,
- "make": "string",
- "model": "string",
- "ownership": "own",
- "primary_use": "Commute Work",
- "trim": "string",
- "vin": "SHHFC1E50HH000000",
- "year": 2017
}
], - "incidents": [
- {
- "amount_paid": 0,
- "description": "string",
- "driver": 0,
- "incident_date": "2019-08-24",
- "type": "ticket",
- "what_damaged": "not applicable",
- "liability_medical_paid": 0,
- "accident_at_fault": true,
- "claim_at_fault": true
}
]
}
}
{- "auction_id": null,
- "bids": [ ],
- "expires_at": "string",
- "payout": "string",
- "sold": true,
- "matched": true,
- "bid_amount": "string",
- "default_accepted_bid_ids": [
- 0
], - "time_ms": 0,
- "data_issues": [ ]
}
Leads Resource allows publishers to use our Ping Post API to request a bid for offered lead information.
In order for us to find the best or multiple matching buyers for a lead and return a bid with a unique temporary id. If you would like to sell that lead for that price, you must post the remaining information to the Post resource. Once you receive a successful response, the sale is completed. Authentication
The Ping resource is a secure way to offer up lead properties needed to match to our advertisers, but do not need to include contact or PII information for that customer.
This is used only to find demand for that consumer and return a bid or no match response.
No Match
responses should not be interpreted as errors or that anything was sent incorrectly in regards to structure or syntax.
The ping is considered the first of two parts that make up sale and should not be considered a complete transaction. Leads & Calls require a pingpost for a complete transaction. Clicks require a click from a user :-)
write:auctions
read:auctions
) Match Request
source_token required | string (Source Token) Given Source Token for your Traffic. |
required | object |
{- "source_token": "ecb41e5c-963d-4da3-bb31-a83b69682aa8",
- "data": {
- "zipcode": "92101",
- "ip_address": "68.139.206.214",
- "phone_suffix": 1234,
- "user_agent": "Mozilla/5.0 (X11; Ubuntu; Linux i686; rv:15.0) Gecko/20100101 Firefox/15.0.1",
- "utm_source": "google",
- "utm_campaign": "string",
- "utm_medium": "string",
- "utm_content": "logolink or textlink",
- "utm_term": "running+shoes",
- "external_id": "123456789",
- "tcpa_call_consent": true,
- "tcpa_sms_consent": true,
- "tcpa_disclosure": "By submitting your quote request, you represent that you are at least 18 and agree to our Privacy Policy and Terms of Use. You also authorize UE.co and/or its marketing partners to contact you for marketing/telemarketing purposes at the number and address provided above, including your wireless number, if provided, using live operators, automated telephone dialing systems, pre-recorded messages, text messages and/or emails. You are not required to consent as a condition of purchasing goods or services and may revoke consent at anytime.",
- "tcpa_url": "example.com",
- "source_url": "example.com",
- "trusted_form_certificate_id": "433cb911f1698abec3a8c3514fad789c2541e823",
- "universal_lead_id": "e8959414-ba71-400a-b5d7-5cd3abede139",
- "form_begin": "2019-03-18T09:23:43.000Z",
- "form_submit": "2019-03-18T09:23:43.000Z",
- "coreg": false,
- "sub_1": "string",
- "sub_2": "string",
- "sub_3": "string",
- "custom": {
- "property1": "string",
- "property2": "string"
}, - "currently_insured": false,
- "continuous_coverage": 48,
- "current_customer": 48,
- "current_policy_started": 90,
- "current_policy_expires": 30,
- "current_company": null,
- "bundle_insurance": true,
- "bi_per_incident": 20000,
- "bi_per_person": 10000,
- "coverage_type": "Standard Protection",
- "property_damage": 100000,
- "military_affiliation": false,
- "home_length": 121,
- "home_ownership": false,
- "home_garage": false,
- "current_employer": "string",
- "drivers": [
- {
- "sr_22": true,
- "relationship": "self",
- "primary_vehicle": 0,
- "occupation": "Administrative Clerical",
- "marital_status": "Married",
- "license_status": "Active",
- "license_state": "CA",
- "gender": "M",
- "first_licensed": 0,
- "education": "None",
- "last_name": "string",
- "first_name": "string",
- "credit_rating": "Excellent",
- "date_of_birth": "2019-08-24",
- "bankruptcy": false,
- "suspended_reason": "DUI",
- "years_employed": 2
}
], - "vehicles": [
- {
- "alarm": true,
- "annual_mileage": 12000,
- "auto_warranty": true,
- "commute_mileage": 24000,
- "current_mileage": 24000,
- "collision": 1000,
- "commute_days": 5,
- "comprehensive": 500,
- "make": "string",
- "model": "string",
- "ownership": "own",
- "primary_use": "Commute Work",
- "trim": "string",
- "vin": "SHHFC1E50HH000000",
- "year": 2017
}
], - "incidents": [
- {
- "amount_paid": 0,
- "description": "string",
- "driver": 0,
- "incident_date": "2019-08-24",
- "type": "ticket",
- "what_damaged": "not applicable",
- "liability_medical_paid": 0,
- "accident_at_fault": true,
- "claim_at_fault": true
}
]
}
}
{- "auction_id": "string",
- "visitor_id": "string",
- "bids": [
- {
- "bid_id": 1,
- "buyer_name": "Acme",
- "exclusive": true,
- "vendor_attributes": { },
- "bid_amount": "string",
- "transfer_number": "string"
}
], - "expires_at": "string",
- "payout": null,
- "sold": true,
- "matched": true,
- "bid_amount": null,
- "default_accepted_bid_ids": [ ],
- "time_ms": 0
}
A Ping Post is the completion and final agreement of the sale. Here you send the remaining Contact and/or PII information for a consumer. You should expect the information to be delivered to the end buyer in near realtime, but this is not always required.
write:pingpost
read:pingpost
) Product Matching Request
auction_id | string |
object | |
accepted_bid_ids | Array of integers |
{- "auction_id": "string",
- "data": {
- "first_name": "Clark",
- "last_name": "Kent",
- "address": "123 Main St",
- "address2": "Apt 4",
- "phone": "6195551212",
- "email": "clark.kent@fakemail.com"
}, - "accepted_bid_ids": [
- 0
]
}
{- "auction_id": "string",
- "bids": [
- {
- "bid_id": 0,
- "bid_amount": "string",
- "buyer_name": "string"
}
], - "expires_at": "string",
- "payout": "string",
- "sold": true,
- "matched": true,
- "bid_amount": "string",
- "default_accepted_bid_ids": [
- 0
], - "time_ms": 0,
- "data_issues": [ ]
}
A Post is sending a full lead to be sold immediately.
write:post
read:post
) Match Request
source_token required | string (Source Token) Given Source Token for your Traffic. |
required | object |
{- "source_token": "ecb41e5c-963d-4da3-bb31-a83b69682aa8",
- "data": {
- "first_name": "Clark",
- "last_name": "Kent",
- "address": "123 Main St",
- "address2": "Apt 4",
- "phone": "6195551212",
- "email": "clark.kent@fakemail.com",
- "zipcode": "92101",
- "ip_address": "68.139.206.214",
- "phone_suffix": 1234,
- "user_agent": "Mozilla/5.0 (X11; Ubuntu; Linux i686; rv:15.0) Gecko/20100101 Firefox/15.0.1",
- "utm_source": "google",
- "utm_campaign": "string",
- "utm_medium": "string",
- "utm_content": "logolink or textlink",
- "utm_term": "running+shoes",
- "external_id": "123456789",
- "tcpa_call_consent": true,
- "tcpa_sms_consent": true,
- "tcpa_disclosure": "By submitting your quote request, you represent that you are at least 18 and agree to our Privacy Policy and Terms of Use. You also authorize UE.co and/or its marketing partners to contact you for marketing/telemarketing purposes at the number and address provided above, including your wireless number, if provided, using live operators, automated telephone dialing systems, pre-recorded messages, text messages and/or emails. You are not required to consent as a condition of purchasing goods or services and may revoke consent at anytime.",
- "tcpa_url": "example.com",
- "source_url": "example.com",
- "trusted_form_certificate_id": "433cb911f1698abec3a8c3514fad789c2541e823",
- "universal_lead_id": "e8959414-ba71-400a-b5d7-5cd3abede139",
- "form_begin": "2019-03-18T09:23:43.000Z",
- "form_submit": "2019-03-18T09:23:43.000Z",
- "coreg": false,
- "sub_1": "string",
- "sub_2": "string",
- "sub_3": "string",
- "custom": {
- "property1": "string",
- "property2": "string"
}, - "currently_insured": false,
- "continuous_coverage": 48,
- "current_customer": 48,
- "current_policy_started": 90,
- "current_policy_expires": 30,
- "current_company": null,
- "bundle_insurance": true,
- "bi_per_incident": 20000,
- "bi_per_person": 10000,
- "coverage_type": "Standard Protection",
- "property_damage": 100000,
- "military_affiliation": false,
- "home_length": 121,
- "home_ownership": false,
- "home_garage": false,
- "current_employer": "string",
- "drivers": [
- {
- "sr_22": true,
- "relationship": "self",
- "primary_vehicle": 0,
- "occupation": "Administrative Clerical",
- "marital_status": "Married",
- "license_status": "Active",
- "license_state": "CA",
- "gender": "M",
- "first_licensed": 0,
- "education": "None",
- "last_name": "string",
- "first_name": "string",
- "credit_rating": "Excellent",
- "date_of_birth": "2019-08-24",
- "bankruptcy": false,
- "suspended_reason": "DUI",
- "years_employed": 2
}
], - "vehicles": [
- {
- "alarm": true,
- "annual_mileage": 12000,
- "auto_warranty": true,
- "commute_mileage": 24000,
- "current_mileage": 24000,
- "collision": 1000,
- "commute_days": 5,
- "comprehensive": 500,
- "make": "string",
- "model": "string",
- "ownership": "own",
- "primary_use": "Commute Work",
- "trim": "string",
- "vin": "SHHFC1E50HH000000",
- "year": 2017
}
], - "incidents": [
- {
- "amount_paid": 0,
- "description": "string",
- "driver": 0,
- "incident_date": "2019-08-24",
- "type": "ticket",
- "what_damaged": "not applicable",
- "liability_medical_paid": 0,
- "accident_at_fault": true,
- "claim_at_fault": true
}
]
}
}
{- "auction_id": null,
- "bids": [ ],
- "expires_at": "string",
- "payout": "string",
- "sold": true,
- "matched": true,
- "bid_amount": "string",
- "default_accepted_bid_ids": [
- 0
], - "time_ms": 0,
- "data_issues": [ ]
}
first_name | string (First Name) [ 2 .. 255 ] characters First Name of Primary Lead |
last_name | string (Last Name) [ 2 .. 255 ] characters Last Name of Primary Lead |
address | string (Address) <= 255 characters Address of Primary Lead |
address2 | string (Secondary Address) <= 255 characters Additional Address Information of Primary Lead |
phone | string (Telelphone Number) [ 10 .. 15 ] characters The phone number to contact the lead (numbers only, no formatting) |
string (Email Address) [ 3 .. 255 ] characters Best Email Address to contact consumer | |
zipcode | string (Zip Code (Postal Code)) [ 5 .. 10 ] characters ^[0-9]{5}$ Zipcode of Primary Lead |
ip_address | string (IP Address) [ 16 .. 45 ] characters IPv4 or IPv6 Address of Consumer when information was collected |
phone_suffix | string (Phone Suffix) 4 characters Last 4 Digits of Consumer Phone if Available |
user_agent | string (User Agent) <= 1024 characters User Agent of Consumer when information was collected |
utm_source | string Use utm_source to identify a search engine, newsletter name, or other source. |
utm_campaign | string Used for keyword analysis. Use utm_campaign to identify a specific product promotion or strategic campaign. |
utm_medium | string Use utm_medium to identify a medium such as email or cost-per- click. |
utm_content | string Used for A/B testing and content-targeted ads. Use utm_content to differentiate ads or links that point to the same URL. |
utm_term | string Used for paid search. Use utm_term to note the keywords for this ad. |
external_id | string (External ID) <= 255 characters Unique ID for Lead from Publisher |
tcpa_call_consent | boolean (TCPA Call Consent) Default: false Enum: true false Indicates whether the user has consented to a call. |
tcpa_sms_consent | boolean (TCPA SMS Consent) Default: false Enum: true false Indicates whether the user has consented to SMS/MMS. |
tcpa_disclosure | string (TCPA Disclosure) <= 255 characters Text displaying TCPA disclosure |
tcpa_url | string (TCPA Link Url) <= 255 characters Link to TCPA text. |
source_url | string (Source URL) <= 255 characters The URL of the web page the lead was generated on. |
trusted_form_certificate_id | string (Trusted Form Certificate Id) <= 255 characters 40+ character Trusted Form Certificate ID (path portion of their URL) Link |
universal_lead_id | string (Jornaya Lead ID) <= 36 characters Jornaya Lead ID for this lead Link |
form_begin | string <date-time> (Form Started Timestamp) Date and time that user starts form. Value must include a time zone. |
form_submit | string <date-time> (Form Submit Timestamp) Date and time that user submits form. Value must include a time zone. |
coreg | boolean (Is Co-Registration Lead) Default: false Enum: true false This Lead was generated using Co-Registration flows or techniques that may not have been the consumers original intent but may still be insterested in hearing about this vertical. |
sub_1 | string |
sub_2 | string |
sub_3 | string |
object | |
currently_insured | boolean (Currently Insured) Default: false Enum: true false Whether the primary consumer has a current valid policy (true) or not (false) |
continuous_coverage | integer (Continuos Coverage) Default: 0 How long has current Customer been continuously insured in months? |
current_customer | integer (Current Customer) Default: 0 How long has current Customer been Insured in Months? |
current_policy_started | integer (Days Since Policy Started) How Many Days Since Current Policy Started? |
current_policy_expires | integer (Days Until Policy Expires) How Many Days Until Current Policy Expires? |
current_company | any Names of Available Company |
bundle_insurance | boolean |
bi_per_incident | integer (Bodily Injury Coverage Limit Per Incident) Enum: 20000 15000 30000 40000 50000 60000 The Amount of Bodily Injury Coverage Limit the primary has requested |
bi_per_person | integer (Bodily Injury Coverage Limit Per Person) Enum: 10000 12500 15000 20000 25000 30000 The Amount of Bodily Injury Coverage Limit Per Person Limit the primary has requested |
coverage_type | string (Coverage Type) Enum: "State Minimum" "Standard Protection" "Superior Protection" "Basic" Requested coverage type. |
property_damage | integer (Property Damage) Desired property damage coverage. |
military_affiliation | boolean Default: false Enum: true false Indicates whether the primary driver is military affiliation. |
home_length | integer Default: 0 Number of months the user lived in the current home (in months). |
home_ownership | boolean (Home Ownership) Default: false Enum: true false Whether the primary residence is owned by primary (true) or is not (false) |
home_garage | boolean (Home Garage) Default: false Enum: true false Whether the primary residence has a garage (true) or does not (false) |
current_employer | string (Current Employer) |
Array of objects (Drivers) Array of drivers requesting to be included in policy | |
Array of objects (Vehicles) Array of vehicles requesting to be included in policy | |
Array of objects (Incident) Array of incidents occurred in the past three years. |
{- "first_name": "Clark",
- "last_name": "Kent",
- "address": "123 Main St",
- "address2": "Apt 4",
- "phone": "6195551212",
- "email": "clark.kent@fakemail.com",
- "zipcode": "92101",
- "ip_address": "68.139.206.214",
- "phone_suffix": 1234,
- "user_agent": "Mozilla/5.0 (X11; Ubuntu; Linux i686; rv:15.0) Gecko/20100101 Firefox/15.0.1",
- "utm_source": "google",
- "utm_campaign": "string",
- "utm_medium": "string",
- "utm_content": "logolink or textlink",
- "utm_term": "running+shoes",
- "external_id": "123456789",
- "tcpa_call_consent": true,
- "tcpa_sms_consent": true,
- "tcpa_disclosure": "By submitting your quote request, you represent that you are at least 18 and agree to our Privacy Policy and Terms of Use. You also authorize UE.co and/or its marketing partners to contact you for marketing/telemarketing purposes at the number and address provided above, including your wireless number, if provided, using live operators, automated telephone dialing systems, pre-recorded messages, text messages and/or emails. You are not required to consent as a condition of purchasing goods or services and may revoke consent at anytime.",
- "tcpa_url": "example.com",
- "source_url": "example.com",
- "trusted_form_certificate_id": "433cb911f1698abec3a8c3514fad789c2541e823",
- "universal_lead_id": "e8959414-ba71-400a-b5d7-5cd3abede139",
- "form_begin": "2019-03-18T09:23:43.000Z",
- "form_submit": "2019-03-18T09:23:43.000Z",
- "coreg": false,
- "sub_1": "string",
- "sub_2": "string",
- "sub_3": "string",
- "custom": {
- "property1": "string",
- "property2": "string"
}, - "currently_insured": false,
- "continuous_coverage": 48,
- "current_customer": 48,
- "current_policy_started": 90,
- "current_policy_expires": 30,
- "current_company": null,
- "bundle_insurance": true,
- "bi_per_incident": 20000,
- "bi_per_person": 10000,
- "coverage_type": "Standard Protection",
- "property_damage": 100000,
- "military_affiliation": false,
- "home_length": 121,
- "home_ownership": false,
- "home_garage": false,
- "current_employer": "string",
- "drivers": [
- {
- "sr_22": true,
- "relationship": "self",
- "primary_vehicle": 0,
- "occupation": "Administrative Clerical",
- "marital_status": "Married",
- "license_status": "Active",
- "license_state": "CA",
- "gender": "M",
- "first_licensed": 0,
- "education": "None",
- "last_name": "string",
- "first_name": "string",
- "credit_rating": "Excellent",
- "date_of_birth": "2019-08-24",
- "bankruptcy": false,
- "suspended_reason": "DUI",
- "years_employed": 2
}
], - "vehicles": [
- {
- "alarm": true,
- "annual_mileage": 12000,
- "auto_warranty": true,
- "commute_mileage": 24000,
- "current_mileage": 24000,
- "collision": 1000,
- "commute_days": 5,
- "comprehensive": 500,
- "make": "string",
- "model": "string",
- "ownership": "own",
- "primary_use": "Commute Work",
- "trim": "string",
- "vin": "SHHFC1E50HH000000",
- "year": 2017
}
], - "incidents": [
- {
- "amount_paid": 0,
- "description": "string",
- "driver": 0,
- "incident_date": "2019-08-24",
- "type": "ticket",
- "what_damaged": "not applicable",
- "liability_medical_paid": 0,
- "accident_at_fault": true,
- "claim_at_fault": true
}
]
}
first_name | string (First Name) [ 2 .. 255 ] characters First Name of Primary Lead |
last_name | string (Last Name) [ 2 .. 255 ] characters Last Name of Primary Lead |
address | string (Address) <= 255 characters Address of Primary Lead |
address2 | string (Secondary Address) <= 255 characters Additional Address Information of Primary Lead |
phone | string (Telelphone Number) [ 10 .. 15 ] characters The phone number to contact the lead (numbers only, no formatting) |
string (Email Address) [ 3 .. 255 ] characters Best Email Address to contact consumer | |
zipcode | string (Zip Code (Postal Code)) [ 5 .. 10 ] characters ^[0-9]{5}$ Zipcode of Primary Lead |
ip_address | string (IP Address) [ 16 .. 45 ] characters IPv4 or IPv6 Address of Consumer when information was collected |
phone_suffix | string (Phone Suffix) 4 characters Last 4 Digits of Consumer Phone if Available |
user_agent | string (User Agent) <= 1024 characters User Agent of Consumer when information was collected |
utm_source | string Use utm_source to identify a search engine, newsletter name, or other source. |
utm_campaign | string Used for keyword analysis. Use utm_campaign to identify a specific product promotion or strategic campaign. |
utm_medium | string Use utm_medium to identify a medium such as email or cost-per- click. |
utm_content | string Used for A/B testing and content-targeted ads. Use utm_content to differentiate ads or links that point to the same URL. |
utm_term | string Used for paid search. Use utm_term to note the keywords for this ad. |
external_id | string (External ID) <= 255 characters Unique ID for Lead from Publisher |
tcpa_call_consent | boolean (TCPA Call Consent) Default: false Enum: true false Indicates whether the user has consented to a call. |
tcpa_sms_consent | boolean (TCPA SMS Consent) Default: false Enum: true false Indicates whether the user has consented to SMS/MMS. |
tcpa_disclosure | string (TCPA Disclosure) <= 255 characters Text displaying TCPA disclosure |
tcpa_url | string (TCPA Link Url) <= 255 characters Link to TCPA text. |
source_url | string (Source URL) <= 255 characters The URL of the web page the lead was generated on. |
trusted_form_certificate_id | string (Trusted Form Certificate Id) <= 255 characters 40+ character Trusted Form Certificate ID (path portion of their URL) Link |
universal_lead_id | string (Jornaya Lead ID) <= 36 characters Jornaya Lead ID for this lead Link |
form_begin | string <date-time> (Form Started Timestamp) Date and time that user starts form. Value must include a time zone. |
form_submit | string <date-time> (Form Submit Timestamp) Date and time that user submits form. Value must include a time zone. |
coreg | boolean (Is Co-Registration Lead) Default: false Enum: true false This Lead was generated using Co-Registration flows or techniques that may not have been the consumers original intent but may still be insterested in hearing about this vertical. |
sub_1 | string |
sub_2 | string |
sub_3 | string |
object | |
currently_insured | boolean (Currently Insured) Default: false Enum: true false Whether the primary consumer has a current valid policy (true) or not (false) |
continuous_coverage | integer (Continuos Coverage) Default: 0 How long has current Customer been continuously insured in months? |
current_customer | integer (Current Customer) Default: 0 How long has current Customer been Insured in Months? |
current_policy_started | integer (Days Since Policy Started) How Many Days Since Current Policy Started? |
current_policy_expires | integer (Days Until Policy Expires) How Many Days Until Current Policy Expires? |
current_company | string Names of Available Company |
bundle_insurance | boolean |
date_of_birth | string <date> (Date of birth) ^([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[... Date of birth of the driver. (YYYY-MM-DD) |
credit_rating | string (Credit Rating) Enum: "Excellent" "Good" "Average" "Below average" "Poor" |
gender | string (Gender) Enum: "M" "F" "X" The gender of the consumer |
marital_status | string (Marital Status) Enum: "Single" "Married" "Divorced" "Separated" "Widowed" "Domestic Partner" "Unknown" The marital status of the consumer |
num_claims | integer (Number of claims) The Number of claims the consumer has had |
Array of Property (object) (Properties) The list of consumer's properties |
{- "first_name": "Clark",
- "last_name": "Kent",
- "address": "123 Main St",
- "address2": "Apt 4",
- "phone": "6195551212",
- "email": "clark.kent@fakemail.com",
- "zipcode": "92101",
- "ip_address": "68.139.206.214",
- "phone_suffix": 1234,
- "user_agent": "Mozilla/5.0 (X11; Ubuntu; Linux i686; rv:15.0) Gecko/20100101 Firefox/15.0.1",
- "utm_source": "google",
- "utm_campaign": "string",
- "utm_medium": "string",
- "utm_content": "logolink or textlink",
- "utm_term": "running+shoes",
- "external_id": "123456789",
- "tcpa_call_consent": true,
- "tcpa_sms_consent": true,
- "tcpa_disclosure": "By submitting your quote request, you represent that you are at least 18 and agree to our Privacy Policy and Terms of Use. You also authorize UE.co and/or its marketing partners to contact you for marketing/telemarketing purposes at the number and address provided above, including your wireless number, if provided, using live operators, automated telephone dialing systems, pre-recorded messages, text messages and/or emails. You are not required to consent as a condition of purchasing goods or services and may revoke consent at anytime.",
- "tcpa_url": "example.com",
- "source_url": "example.com",
- "trusted_form_certificate_id": "433cb911f1698abec3a8c3514fad789c2541e823",
- "universal_lead_id": "e8959414-ba71-400a-b5d7-5cd3abede139",
- "form_begin": "2019-03-18T09:23:43.000Z",
- "form_submit": "2019-03-18T09:23:43.000Z",
- "coreg": false,
- "sub_1": "string",
- "sub_2": "string",
- "sub_3": "string",
- "custom": {
- "property1": "string",
- "property2": "string"
}, - "currently_insured": false,
- "continuous_coverage": 48,
- "current_customer": 48,
- "current_policy_started": 90,
- "current_policy_expires": 30,
- "current_company": "Acme Insurance",
- "bundle_insurance": true,
- "date_of_birth": "1984-01-01T00:00:00.000Z",
- "credit_rating": "Excellent",
- "gender": "F",
- "marital_status": "Married",
- "num_claims": 0,
- "properties": [
- {
- "address": "123 Main St",
- "address2": "Apt. 101",
- "zipcode": "92101",
- "property_type": "Single Family Home",
- "construction": "Wood Frame",
- "foundation": "Concrete Slab",
- "electrical": "Circuit Breakers",
- "security": "None",
- "garage": "Attached 2 Car Garage",
- "occupancy": "Primary Residence",
- "residence": "own",
- "roof": "Asphalt Shingle",
- "roof_age": 10,
- "num_stories": 2,
- "num_bedrooms": 3,
- "num_bathrooms": 2,
- "year_built": 1984,
- "square_footage": 1500,
- "years_at_residence": 10,
- "deductible": 100,
- "coverage_amount": 100000,
- "liability_coverage_amount": 200000,
- "new_purchase": true,
- "flood": true,
- "earthquake": true,
- "central_air_conditioning": true,
- "copper_water_pipes": true,
- "covered_deck": true,
- "deadbolt_locks": true,
- "fire_extinguisher": true,
- "fire_hydrant_within_1000_ft": true,
- "fireplace": true,
- "indoor_sprinklers": true,
- "manned_fire_station_within_5_mi": true,
- "in_ground_swimming_pool": true,
- "smoke_alarm": true,
- "smoker_in_household": true,
- "swimming_pool_is_fenced": true,
- "uncovered_deck": true,
- "trampoline": true,
- "woodburning_stove": true,
- "dog": true,
- "heating": true,
- "owner_occupied": true,
- "replacement_cost": 1
}
]
}
first_name | string (First Name) [ 2 .. 255 ] characters First Name of Primary Lead |
last_name | string (Last Name) [ 2 .. 255 ] characters Last Name of Primary Lead |
address | string (Address) <= 255 characters Address of Primary Lead |
address2 | string (Secondary Address) <= 255 characters Additional Address Information of Primary Lead |
phone | string (Telelphone Number) [ 10 .. 15 ] characters The phone number to contact the lead (numbers only, no formatting) |
string (Email Address) [ 3 .. 255 ] characters Best Email Address to contact consumer | |
zipcode | string (Zip Code (Postal Code)) [ 5 .. 10 ] characters ^[0-9]{5}$ Zipcode of Primary Lead |
ip_address | string (IP Address) [ 16 .. 45 ] characters IPv4 or IPv6 Address of Consumer when information was collected |
phone_suffix | string (Phone Suffix) 4 characters Last 4 Digits of Consumer Phone if Available |
user_agent | string (User Agent) <= 1024 characters User Agent of Consumer when information was collected |
utm_source | string Use utm_source to identify a search engine, newsletter name, or other source. |
utm_campaign | string Used for keyword analysis. Use utm_campaign to identify a specific product promotion or strategic campaign. |
utm_medium | string Use utm_medium to identify a medium such as email or cost-per- click. |
utm_content | string Used for A/B testing and content-targeted ads. Use utm_content to differentiate ads or links that point to the same URL. |
utm_term | string Used for paid search. Use utm_term to note the keywords for this ad. |
external_id | string (External ID) <= 255 characters Unique ID for Lead from Publisher |
tcpa_call_consent | boolean (TCPA Call Consent) Default: false Enum: true false Indicates whether the user has consented to a call. |
tcpa_sms_consent | boolean (TCPA SMS Consent) Default: false Enum: true false Indicates whether the user has consented to SMS/MMS. |
tcpa_disclosure | string (TCPA Disclosure) <= 255 characters Text displaying TCPA disclosure |
tcpa_url | string (TCPA Link Url) <= 255 characters Link to TCPA text. |
source_url | string (Source URL) <= 255 characters The URL of the web page the lead was generated on. |
trusted_form_certificate_id | string (Trusted Form Certificate Id) <= 255 characters 40+ character Trusted Form Certificate ID (path portion of their URL) Link |
universal_lead_id | string (Jornaya Lead ID) <= 36 characters Jornaya Lead ID for this lead Link |
form_begin | string <date-time> (Form Started Timestamp) Date and time that user starts form. Value must include a time zone. |
form_submit | string <date-time> (Form Submit Timestamp) Date and time that user submits form. Value must include a time zone. |
coreg | boolean (Is Co-Registration Lead) Default: false Enum: true false This Lead was generated using Co-Registration flows or techniques that may not have been the consumers original intent but may still be insterested in hearing about this vertical. |
sub_1 | string |
sub_2 | string |
sub_3 | string |
object | |
currently_insured | boolean (Currently Insured) Default: false Enum: true false Whether the primary consumer has a current valid policy (true) or not (false) |
continuous_coverage | integer (Continuos Coverage) Default: 0 How long has current Customer been continuously insured in months? |
current_customer | integer (Current Customer) Default: 0 How long has current Customer been Insured in Months? |
current_policy_started | integer (Days Since Policy Started) How Many Days Since Current Policy Started? |
current_policy_expires | integer (Days Until Policy Expires) How Many Days Until Current Policy Expires? |
current_company | any Names of Available Company |
bundle_insurance | boolean |
gender | string (Gender) Enum: "M" "F" "X" The gender of the consumer |
date_of_birth | string <date> |
height_inches | integer |
weight_pounds | integer |
household_size | integer |
pregnant | boolean Enum: true false |
tobacco_user | boolean Enum: true false |
preexisting_conditions | boolean Enum: true false |
denied_coverage | boolean Enum: true false |
social_security | boolean Enum: true false |
income | string |
aca_interest | boolean Enum: true false |
medicare_type | string |
{- "first_name": "Clark",
- "last_name": "Kent",
- "address": "123 Main St",
- "address2": "Apt 4",
- "phone": "6195551212",
- "email": "clark.kent@fakemail.com",
- "zipcode": "92101",
- "ip_address": "68.139.206.214",
- "phone_suffix": 1234,
- "user_agent": "Mozilla/5.0 (X11; Ubuntu; Linux i686; rv:15.0) Gecko/20100101 Firefox/15.0.1",
- "utm_source": "google",
- "utm_campaign": "string",
- "utm_medium": "string",
- "utm_content": "logolink or textlink",
- "utm_term": "running+shoes",
- "external_id": "123456789",
- "tcpa_call_consent": true,
- "tcpa_sms_consent": true,
- "tcpa_disclosure": "By submitting your quote request, you represent that you are at least 18 and agree to our Privacy Policy and Terms of Use. You also authorize UE.co and/or its marketing partners to contact you for marketing/telemarketing purposes at the number and address provided above, including your wireless number, if provided, using live operators, automated telephone dialing systems, pre-recorded messages, text messages and/or emails. You are not required to consent as a condition of purchasing goods or services and may revoke consent at anytime.",
- "tcpa_url": "example.com",
- "source_url": "example.com",
- "trusted_form_certificate_id": "433cb911f1698abec3a8c3514fad789c2541e823",
- "universal_lead_id": "e8959414-ba71-400a-b5d7-5cd3abede139",
- "form_begin": "2019-03-18T09:23:43.000Z",
- "form_submit": "2019-03-18T09:23:43.000Z",
- "coreg": false,
- "sub_1": "string",
- "sub_2": "string",
- "sub_3": "string",
- "custom": {
- "property1": "string",
- "property2": "string"
}, - "currently_insured": false,
- "continuous_coverage": 48,
- "current_customer": 48,
- "current_policy_started": 90,
- "current_policy_expires": 30,
- "current_company": null,
- "bundle_insurance": true,
- "gender": "F",
- "date_of_birth": "2019-08-24",
- "height_inches": 0,
- "weight_pounds": 0,
- "household_size": 0,
- "pregnant": true,
- "tobacco_user": true,
- "preexisting_conditions": true,
- "denied_coverage": true,
- "social_security": true,
- "income": "string",
- "aca_interest": true,
- "medicare_type": "string"
}
first_name | string (First Name) [ 2 .. 255 ] characters First Name of Primary Lead |
last_name | string (Last Name) [ 2 .. 255 ] characters Last Name of Primary Lead |
address | string (Address) <= 255 characters Address of Primary Lead |
address2 | string (Secondary Address) <= 255 characters Additional Address Information of Primary Lead |
phone | string (Telelphone Number) [ 10 .. 15 ] characters The phone number to contact the lead (numbers only, no formatting) |
string (Email Address) [ 3 .. 255 ] characters Best Email Address to contact consumer | |
zipcode | string (Zip Code (Postal Code)) [ 5 .. 10 ] characters ^[0-9]{5}$ Zipcode of Primary Lead |
ip_address | string (IP Address) [ 16 .. 45 ] characters IPv4 or IPv6 Address of Consumer when information was collected |
phone_suffix | string (Phone Suffix) 4 characters Last 4 Digits of Consumer Phone if Available |
user_agent | string (User Agent) <= 1024 characters User Agent of Consumer when information was collected |
utm_source | string Use utm_source to identify a search engine, newsletter name, or other source. |
utm_campaign | string Used for keyword analysis. Use utm_campaign to identify a specific product promotion or strategic campaign. |
utm_medium | string Use utm_medium to identify a medium such as email or cost-per- click. |
utm_content | string Used for A/B testing and content-targeted ads. Use utm_content to differentiate ads or links that point to the same URL. |
utm_term | string Used for paid search. Use utm_term to note the keywords for this ad. |
external_id | string (External ID) <= 255 characters Unique ID for Lead from Publisher |
tcpa_call_consent | boolean (TCPA Call Consent) Default: false Enum: true false Indicates whether the user has consented to a call. |
tcpa_sms_consent | boolean (TCPA SMS Consent) Default: false Enum: true false Indicates whether the user has consented to SMS/MMS. |
tcpa_disclosure | string (TCPA Disclosure) <= 255 characters Text displaying TCPA disclosure |
tcpa_url | string (TCPA Link Url) <= 255 characters Link to TCPA text. |
source_url | string (Source URL) <= 255 characters The URL of the web page the lead was generated on. |
trusted_form_certificate_id | string (Trusted Form Certificate Id) <= 255 characters 40+ character Trusted Form Certificate ID (path portion of their URL) Link |
universal_lead_id | string (Jornaya Lead ID) <= 36 characters Jornaya Lead ID for this lead Link |
form_begin | string <date-time> (Form Started Timestamp) Date and time that user starts form. Value must include a time zone. |
form_submit | string <date-time> (Form Submit Timestamp) Date and time that user submits form. Value must include a time zone. |
coreg | boolean (Is Co-Registration Lead) Default: false Enum: true false This Lead was generated using Co-Registration flows or techniques that may not have been the consumers original intent but may still be insterested in hearing about this vertical. |
sub_1 | string |
sub_2 | string |
sub_3 | string |
object | |
date_of_birth | string <date> (Date of Birth) |
home_ownership | boolean (Home Ownership) Default: false Enum: true false Whether the primary residence is owned by primary (true) or is not (false) |
Array of objects (Vehicle) |
{- "first_name": "Clark",
- "last_name": "Kent",
- "address": "123 Main St",
- "address2": "Apt 4",
- "phone": "6195551212",
- "email": "clark.kent@fakemail.com",
- "zipcode": "92101",
- "ip_address": "68.139.206.214",
- "phone_suffix": 1234,
- "user_agent": "Mozilla/5.0 (X11; Ubuntu; Linux i686; rv:15.0) Gecko/20100101 Firefox/15.0.1",
- "utm_source": "google",
- "utm_campaign": "string",
- "utm_medium": "string",
- "utm_content": "logolink or textlink",
- "utm_term": "running+shoes",
- "external_id": "123456789",
- "tcpa_call_consent": true,
- "tcpa_sms_consent": true,
- "tcpa_disclosure": "By submitting your quote request, you represent that you are at least 18 and agree to our Privacy Policy and Terms of Use. You also authorize UE.co and/or its marketing partners to contact you for marketing/telemarketing purposes at the number and address provided above, including your wireless number, if provided, using live operators, automated telephone dialing systems, pre-recorded messages, text messages and/or emails. You are not required to consent as a condition of purchasing goods or services and may revoke consent at anytime.",
- "tcpa_url": "example.com",
- "source_url": "example.com",
- "trusted_form_certificate_id": "433cb911f1698abec3a8c3514fad789c2541e823",
- "universal_lead_id": "e8959414-ba71-400a-b5d7-5cd3abede139",
- "form_begin": "2019-03-18T09:23:43.000Z",
- "form_submit": "2019-03-18T09:23:43.000Z",
- "coreg": false,
- "sub_1": "string",
- "sub_2": "string",
- "sub_3": "string",
- "custom": {
- "property1": "string",
- "property2": "string"
}, - "date_of_birth": "2019-08-24",
- "home_ownership": false,
- "vehicles": [
- {
- "current_mileage": 0,
- "make": "string",
- "model": "string",
- "trim": "string",
- "vin": "string",
- "year": 0
}
]
}
first_name | string (First Name) [ 2 .. 255 ] characters First Name of Primary Lead |
last_name | string (Last Name) [ 2 .. 255 ] characters Last Name of Primary Lead |
address | string (Address) <= 255 characters Address of Primary Lead |
address2 | string (Secondary Address) <= 255 characters Additional Address Information of Primary Lead |
phone | string (Telelphone Number) [ 10 .. 15 ] characters The phone number to contact the lead (numbers only, no formatting) |
string (Email Address) [ 3 .. 255 ] characters Best Email Address to contact consumer | |
zipcode | string (Zip Code (Postal Code)) [ 5 .. 10 ] characters ^[0-9]{5}$ Zipcode of Primary Lead |
ip_address | string (IP Address) [ 16 .. 45 ] characters IPv4 or IPv6 Address of Consumer when information was collected |
phone_suffix | string (Phone Suffix) 4 characters Last 4 Digits of Consumer Phone if Available |
user_agent | string (User Agent) <= 1024 characters User Agent of Consumer when information was collected |
utm_source | string Use utm_source to identify a search engine, newsletter name, or other source. |
utm_campaign | string Used for keyword analysis. Use utm_campaign to identify a specific product promotion or strategic campaign. |
utm_medium | string Use utm_medium to identify a medium such as email or cost-per- click. |
utm_content | string Used for A/B testing and content-targeted ads. Use utm_content to differentiate ads or links that point to the same URL. |
utm_term | string Used for paid search. Use utm_term to note the keywords for this ad. |
external_id | string (External ID) <= 255 characters Unique ID for Lead from Publisher |
tcpa_call_consent | boolean (TCPA Call Consent) Default: false Enum: true false Indicates whether the user has consented to a call. |
tcpa_sms_consent | boolean (TCPA SMS Consent) Default: false Enum: true false Indicates whether the user has consented to SMS/MMS. |
tcpa_disclosure | string (TCPA Disclosure) <= 255 characters Text displaying TCPA disclosure |
tcpa_url | string (TCPA Link Url) <= 255 characters Link to TCPA text. |
source_url | string (Source URL) <= 255 characters The URL of the web page the lead was generated on. |
trusted_form_certificate_id | string (Trusted Form Certificate Id) <= 255 characters 40+ character Trusted Form Certificate ID (path portion of their URL) Link |
universal_lead_id | string (Jornaya Lead ID) <= 36 characters Jornaya Lead ID for this lead Link |
form_begin | string <date-time> (Form Started Timestamp) Date and time that user starts form. Value must include a time zone. |
form_submit | string <date-time> (Form Submit Timestamp) Date and time that user submits form. Value must include a time zone. |
coreg | boolean (Is Co-Registration Lead) Default: false Enum: true false This Lead was generated using Co-Registration flows or techniques that may not have been the consumers original intent but may still be insterested in hearing about this vertical. |
sub_1 | string |
sub_2 | string |
sub_3 | string |
object | |
education | string Enum: "None" "Some High School" "High School" "GED" "Incomplete" "Some College" "Vocational" "Associate" "Bachelor" "Master" "PhD" "Law" "Unknown" "Other Nonprofessional Degree" "Other Professional Degree" |
job_category | string Enum: "Delivery Driver" "Cashier" "Stocker" "Sales" "Customer Service" "Clerical or Admin" "Package Handler" "IT" "Accounting" "Other" |
employment_status | string Enum: "Full Time" "Part Time" "Not Employed" "Self Employed" |
hs_graduation_year | integer |
interests_career | string Name of Career consumer is interested in being matched with |
military_affiliation | boolean Enum: true false |
interested_education | boolean Enum: true false |
interested_auto_repair | boolean Enum: true false |
interested_debt_consolidation | boolean Enum: true false |
Array of objects (Vehicles) Array of vehicles requesting to be included |
{- "first_name": "Clark",
- "last_name": "Kent",
- "address": "123 Main St",
- "address2": "Apt 4",
- "phone": "6195551212",
- "email": "clark.kent@fakemail.com",
- "zipcode": "92101",
- "ip_address": "68.139.206.214",
- "phone_suffix": 1234,
- "user_agent": "Mozilla/5.0 (X11; Ubuntu; Linux i686; rv:15.0) Gecko/20100101 Firefox/15.0.1",
- "utm_source": "google",
- "utm_campaign": "string",
- "utm_medium": "string",
- "utm_content": "logolink or textlink",
- "utm_term": "running+shoes",
- "external_id": "123456789",
- "tcpa_call_consent": true,
- "tcpa_sms_consent": true,
- "tcpa_disclosure": "By submitting your quote request, you represent that you are at least 18 and agree to our Privacy Policy and Terms of Use. You also authorize UE.co and/or its marketing partners to contact you for marketing/telemarketing purposes at the number and address provided above, including your wireless number, if provided, using live operators, automated telephone dialing systems, pre-recorded messages, text messages and/or emails. You are not required to consent as a condition of purchasing goods or services and may revoke consent at anytime.",
- "tcpa_url": "example.com",
- "source_url": "example.com",
- "trusted_form_certificate_id": "433cb911f1698abec3a8c3514fad789c2541e823",
- "universal_lead_id": "e8959414-ba71-400a-b5d7-5cd3abede139",
- "form_begin": "2019-03-18T09:23:43.000Z",
- "form_submit": "2019-03-18T09:23:43.000Z",
- "coreg": false,
- "sub_1": "string",
- "sub_2": "string",
- "sub_3": "string",
- "custom": {
- "property1": "string",
- "property2": "string"
}, - "education": "None",
- "job_category": "Delivery Driver",
- "employment_status": "Full Time",
- "hs_graduation_year": 0,
- "interests_career": "Cashier",
- "military_affiliation": true,
- "interested_education": true,
- "interested_auto_repair": true,
- "interested_debt_consolidation": true,
- "vehicles": [
- {
- "make": "string",
- "model": "string",
- "ownership": "own",
- "trim": "string",
- "year": 2017
}
]
}
first_name | string (First Name) [ 2 .. 255 ] characters First Name of Primary Lead |
last_name | string (Last Name) [ 2 .. 255 ] characters Last Name of Primary Lead |
address | string (Address) <= 255 characters Address of Primary Lead |
address2 | string (Secondary Address) <= 255 characters Additional Address Information of Primary Lead |
phone | string (Telelphone Number) [ 10 .. 15 ] characters The phone number to contact the lead (numbers only, no formatting) |
string (Email Address) [ 3 .. 255 ] characters Best Email Address to contact consumer | |
zipcode | string (Zip Code (Postal Code)) [ 5 .. 10 ] characters ^[0-9]{5}$ Zipcode of Primary Lead |
ip_address | string (IP Address) [ 16 .. 45 ] characters IPv4 or IPv6 Address of Consumer when information was collected |
phone_suffix | string (Phone Suffix) 4 characters Last 4 Digits of Consumer Phone if Available |
user_agent | string (User Agent) <= 1024 characters User Agent of Consumer when information was collected |
utm_source | string Use utm_source to identify a search engine, newsletter name, or other source. |
utm_campaign | string Used for keyword analysis. Use utm_campaign to identify a specific product promotion or strategic campaign. |
utm_medium | string Use utm_medium to identify a medium such as email or cost-per- click. |
utm_content | string Used for A/B testing and content-targeted ads. Use utm_content to differentiate ads or links that point to the same URL. |
utm_term | string Used for paid search. Use utm_term to note the keywords for this ad. |
external_id | string (External ID) <= 255 characters Unique ID for Lead from Publisher |
tcpa_call_consent | boolean (TCPA Call Consent) Default: false Enum: true false Indicates whether the user has consented to a call. |
tcpa_sms_consent | boolean (TCPA SMS Consent) Default: false Enum: true false Indicates whether the user has consented to SMS/MMS. |
tcpa_disclosure | string (TCPA Disclosure) <= 255 characters Text displaying TCPA disclosure |
tcpa_url | string (TCPA Link Url) <= 255 characters Link to TCPA text. |
source_url | string (Source URL) <= 255 characters The URL of the web page the lead was generated on. |
trusted_form_certificate_id | string (Trusted Form Certificate Id) <= 255 characters 40+ character Trusted Form Certificate ID (path portion of their URL) Link |
universal_lead_id | string (Jornaya Lead ID) <= 36 characters Jornaya Lead ID for this lead Link |
form_begin | string <date-time> (Form Started Timestamp) Date and time that user starts form. Value must include a time zone. |
form_submit | string <date-time> (Form Submit Timestamp) Date and time that user submits form. Value must include a time zone. |
coreg | boolean (Is Co-Registration Lead) Default: false Enum: true false This Lead was generated using Co-Registration flows or techniques that may not have been the consumers original intent but may still be insterested in hearing about this vertical. |
sub_1 | string |
sub_2 | string |
sub_3 | string |
object | |
gender | string |
date_of_birth | string <date> |
military_branch | string Enum: "None" "Air Force" "Army" "Coast Guard" "Marine Corps" "Navy" |
military_affiliation | string Enum: "None" "Active Duty(AD)" "Civilian" "Selective Reserve(SR)" "Spouse of AD or SR" "Veteran" |
high_school_graduation_year | integer |
high_school_gpa | float [ 0.1 .. 4 ] |
education_level | string Enum: "Haven't completed High School" "GED" "High School" "Some College" "Associate" "Bachelor" "Master" "Doctorate" |
college_credits | integer |
registered_nurse | boolean Enum: true false |
teaching_certificate | boolean Enum: true false |
us_citizen | boolean Enum: true false |
income | integer |
degree_level | string Enum: "Certificate / Diploma" "Associate" "Bachelor" "Master" "Doctorate" |
area_of_study | Array of strings Items Enum: "Art & Architecture" "Biological & Life Sciences" "Business" "Business & Communications" "Computers & Technology" "Criminal Justice & Legal" "Education" "Education & Teaching" "Engineering" "Fine Arts & Design" "Health & Medicine" "Health, Nursing, Medicine" "Humanities, Cultures & Languages" "Law, Military, Criminal Justice" "Liberal Arts & Humanities" "Math, Science & Engineering" "Mathematics, Earth & Physical Sciences" "Psychology" "Public Affairs & Social Sciences" "Religious Studies" "Social and Behavioral Sciences" "Technology" "Undecided" "Vocational Training" |
specialty | string |
planned_start_date | string <date> |
learning_preference | string Enum: "Campus Only" "Campus or Online" "Online Only" |
{- "first_name": "Clark",
- "last_name": "Kent",
- "address": "123 Main St",
- "address2": "Apt 4",
- "phone": "6195551212",
- "email": "clark.kent@fakemail.com",
- "zipcode": "92101",
- "ip_address": "68.139.206.214",
- "phone_suffix": 1234,
- "user_agent": "Mozilla/5.0 (X11; Ubuntu; Linux i686; rv:15.0) Gecko/20100101 Firefox/15.0.1",
- "utm_source": "google",
- "utm_campaign": "string",
- "utm_medium": "string",
- "utm_content": "logolink or textlink",
- "utm_term": "running+shoes",
- "external_id": "123456789",
- "tcpa_call_consent": true,
- "tcpa_sms_consent": true,
- "tcpa_disclosure": "By submitting your quote request, you represent that you are at least 18 and agree to our Privacy Policy and Terms of Use. You also authorize UE.co and/or its marketing partners to contact you for marketing/telemarketing purposes at the number and address provided above, including your wireless number, if provided, using live operators, automated telephone dialing systems, pre-recorded messages, text messages and/or emails. You are not required to consent as a condition of purchasing goods or services and may revoke consent at anytime.",
- "tcpa_url": "example.com",
- "source_url": "example.com",
- "trusted_form_certificate_id": "433cb911f1698abec3a8c3514fad789c2541e823",
- "universal_lead_id": "e8959414-ba71-400a-b5d7-5cd3abede139",
- "form_begin": "2019-03-18T09:23:43.000Z",
- "form_submit": "2019-03-18T09:23:43.000Z",
- "coreg": false,
- "sub_1": "string",
- "sub_2": "string",
- "sub_3": "string",
- "custom": {
- "property1": "string",
- "property2": "string"
}, - "gender": "string",
- "date_of_birth": "2019-08-24",
- "military_branch": "None",
- "military_affiliation": "None",
- "high_school_graduation_year": 0,
- "high_school_gpa": null,
- "education_level": "Haven't completed High School",
- "college_credits": 0,
- "registered_nurse": true,
- "teaching_certificate": true,
- "us_citizen": true,
- "income": 0,
- "degree_level": "Certificate / Diploma",
- "area_of_study": [
- "Art & Architecture"
], - "specialty": "string",
- "planned_start_date": "2019-08-24",
- "learning_preference": "Campus Only"
}
first_name | string (First Name) [ 2 .. 255 ] characters First Name of Primary Lead |
last_name | string (Last Name) [ 2 .. 255 ] characters Last Name of Primary Lead |
address | string (Address) <= 255 characters Address of Primary Lead |
address2 | string (Secondary Address) <= 255 characters Additional Address Information of Primary Lead |
phone | string (Telelphone Number) [ 10 .. 15 ] characters The phone number to contact the lead (numbers only, no formatting) |
string (Email Address) [ 3 .. 255 ] characters Best Email Address to contact consumer | |
zipcode | string (Zip Code (Postal Code)) [ 5 .. 10 ] characters ^[0-9]{5}$ Zipcode of Primary Lead |
ip_address | string (IP Address) [ 16 .. 45 ] characters IPv4 or IPv6 Address of Consumer when information was collected |
phone_suffix | string (Phone Suffix) 4 characters Last 4 Digits of Consumer Phone if Available |
user_agent | string (User Agent) <= 1024 characters User Agent of Consumer when information was collected |
utm_source | string Use utm_source to identify a search engine, newsletter name, or other source. |
utm_campaign | string Used for keyword analysis. Use utm_campaign to identify a specific product promotion or strategic campaign. |
utm_medium | string Use utm_medium to identify a medium such as email or cost-per- click. |
utm_content | string Used for A/B testing and content-targeted ads. Use utm_content to differentiate ads or links that point to the same URL. |
utm_term | string Used for paid search. Use utm_term to note the keywords for this ad. |
external_id | string (External ID) <= 255 characters Unique ID for Lead from Publisher |
tcpa_call_consent | boolean (TCPA Call Consent) Default: false Enum: true false Indicates whether the user has consented to a call. |
tcpa_sms_consent | boolean (TCPA SMS Consent) Default: false Enum: true false Indicates whether the user has consented to SMS/MMS. |
tcpa_disclosure | string (TCPA Disclosure) <= 255 characters Text displaying TCPA disclosure |
tcpa_url | string (TCPA Link Url) <= 255 characters Link to TCPA text. |
source_url | string (Source URL) <= 255 characters The URL of the web page the lead was generated on. |
trusted_form_certificate_id | string (Trusted Form Certificate Id) <= 255 characters 40+ character Trusted Form Certificate ID (path portion of their URL) Link |
universal_lead_id | string (Jornaya Lead ID) <= 36 characters Jornaya Lead ID for this lead Link |
form_begin | string <date-time> (Form Started Timestamp) Date and time that user starts form. Value must include a time zone. |
form_submit | string <date-time> (Form Submit Timestamp) Date and time that user submits form. Value must include a time zone. |
coreg | boolean (Is Co-Registration Lead) Default: false Enum: true false This Lead was generated using Co-Registration flows or techniques that may not have been the consumers original intent but may still be insterested in hearing about this vertical. |
sub_1 | string |
sub_2 | string |
sub_3 | string |
object | |
currently_insured | boolean (Currently Insured) Default: false Enum: true false Whether the primary consumer has a current valid policy (true) or not (false) |
continuous_coverage | integer (Continuos Coverage) Default: 0 How long has current Customer been continuously insured in months? |
current_customer | integer (Current Customer) Default: 0 How long has current Customer been Insured in Months? |
current_policy_started | integer (Days Since Policy Started) How Many Days Since Current Policy Started? |
current_policy_expires | integer (Days Until Policy Expires) How Many Days Until Current Policy Expires? |
current_company | any Names of Available Company |
bundle_insurance | boolean |
gender | string (Gender) Enum: "M" "F" "X" The gender of the consumer |
date_of_birth | string <date> |
height_inches | integer |
weight_pounds | integer |
household_size | integer |
pregnant | boolean Enum: true false |
tobacco_user | boolean Enum: true false |
preexisting_conditions | boolean Enum: true false |
denied_coverage | boolean Enum: true false |
social_security | boolean Enum: true false |
income | string |
aca_interest | boolean Enum: true false |
medicare_type | string Default: "None" Enum: "Medicare Supplement" "Medicare Advantage" "Medicare Part D" "Unspecified" "None" |
{- "first_name": "Clark",
- "last_name": "Kent",
- "address": "123 Main St",
- "address2": "Apt 4",
- "phone": "6195551212",
- "email": "clark.kent@fakemail.com",
- "zipcode": "92101",
- "ip_address": "68.139.206.214",
- "phone_suffix": 1234,
- "user_agent": "Mozilla/5.0 (X11; Ubuntu; Linux i686; rv:15.0) Gecko/20100101 Firefox/15.0.1",
- "utm_source": "google",
- "utm_campaign": "string",
- "utm_medium": "string",
- "utm_content": "logolink or textlink",
- "utm_term": "running+shoes",
- "external_id": "123456789",
- "tcpa_call_consent": true,
- "tcpa_sms_consent": true,
- "tcpa_disclosure": "By submitting your quote request, you represent that you are at least 18 and agree to our Privacy Policy and Terms of Use. You also authorize UE.co and/or its marketing partners to contact you for marketing/telemarketing purposes at the number and address provided above, including your wireless number, if provided, using live operators, automated telephone dialing systems, pre-recorded messages, text messages and/or emails. You are not required to consent as a condition of purchasing goods or services and may revoke consent at anytime.",
- "tcpa_url": "example.com",
- "source_url": "example.com",
- "trusted_form_certificate_id": "433cb911f1698abec3a8c3514fad789c2541e823",
- "universal_lead_id": "e8959414-ba71-400a-b5d7-5cd3abede139",
- "form_begin": "2019-03-18T09:23:43.000Z",
- "form_submit": "2019-03-18T09:23:43.000Z",
- "coreg": false,
- "sub_1": "string",
- "sub_2": "string",
- "sub_3": "string",
- "custom": {
- "property1": "string",
- "property2": "string"
}, - "currently_insured": false,
- "continuous_coverage": 48,
- "current_customer": 48,
- "current_policy_started": 90,
- "current_policy_expires": 30,
- "current_company": null,
- "bundle_insurance": true,
- "gender": "F",
- "date_of_birth": "2019-08-24",
- "height_inches": 0,
- "weight_pounds": 0,
- "household_size": 0,
- "pregnant": true,
- "tobacco_user": true,
- "preexisting_conditions": true,
- "denied_coverage": true,
- "social_security": true,
- "income": "string",
- "aca_interest": true,
- "medicare_type": "None"
}
first_name | string (First Name) [ 2 .. 255 ] characters First Name of Primary Lead |
last_name | string (Last Name) [ 2 .. 255 ] characters Last Name of Primary Lead |
address | string (Address) <= 255 characters Address of Primary Lead |
address2 | string (Secondary Address) <= 255 characters Additional Address Information of Primary Lead |
phone | string (Telelphone Number) [ 10 .. 15 ] characters The phone number to contact the lead (numbers only, no formatting) |
string (Email Address) [ 3 .. 255 ] characters Best Email Address to contact consumer | |
zipcode | string (Zip Code (Postal Code)) [ 5 .. 10 ] characters ^[0-9]{5}$ Zipcode of Primary Lead |
ip_address | string (IP Address) [ 16 .. 45 ] characters IPv4 or IPv6 Address of Consumer when information was collected |
phone_suffix | string (Phone Suffix) 4 characters Last 4 Digits of Consumer Phone if Available |
user_agent | string (User Agent) <= 1024 characters User Agent of Consumer when information was collected |
utm_source | string Use utm_source to identify a search engine, newsletter name, or other source. |
utm_campaign | string Used for keyword analysis. Use utm_campaign to identify a specific product promotion or strategic campaign. |
utm_medium | string Use utm_medium to identify a medium such as email or cost-per- click. |
utm_content | string Used for A/B testing and content-targeted ads. Use utm_content to differentiate ads or links that point to the same URL. |
utm_term | string Used for paid search. Use utm_term to note the keywords for this ad. |
external_id | string (External ID) <= 255 characters Unique ID for Lead from Publisher |
tcpa_call_consent | boolean (TCPA Call Consent) Default: false Enum: true false Indicates whether the user has consented to a call. |
tcpa_sms_consent | boolean (TCPA SMS Consent) Default: false Enum: true false Indicates whether the user has consented to SMS/MMS. |
tcpa_disclosure | string (TCPA Disclosure) <= 255 characters Text displaying TCPA disclosure |
tcpa_url | string (TCPA Link Url) <= 255 characters Link to TCPA text. |
source_url | string (Source URL) <= 255 characters The URL of the web page the lead was generated on. |
trusted_form_certificate_id | string (Trusted Form Certificate Id) <= 255 characters 40+ character Trusted Form Certificate ID (path portion of their URL) Link |
universal_lead_id | string (Jornaya Lead ID) <= 36 characters Jornaya Lead ID for this lead Link |
form_begin | string <date-time> (Form Started Timestamp) Date and time that user starts form. Value must include a time zone. |
form_submit | string <date-time> (Form Submit Timestamp) Date and time that user submits form. Value must include a time zone. |
coreg | boolean (Is Co-Registration Lead) Default: false Enum: true false This Lead was generated using Co-Registration flows or techniques that may not have been the consumers original intent but may still be insterested in hearing about this vertical. |
sub_1 | string |
sub_2 | string |
sub_3 | string |
object | |
credit_rating | string (Credit Rating) Enum: "Excellent" "Good" "Average" "Below average" "Poor" |
military_affiliation | string Enum: "None" "Active Duty(AD)" "Civilian" "Selective Reserve(SR)" "Spouse of AD or SR" "Veteran" |
property_foreclosure | boolean |
loan_interest_rate | float |
loan_type | string Enum: "Refinance" "Purchase" |
loan_amount | integer |
cash_out_amount | integer |
property_value | integer |
property_type | string Enum: "Condo" "Townhome" "Single Family" "Multi-Unit" "Mobile" |
property_use | string Enum: "Primary Residence" "Vacation Home" "Investment" |
current_va | boolean |
current_fha | boolean |
{- "first_name": "Clark",
- "last_name": "Kent",
- "address": "123 Main St",
- "address2": "Apt 4",
- "phone": "6195551212",
- "email": "clark.kent@fakemail.com",
- "zipcode": "92101",
- "ip_address": "68.139.206.214",
- "phone_suffix": 1234,
- "user_agent": "Mozilla/5.0 (X11; Ubuntu; Linux i686; rv:15.0) Gecko/20100101 Firefox/15.0.1",
- "utm_source": "google",
- "utm_campaign": "string",
- "utm_medium": "string",
- "utm_content": "logolink or textlink",
- "utm_term": "running+shoes",
- "external_id": "123456789",
- "tcpa_call_consent": true,
- "tcpa_sms_consent": true,
- "tcpa_disclosure": "By submitting your quote request, you represent that you are at least 18 and agree to our Privacy Policy and Terms of Use. You also authorize UE.co and/or its marketing partners to contact you for marketing/telemarketing purposes at the number and address provided above, including your wireless number, if provided, using live operators, automated telephone dialing systems, pre-recorded messages, text messages and/or emails. You are not required to consent as a condition of purchasing goods or services and may revoke consent at anytime.",
- "tcpa_url": "example.com",
- "source_url": "example.com",
- "trusted_form_certificate_id": "433cb911f1698abec3a8c3514fad789c2541e823",
- "universal_lead_id": "e8959414-ba71-400a-b5d7-5cd3abede139",
- "form_begin": "2019-03-18T09:23:43.000Z",
- "form_submit": "2019-03-18T09:23:43.000Z",
- "coreg": false,
- "sub_1": "string",
- "sub_2": "string",
- "sub_3": "string",
- "custom": {
- "property1": "string",
- "property2": "string"
}, - "credit_rating": "Excellent",
- "military_affiliation": "None",
- "property_foreclosure": true,
- "loan_interest_rate": null,
- "loan_type": "Refinance",
- "loan_amount": 0,
- "cash_out_amount": 0,
- "property_value": 0,
- "property_type": "Condo",
- "property_use": "Primary Residence",
- "current_va": true,
- "current_fha": true
}
first_name | string (First Name) [ 2 .. 255 ] characters First Name of Primary Lead |
last_name | string (Last Name) [ 2 .. 255 ] characters Last Name of Primary Lead |
address | string (Address) <= 255 characters Address of Primary Lead |
address2 | string (Secondary Address) <= 255 characters Additional Address Information of Primary Lead |
phone | string (Telelphone Number) [ 10 .. 15 ] characters The phone number to contact the lead (numbers only, no formatting) |
string (Email Address) [ 3 .. 255 ] characters Best Email Address to contact consumer | |
zipcode | string (Zip Code (Postal Code)) [ 5 .. 10 ] characters ^[0-9]{5}$ Zipcode of Primary Lead |
ip_address | string (IP Address) [ 16 .. 45 ] characters IPv4 or IPv6 Address of Consumer when information was collected |
phone_suffix | string (Phone Suffix) 4 characters Last 4 Digits of Consumer Phone if Available |
user_agent | string (User Agent) <= 1024 characters User Agent of Consumer when information was collected |
utm_source | string Use utm_source to identify a search engine, newsletter name, or other source. |
utm_campaign | string Used for keyword analysis. Use utm_campaign to identify a specific product promotion or strategic campaign. |
utm_medium | string Use utm_medium to identify a medium such as email or cost-per- click. |
utm_content | string Used for A/B testing and content-targeted ads. Use utm_content to differentiate ads or links that point to the same URL. |
utm_term | string Used for paid search. Use utm_term to note the keywords for this ad. |
external_id | string (External ID) <= 255 characters Unique ID for Lead from Publisher |
tcpa_call_consent | boolean (TCPA Call Consent) Default: false Enum: true false Indicates whether the user has consented to a call. |
tcpa_sms_consent | boolean (TCPA SMS Consent) Default: false Enum: true false Indicates whether the user has consented to SMS/MMS. |
tcpa_disclosure | string (TCPA Disclosure) <= 255 characters Text displaying TCPA disclosure |
tcpa_url | string (TCPA Link Url) <= 255 characters Link to TCPA text. |
source_url | string (Source URL) <= 255 characters The URL of the web page the lead was generated on. |
trusted_form_certificate_id | string (Trusted Form Certificate Id) <= 255 characters 40+ character Trusted Form Certificate ID (path portion of their URL) Link |
universal_lead_id | string (Jornaya Lead ID) <= 36 characters Jornaya Lead ID for this lead Link |
form_begin | string <date-time> (Form Started Timestamp) Date and time that user starts form. Value must include a time zone. |
form_submit | string <date-time> (Form Submit Timestamp) Date and time that user submits form. Value must include a time zone. |
coreg | boolean (Is Co-Registration Lead) Default: false Enum: true false This Lead was generated using Co-Registration flows or techniques that may not have been the consumers original intent but may still be insterested in hearing about this vertical. |
sub_1 | string |
sub_2 | string |
sub_3 | string |
object | |
gender | string (Gender) Enum: "M" "F" "X" Gender |
marital_status | string (Marital Status) Enum: "Married" "Single" Marital Status |
date_of_birth | string <date> (Date of Birth) Date of birth of the driver. (YYYY-MM-DD) |
best_time_to_contact | string (Best Time to Contact) Enum: "Morning" "Afternoon" "Evening" "Anytime" Best time to be contacted |
time_frame | string Enum: "Immediately" "1 to 6 months" "Not Sure" Start time frame of the project |
sub_vertical | string (Sub Vertical) Enum: "windows" "gutter" "roofing" "hvac" "solar" "bathroom" "flooring" "siding" "kitchen" "walk-in tubs" "plumbing" "home warranty" |
home_ownership | boolean (Home Ownership) Enum: true false Whether the primary residence is owned by primary (true) or is not (false) |
property_type | string (Property Type) Enum: "Single Family Home" "Multi Family Home" "Duplex" "Townhome" "Condominium" "Mobile Home" The building type of property |
project_type | string (Project Type) Enum: "Repair" "Replace" "New Installation" "Refinish" The project type of home service |
number_of_windows | integer (Number of Windows) Number of windows at property |
interested_gutter_covers | boolean (Interested Gutter Covers) Enum: true false Interested in gutter covers |
roof_material | string (Roof Material) Enum: "Asphalt Shingle" "Wood Shingle" "Tile" "Metal" "Slate" "Tar Torchdown" "Other / Not Sure" The roof material of the property |
walk_in_tubs_reason | string (Walk in Tubs Reason) Enum: "Safety" "Therapeutic" "Other" Walk in tubs reason |
reason | string Enum: "Safety" "Therapeutic" "Other" The reason of the walk-in tub setup |
bathroom_project_interest | string Enum: "Tub to Shower Conversion" "Shower Installation" "Bathroom Remodeling" "Fixture Upgrade" Bathroom project interest |
hvac_system_type | string Enum: "Furnace" "Heat Pump" "Boiler/Radiator" "Air Conditioner" Hvac system type |
hvac_energy_source | string Enum: "Natural Gas" "Oil" "Propane Gas" "Electricity" "Not Sure" Hvac energy source |
flooring_material | string Enum: "Linoleum" "Laminate" "Carpet" "Tile" "Wood" "Other" The material of the flooring |
project_scope | string Enum: "Labor Only" "Labor and Material" Scope of the project |
service_type | string Enum: "Bathtubs" "Commercial Industrial Plumbing" "Faucets Fixtures Pipes" "Gas Pipes" "General Repair" "Leak Detection and Repair" "Remodeling and Construction" "Sewer and Drain" "Showers" "Solar Water Heater System" "Sump Pump" "Tank" "Toilet" "Water Heater" "Water or Fuel Tank" "Water Treatment or Purification" "Well Pump" "Other" Service type |
siding_material | string Enum: "Vinyl" "Brick" "Stucco" "Wood" "Stone" "Cement" "Aluminum" "Other" The material of the siding |
kitchen_upgrade | string Enum: "Kitchen Remodel" "Cabinet Refacing" "Cabinet Install" "Other\"" The material of the siding |
square_footage | integer Measurement of the property in square footage |
electric_bill | integer Monthly average electric bill |
roof_shade | string Enum: "No Shade" "Partial Shade" "Full Shade" "Not Sure" How much sun exposure at the property |
current_utility_provider | string Who is your current utility provider |
{- "first_name": "Clark",
- "last_name": "Kent",
- "address": "123 Main St",
- "address2": "Apt 4",
- "phone": "6195551212",
- "email": "clark.kent@fakemail.com",
- "zipcode": "92101",
- "ip_address": "68.139.206.214",
- "phone_suffix": 1234,
- "user_agent": "Mozilla/5.0 (X11; Ubuntu; Linux i686; rv:15.0) Gecko/20100101 Firefox/15.0.1",
- "utm_source": "google",
- "utm_campaign": "string",
- "utm_medium": "string",
- "utm_content": "logolink or textlink",
- "utm_term": "running+shoes",
- "external_id": "123456789",
- "tcpa_call_consent": true,
- "tcpa_sms_consent": true,
- "tcpa_disclosure": "By submitting your quote request, you represent that you are at least 18 and agree to our Privacy Policy and Terms of Use. You also authorize UE.co and/or its marketing partners to contact you for marketing/telemarketing purposes at the number and address provided above, including your wireless number, if provided, using live operators, automated telephone dialing systems, pre-recorded messages, text messages and/or emails. You are not required to consent as a condition of purchasing goods or services and may revoke consent at anytime.",
- "tcpa_url": "example.com",
- "source_url": "example.com",
- "trusted_form_certificate_id": "433cb911f1698abec3a8c3514fad789c2541e823",
- "universal_lead_id": "e8959414-ba71-400a-b5d7-5cd3abede139",
- "form_begin": "2019-03-18T09:23:43.000Z",
- "form_submit": "2019-03-18T09:23:43.000Z",
- "coreg": false,
- "sub_1": "string",
- "sub_2": "string",
- "sub_3": "string",
- "custom": {
- "property1": "string",
- "property2": "string"
}, - "gender": "F",
- "marital_status": "Single",
- "date_of_birth": "1990-01-01T00:00:00.000Z",
- "best_time_to_contact": "Anytime",
- "time_frame": "Immediately",
- "sub_vertical": "windows",
- "home_ownership": true,
- "property_type": "Single Family Home",
- "project_type": "Repair",
- "number_of_windows": 6,
- "interested_gutter_covers": true,
- "roof_material": "Asphalt Shingle",
- "walk_in_tubs_reason": "Safety",
- "reason": "Therapeutic",
- "bathroom_project_interest": "Bathroom Remodeling",
- "hvac_system_type": "Air Conditioner",
- "hvac_energy_source": "Natural Gas",
- "flooring_material": "Wood",
- "project_scope": "Labor and Material",
- "service_type": "Other",
- "siding_material": "Vinyl",
- "kitchen_upgrade": "Kitchen Remodel",
- "square_footage": 240,
- "electric_bill": 154,
- "roof_shade": "Full Shade",
- "current_utility_provider": "San Diego Gas & Electric"
}