MVA Exchange API Specification document

Fields

The following fields will be captured by this campaign. For examples of how to submit these fields, please see the examples below.

Field Name	Type	Format	PING Required	POST Required	Description
lp_campaign_id	Numeric	123, -12.34	Yes	Yes	Must be set to: 6309
lp_supplier_id	Numeric	123, -12.34	Yes	Yes	Must be set to: 12465
lp_key	Text	Text	Yes	Yes	Must be set to: yq0h0jphvp5
lp_action	Text	Text	No	No	Send test for testing
lp_ping_id	Text	Text	No	Yes	`ping_id` value retrieved from PING response
lp_subid1	Text	Text	No	No	sub_id1, max 75 chars
lp_subid2	Text	Text	No	No	sub_id2, max 75 chars
first_name	Text	Text	No	Yes	Any text
last_name	Text	Text	No	Yes	Any text
phone	Phone	6503271100	No	Yes	10 digits
email	Email	[email protected]	No	Yes	Valid formatted email address
address	Text	Text	No	No	Any text
city	Text	Text	Yes	Yes	Any text
state	State	CA, NY	Yes	Yes	Any valid US state, 2 letter
zip_code	Postal code	78124	Yes	Yes	5 digit
gender	Multiple values, one choice	Text	No	No	Allowed values: male female
incident_date	Age	2015-07-21	Yes	Yes	Format: YYYY-MM-DD
physical_injury	Multiple values, one choice	Text	Yes	Yes	Allowed values: yes no
currently_represented	Multiple values, one choice	Text	Yes	Yes	Allowed values: yes no
at_fault	Multiple values, one choice	Text	Yes	Yes	Allowed values: yes no
police_report	Multiple values, one choice	Text	No	No	Allowed values: yes no
case_description	Text	Text	Yes	Yes	Any text
ip_address	IP address	127.0.0.1	Yes	Yes	IPv4, IPv6
user_agent	Text	Text	Yes	Yes	Any text
landing_page	URL	http(s)://example.com	Yes	Yes	The url page where the lead was generated
tcpa_text	Text	Text	Yes	Yes	Any text
jornaya_lead_id	Text	Text	No	No	Any text
trusted_form_cert_url	Text	Text	No	No	https://cert.trustedform.com/xxxxxx
sub_id1	Text	Text	Yes	Yes	Any text
sub_id2	Text	Text	No	No	Any text
sub_id3	Text	Text	No	No	Any text
sub_id4	Text	Text	No	No	Any text

IMPORTANT: fields are case sensitive. first_name is not the same as First_Name

Active filters

The table below contains the active filters.

Name	Action	Condition	Value(s)
Field: currently_represented	block	equal to	Yes
Field: physical_injury	block	equal to	No
Field: at_fault	block	equal to	Yes
Field: email_valid	block	matches exactly	1 records
Field: phone_valid	block	matches exactly	1 records
Field: accident_limit_exceeded	block	matches exactly	1 records
Field: description_bad_words	block	matches exactly	1 records
Field: description_enough_words	block	matches exactly	1 records
Field: description_gibberish	block	matches exactly	1 records
Field: name_bad_word	block	matches exactly	1 records
Field: name_gibberish	block	matches exactly	1 records
Field: both_jornaya_and_tf_are_missing	block	matches exactly	1 records
Field: landing_page_valid	block	matches exactly	1 records
Field: phone	block	matches exactly	1 records
Field: sub_id1	block	matches exactly	10 records
Field: landing_page	block	contains	1 records
Field: _tf_landing_page_valid	block	matches exactly	1 records
Field: trusted_form_cert_url	block	matches exactly	1 records

* Contact your campaign manager to get more details about these filters.

PING

We only accept POST HTTP requests. Requests can be sent either as FORM or JSON.

Method:	POST
URL:	https://example.leadprosper.tech/leadprosper/ping
FORM	Headers: Content-Type: application/x-www-form-urlencoded Payload: `lp_campaign_id=6309&lp_supplier_id=12465&lp_key=yq0h0jphvp5&lp_action=&lp_subid1=&lp_subid2=&zip_code=90018&ip_address=41.83.228.117&user_agent=Mozilla/5.0 (X11; Linux i686) AppleWebKit/5340 (KHTML, like Gecko) Chrome/39.0.808.0 Mobile Safari/5340&physical_injury=yes&at_fault=no&incident_date=1956-03-19&case_description=New&state=CA&city=Harrisborough&landing_page=https://example.com/voluptatem¤tly_represented=yes&tcpa_text=Spurs&sub_id1=yellow` HTTP Copy
JSON	Headers: Content-Type: application/json Payload: { "lp_campaign_id": "6309", "lp_supplier_id": "12465", "lp_key": "yq0h0jphvp5", "lp_action": "", "lp_subid1": "", "lp_subid2": "", "zip_code": 90018, "ip_address": "41.83.228.117", "user_agent": "Mozilla/5.0 (X11; Linux i686) AppleWebKit/5340 (KHTML, like Gecko) Chrome/39.0.808.0 Mobile Safari/5340", "physical_injury": "yes", "at_fault": "no", "incident_date": "1956-03-19", "case_description": "New", "state": "CA", "city": "Harrisborough", "landing_page": "https://example.com/voluptatem", "currently_represented": "yes", "tcpa_text": "Spurs", "sub_id1": "yellow" } JSON Copy

Possible Responses

All responses are sent back in JSON format. There are 2 possible responses: ACCEPTED, and ERROR.

Accepted

{
    "ping_id": "90e2b41b-00d6-4ccc-b224-f0c982d0cab8",
    "status": "ACCEPTED",
    "code": 0,
    "message": "",
    "bids": [
        {
            "bid_id": "940575ca-12f3-4a7f-8e72-d03a8aae3612",
            "payout": 12.34
        }
    ]
}

Error

{
    "ping_id": "90e2b2fa-514f-47a8-8e55-2f75abf88aee",
    "status": "ERROR",
    "code": 1032,
    "message": "Error: PING rejected",
    "bids": []
}

POST

We only accept POST HTTP requests. Requests can be sent either as FORM or JSON.

Method:	POST
URL:	https://example.leadprosper.tech/leadprosper/post
FORM	Headers: Content-Type: application/x-www-form-urlencoded Payload: lp_campaign_id=6309&lp_supplier_id=12465&lp_key=yq0h0jphvp5&lp_action=&lp_ping_id=90e2b41b-00d6-4ccc-b224-f0c982d0cab8&lp_subid1=&lp_subid2=&first_name=Concepcion&last_name=Everett&phone=6313278775&[email protected]&address=930 Rodrick Walk Apt. 175&city=Harrisborough&state=CA&zip_code=90018&gender=female&incident_date=1956-03-19&physical_injury=yes¤tly_represented=yes&at_fault=no&police_report=yes&case_description=New&ip_address=41.83.228.117&user_agent=Mozilla/5.0 (X11; Linux i686) AppleWebKit/5340 (KHTML, like Gecko) Chrome/39.0.808.0 Mobile Safari/5340&landing_page=https://example.com/voluptatem&tcpa_text=Spurs&jornaya_lead_id=3002675E-6002-4F07-BB80-99C86E91F5FA&trusted_form_cert_url=https://cert.trustedform.com/b57458240078e430953bdf9fe5ab4cd18f734749&sub_id1=yellow&sub_id2=silver&sub_id3=New&sub_id4=April HTTP Copy
JSON	Headers: Content-Type: application/json Payload: { "lp_campaign_id": "6309", "lp_supplier_id": "12465", "lp_key": "yq0h0jphvp5", "lp_action": "", "lp_ping_id": "90e2b41b-00d6-4ccc-b224-f0c982d0cab8", "lp_subid1": "", "lp_subid2": "", "first_name": "Concepcion", "last_name": "Everett", "phone": "6313278775", "email": "[email protected]", "address": "930 Rodrick Walk Apt. 175", "city": "Harrisborough", "state": "CA", "zip_code": 90018, "gender": "female", "incident_date": "1956-03-19", "physical_injury": "yes", "currently_represented": "yes", "at_fault": "no", "police_report": "yes", "case_description": "New", "ip_address": "41.83.228.117", "user_agent": "Mozilla/5.0 (X11; Linux i686) AppleWebKit/5340 (KHTML, like Gecko) Chrome/39.0.808.0 Mobile Safari/5340", "landing_page": "https://example.com/voluptatem", "tcpa_text": "Spurs", "jornaya_lead_id": "3002675E-6002-4F07-BB80-99C86E91F5FA", "trusted_form_cert_url": "https://cert.trustedform.com/b57458240078e430953bdf9fe5ab4cd18f734749", "sub_id1": "yellow", "sub_id2": "silver", "sub_id3": "New", "sub_id4": "April" } JSON Copy

Possible Responses

All responses are sent back in JSON format. There are 3 possible responses: ACCEPTED, DUPLICATED, ERROR.

Accepted

{
    "id": "19a63c72-8709-4256-b099-09eb07c6f810",
    "lead_id": "b59OMX4B8J-QmL7XJ211",
    "status": "ACCEPTED",
    "code": 0,
    "message": "",
    "payout": 12.34
}

Duplicated

{
    "id": "1d79d5c8-cf7a-4800-806e-b9b8bf2c96b9",
    "lead_id": "b59OMX4B8J-QmL7XJ211",
    "status": "DUPLICATED",
    "code": 1009,
    "message": "Error: duplicate lead",
    "payout": 0
}

Error

{
    "id": "f2be15b3-291b-4677-8a4e-75af489740e2",
    "lead_id": "b59OMX4B8J-QmL7XJ211",
    "status": "ERROR",
    "code": 1006,
    "message": "Error: lead rejected",
    "payout": 0
}

Testing

If you wish to test your setup to ensure that all the fields are correctly sent, you can add the following parameters to the API URL. Please note that testing will skip any configured filters or any cap limits.

Parameter	Value	Description
lp_action	test	Required for testing only

Error codes

Code	Message
1018	Error: account inactive
1048	Error: buyer budget cap exceeded
1040	Error: buyer configuration changed between PING and POST request
1016	Error: buyer configuration error
1024	Error: buyer configuration is incomplete
1041	Error: buyer excluded by lp_bids
1039	Error: buyer was not found in the PING request
1042	Error: buyer was not successful in the PING request
1000,1022,1031	Error: could not process request. Contact your campaign manager
1011,1012	Error: could not process request. The campaign is paused. Contact your campaign manager
1007,1008,1009	Error: duplicate lead
1003	Error: field has wrong format
1002	Error: field is required
1034	Error: invalid lp_ping_id
1001	Error: invalid request URL
1015,1017	Error: lead failed validation
1005,1006,1013,1019,1020,1021,1025,1026,1046	Error: lead rejected
1010,1027,1028	Error: lead rejected - cap reached
1038	Error: lp_bids contains invalid bid(s)
1043	Error: lp_ping_id was already processed
1014	Error: missing or invalid field value
1032,1033	Error: PING rejected
1036	Error: POST data does not match PING data
1037	Error: POST not accepted due to PING failure
1035	Error: POST sent outside of PING timeout window
1044	Error: pre-ping dupe checker is not enabled on this campaign
1045	Error: skipped by repost configuration
1047	Error: supplier budget cap exceeded
1004,1029,1030	Rejected by filter

Help

Questions? Please email: [email protected]