Astoria Company Mortgage Ping Post Direct Post Integration Instructions


Contents

IMPORTANT NOTE: PLEASE ENSURE YOU CAREFULLY FOLLOW THE TESTING INSTRUCTIONS ONCE YOU'VE COMPLETED THE INTEGRATION!




Introduction to Direct Post

Mortgage Ping Post Direct Post is a single-step integration process. Commonly, it is referred to as direct post, i.e. you send us a 'direct post' (including all PII) and we purchase the lead (we would respond with our payout) or we reject the lead.

Please review the following to complete the integration. When you believe you are ready, please follow these steps to test your integration.

Field names and acceptable values

The absence of any required field (Required) will result in an error. If you do not collect the data for a required field, please refer to the 'Suggested Default' column.
Preferred fields (Preferred) may be omitted, but doing so could reduce a lead's chances of finding a buyer.
Optional fields (Optional) can be omitted without any major impact.

Field Contents Suggested Default Required?
lead_type Determines the type of lead.
MUST be '27' for Mortgage Ping Post
27 Required
lead_mode Determines if the lead should be treated as a test lead or a live lead.
0 = TEST LEAD
1 = LIVE LEAD
Click here for full testing instructions.
Required
vendor_id This is the VID code you were provided by Astoria; if you do not know it, please contact us.
Please ensure you are using the correct code, otherwise your leads may be credited to another partner!
Required
sub_id Code of your choosing for your own tracking purposes, e.g. '123-ABC'
This should enable us to distinguish your lead sources from each other, so that we can optimize lead flow to buyers.
There is a maximum length of 35 characters, and it may only contain letters, numbers, underscores and hyphens.
Required
tcpa_optin Indicates whether or not the consumer was presented with, and accepted, unambiguous consent to be contacted via automated telephone systems pursuant to TCPA requirements.
0 = No
1 = Yes
Click here for more information.
0 Preferred
tcpa_text Contains the TCPA language the consumer was presented with on the form where their information was submitted,
e.g. 'By submitting this form…'
Click here for more information.
Preferred
universal_leadid Unique LeadiD as generated by LeadiD.com,
e.g. 'DEC47BA7-68A8-F712-8BC8-F9A4245F4FE2'
Required
origination_datetime Date/time when lead was submitted by consumer, in format 'YYYY-MM-DD hh:mm:ss',
e.g. '2019-05-19 14:08:41'
Required
origination_timezone The timezone for the date/time passed in origination_datetime.
1 = EST / EDT
2 = CST / CDT
3 = MST / MDT
4 = PST / PDT
Required
ipaddress Applicants IP address, e.g. '18.234.88.196' Required
user_agent The user agent string for the browser used by the applicant when their information was submitted,
e.g. 'CCBot/2.0 (https://commoncrawl.org/faq/)'
Preferred
vendor_lead_id Your internal ID for this lead (useful if we need to contact you about a specific lead and when processing returns),
e.g. '73916479'
Preferred
url URL of form where lead was generated, e.g. 'http://ratechecker.com/auto-insurance/' Preferred
first_name Applicants first name. Required
last_name Applicants last name. Required
email Email address Required
address Street Address Required
zip Valid 5-digit US Zip Code.
Can be used when lead_mode=0 to influence test results.
Click here for full testing instructions.
Required
primary_phone Primary phone number, exactly 10 digits (3 For PhoneAreaCode, 3 For PhoneExchange and 4 For PhoneSuffix ) no (), -, or spaces Required
secondary_phone Secondary phone number, exactly 10 digits (3 For PhoneAreaCode, 3 For PhoneExchange and 4 For PhoneSuffix ) no (), -, or spaces Optional
dob Applicants date of birth, in the format YYYY-MM-DD, e.g. '1994-03-13' Optional
employment_type Main source of income.
1 = Employed
2 = Self Employed
3 = Fixed Income
1 Required
income Annual Verifiable Income, no $, commas, or decimals Required
in_military Currently serving in the military?
0 = No
1 = Yes
0 Required
credit_rating Credit Rating
1 = Excellent
2 = Good
3 = Fair
4 = Poor
3 Required
bankruptcy Has applicant filed for bankruptcy within the last 7 years?
0 = No
1 = Yes
0 Required
loan_amount Required Loan Amount, no $, commas, or decimals Required
mortgage_lead_type What type of mortgage lead is this?
1 = New Purchase
2 = Refinance
3 = Home Equity Loan
4 = Reverse Mortgage
1 Required

If mortgage_lead_type = 1 (New Purchase) then the following fields are REQUIRED!

down_payment Applicants available down payment amount, as a percentage of home value (no % sign), e.g. 10 = 10%, 15 = 15%, etc. Required
spec_home Is this loan to purchase a spec home?
0 = No
1 = Yes
Required
buy_timeframe What is the timeframe for purchasing this home?
1 = Immediately
2 = Up to 30 days
3 = Up to 60 days
4 = Up to 90 days
5 = No time constraint
Required
agent_found Has applicant already found an agent?
0 = No
1 = Yes
Required
property_street Street Address of Property Optional
property_city City of Property Optional
property_state State of Property Optional
property_zip Zip of Property, valid 5-digit US Zip Code. Optional

If mortgage_lead_type = 2 (Refinance) then the following fields are REQUIRED!

first_balance Balance of first mortgage, no $, commas, or decimals Required
first_interest_rate Interest rate of first mortgage, decimals are OK, e.g. 3, 3.0, 3.125, etc. Required
second_balance Balance of second mortgage, no $, commas, or decimals Optional
second_interest_rate Interest rate of second mortgage, decimals are OK, e.g. 3, 3.0, 3.125, etc. Optional
property_street Street Address of Property Required
property_city City of Property Required
property_state State of Property Required
property_zip Zip of Property, valid 5-digit US Zip Code. Required

If mortgage_lead_type = 3 (Home Equity Loan) then the following fields are REQUIRED!

home_equity_type What type of home equity loan is being requested?
1 = Second Mortgage
2 = HELOC
3 = Not Sure
Required
first_balance Balance of first mortgage, no $, commas, or decimals Required
first_interest_rate Interest rate of first mortgage, decimals are OK, e.g. 3, 3.0, 3.125, etc. Required
second_balance Balance of second mortgage, no $, commas, or decimals Optional
second_interest_rate Interest rate of second mortgage, decimals are OK, e.g. 3, 3.0, 3.125, etc. Optional
additional_cash Amount of additional cash consumer would like to take out of property, no $, commas, or decimals Required
property_street Street Address of Property Required
property_city City of Property Required
property_state State of Property Required
property_zip Zip of Property, valid 5-digit US Zip Code. Required

If mortgage_lead_type = 4 (Reverse Mortgage) then the following fields are REQUIRED!

first_balance Balance of first mortgage, no $, commas, or decimals Required
first_interest_rate Interest rate of first mortgage, decimals are OK, e.g. 3, 3.0, 3.125, etc. Required
second_balance Balance of second mortgage, no $, commas, or decimals Optional
second_interest_rate Interest rate of second mortgage, decimals are OK, e.g. 3, 3.0, 3.125, etc. Optional
property_street Street Address of Property Required
property_city City of Property Required
property_state State of Property Required
property_zip Zip of Property, valid 5-digit US Zip Code. Required
property_use What is the intended property use?
1 = Primary Residence
2 = Second Home
3 = Investment Property
Required
property_desc What is the best description of this property?
1 = Single Family
2 = Multi Family
3 = Town House
4 = Condominium
5 = Mobile Home
Required
estimate_value Estimated value of property, no $, commas, or decimals Required
rate_type What is the consumers desired interest rate type?
1 = Fixed Rate
2 = Adjustable Rate
3 = Fixed/Adjustable
Required
ltv_percentage Loan-To-Value (LTV) as a percentage (no % sign), e.g. 100 = 100%, 95 = 95%, etc.
NOTE: If you omit this field, we will calculate it on our end according to our buyers requirements)
Optional
bank_foreclosure Is this property a bank foreclosure?
0 = No
1 = Yes
0 Required
num_mortgage_lates How many mortgage lates has this applicant had previously? 0 Required
va_loan Is this a VA loan?
0 = No
1 = Yes
0 Required
comments Please pass any extra comments in this field. Optional

Additional Requirements

To be considered for a loan, a customer must:

  • Reside in the United States

Sending a Direct Post Request

Direct Post Request Using HTTP/1.1 POST

Our POST URL is https://api.astoriacompany.com/v2/direct/. Please do not begin posting with lead_mode=1 until we have manually verified your test data (in addition to our automatic validation process), and we've explicitly notified you that your campaign has been activated within our system. Any leads posted to the live address while your campaign is still in test mode will return an error and neither be counted nor returned.

The data in the request should be URLENCODED to ensure it is received as intended.

Example Request

URL: https://api.astoriacompany.com/v2/direct/
Content-Type: application/x-www-form-urlencoded

lead_type=27&lead_mode=0&vendor_id=76&sub_id=6&tcpa_optin=1&tcpa_text=By+submitting+this+form...&universal_leadid=DEC47BA7-68A8-F712-8BC8-F9A4245F4FE2&origination_datetime=2019-05-19+14%3A08%3A41&origination_timezone=1&ipaddress=18.234.88.196&user_agent=CCBot%2F2.0+%28https%3A%2F%2Fcommoncrawl.org%2Ffaq%2F%29&vendor_lead_id=73916479&url=http%3A%2F%2Fratechecker.com%2Fpayday%2F&tier=ALL&first_name=John&last_name=Smith&email=test%40test.com&address=123+High+Street&zip=35222&primary_phone=6105551212&residence_type=1&years_at_residence=3&months_at_residence=0&ssn=123456789&license_number=123456&license_state=PA&employer=Big+Company%2C+LLC&job_title=Shop+Foreman&best_time_contact=1&employment_in_year=3&employment_in_month=0&loan_amount=5000

Back to contents




Post Responses

This is exact text that will definitely be present.
This indicates variable data, or nodes that may or may not be present.

Accept:

NOTE: An 'Accept' response on the POST indicates we HAVE purchased the lead. The 'Response' tag will always contain 'Accepted', but the 'Confirmation' code and the 'Price' will differ for each response.

<PostResponse>
<Response>Accepted</Response>
<Confirmation>12345678901</Confirmation>
<Price>6.00</Price><Reason></Reason>
<Message></Message>
</PostResponse>

Reject:

NOTE: There are many reasons why we might reject a post - below you will see all the possible rejection responses. The 'Response' tag will always contain 'Rejected', and the 'Price' will always be '0.00'. The 'Confirmation' code will differ for each response.

For rejected responses, we also add two extra tags: 'Reason' tells you why the lead was rejected, and 'Message' gives some more descriptive text.

Also, where 'Reason' is 'Errors Detected', we add an 'Errors' section with a separate 'Error' node for each error - see the example below! This is designed to help you troubleshoot and fix any errors found.

<PostResponse>
<Response>Rejected</Response>
<Confirmation>12345678901</Confirmation>
<Price>0.00</Price>
<Reason>Unable to Monetize</Reason>
<Message>All buyers rejected this lead (IF POSSIBLE, WE WILL ATTEMPT TO EXPLAIN WHY HERE)</Message>
</PostResponse>

<PostResponse>
<Response>Rejected</Response>
<Confirmation>12345678901</Confirmation>
<Price>0.00</Price>
<Reason>Unable to Monetize</Reason>
<Message>Bids do not meet minimum_price requirement</Message>
</PostResponse>

<PostResponse>
<Response>Rejected</Response>
<Confirmation>12345678901</Confirmation>
<Price>0.00</Price>
<Reason>Maintenance Mode</Reason>
<Message>Our system is currently in maintenance mode</Message>
</PostResponse>

<PostResponse>
<Response>Rejected</Response>
<Confirmation>12345678901</Confirmation>
<Price>0.00</Price>
<Reason>Post data is empty</Reason>
<Message>Please check your integration</Message>
</PostResponse>

<PostResponse>
<Response>Rejected</Response>
<Confirmation>12345678901</Confirmation>
<Price>0.00</Price>
<Reason>Invalid lead_type</Reason>
<Message>Please pass a valid lead_type as per our specs</Message>
</PostResponse>

<PostResponse>
<Response>Rejected</Response>
<Confirmation>12345678901</Confirmation>
<Price>0.00</Price>
<Reason>Invalid lead_type for this vendor_id</Reason>
<Message>You are not currently approved to send leads of the given lead_type</Message>
</PostResponse>

<PostResponse>
<Response>Rejected</Response>
<Confirmation>12345678901</Confirmation>
<Price>0.00</Price>
<Reason>Invalid lead_mode</Reason>
<Message>Please ensure lead_mode is either '0' for TEST or '1' for LIVE</Message>
</PostResponse>

<PostResponse>
<Response>Rejected</Response>
<Confirmation>12345678901</Confirmation>
<Price>0.00</Price>
<Reason>Invalid vendor_id</Reason>
<Message>Please check the vendor_id is correct</Message>
</PostResponse>

<PostResponse>
<Response>Rejected</Response>
<Confirmation>12345678901</Confirmation>
<Price>0.00</Price>
<Reason>Provided vendor_id is in TEST MODE</Reason>
<Message>Please contact us if you believe your account should be in LIVE MODE</Message>
</PostResponse>

<PostResponse>
<Response>Rejected</Response>
<Confirmation>12345678901</Confirmation>
<Price>0.00</Price>
<Reason>Daily Cap Exhausted</Reason>
<Message>Please contact us to increase your daily cap</Message>
</PostResponse>

<PostResponse>
<Response>Rejected</Response>
<Confirmation>12345678901</Confirmation>
<Price>0.00</Price>
<Reason>Per Minute Cap Exhausted</Reason>
<Message>Please contact us to increase your per minute cap</Message>
</PostResponse>

<PostResponse>
<Response>Rejected</Response>
<Confirmation>12345678901</Confirmation>
<Price>0.00</Price>
<Reason>Errors Detected</Reason>
<Message>The following errors were detected in this lead:</Message>
<Errors>
<Error>1</Error>
<Error>2</Error>
<Error>3</Error>
</Errors>
</PostResponse>

<PostResponse>
<Response>Rejected</Response>
<Confirmation>12345678901</Confirmation>
<Price>0.00</Price>
<Reason>Duplicate Lead</Reason>
<Message>Lead was identified as a duplicate in our system</Message>
</PostResponse>

<PostResponse>
<Response>Rejected</Response>
<Confirmation>12345678901</Confirmation>
<Price>0.00</Price>
<Reason>Blacklisted Data</Reason>
<Message>The lead matches data on our internal blacklist - please investigate the lead source</Message>
</PostResponse>

Back to contents




Sample Post Code

Here is some sample PHP code to help you create your call to our API. This is simple stuff, so you should be able to readily convery it into another programming language if necessary.

$apiUrl = 'https://api.astoriacompany.com/v2/direct/';
$headers = array('Content-Type: application/x-www-form-urlencoded');

$request = 'lead_type=27&lead_mode=0&vendor_id=76&sub_id=6&tcpa_optin=1&tcpa_text=By+submitting+this+form...&universal_leadid=DEC47BA7-68A8-F712-8BC8-F9A4245F4FE2&origination_datetime=2019-05-19+14%3A08%3A41&origination_timezone=1&ipaddress=18.234.88.196&user_agent=CCBot%2F2.0+%28https%3A%2F%2Fcommoncrawl.org%2Ffaq%2F%29&vendor_lead_id=73916479&url=http%3A%2F%2Fratechecker.com%2Fpayday%2F&tier=ALL&first_name=John&last_name=Smith&email=test%40test.com&address=123+High+Street&zip=35222&primary_phone=6105551212&residence_type=1&years_at_residence=3&months_at_residence=0&ssn=123456789&license_number=123456&license_state=PA&employer=Big+Company%2C+LLC&job_title=Shop+Foreman&best_time_contact=1&employment_in_year=3&employment_in_month=0&loan_amount=5000';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $apiUrl);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $request);

$response = curl_exec($ch);
curl_close($ch);

Back to contents




Common Mistakes

  • Values must be URL encoded. For example, james.doe@example.com should be james.doe%40example.com and 4 Pennsylvania Plaza should be 4+Pennsylvania+Plaza.
  • All field names and explicitly allowed values (employment_in_month, is_rented, income_payment_type, etc.) are case-sensitive.
  • Passing unlisted values (for example: family for reference_relationship1) will result in errors. Likewise, do not pass empty fields; instead omit the fields.
  • Out-of-range or logically impossible values, like stay_in_month=100, or stay_in_year=100 when dob=1980, will fail.
  • Remember to set lead_mode=1 when you go live!

Back to contents




Testing

For testing, i.e. when lead_mode=0, please omit the 'tier' parameter (or use 'tier=ALL'), and attempt at least three different leads, each with a different zip code. One should end with and even number, one should end with an odd number, and one should end with a 0 (zero). The responses generated will vary based on the zip code used, as follows:

  • If you POST a test lead with a zip code that ends with a ZERO (e.g. 19460) or an ODD number (e.g. 19461), you will receive the 'No Coverage' response, i.e. it will be REJECTED.
  • If you POST a test lead with a zip code that ends with an EVEN number (e.g. 19462), it will be ACCEPTED.

Please email all of the post requests AND their corresponding responses to tech@astoriacompany.com so that we can verify the tests and activate your account.

Testing via a Third Party Service

If you are having issues getting the response you expect, please use hurl.it or a similar service to hit our API with the following settings (refer to this image):

  1. Go to: hurl.it
  2. Select 'POST' in the first dropdown
  3. For the URL, enter: https://api.astoriacompany.com/v2/direct/
  4. Add a Header: 'Content-Type' with a value of 'application/x-www-form-urlencoded'
  5. Paste your post request into the 'Parameters' text area
  6. Click: Launch Request

Back to contents