Third party lead integration endpoint. Please make a POST request to our leads endpoint at https://www.americanfinancing.net/v2/leads. The request will need a JSON body containing the key/value pairs listed below.
Back to Top
Leads
Submit a lead
Endpoint
POST /v2/leads
Parameters
| Name | Description | Example | Accepted Inputs |
|---|---|---|---|
| first_name required | First name of borrower | Frida | |
| last_name required | Last name of borrower | Kahlo | |
| email required | Valid email address of borrower | frida.kahlo@gmail.com | |
| phone required | 10-digit phone number of borrower | 1234567890 | |
| zip_code | 5-digit zip code of borrower | 12345 | |
| us_state required | US state of residence | Colorado or CO | |
| loan_type required | purchase or refinance | refinance | |
| medium required | Marketing Channel | Affiliate | "Affiliate", "Email", "Display", etc. |
| source required | Marketing parameter | Your Company Name | |
| campaign required | Marketing parameter | AFC Leads Campaign | |
| term | Marketing Campaign Type | Home Improvement Loan | |
| collected_at required | ISO8601 format DateTime (preferred) or Date | 2022-09-28 12:47:25 -0600 | |
| tracking_id | Lead specific tracking id | 12334567865432123456 |
Request
Route
POST /v2/leads
Headers
Content-Type: application/json
Host: https://www.americanfinancing.net
Cookie: None
Authorization: Token your_private_afc_api_token_hereBody
{
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@gmail.net",
"phone": "+15555555555",
"us_state": "co",
"loan_type": "purchase",
"collected_at": "2022-09-28T12:47:25.090-06:00",
"source": "OnlineLeadGenerators.com",
"campaign": "Refinance Long Form",
"medium": "Affiliate"
}Response
Simulated Response
Status
201Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
ETag: W/"65360f2d5973634cd970cf77621f4a68"
Cache-Control: max-age=0, private, must-revalidate
Content-Security-Policy: connect-src 'self' https: http://localhost:3035 ws://localhost:3035
X-Request-Id: 1c7e13ab-20d0-4eee-b8e7-040aed652b4d
X-Runtime: 0.844464
Vary: Origin
Content-Length: 679Body
{
"id": 22,
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@gmail.net",
"phone": "5555555555",
"zip": null,
"type": "purchase",
"source": "OnlineLeadGenerators.com",
"endorser": "Refinance Long Form",
"internet_source": "Affiliate",
"created_at": "2022-09-28T13:47:25.870-06:00",
"updated_at": "2022-09-28T13:47:25.870-06:00",
"session_uuid": null,
"original_endorser": "Refinance Long Form",
"borrower_timezone_offset": null,
"original_source": "OnlineLeadGenerators.com",
"submitted_at": null,
"_ga": null,
"gclid": null,
"source_ip": null,
"msclkid": null,
"tracking_id": null,
"collected_on": null,
"collected_at": "2022-09-28T12:47:25.090-06:00",
"state": "Colorado",
"cid": null,
"nal": false,
"campaign_type": null
}Error: Missing required fields
Endpoint
POST /v2/leads
Parameters
| Name | Description | Example | Accepted Inputs |
|---|---|---|---|
| first_name required | First name of borrower | Frida | |
| last_name required | Last name of borrower | Kahlo | |
| email required | Valid email address of borrower | frida.kahlo@gmail.com | |
| phone required | 10-digit phone number of borrower | 1234567890 | |
| zip_code | 5-digit zip code of borrower | 12345 | |
| us_state required | US state of residence | Colorado or CO | |
| loan_type required | purchase or refinance | refinance | |
| medium required | Marketing Channel | Affiliate | "Affiliate", "Email", "Display", etc. |
| source required | Marketing parameter | Your Company Name | |
| campaign required | Marketing parameter | AFC Leads Campaign | |
| term | Marketing Campaign Type | Home Improvement Loan | |
| collected_at required | ISO8601 format DateTime (preferred) or Date | 2022-09-28 12:47:25 -0600 | |
| tracking_id | Lead specific tracking id | 12334567865432123456 |
Request
Route
POST /v2/leads
Headers
Content-Type: application/json
Host: https://www.americanfinancing.net
Cookie: None
Authorization: Token your_private_afc_api_token_hereBody
{
"first_name": "Jane",
"last_name": "Doe",
"phone": "5555555555",
"zip_code": "99999",
"us_state": "Colorado",
"loan_type": "purchase",
"collected_at": "2022-09-28T12:47:25.978-06:00",
"source": "OnlineLeadGenerators.com",
"campaign": "Refinance Long Form",
"medium": "Affiliate"
}Response
Simulated Response
Status
422Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Content-Security-Policy: connect-src 'self' https: http://localhost:3035 ws://localhost:3035
X-Request-Id: af159af9-7418-40e0-ac45-9bf5ca9f5b43
X-Runtime: 0.285192
Vary: Origin
Content-Length: 48Body
[
"Email can't be blank",
"Email is not an email"
]Error: Invalid parameter value
Endpoint
POST /v2/leads
Parameters
| Name | Description | Example | Accepted Inputs |
|---|---|---|---|
| first_name required | First name of borrower | Frida | |
| last_name required | Last name of borrower | Kahlo | |
| email required | Valid email address of borrower | frida.kahlo@gmail.com | |
| phone required | 10-digit phone number of borrower | 1234567890 | |
| zip_code | 5-digit zip code of borrower | 12345 | |
| us_state required | US state of residence | Colorado or CO | |
| loan_type required | purchase or refinance | refinance | |
| medium required | Marketing Channel | Affiliate | "Affiliate", "Email", "Display", etc. |
| source required | Marketing parameter | Your Company Name | |
| campaign required | Marketing parameter | AFC Leads Campaign | |
| term | Marketing Campaign Type | Home Improvement Loan | |
| collected_at required | ISO8601 format DateTime (preferred) or Date | 2022-09-28 12:47:25 -0600 | |
| tracking_id | Lead specific tracking id | 12334567865432123456 |
Request
Route
POST /v2/leads
Headers
Content-Type: application/json
Host: https://www.americanfinancing.net
Cookie: None
Authorization: Token your_private_afc_api_token_hereBody
{
"first_name": "Jane",
"last_name": "Doe",
"phone": "5555555555",
"email": "jane.doe@gmail.net",
"us_state": "Ontario",
"loan_type": "refinance",
"collected_at": "2022-09-28T12:47:26.286-06:00",
"source": "OnlineLeadGenerators.com",
"campaign": "Refinance Long Form",
"medium": "Affiliate"
}Response
Simulated Response
Status
422Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Content-Security-Policy: connect-src 'self' https: http://localhost:3035 ws://localhost:3035
X-Request-Id: 98f10a33-15ae-4eac-83b5-3b388c027731
X-Runtime: 0.025508
Vary: Origin
Content-Length: 65Body
[
"Us state must be a US state, either full name or abbreviation"
]PurchaseApplication
Third party purchase application integration endpoint. Please make a POST request to our purchase application endpoint at https://www.americanfinancing.net/v2/purchase_applications. The request will need a JSON body containing the key/value pairs listed below. All values that can be placed under the primary_borrower key can also be provided for a co_borrower.
Submit a purchase application with only required data points
Endpoint
POST /v2/purchase_applications
Parameters
| Name | Description | Example | Accepted Inputs |
|---|---|---|---|
| property_down_payment_percentage | Percentage of purchase price for down payment | 20 | |
| property_down_payment_source | Source of down payment | Savings | |
| property_down_payment | Amount of down payment | 60000 | |
| property_price | Price of the purchase property | 300000 | |
| area_address | Area of the purchase property | Denver | |
| area_city | City of the purchase property area | Denver | |
| area_state required | State of the purchase property area | Colorado | |
| area_zip | Zip code of the purchase property area | 80112 | |
| property_city | City of the address of the purchase property | Denver | |
| property_state | State of the address of the purchase property | Colorado | |
| property_address | Street address of the purchase property | 123 Main St. | |
| property_zip | Zip code of the purchase property | 45678 | |
| medium required | Marketing Channel | Affiliate | "Affiliate", "Email", "Display", etc. |
| source required | Marketing parameter | Request this from American Financing | |
| campaign required | Marketing parameter | Request this from American Financing | |
| term | Marketing Campaign Type | Home Improvement Loan | |
| collected_at required | Optimal date format is ISO-8601. Most common UTC date formats, such as YYYY-MM-DD, are also supported. | 2022-09-28 12:47:25 -0600 | |
| primary_borrower[first_name] required | First name of borrower | Frida | |
| primary_borrower[last_name] required | Last name of borrower | Kahlo | |
| primary_borrower[email] required | Valid email address of borrower | frida.kahlo@gmail.com | |
| primary_borrower[phone] required | 10-digit phone number of borrower | 1234567890 | |
| tracking_id | Lead specific tracking id | 12334567865432123456 | |
| property_type | Type of property | Condo | Single Family, Townhome, Condo, Multiple Unit |
| borrower_years_on_job | Borrower consecutive years at current employment | 4 | |
| borrower_marital_status | Borrower marital status | Married | Married, Unmarried, Separated |
| borrower_property_intent | How will borrower use the property | Investment property | Primary residence, Second home, Investment property |
| occupancy_type | How will borrower occupy residence | Owner Occupied | Owner Occupied, Not Owner Occupied |
| multiple_unit_type | Integer indicating multiplex units: 2, 3, or 4 | 3 | 2, 3, 4 |
| condo_type | Type of condo | High Rise Condo | High Rise Condo, Condominium |
| military_service | Boolean value borrower military service | false | true, false |
| self_rated_credit | Borrower credit score | 710 | |
| military_projected_service_end | Date of end of borrower miliary service YYYY-MM-DD | 2025-04-28 | |
| borrower_former_bankruptcy_type | Type of bankruptcy | Chapter13 | Chapter7, Chapter11, Chapter12, Chapter13 |
| coborrower_former_bankruptcy_type | Type of bankruptcy | Chapter13 | Chapter7, Chapter11, Chapter12, Chapter13 |
| dependents_ages | Array of ages of dependents | [1, 3, 13] | |
| dependents_count | Number of dependents borrower has | 3 | |
| borrower_former_foreclosure | Boolean value borrower had a foreclosure | false | true, false |
| foreclosure_date | Date of forclosure YYYY-MM-DD | 2020-04-13 | |
| former_pre_foreclosure | Boolean value borrower had a pre-foreclosure | true | true, false |
| pre_foreclosure_date | Date of pre-forclosure YYYY-MM-DD | 2020-04-13 | |
| coborrower_former_bankruptcy | Boolean value coborrower has former bankruptcy | false | true, false |
| coborrower_former_foreclosure | Boolean value coborrower has former foreclosure | false | true, false |
| borrower_former_bankruptcy | Boolean value borrower has former bankruptcy | false | true, false |
| military_active_duty | Boolean value borrower is active military | false | true, false |
| military_retired_or_discharged | Boolean value borrower military or discharged | false | true, false |
| military_surviving_spouse | Boolean value borrower is surviing spouse of military | false | true, false |
| property_mixed_use | Boolean value property will be residential and business | false | true, false |
| borrower_former_pre_foreclosure | Boolean value borrower has former pre-foreclosure | false | true, false |
| coborrower_former_pre_foreclosure | Boolean value coborrower has former pre-foreclosure | false | true, false |
| military_non_activated_member | Boolean value borrower is non-active miliary | false | true, false |
| working_with_realtor | Boolean value borrower currently has a realtor | true | true, false |
| realtor_introduction | Boolean value borrower would like to be introduced to a realtor | true | true, false |
| realtor_name | Name of borrower's realtor | Joan Del Arco | |
| realtor_phone | 10 digit phone number of borrower's realtor | 3334445555 | |
| realtor_email | Valid email of borrower's realtor | joan.del.arco@example.com | |
| primary_borrower[citizenship_residency_type] | Type of citizen residency | USCitizen | USCitizen, PermanentResidentAlien, NonPermanentResidentAlien |
| primary_borrower[continuous_employment] | Boolean value borrower has had two years of continuous employment | true | true, false |
| primary_borrower[dob] | YYYY-MM-DD of the borrower date of birth | 1985-11-15 | |
| primary_borrower[email] | Valid email of borrower | borrower_name@example.com | |
| primary_borrower[ethnicity_origin_type] | Ethnicity origin type | Mexican | Mexican, Puerto Rican, Cuban |
| primary_borrower[ethnicity_origin_type_other_desc] | Description of origin type | Peruvian | |
| primary_borrower[ethnicity_refused] | Boolean value does not provide ethnicity | true | true, false |
| primary_borrower[ethnicity_type] | Ethnicity type | NonHispanicOrLatino | HispanicOrLatino, NonHispanicOrLatino |
| primary_borrower[gender_refused] | Boolean value does not probide gender | true | true, false |
| primary_borrower[gender_type] | Gender type | Female | Female, Male |
| primary_borrower[homeownership_past_3_years] | Boolean value has owned a home in the last three years | true | true, false |
| primary_borrower[income_type] | Employment type | retirement | employment, self-employed, social-security, retirement |
| primary_borrower[outstanding_judgments] | Boolean value has outstanding judgements | true | true, false |
| primary_borrower[party_to_lawsuit] | Boolean value is party to a lawsuit | true | true, false |
| primary_borrower[presently_delinquent] | Boolean value is presently delinquient | true | true, false |
| primary_borrower[prior_property_title_type] | Prior property title type | JointWithOtherThanSpouse | Sole, JointWithSpouse, JointWithOtherThanSpouse |
| primary_borrower[prior_property_usage_type] | Prior property usage type | FhaSecondaryResidence | PrimaryResidence, SecondHome, Investment, FhaSecondaryResidence |
| primary_borrower[race_designation_other_asian_desc] | Other Asian description | Hmong | |
| primary_borrower[race_designation_other_pacific_islander_desc] | Other Pacific Islander description | Fijian | |
| primary_borrower[race_designation_type] | Race designation type | Vietnamese | AsianIndian, Chinese, Filipino, Japanese, Korean, Vietnamese, NativeHawaiian, GuamanianOrChamorro, Samoan |
| primary_borrower[race_refused] | Boolean value does not provide race | true | true, false |
| primary_borrower[race_type] | Race type | BlackOrAfricanAmerican | AmericanIndianOrAlaskaNative, Asian, NativeHawaiianOrOtherPacificIslander, BlackOrAfricanAmerican, White |
| primary_borrower[race_type_additional_desc] | Enrolled/principal tribe | Tribe Name | |
| primary_borrower[residences_past_2yrs] | Integer number of borrower residences | 1 | |
| primary_borrower[self_employed] | Boolean value is self employed | true | true, false |
| primary_borrower[ssn] | Borrower social security number | 123-45-6789 | |
| primary_borrower[suffix] | Borrower name suffix | Esq. | |
| primary_borrower[time_in_property] | Integer years borrower has owned purchase property | 3 | |
| primary_borrower[undisclosed_borrowed_funds] | Boolean value has undisclosed funds | true | true, false |
| primary_borrower[undisclosed_borrowed_funds_amount] | Integer amount of undisclosed funds | 10000 | |
| primary_borrower[undisclosed_comaker_of_note] | Boolean value is comaker of note | true | true, false |
| primary_borrower[occupy_as_primary_residence] | Boolean value occupies home as primary residence | true | true, false |
| primary_borrower[special_seller_relationship] | Boolean value has special relationship to seller | true | true, false |
| primary_borrower[undisclosed_mortgage_application] | Boolean value has undisclosed mortgage application | true | true, false |
| primary_borrower[undisclosed_credit_application] | Boolean value has undisclosed credit application | true | true, false |
| primary_borrower[conveyed_title] | Boolean value has conveyed title | true | true, false |
| primary_borrower[incomes][start_on] | Date format MM-YYYY | 02-2012 | |
| primary_borrower[incomes][end_on] | Date format MM-YYYY | 02-2012 | |
| primary_borrower[incomes][income_type] | Type of income | retirement | employment, self-employed, social-security, retirement |
| primary_borrower[incomes][name] | Name of the employment or employer | My Great Company | |
| primary_borrower[incomes][yearly_income] | Integer yearly income | 60000 | |
| primary_borrower[properties][address] | Purchase property street address | 123 Main St. | |
| primary_borrower[properties][city] | Purchase property city | Denver | |
| primary_borrower[properties][state] | Purchase property state | Colorado | |
| primary_borrower[properties][zip] | Purchase property zip code | 55555 | |
| primary_borrower[properties][move_in_on] | MM-YYYY Move in on date for this property | 04-2012 | |
| property_down_payment_source | Asset which will be used for down payment | Savings | |
| property_down_payment_percentage | Percent of purchase price that the down payment will cover | 20 | |
| first_time_buyer | Boolean value borrower is first time buyer | true | |
| assets[source] | Type of asset | Savings | |
| assets[name] | Name of asset | Bank of Banking Savings Account | |
| assets[amount] | Amount of money in asset | 30000 | |
| assets[id] | ID for an asset | 12345 | |
| assets[owner] | Owner of the asset | Tom |
Request
Route
POST /v2/purchase_applications
Headers
Content-Type: application/json
Host: https://www.americanfinancing.net
Cookie: None
Authorization: Token your_private_afc_api_token_hereBody
{
"primary_borrower": {
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@gmail.net",
"phone": "5555555555"
},
"area_state": "Colorado",
"collected_at": "2022-09-28T12:47:26.330-06:00",
"source": "OnlineLeadGenerators.com",
"campaign": "Refinance Long Form",
"medium": "Affiliate"
}Response
Simulated Response
Status
201Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
ETag: W/"3d9aa7e0ce265257667a72f4ab8af63d"
Cache-Control: max-age=0, private, must-revalidate
Content-Security-Policy: connect-src 'self' https: http://localhost:3035 ws://localhost:3035
X-Request-Id: 3537e212-d73a-413b-8fd6-85b0111f1c8b
X-Runtime: 0.536579
Vary: Origin
Content-Length: 2550Body
{
"id": 64,
"internet_protocol": null,
"loan_purpose": "purchase",
"source": "OnlineLeadGenerators.com",
"endorser": "Refinance Long Form",
"internet_source": "Affiliate",
"_ga": null,
"property_address": null,
"property_city": null,
"property_state": null,
"property_zip": null,
"property_type": null,
"property_price": null,
"property_down_payment": null,
"area_address": null,
"area_city": null,
"area_state": "Colorado",
"area_zip": null,
"borrower_years_on_job": null,
"borrower_marital_status": null,
"realtor_name": null,
"realtor_phone": null,
"realtor_email": null,
"working_with_realtor": null,
"realtor_introduction": null,
"created_at": "2022-09-28T13:47:26.695-06:00",
"updated_at": "2022-09-28T13:47:26.695-06:00",
"condo_type": null,
"multiple_unit_type": null,
"session_uuid": null,
"slug": "GXaQYP5OEd",
"current_step": "property_area",
"breadcrumbs": [
],
"military_service": null,
"self_rated_credit": null,
"borrower_property_intent": null,
"occupancy_type": null,
"bankruptcy_date": null,
"bankruptcy_type": null,
"short": false,
"dependents_ages": null,
"dependents_count": 0,
"borrower_former_foreclosure": null,
"foreclosure_date": null,
"former_pre_foreclosure": null,
"pre_foreclosure_date": null,
"borrower_consented": null,
"fallout_reason": [
],
"credit_check_consented": null,
"aggregate_id": "611f3768-3f66-11ed-8f23-0242ac140008",
"dm_call": false,
"property_down_payment_source": null,
"property_down_payment_percentage": null,
"ob_loan_option_details": null,
"initial_underwriting_status": null,
"initial_portal_created": null,
"dm_completed_at": null,
"app_complete": false,
"stale_for": null,
"saved_for_later": false,
"original_endorser": "Refinance Long Form",
"loan_already_in_progress": null,
"borrower_timezone_offset": null,
"asset_verification_id": null,
"original_source": "OnlineLeadGenerators.com",
"first_time_buyer": null,
"borrower_ssn_last_four": null,
"converted_at": null,
"test_variation": null,
"gclid": null,
"assisted": false,
"coborrower_former_bankruptcy": null,
"coborrower_former_foreclosure": null,
"borrower_former_bankruptcy": null,
"source_ip": null,
"msclkid": null,
"marketing_keyword": null,
"military_active_duty": null,
"military_retired_or_discharged": null,
"military_surviving_spouse": null,
"property_mixed_use": null,
"borrower_former_pre_foreclosure": null,
"coborrower_former_pre_foreclosure": null,
"borrower_former_bankruptcy_type": null,
"coborrower_former_bankruptcy_type": null,
"military_projected_service_end": null,
"military_non_activated_member": null,
"how_did_you_hear_about_us": null,
"tracking_id": null,
"collected_on": null,
"collected_at": "2022-09-28T12:47:26.330-06:00",
"cid": null,
"nal": false,
"marketing_variant": null,
"campaign_type": null
}Submit a purchase application with some optional data points
Endpoint
POST /v2/purchase_applications
Parameters
| Name | Description | Example | Accepted Inputs |
|---|---|---|---|
| property_down_payment_percentage | Percentage of purchase price for down payment | 20 | |
| property_down_payment_source | Source of down payment | Savings | |
| property_down_payment | Amount of down payment | 60000 | |
| property_price | Price of the purchase property | 300000 | |
| area_address | Area of the purchase property | Denver | |
| area_city | City of the purchase property area | Denver | |
| area_state required | State of the purchase property area | Colorado | |
| area_zip | Zip code of the purchase property area | 80112 | |
| property_city | City of the address of the purchase property | Denver | |
| property_state | State of the address of the purchase property | Colorado | |
| property_address | Street address of the purchase property | 123 Main St. | |
| property_zip | Zip code of the purchase property | 45678 | |
| medium required | Marketing Channel | Affiliate | "Affiliate", "Email", "Display", etc. |
| source required | Marketing parameter | Request this from American Financing | |
| campaign required | Marketing parameter | Request this from American Financing | |
| term | Marketing Campaign Type | Home Improvement Loan | |
| collected_at required | Optimal date format is ISO-8601. Most common UTC date formats, such as YYYY-MM-DD, are also supported. | 2022-09-28 12:47:25 -0600 | |
| primary_borrower[first_name] required | First name of borrower | Frida | |
| primary_borrower[last_name] required | Last name of borrower | Kahlo | |
| primary_borrower[email] required | Valid email address of borrower | frida.kahlo@gmail.com | |
| primary_borrower[phone] required | 10-digit phone number of borrower | 1234567890 | |
| tracking_id | Lead specific tracking id | 12334567865432123456 | |
| property_type | Type of property | Condo | Single Family, Townhome, Condo, Multiple Unit |
| borrower_years_on_job | Borrower consecutive years at current employment | 4 | |
| borrower_marital_status | Borrower marital status | Married | Married, Unmarried, Separated |
| borrower_property_intent | How will borrower use the property | Investment property | Primary residence, Second home, Investment property |
| occupancy_type | How will borrower occupy residence | Owner Occupied | Owner Occupied, Not Owner Occupied |
| multiple_unit_type | Integer indicating multiplex units: 2, 3, or 4 | 3 | 2, 3, 4 |
| condo_type | Type of condo | High Rise Condo | High Rise Condo, Condominium |
| military_service | Boolean value borrower military service | false | true, false |
| self_rated_credit | Borrower credit score | 710 | |
| military_projected_service_end | Date of end of borrower miliary service YYYY-MM-DD | 2025-04-28 | |
| borrower_former_bankruptcy_type | Type of bankruptcy | Chapter13 | Chapter7, Chapter11, Chapter12, Chapter13 |
| coborrower_former_bankruptcy_type | Type of bankruptcy | Chapter13 | Chapter7, Chapter11, Chapter12, Chapter13 |
| dependents_ages | Array of ages of dependents | [1, 3, 13] | |
| dependents_count | Number of dependents borrower has | 3 | |
| borrower_former_foreclosure | Boolean value borrower had a foreclosure | false | true, false |
| foreclosure_date | Date of forclosure YYYY-MM-DD | 2020-04-13 | |
| former_pre_foreclosure | Boolean value borrower had a pre-foreclosure | true | true, false |
| pre_foreclosure_date | Date of pre-forclosure YYYY-MM-DD | 2020-04-13 | |
| coborrower_former_bankruptcy | Boolean value coborrower has former bankruptcy | false | true, false |
| coborrower_former_foreclosure | Boolean value coborrower has former foreclosure | false | true, false |
| borrower_former_bankruptcy | Boolean value borrower has former bankruptcy | false | true, false |
| military_active_duty | Boolean value borrower is active military | false | true, false |
| military_retired_or_discharged | Boolean value borrower military or discharged | false | true, false |
| military_surviving_spouse | Boolean value borrower is surviing spouse of military | false | true, false |
| property_mixed_use | Boolean value property will be residential and business | false | true, false |
| borrower_former_pre_foreclosure | Boolean value borrower has former pre-foreclosure | false | true, false |
| coborrower_former_pre_foreclosure | Boolean value coborrower has former pre-foreclosure | false | true, false |
| military_non_activated_member | Boolean value borrower is non-active miliary | false | true, false |
| working_with_realtor | Boolean value borrower currently has a realtor | true | true, false |
| realtor_introduction | Boolean value borrower would like to be introduced to a realtor | true | true, false |
| realtor_name | Name of borrower's realtor | Joan Del Arco | |
| realtor_phone | 10 digit phone number of borrower's realtor | 3334445555 | |
| realtor_email | Valid email of borrower's realtor | joan.del.arco@example.com | |
| primary_borrower[citizenship_residency_type] | Type of citizen residency | USCitizen | USCitizen, PermanentResidentAlien, NonPermanentResidentAlien |
| primary_borrower[continuous_employment] | Boolean value borrower has had two years of continuous employment | true | true, false |
| primary_borrower[dob] | YYYY-MM-DD of the borrower date of birth | 1985-11-15 | |
| primary_borrower[email] | Valid email of borrower | borrower_name@example.com | |
| primary_borrower[ethnicity_origin_type] | Ethnicity origin type | Mexican | Mexican, Puerto Rican, Cuban |
| primary_borrower[ethnicity_origin_type_other_desc] | Description of origin type | Peruvian | |
| primary_borrower[ethnicity_refused] | Boolean value does not provide ethnicity | true | true, false |
| primary_borrower[ethnicity_type] | Ethnicity type | NonHispanicOrLatino | HispanicOrLatino, NonHispanicOrLatino |
| primary_borrower[gender_refused] | Boolean value does not probide gender | true | true, false |
| primary_borrower[gender_type] | Gender type | Female | Female, Male |
| primary_borrower[homeownership_past_3_years] | Boolean value has owned a home in the last three years | true | true, false |
| primary_borrower[income_type] | Employment type | retirement | employment, self-employed, social-security, retirement |
| primary_borrower[outstanding_judgments] | Boolean value has outstanding judgements | true | true, false |
| primary_borrower[party_to_lawsuit] | Boolean value is party to a lawsuit | true | true, false |
| primary_borrower[presently_delinquent] | Boolean value is presently delinquient | true | true, false |
| primary_borrower[prior_property_title_type] | Prior property title type | JointWithOtherThanSpouse | Sole, JointWithSpouse, JointWithOtherThanSpouse |
| primary_borrower[prior_property_usage_type] | Prior property usage type | FhaSecondaryResidence | PrimaryResidence, SecondHome, Investment, FhaSecondaryResidence |
| primary_borrower[race_designation_other_asian_desc] | Other Asian description | Hmong | |
| primary_borrower[race_designation_other_pacific_islander_desc] | Other Pacific Islander description | Fijian | |
| primary_borrower[race_designation_type] | Race designation type | Vietnamese | AsianIndian, Chinese, Filipino, Japanese, Korean, Vietnamese, NativeHawaiian, GuamanianOrChamorro, Samoan |
| primary_borrower[race_refused] | Boolean value does not provide race | true | true, false |
| primary_borrower[race_type] | Race type | BlackOrAfricanAmerican | AmericanIndianOrAlaskaNative, Asian, NativeHawaiianOrOtherPacificIslander, BlackOrAfricanAmerican, White |
| primary_borrower[race_type_additional_desc] | Enrolled/principal tribe | Tribe Name | |
| primary_borrower[residences_past_2yrs] | Integer number of borrower residences | 1 | |
| primary_borrower[self_employed] | Boolean value is self employed | true | true, false |
| primary_borrower[ssn] | Borrower social security number | 123-45-6789 | |
| primary_borrower[suffix] | Borrower name suffix | Esq. | |
| primary_borrower[time_in_property] | Integer years borrower has owned purchase property | 3 | |
| primary_borrower[undisclosed_borrowed_funds] | Boolean value has undisclosed funds | true | true, false |
| primary_borrower[undisclosed_borrowed_funds_amount] | Integer amount of undisclosed funds | 10000 | |
| primary_borrower[undisclosed_comaker_of_note] | Boolean value is comaker of note | true | true, false |
| primary_borrower[occupy_as_primary_residence] | Boolean value occupies home as primary residence | true | true, false |
| primary_borrower[special_seller_relationship] | Boolean value has special relationship to seller | true | true, false |
| primary_borrower[undisclosed_mortgage_application] | Boolean value has undisclosed mortgage application | true | true, false |
| primary_borrower[undisclosed_credit_application] | Boolean value has undisclosed credit application | true | true, false |
| primary_borrower[conveyed_title] | Boolean value has conveyed title | true | true, false |
| primary_borrower[incomes][start_on] | Date format MM-YYYY | 02-2012 | |
| primary_borrower[incomes][end_on] | Date format MM-YYYY | 02-2012 | |
| primary_borrower[incomes][income_type] | Type of income | retirement | employment, self-employed, social-security, retirement |
| primary_borrower[incomes][name] | Name of the employment or employer | My Great Company | |
| primary_borrower[incomes][yearly_income] | Integer yearly income | 60000 | |
| primary_borrower[properties][address] | Purchase property street address | 123 Main St. | |
| primary_borrower[properties][city] | Purchase property city | Denver | |
| primary_borrower[properties][state] | Purchase property state | Colorado | |
| primary_borrower[properties][zip] | Purchase property zip code | 55555 | |
| primary_borrower[properties][move_in_on] | MM-YYYY Move in on date for this property | 04-2012 | |
| property_down_payment_source | Asset which will be used for down payment | Savings | |
| property_down_payment_percentage | Percent of purchase price that the down payment will cover | 20 | |
| first_time_buyer | Boolean value borrower is first time buyer | true | |
| assets[source] | Type of asset | Savings | |
| assets[name] | Name of asset | Bank of Banking Savings Account | |
| assets[amount] | Amount of money in asset | 30000 | |
| assets[id] | ID for an asset | 12345 | |
| assets[owner] | Owner of the asset | Tom |
Request
Route
POST /v2/purchase_applications
Headers
Content-Type: application/json
Host: https://www.americanfinancing.net
Cookie: None
Authorization: Token your_private_afc_api_token_hereBody
{
"primary_borrower": {
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@gmail.net",
"phone": "5555555555"
},
"co_borrower": {
"first_name": "Susan",
"last_name": "Anthony",
"email": "susan.b@vote.org",
"phone": "1919191920"
},
"asset": {
"name": "MyAccount",
"amount": "100000"
},
"area_state": "Colorado",
"collected_at": "2022-09-28T12:47:26.890-06:00",
"source": "OnlineLeadGenerators.com",
"term": "Home Improvement Loan",
"campaign": "Refinance Long Form",
"medium": "Affiliate",
"military_service": false,
"property_type": "Townhome"
}Response
Simulated Response
Status
201Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
ETag: W/"703304eb6e48c899f6a8d816f4f8e8de"
Cache-Control: max-age=0, private, must-revalidate
Content-Security-Policy: connect-src 'self' https: http://localhost:3035 ws://localhost:3035
X-Request-Id: aebc12f8-1af7-43ea-a40c-5ce03cb379dc
X-Runtime: 0.048298
Vary: Origin
Content-Length: 2595Body
{
"id": 65,
"internet_protocol": null,
"loan_purpose": "purchase",
"source": "OnlineLeadGenerators.com",
"endorser": "Refinance Long Form",
"internet_source": "Affiliate",
"_ga": null,
"property_address": null,
"property_city": null,
"property_state": null,
"property_zip": null,
"property_type": "Townhome",
"property_price": null,
"property_down_payment": null,
"area_address": null,
"area_city": null,
"area_state": "Colorado",
"area_zip": null,
"borrower_years_on_job": null,
"borrower_marital_status": null,
"realtor_name": null,
"realtor_phone": null,
"realtor_email": null,
"working_with_realtor": null,
"realtor_introduction": null,
"created_at": "2022-09-28T13:47:26.931-06:00",
"updated_at": "2022-09-28T13:47:26.931-06:00",
"condo_type": null,
"multiple_unit_type": null,
"session_uuid": null,
"slug": "8f7tAzjxvh",
"current_step": "property_area",
"breadcrumbs": [
],
"military_service": false,
"self_rated_credit": null,
"borrower_property_intent": null,
"occupancy_type": null,
"bankruptcy_date": null,
"bankruptcy_type": null,
"short": false,
"dependents_ages": null,
"dependents_count": 0,
"borrower_former_foreclosure": null,
"foreclosure_date": null,
"former_pre_foreclosure": null,
"pre_foreclosure_date": null,
"borrower_consented": null,
"fallout_reason": [
],
"credit_check_consented": null,
"aggregate_id": "6142ea46-3f66-11ed-8f23-0242ac140008",
"dm_call": false,
"property_down_payment_source": null,
"property_down_payment_percentage": null,
"ob_loan_option_details": null,
"initial_underwriting_status": null,
"initial_portal_created": null,
"dm_completed_at": null,
"app_complete": false,
"stale_for": null,
"saved_for_later": false,
"original_endorser": "Refinance Long Form",
"loan_already_in_progress": null,
"borrower_timezone_offset": null,
"asset_verification_id": null,
"original_source": "OnlineLeadGenerators.com",
"first_time_buyer": null,
"borrower_ssn_last_four": null,
"converted_at": null,
"test_variation": null,
"gclid": null,
"assisted": false,
"coborrower_former_bankruptcy": null,
"coborrower_former_foreclosure": null,
"borrower_former_bankruptcy": null,
"source_ip": null,
"msclkid": null,
"marketing_keyword": null,
"military_active_duty": null,
"military_retired_or_discharged": null,
"military_surviving_spouse": null,
"property_mixed_use": null,
"borrower_former_pre_foreclosure": null,
"coborrower_former_pre_foreclosure": null,
"borrower_former_bankruptcy_type": null,
"coborrower_former_bankruptcy_type": null,
"military_projected_service_end": null,
"military_non_activated_member": null,
"how_did_you_hear_about_us": null,
"tracking_id": null,
"collected_on": null,
"collected_at": "2022-09-28T12:47:26.890-06:00",
"cid": "Home Improvement Loan",
"nal": false,
"marketing_variant": null,
"campaign_type": "Home Improvement Loan"
}Error: Missing required fields
Endpoint
POST /v2/purchase_applications
Parameters
| Name | Description | Example | Accepted Inputs |
|---|---|---|---|
| property_down_payment_percentage | Percentage of purchase price for down payment | 20 | |
| property_down_payment_source | Source of down payment | Savings | |
| property_down_payment | Amount of down payment | 60000 | |
| property_price | Price of the purchase property | 300000 | |
| area_address | Area of the purchase property | Denver | |
| area_city | City of the purchase property area | Denver | |
| area_state required | State of the purchase property area | Colorado | |
| area_zip | Zip code of the purchase property area | 80112 | |
| property_city | City of the address of the purchase property | Denver | |
| property_state | State of the address of the purchase property | Colorado | |
| property_address | Street address of the purchase property | 123 Main St. | |
| property_zip | Zip code of the purchase property | 45678 | |
| medium required | Marketing Channel | Affiliate | "Affiliate", "Email", "Display", etc. |
| source required | Marketing parameter | Request this from American Financing | |
| campaign required | Marketing parameter | Request this from American Financing | |
| term | Marketing Campaign Type | Home Improvement Loan | |
| collected_at required | Optimal date format is ISO-8601. Most common UTC date formats, such as YYYY-MM-DD, are also supported. | 2022-10-03 12:11:14 -0600 | |
| primary_borrower[first_name] required | First name of borrower | Frida | |
| primary_borrower[last_name] required | Last name of borrower | Kahlo | |
| primary_borrower[email] required | Valid email address of borrower | frida.kahlo@gmail.com | |
| primary_borrower[phone] required | 10-digit phone number of borrower | 1234567890 | |
| tracking_id | Lead specific tracking id | 12334567865432123456 | |
| property_type | Type of property | Condo | Single Family, Townhome, Condo, Multiple Unit |
| borrower_years_on_job | Borrower consecutive years at current employment | 4 | |
| borrower_marital_status | Borrower marital status | Married | Married, Unmarried, Separated |
| borrower_property_intent | How will borrower use the property | Investment property | Primary residence, Second home, Investment property |
| occupancy_type | How will borrower occupy residence | Owner Occupied | Owner Occupied, Not Owner Occupied |
| multiple_unit_type | Integer indicating multiplex units: 2, 3, or 4 | 3 | 2, 3, 4 |
| condo_type | Type of condo | High Rise Condo | High Rise Condo, Condominium |
| military_service | Boolean value borrower military service | false | true, false |
| self_rated_credit | Borrower credit score | 710 | |
| military_projected_service_end | Date of end of borrower miliary service YYYY-MM-DD | 2025-04-28 | |
| borrower_former_bankruptcy_type | Type of bankruptcy | Chapter13 | Chapter7, Chapter11, Chapter12, Chapter13 |
| coborrower_former_bankruptcy_type | Type of bankruptcy | Chapter13 | Chapter7, Chapter11, Chapter12, Chapter13 |
| dependents_ages | Array of ages of dependents | [1, 3, 13] | |
| dependents_count | Number of dependents borrower has | 3 | |
| borrower_former_foreclosure | Boolean value borrower had a foreclosure | false | true, false |
| foreclosure_date | Date of forclosure YYYY-MM-DD | 2020-04-13 | |
| former_pre_foreclosure | Boolean value borrower had a pre-foreclosure | true | true, false |
| pre_foreclosure_date | Date of pre-forclosure YYYY-MM-DD | 2020-04-13 | |
| coborrower_former_bankruptcy | Boolean value coborrower has former bankruptcy | false | true, false |
| coborrower_former_foreclosure | Boolean value coborrower has former foreclosure | false | true, false |
| borrower_former_bankruptcy | Boolean value borrower has former bankruptcy | false | true, false |
| military_active_duty | Boolean value borrower is active military | false | true, false |
| military_retired_or_discharged | Boolean value borrower military or discharged | false | true, false |
| military_surviving_spouse | Boolean value borrower is surviing spouse of military | false | true, false |
| property_mixed_use | Boolean value property will be residential and business | false | true, false |
| borrower_former_pre_foreclosure | Boolean value borrower has former pre-foreclosure | false | true, false |
| coborrower_former_pre_foreclosure | Boolean value coborrower has former pre-foreclosure | false | true, false |
| military_non_activated_member | Boolean value borrower is non-active miliary | false | true, false |
| working_with_realtor | Boolean value borrower currently has a realtor | true | true, false |
| realtor_introduction | Boolean value borrower would like to be introduced to a realtor | true | true, false |
| realtor_name | Name of borrower's realtor | Joan Del Arco | |
| realtor_phone | 10 digit phone number of borrower's realtor | 3334445555 | |
| realtor_email | Valid email of borrower's realtor | joan.del.arco@example.com | |
| primary_borrower[citizenship_residency_type] | Type of citizen residency | USCitizen | USCitizen, PermanentResidentAlien, NonPermanentResidentAlien |
| primary_borrower[continuous_employment] | Boolean value borrower has had two years of continuous employment | true | true, false |
| primary_borrower[dob] | YYYY-MM-DD of the borrower date of birth | 1985-11-15 | |
| primary_borrower[email] | Valid email of borrower | borrower_name@example.com | |
| primary_borrower[ethnicity_origin_type] | Ethnicity origin type | Mexican | Mexican, Puerto Rican, Cuban |
| primary_borrower[ethnicity_origin_type_other_desc] | Description of origin type | Peruvian | |
| primary_borrower[ethnicity_refused] | Boolean value does not provide ethnicity | true | true, false |
| primary_borrower[ethnicity_type] | Ethnicity type | NonHispanicOrLatino | HispanicOrLatino, NonHispanicOrLatino |
| primary_borrower[gender_refused] | Boolean value does not probide gender | true | true, false |
| primary_borrower[gender_type] | Gender type | Female | Female, Male |
| primary_borrower[homeownership_past_3_years] | Boolean value has owned a home in the last three years | true | true, false |
| primary_borrower[income_type] | Employment type | retirement | employment, self-employed, social-security, retirement |
| primary_borrower[outstanding_judgments] | Boolean value has outstanding judgements | true | true, false |
| primary_borrower[party_to_lawsuit] | Boolean value is party to a lawsuit | true | true, false |
| primary_borrower[presently_delinquent] | Boolean value is presently delinquient | true | true, false |
| primary_borrower[prior_property_title_type] | Prior property title type | JointWithOtherThanSpouse | Sole, JointWithSpouse, JointWithOtherThanSpouse |
| primary_borrower[prior_property_usage_type] | Prior property usage type | FhaSecondaryResidence | PrimaryResidence, SecondHome, Investment, FhaSecondaryResidence |
| primary_borrower[race_designation_other_asian_desc] | Other Asian description | Hmong | |
| primary_borrower[race_designation_other_pacific_islander_desc] | Other Pacific Islander description | Fijian | |
| primary_borrower[race_designation_type] | Race designation type | Vietnamese | AsianIndian, Chinese, Filipino, Japanese, Korean, Vietnamese, NativeHawaiian, GuamanianOrChamorro, Samoan |
| primary_borrower[race_refused] | Boolean value does not provide race | true | true, false |
| primary_borrower[race_type] | Race type | BlackOrAfricanAmerican | AmericanIndianOrAlaskaNative, Asian, NativeHawaiianOrOtherPacificIslander, BlackOrAfricanAmerican, White |
| primary_borrower[race_type_additional_desc] | Enrolled/principal tribe | Tribe Name | |
| primary_borrower[residences_past_2yrs] | Integer number of borrower residences | 1 | |
| primary_borrower[self_employed] | Boolean value is self employed | true | true, false |
| primary_borrower[ssn] | Borrower social security number | 123-45-6789 | |
| primary_borrower[suffix] | Borrower name suffix | Esq. | |
| primary_borrower[time_in_property] | Integer years borrower has owned purchase property | 3 | |
| primary_borrower[undisclosed_borrowed_funds] | Boolean value has undisclosed funds | true | true, false |
| primary_borrower[undisclosed_borrowed_funds_amount] | Integer amount of undisclosed funds | 10000 | |
| primary_borrower[undisclosed_comaker_of_note] | Boolean value is comaker of note | true | true, false |
| primary_borrower[occupy_as_primary_residence] | Boolean value occupies home as primary residence | true | true, false |
| primary_borrower[special_seller_relationship] | Boolean value has special relationship to seller | true | true, false |
| primary_borrower[undisclosed_mortgage_application] | Boolean value has undisclosed mortgage application | true | true, false |
| primary_borrower[undisclosed_credit_application] | Boolean value has undisclosed credit application | true | true, false |
| primary_borrower[conveyed_title] | Boolean value has conveyed title | true | true, false |
| primary_borrower[incomes][start_on] | Date format MM-YYYY | 02-2012 | |
| primary_borrower[incomes][end_on] | Date format MM-YYYY | 02-2012 | |
| primary_borrower[incomes][income_type] | Type of income | retirement | employment, self-employed, social-security, retirement |
| primary_borrower[incomes][name] | Name of the employment or employer | My Great Company | |
| primary_borrower[incomes][yearly_income] | Integer yearly income | 60000 | |
| primary_borrower[properties][address] | Purchase property street address | 123 Main St. | |
| primary_borrower[properties][city] | Purchase property city | Denver | |
| primary_borrower[properties][state] | Purchase property state | Colorado | |
| primary_borrower[properties][zip] | Purchase property zip code | 55555 | |
| primary_borrower[properties][move_in_on] | MM-YYYY Move in on date for this property | 04-2012 | |
| property_down_payment_source | Asset which will be used for down payment | Savings | |
| property_down_payment_percentage | Percent of purchase price that the down payment will cover | 20 | |
| first_time_buyer | Boolean value borrower is first time buyer | true | |
| assets[source] | Type of asset | Savings | |
| assets[name] | Name of asset | Bank of Banking Savings Account | |
| assets[amount] | Amount of money in asset | 30000 | |
| assets[id] | ID for an asset | 12345 | |
| assets[owner] | Owner of the asset | Tom |
Request
Route
POST /v2/purchase_applications
Headers
Content-Type: application/json
Host: https://www.americanfinancing.net
Cookie: None
Authorization: Token your_private_afc_api_token_hereBody
{
"area_state": "Colorado",
"collected_at": "2022-10-03T12:11:16.757-06:00",
"source": "OnlineLeadGenerators.com",
"campaign": "Refinance Long Form",
"medium": "Affiliate"
}Response
Simulated Response
Status
422Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Content-Security-Policy: connect-src 'self' https: http://localhost:3035 ws://localhost:3035
X-Request-Id: 22d80fd5-315b-487e-b8d8-9dc0a789e910
X-Runtime: 0.022022
Vary: Origin
Content-Length: 261Body
[
"Primary borrower can't be blank",
"Primary borrower {:first_name=>[\"can't be blank\"], :last_name=>[\"can't be blank\"], :email=>[\"can't be blank\", \"is not an email\"], :phone=>[\"can't be blank\", \"must contain exactly 10 digits\"]}"
]Error: Invalid parameter value
Endpoint
POST /v2/purchase_applications
Parameters
| Name | Description | Example | Accepted Inputs |
|---|---|---|---|
| property_down_payment_percentage | Percentage of purchase price for down payment | 20 | |
| property_down_payment_source | Source of down payment | Savings | |
| property_down_payment | Amount of down payment | 60000 | |
| property_price | Price of the purchase property | 300000 | |
| area_address | Area of the purchase property | Denver | |
| area_city | City of the purchase property area | Denver | |
| area_state required | State of the purchase property area | Colorado | |
| area_zip | Zip code of the purchase property area | 80112 | |
| property_city | City of the address of the purchase property | Denver | |
| property_state | State of the address of the purchase property | Colorado | |
| property_address | Street address of the purchase property | 123 Main St. | |
| property_zip | Zip code of the purchase property | 45678 | |
| medium required | Marketing Channel | Affiliate | "Affiliate", "Email", "Display", etc. |
| source required | Marketing parameter | Request this from American Financing | |
| campaign required | Marketing parameter | Request this from American Financing | |
| term | Marketing Campaign Type | Home Improvement Loan | |
| collected_at required | Optimal date format is ISO-8601. Most common UTC date formats, such as YYYY-MM-DD, are also supported. | 2022-10-03 12:11:14 -0600 | |
| primary_borrower[first_name] required | First name of borrower | Frida | |
| primary_borrower[last_name] required | Last name of borrower | Kahlo | |
| primary_borrower[email] required | Valid email address of borrower | frida.kahlo@gmail.com | |
| primary_borrower[phone] required | 10-digit phone number of borrower | 1234567890 | |
| tracking_id | Lead specific tracking id | 12334567865432123456 | |
| property_type | Type of property | Condo | Single Family, Townhome, Condo, Multiple Unit |
| borrower_years_on_job | Borrower consecutive years at current employment | 4 | |
| borrower_marital_status | Borrower marital status | Married | Married, Unmarried, Separated |
| borrower_property_intent | How will borrower use the property | Investment property | Primary residence, Second home, Investment property |
| occupancy_type | How will borrower occupy residence | Owner Occupied | Owner Occupied, Not Owner Occupied |
| multiple_unit_type | Integer indicating multiplex units: 2, 3, or 4 | 3 | 2, 3, 4 |
| condo_type | Type of condo | High Rise Condo | High Rise Condo, Condominium |
| military_service | Boolean value borrower military service | false | true, false |
| self_rated_credit | Borrower credit score | 710 | |
| military_projected_service_end | Date of end of borrower miliary service YYYY-MM-DD | 2025-04-28 | |
| borrower_former_bankruptcy_type | Type of bankruptcy | Chapter13 | Chapter7, Chapter11, Chapter12, Chapter13 |
| coborrower_former_bankruptcy_type | Type of bankruptcy | Chapter13 | Chapter7, Chapter11, Chapter12, Chapter13 |
| dependents_ages | Array of ages of dependents | [1, 3, 13] | |
| dependents_count | Number of dependents borrower has | 3 | |
| borrower_former_foreclosure | Boolean value borrower had a foreclosure | false | true, false |
| foreclosure_date | Date of forclosure YYYY-MM-DD | 2020-04-13 | |
| former_pre_foreclosure | Boolean value borrower had a pre-foreclosure | true | true, false |
| pre_foreclosure_date | Date of pre-forclosure YYYY-MM-DD | 2020-04-13 | |
| coborrower_former_bankruptcy | Boolean value coborrower has former bankruptcy | false | true, false |
| coborrower_former_foreclosure | Boolean value coborrower has former foreclosure | false | true, false |
| borrower_former_bankruptcy | Boolean value borrower has former bankruptcy | false | true, false |
| military_active_duty | Boolean value borrower is active military | false | true, false |
| military_retired_or_discharged | Boolean value borrower military or discharged | false | true, false |
| military_surviving_spouse | Boolean value borrower is surviing spouse of military | false | true, false |
| property_mixed_use | Boolean value property will be residential and business | false | true, false |
| borrower_former_pre_foreclosure | Boolean value borrower has former pre-foreclosure | false | true, false |
| coborrower_former_pre_foreclosure | Boolean value coborrower has former pre-foreclosure | false | true, false |
| military_non_activated_member | Boolean value borrower is non-active miliary | false | true, false |
| working_with_realtor | Boolean value borrower currently has a realtor | true | true, false |
| realtor_introduction | Boolean value borrower would like to be introduced to a realtor | true | true, false |
| realtor_name | Name of borrower's realtor | Joan Del Arco | |
| realtor_phone | 10 digit phone number of borrower's realtor | 3334445555 | |
| realtor_email | Valid email of borrower's realtor | joan.del.arco@example.com | |
| primary_borrower[citizenship_residency_type] | Type of citizen residency | USCitizen | USCitizen, PermanentResidentAlien, NonPermanentResidentAlien |
| primary_borrower[continuous_employment] | Boolean value borrower has had two years of continuous employment | true | true, false |
| primary_borrower[dob] | YYYY-MM-DD of the borrower date of birth | 1985-11-15 | |
| primary_borrower[email] | Valid email of borrower | borrower_name@example.com | |
| primary_borrower[ethnicity_origin_type] | Ethnicity origin type | Mexican | Mexican, Puerto Rican, Cuban |
| primary_borrower[ethnicity_origin_type_other_desc] | Description of origin type | Peruvian | |
| primary_borrower[ethnicity_refused] | Boolean value does not provide ethnicity | true | true, false |
| primary_borrower[ethnicity_type] | Ethnicity type | NonHispanicOrLatino | HispanicOrLatino, NonHispanicOrLatino |
| primary_borrower[gender_refused] | Boolean value does not probide gender | true | true, false |
| primary_borrower[gender_type] | Gender type | Female | Female, Male |
| primary_borrower[homeownership_past_3_years] | Boolean value has owned a home in the last three years | true | true, false |
| primary_borrower[income_type] | Employment type | retirement | employment, self-employed, social-security, retirement |
| primary_borrower[outstanding_judgments] | Boolean value has outstanding judgements | true | true, false |
| primary_borrower[party_to_lawsuit] | Boolean value is party to a lawsuit | true | true, false |
| primary_borrower[presently_delinquent] | Boolean value is presently delinquient | true | true, false |
| primary_borrower[prior_property_title_type] | Prior property title type | JointWithOtherThanSpouse | Sole, JointWithSpouse, JointWithOtherThanSpouse |
| primary_borrower[prior_property_usage_type] | Prior property usage type | FhaSecondaryResidence | PrimaryResidence, SecondHome, Investment, FhaSecondaryResidence |
| primary_borrower[race_designation_other_asian_desc] | Other Asian description | Hmong | |
| primary_borrower[race_designation_other_pacific_islander_desc] | Other Pacific Islander description | Fijian | |
| primary_borrower[race_designation_type] | Race designation type | Vietnamese | AsianIndian, Chinese, Filipino, Japanese, Korean, Vietnamese, NativeHawaiian, GuamanianOrChamorro, Samoan |
| primary_borrower[race_refused] | Boolean value does not provide race | true | true, false |
| primary_borrower[race_type] | Race type | BlackOrAfricanAmerican | AmericanIndianOrAlaskaNative, Asian, NativeHawaiianOrOtherPacificIslander, BlackOrAfricanAmerican, White |
| primary_borrower[race_type_additional_desc] | Enrolled/principal tribe | Tribe Name | |
| primary_borrower[residences_past_2yrs] | Integer number of borrower residences | 1 | |
| primary_borrower[self_employed] | Boolean value is self employed | true | true, false |
| primary_borrower[ssn] | Borrower social security number | 123-45-6789 | |
| primary_borrower[suffix] | Borrower name suffix | Esq. | |
| primary_borrower[time_in_property] | Integer years borrower has owned purchase property | 3 | |
| primary_borrower[undisclosed_borrowed_funds] | Boolean value has undisclosed funds | true | true, false |
| primary_borrower[undisclosed_borrowed_funds_amount] | Integer amount of undisclosed funds | 10000 | |
| primary_borrower[undisclosed_comaker_of_note] | Boolean value is comaker of note | true | true, false |
| primary_borrower[occupy_as_primary_residence] | Boolean value occupies home as primary residence | true | true, false |
| primary_borrower[special_seller_relationship] | Boolean value has special relationship to seller | true | true, false |
| primary_borrower[undisclosed_mortgage_application] | Boolean value has undisclosed mortgage application | true | true, false |
| primary_borrower[undisclosed_credit_application] | Boolean value has undisclosed credit application | true | true, false |
| primary_borrower[conveyed_title] | Boolean value has conveyed title | true | true, false |
| primary_borrower[incomes][start_on] | Date format MM-YYYY | 02-2012 | |
| primary_borrower[incomes][end_on] | Date format MM-YYYY | 02-2012 | |
| primary_borrower[incomes][income_type] | Type of income | retirement | employment, self-employed, social-security, retirement |
| primary_borrower[incomes][name] | Name of the employment or employer | My Great Company | |
| primary_borrower[incomes][yearly_income] | Integer yearly income | 60000 | |
| primary_borrower[properties][address] | Purchase property street address | 123 Main St. | |
| primary_borrower[properties][city] | Purchase property city | Denver | |
| primary_borrower[properties][state] | Purchase property state | Colorado | |
| primary_borrower[properties][zip] | Purchase property zip code | 55555 | |
| primary_borrower[properties][move_in_on] | MM-YYYY Move in on date for this property | 04-2012 | |
| property_down_payment_source | Asset which will be used for down payment | Savings | |
| property_down_payment_percentage | Percent of purchase price that the down payment will cover | 20 | |
| first_time_buyer | Boolean value borrower is first time buyer | true | |
| assets[source] | Type of asset | Savings | |
| assets[name] | Name of asset | Bank of Banking Savings Account | |
| assets[amount] | Amount of money in asset | 30000 | |
| assets[id] | ID for an asset | 12345 | |
| assets[owner] | Owner of the asset | Tom |
Request
Route
POST /v2/purchase_applications
Headers
Content-Type: application/json
Host: https://www.americanfinancing.net
Cookie: None
Authorization: Token your_private_afc_api_token_hereBody
{
"primary_borrower": {
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@gmail.net",
"phone": "5555555555"
},
"foreclosure_date": "1890-9-20",
"property_zip": "1234",
"area_state": "Colorado",
"collected_at": "2022-10-03T12:11:16.801-06:00",
"source": "OnlineLeadGenerators.com",
"campaign": "Refinance Long Form",
"medium": "Affiliate"
}Response
Simulated Response
Status
422Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Content-Security-Policy: connect-src 'self' https: http://localhost:3035 ws://localhost:3035
X-Request-Id: 5d426fc3-bfa6-4d9e-ab47-0444a0956cf6
X-Runtime: 0.021017
Vary: Origin
Content-Length: 117Body
[
"Foreclosure date must be a valid date no older than 1900-1-1",
"Property zip must contain 5 digits in format XXXXX"
]RefinanceApplication
Third party refinance application integration endpoint. Please make a POST request to our refinance application endpoint at https://www.americanfinancing.net/v2/refinance_applications. The request will need a JSON body containing the key/value pairs listed below. All values that can be placed under the primary_borrower key can also be provided for a co_borrower.
Submit a refinance application with only required data points
Endpoint
POST /v2/refinance_applications
Parameters
| Name | Description | Example | Accepted Inputs |
|---|---|---|---|
| property_city required | City of the address of the refinance property | Denver | |
| property_state required | State of the address of the refinance property | Colorado | |
| property_street required | Street address of the refinance property | 123 Main St. | |
| property_zip required | Zip code of the refinance property | 45678 | |
| medium required | Marketing Channel | Affiliate | "Affiliate", "Email", "Display", etc. |
| source required | Marketing parameter | Request this from American Financing | |
| campaign required | Marketing parameter | Request this from American Financing | |
| term | Marketing Campaign Type | Home Improvement Loan | |
| collected_at required | Optimal date format is ISO-8601. Most common UTC date formats, such as YYYY-MM-DD, are also supported. | 2022-09-28 12:47:25 -0600 | |
| primary_borrower[first_name] required | First name of borrower | Frida | |
| primary_borrower[last_name] required | Last name of borrower | Kahlo | |
| primary_borrower[email] required | Valid email address of borrower | frida.kahlo@gmail.com | |
| primary_borrower[phone] required | 10-digit phone number of borrower | 1234567890 | |
| tracking_id | Lead specific tracking id | 12334567865432123456 | |
| property_type | Type of property | Condo | Single Family, Townhome, Condo, Multiple Unit |
| initial_purchase_price | Purchase price of refinance property | 500000 | |
| remaining_balance | Amount left on the current mortgage | 250000 | |
| second_mortgage | Boolean value borrower has a second mortgage | false | true, false |
| second_mortgage_remaining_balance | Amount left on second mortgage | 120000 | |
| borrower_birthdate | YYYY-MM-DD of the borrower date of birth | 1985-11-15 | |
| coborrower_birthdate | YYYY-MM-DD of the coborrower date of birth | 1944-01-30 | |
| borrower_years_on_job | Borrower consecutive years at current employment | 4 | |
| borrower_marital_status | Borrower marital status | Married | Married, Unmarried |
| borrower_property_intent | How will borrower use the property | Investment property | Primary residence, Second home, Investment property |
| borrower_primary_address | Borrower street address | 123 Main St. | |
| borrower_primary_city | Borrower address city | Denver | |
| borrower_primary_state | Borrower address state | Colorado | |
| borrower_primary_zip | Borrower address zip code (5 digits) | 55555 | |
| reason | Why is borrower refinancing | Cash Out For Other Use | Lower Rate/Payment, Shorten Loan Term, Cash Out To Payoff Debts, Cash Out For Other Use |
| occupancy_type | How will borrower occupy residence | Owner Occupied | Owner Occupied, Not Owner Occupied |
| multiple_unit_type | Integer indicating multiplex units: 2, 3, or 4 | 3 | 2, 3, 4 |
| approximate_value | Approximate current value of refinance property | 600000 | |
| condo_type | Type of condo | High Rise Condo | High Rise Condo, Condominium |
| military_service | Boolean value borrower military service | false | true, false |
| self_rated_credit | Borrower credit score | 710 | |
| military_projected_service_end | Date of end of borrower miliary service YYYY-MM-DD | 2025-04-28 | |
| borrower_former_bankruptcy_type | Type of bankruptcy | Chapter13 | Chapter7, Chapter11, Chapter12, Chapter13 |
| coborrower_former_bankruptcy_type | Type of bankruptcy | Chapter13 | Chapter7, Chapter11, Chapter12, Chapter13 |
| dependents_ages | Array of ages of dependents | [1, 3, 13] | |
| dependents_count | Number of dependents borrower has | 3 | |
| borrower_former_foreclosure | Boolean value borrower had a foreclosure | false | true, false |
| foreclosure_date | Date of forclosure YYYY-MM-DD | 2020-04-13 | |
| former_pre_foreclosure | Boolean value borrower had a pre-foreclosure | true | true, false |
| pre_foreclosure_date | Date of pre-forclosure YYYY-MM-DD | 2020-04-13 | |
| cash_out_amount | Amount borrower wants as cash out | 100000 | |
| second_mortgage_type | Type of second mortgage | HELOC | Home Equity, HELOC |
| heloc_drawn_amount | HELOC amount drawn | 30000 | |
| heloc_line_amount | HELOC line amount | 200000 | |
| housing_expense_monthly_mortgage_payment | Monthly mortgage payment amount | 2000 | |
| housing_expense_principal_interest | Monthly interest on mortgage principle | 100 | |
| housing_expense_taxes | Monthly taxes | 400 | |
| housing_expense_insurance | Monthly insurance | 200 | |
| housing_expense_hoa_dues | Monthly HOA dues | 300 | |
| housing_expense_second_mortgage | Monthly expense for a second mortgage | 1000 | |
| current_interest_rate | Monthly interest rate | .04 | |
| borrower_loan_objective | Why does the borrower want to refinance | Cash out for a new kitchen | |
| coborrower_former_bankruptcy | Boolean value coborrower has former bankruptcy | false | true, false |
| coborrower_former_foreclosure | Boolean value coborrower has former foreclosure | false | true, false |
| borrower_former_bankruptcy | Boolean value borrower has former bankruptcy | false | true, false |
| military_active_duty | Boolean value borrower is active military | false | true, false |
| military_retired_or_discharged | Boolean value borrower military or discharged | false | true, false |
| military_surviving_spouse | Boolean value borrower is surviing spouse of military | false | true, false |
| property_mixed_use | Boolean value property will be residential and business | false | true, false |
| borrower_former_pre_foreclosure | Boolean value borrower has former pre-foreclosure | false | true, false |
| coborrower_former_pre_foreclosure | Boolean value coborrower has former pre-foreclosure | false | true, false |
| military_non_activated_member | Boolean value borrower is non-active miliary | false | true, false |
| working_with_realtor | Boolean value borrower currently has a realtor | true | true, false |
| realtor_introduction | Boolean value borrower would like to be introduced to a realtor | true | true, false |
| realtor_name | Name of borrower's realtor | Joan Del Arco | |
| realtor_phone | 10 digit phone number of borrower's realtor | 3334445555 | |
| realtor_email | Valid email of borrower's realtor | joan.del.arco@example.com | |
| primary_borrower[citizenship_residency_type] | Type of citizen residency | USCitizen | USCitizen, PermanentResidentAlien, NonPermanentResidentAlien |
| primary_borrower[continuous_employment] | Boolean value borrower has had two years of continuous employment | true | true, false |
| primary_borrower[dob] | YYYY-MM-DD of the borrower date of birth | 1985-11-15 | |
| primary_borrower[email] | Valid email of borrower | borrower_name@example.com | |
| primary_borrower[ethnicity_origin_type] | Ethnicity origin type | Mexican | Mexican, Puerto Rican, Cuban |
| primary_borrower[ethnicity_origin_type_other_desc] | Description of origin type | Peruvian | |
| primary_borrower[ethnicity_refused] | Boolean value does not provide ethnicity | true | true, false |
| primary_borrower[ethnicity_type] | Ethnicity type | NonHispanicOrLatino | HispanicOrLatino, NonHispanicOrLatino |
| primary_borrower[gender_refused] | Boolean value does not probide gender | true | true, false |
| primary_borrower[gender_type] | Gender type | Female | Female, Male |
| primary_borrower[homeownership_past_3_years] | Boolean value has owned a home in the last three years | true | true, false |
| primary_borrower[income_type] | Employment type | retirement | employment, self-employed, social-security, retirement |
| primary_borrower[outstanding_judgments] | Boolean value has outstanding judgements | true | true, false |
| primary_borrower[party_to_lawsuit] | Boolean value is party to a lawsuit | true | true, false |
| primary_borrower[presently_delinquent] | Boolean value is presently delinquient | true | true, false |
| primary_borrower[prior_property_title_type] | Prior property title type | JointWithOtherThanSpouse | Sole, JointWithSpouse, JointWithOtherThanSpouse |
| primary_borrower[prior_property_usage_type] | Prior property usage type | FhaSecondaryResidence | PrimaryResidence, SecondHome, Investment, FhaSecondaryResidence |
| primary_borrower[race_designation_other_asian_desc] | Other Asian description | Hmong | |
| primary_borrower[race_designation_other_pacific_islander_desc] | Other Pacific Islander description | Fijian | |
| primary_borrower[race_designation_type] | Race designation type | Vietnamese | AsianIndian, Chinese, Filipino, Japanese, Korean, Vietnamese, NativeHawaiian, GuamanianOrChamorro, Samoan |
| primary_borrower[race_refused] | Boolean value does not provide race | true | true, false |
| primary_borrower[race_type] | Race type | BlackOrAfricanAmerican | AmericanIndianOrAlaskaNative, Asian, NativeHawaiianOrOtherPacificIslander, BlackOrAfricanAmerican, White |
| primary_borrower[race_type_additional_desc] | Enrolled/principal tribe | Tribe Name | |
| primary_borrower[residences_past_2yrs] | Integer number of borrower residences | 1 | |
| primary_borrower[self_employed] | Boolean value is self employed | true | true, false |
| primary_borrower[ssn] | Borrower social security number | 123-45-6789 | |
| primary_borrower[suffix] | Borrower name suffix | Esq. | |
| primary_borrower[time_in_property] | Integer years borrower has owned refinance property | 3 | |
| primary_borrower[undisclosed_borrowed_funds] | Boolean value has undisclosed funds | true | true, false |
| primary_borrower[undisclosed_borrowed_funds_amount] | Integer amount of undisclosed funds | 10000 | |
| primary_borrower[undisclosed_comaker_of_note] | Boolean value is comaker of note | true | true, false |
| primary_borrower[occupy_as_primary_residence] | Boolean value occupies home as primary residence | true | true, false |
| primary_borrower[special_seller_relationship] | Boolean value has special relationship to seller | true | true, false |
| primary_borrower[undisclosed_mortgage_application] | Boolean value has undisclosed mortgage application | true | true, false |
| primary_borrower[undisclosed_credit_application] | Boolean value has undisclosed credit application | true | true, false |
| primary_borrower[conveyed_title] | Boolean value has conveyed title | true | true, false |
| primary_borrower[incomes][start_on] | Date format MM-YYYY | 02-2012 | |
| primary_borrower[incomes][end_on] | Date format MM-YYYY | 02-2012 | |
| primary_borrower[incomes][income_type] | Type of income | retirement | employment, self-employed, social-security, retirement |
| primary_borrower[incomes][name] | Name of the employment or employer | My Great Company | |
| primary_borrower[incomes][yearly_income] | Integer yearly income | 60000 | |
| primary_borrower[properties][address] | Refinance property street address | 123 Main St. | |
| primary_borrower[properties][city] | Refinance property city | Denver | |
| primary_borrower[properties][state] | Refinance property state | Colorado | |
| primary_borrower[properties][zip] | Refinance property zip code | 55555 | |
| primary_borrower[properties][move_in_on] | MM-YYYY Move in on date for this property | 04-2012 |
Request
Route
POST /v2/refinance_applications
Headers
Content-Type: application/json
Host: https://www.americanfinancing.net
Cookie: None
Authorization: Token your_private_afc_api_token_hereBody
{
"primary_borrower": {
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@gmail.net",
"phone": "5555555555"
},
"property_zip": "99999",
"property_state": "Colorado",
"property_street": "2061 Apple River Rd.",
"property_city": "Denver",
"collected_at": "2022-09-28T12:47:27.065-06:00",
"source": "OnlineLeadGenerators.com",
"campaign": "Refinance Long Form",
"medium": "Affiliate"
}Response
Simulated Response
Status
201Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
ETag: W/"ed16feda2108f8116b3670d90ab70c9e"
Cache-Control: max-age=0, private, must-revalidate
Content-Security-Policy: connect-src 'self' https: http://localhost:3035 ws://localhost:3035
X-Request-Id: 66f55e16-4805-4ef7-8559-0261125b786f
X-Runtime: 0.268969
Vary: Origin
Content-Length: 3074Body
{
"id": 108,
"internet_protocol": null,
"loan_purpose": "refinance",
"source": "OnlineLeadGenerators.com",
"endorser": "Refinance Long Form",
"internet_source": "Affiliate",
"_ga": null,
"property_type": null,
"initial_purchase_price": null,
"remaining_balance": null,
"second_mortgage": null,
"second_mortgage_remaining_balance": null,
"borrower_birthdate": null,
"coborrower_birthdate": null,
"borrower_years_on_job": null,
"borrower_marital_status": null,
"borrower_property_intent": null,
"borrower_primary_address": null,
"borrower_primary_city": null,
"borrower_primary_state": null,
"borrower_primary_zip": null,
"reason": null,
"occupancy_type": null,
"multiple_unit_type": null,
"approximate_value": null,
"condo_type": null,
"created_at": "2022-09-28T13:47:27.261-06:00",
"updated_at": "2022-09-28T13:47:27.261-06:00",
"session_uuid": null,
"slug": "HrmAcazW0q",
"breadcrumbs": [
],
"current_step": "refinance_address",
"military_service": null,
"self_rated_credit": null,
"bankruptcy_date": null,
"bankruptcy_type": null,
"short": false,
"dependents_ages": null,
"dependents_count": 0,
"property_city": "Denver",
"property_state": "Colorado",
"property_street": "2061 Apple River Rd.",
"property_zip": "99999",
"borrower_former_foreclosure": null,
"foreclosure_date": null,
"former_pre_foreclosure": null,
"pre_foreclosure_date": null,
"borrower_consented": null,
"fallout_reason": [
],
"credit_check_consented": null,
"aggregate_id": "6175a3be-3f66-11ed-8f23-0242ac140008",
"dm_call": false,
"ob_loan_option_details": null,
"initial_underwriting_status": null,
"initial_portal_created": null,
"dm_completed_at": null,
"app_complete": false,
"stale_for": null,
"saved_for_later": false,
"original_endorser": "Refinance Long Form",
"loan_already_in_progress": null,
"borrower_timezone_offset": null,
"asset_verification_id": null,
"cash_out_amount": null,
"original_source": "OnlineLeadGenerators.com",
"second_mortgage_type": null,
"heloc_line_amount": null,
"heloc_drawn_amount": null,
"housing_expense_monthly_mortgage_payment": null,
"housing_expense_principal_interest": null,
"housing_expense_taxes": null,
"housing_expense_insurance": null,
"housing_expense_hoa_dues": null,
"housing_expense_second_mortgage": null,
"borrower_ssn_last_four": null,
"converted_at": null,
"test_variation": null,
"gclid": null,
"assisted": false,
"current_interest_rate": null,
"borrower_loan_objective": null,
"coborrower_former_bankruptcy": null,
"coborrower_former_foreclosure": null,
"borrower_former_bankruptcy": null,
"source_ip": null,
"msclkid": null,
"marketing_keyword": null,
"military_active_duty": null,
"military_retired_or_discharged": null,
"military_surviving_spouse": null,
"property_mixed_use": null,
"military_projected_service_end": null,
"borrower_former_pre_foreclosure": null,
"coborrower_former_pre_foreclosure": null,
"borrower_former_bankruptcy_type": null,
"coborrower_former_bankruptcy_type": null,
"military_non_activated_member": null,
"realtor_name": null,
"realtor_phone": null,
"realtor_email": null,
"working_with_realtor": null,
"realtor_introduction": null,
"how_did_you_hear_about_us": null,
"tracking_id": null,
"collected_on": null,
"collected_at": "2022-09-28T12:47:27.065-06:00",
"cid": null,
"nal": false,
"marketing_variant": null,
"campaign_type": null
}Submit a refinance application with some optional data points
Endpoint
POST /v2/refinance_applications
Parameters
| Name | Description | Example | Accepted Inputs |
|---|---|---|---|
| property_city required | City of the address of the refinance property | Denver | |
| property_state required | State of the address of the refinance property | Colorado | |
| property_street required | Street address of the refinance property | 123 Main St. | |
| property_zip required | Zip code of the refinance property | 45678 | |
| medium required | Marketing Channel | Affiliate | "Affiliate", "Email", "Display", etc. |
| source required | Marketing parameter | Request this from American Financing | |
| campaign required | Marketing parameter | Request this from American Financing | |
| term | Marketing Campaign Type | Home Improvement Loan | |
| collected_at required | Optimal date format is ISO-8601. Most common UTC date formats, such as YYYY-MM-DD, are also supported. | 2022-09-28 12:47:25 -0600 | |
| primary_borrower[first_name] required | First name of borrower | Frida | |
| primary_borrower[last_name] required | Last name of borrower | Kahlo | |
| primary_borrower[email] required | Valid email address of borrower | frida.kahlo@gmail.com | |
| primary_borrower[phone] required | 10-digit phone number of borrower | 1234567890 | |
| tracking_id | Lead specific tracking id | 12334567865432123456 | |
| property_type | Type of property | Condo | Single Family, Townhome, Condo, Multiple Unit |
| initial_purchase_price | Purchase price of refinance property | 500000 | |
| remaining_balance | Amount left on the current mortgage | 250000 | |
| second_mortgage | Boolean value borrower has a second mortgage | false | true, false |
| second_mortgage_remaining_balance | Amount left on second mortgage | 120000 | |
| borrower_birthdate | YYYY-MM-DD of the borrower date of birth | 1985-11-15 | |
| coborrower_birthdate | YYYY-MM-DD of the coborrower date of birth | 1944-01-30 | |
| borrower_years_on_job | Borrower consecutive years at current employment | 4 | |
| borrower_marital_status | Borrower marital status | Married | Married, Unmarried |
| borrower_property_intent | How will borrower use the property | Investment property | Primary residence, Second home, Investment property |
| borrower_primary_address | Borrower street address | 123 Main St. | |
| borrower_primary_city | Borrower address city | Denver | |
| borrower_primary_state | Borrower address state | Colorado | |
| borrower_primary_zip | Borrower address zip code (5 digits) | 55555 | |
| reason | Why is borrower refinancing | Cash Out For Other Use | Lower Rate/Payment, Shorten Loan Term, Cash Out To Payoff Debts, Cash Out For Other Use |
| occupancy_type | How will borrower occupy residence | Owner Occupied | Owner Occupied, Not Owner Occupied |
| multiple_unit_type | Integer indicating multiplex units: 2, 3, or 4 | 3 | 2, 3, 4 |
| approximate_value | Approximate current value of refinance property | 600000 | |
| condo_type | Type of condo | High Rise Condo | High Rise Condo, Condominium |
| military_service | Boolean value borrower military service | false | true, false |
| self_rated_credit | Borrower credit score | 710 | |
| military_projected_service_end | Date of end of borrower miliary service YYYY-MM-DD | 2025-04-28 | |
| borrower_former_bankruptcy_type | Type of bankruptcy | Chapter13 | Chapter7, Chapter11, Chapter12, Chapter13 |
| coborrower_former_bankruptcy_type | Type of bankruptcy | Chapter13 | Chapter7, Chapter11, Chapter12, Chapter13 |
| dependents_ages | Array of ages of dependents | [1, 3, 13] | |
| dependents_count | Number of dependents borrower has | 3 | |
| borrower_former_foreclosure | Boolean value borrower had a foreclosure | false | true, false |
| foreclosure_date | Date of forclosure YYYY-MM-DD | 2020-04-13 | |
| former_pre_foreclosure | Boolean value borrower had a pre-foreclosure | true | true, false |
| pre_foreclosure_date | Date of pre-forclosure YYYY-MM-DD | 2020-04-13 | |
| cash_out_amount | Amount borrower wants as cash out | 100000 | |
| second_mortgage_type | Type of second mortgage | HELOC | Home Equity, HELOC |
| heloc_drawn_amount | HELOC amount drawn | 30000 | |
| heloc_line_amount | HELOC line amount | 200000 | |
| housing_expense_monthly_mortgage_payment | Monthly mortgage payment amount | 2000 | |
| housing_expense_principal_interest | Monthly interest on mortgage principle | 100 | |
| housing_expense_taxes | Monthly taxes | 400 | |
| housing_expense_insurance | Monthly insurance | 200 | |
| housing_expense_hoa_dues | Monthly HOA dues | 300 | |
| housing_expense_second_mortgage | Monthly expense for a second mortgage | 1000 | |
| current_interest_rate | Monthly interest rate | .04 | |
| borrower_loan_objective | Why does the borrower want to refinance | Cash out for a new kitchen | |
| coborrower_former_bankruptcy | Boolean value coborrower has former bankruptcy | false | true, false |
| coborrower_former_foreclosure | Boolean value coborrower has former foreclosure | false | true, false |
| borrower_former_bankruptcy | Boolean value borrower has former bankruptcy | false | true, false |
| military_active_duty | Boolean value borrower is active military | false | true, false |
| military_retired_or_discharged | Boolean value borrower military or discharged | false | true, false |
| military_surviving_spouse | Boolean value borrower is surviing spouse of military | false | true, false |
| property_mixed_use | Boolean value property will be residential and business | false | true, false |
| borrower_former_pre_foreclosure | Boolean value borrower has former pre-foreclosure | false | true, false |
| coborrower_former_pre_foreclosure | Boolean value coborrower has former pre-foreclosure | false | true, false |
| military_non_activated_member | Boolean value borrower is non-active miliary | false | true, false |
| working_with_realtor | Boolean value borrower currently has a realtor | true | true, false |
| realtor_introduction | Boolean value borrower would like to be introduced to a realtor | true | true, false |
| realtor_name | Name of borrower's realtor | Joan Del Arco | |
| realtor_phone | 10 digit phone number of borrower's realtor | 3334445555 | |
| realtor_email | Valid email of borrower's realtor | joan.del.arco@example.com | |
| primary_borrower[citizenship_residency_type] | Type of citizen residency | USCitizen | USCitizen, PermanentResidentAlien, NonPermanentResidentAlien |
| primary_borrower[continuous_employment] | Boolean value borrower has had two years of continuous employment | true | true, false |
| primary_borrower[dob] | YYYY-MM-DD of the borrower date of birth | 1985-11-15 | |
| primary_borrower[email] | Valid email of borrower | borrower_name@example.com | |
| primary_borrower[ethnicity_origin_type] | Ethnicity origin type | Mexican | Mexican, Puerto Rican, Cuban |
| primary_borrower[ethnicity_origin_type_other_desc] | Description of origin type | Peruvian | |
| primary_borrower[ethnicity_refused] | Boolean value does not provide ethnicity | true | true, false |
| primary_borrower[ethnicity_type] | Ethnicity type | NonHispanicOrLatino | HispanicOrLatino, NonHispanicOrLatino |
| primary_borrower[gender_refused] | Boolean value does not probide gender | true | true, false |
| primary_borrower[gender_type] | Gender type | Female | Female, Male |
| primary_borrower[homeownership_past_3_years] | Boolean value has owned a home in the last three years | true | true, false |
| primary_borrower[income_type] | Employment type | retirement | employment, self-employed, social-security, retirement |
| primary_borrower[outstanding_judgments] | Boolean value has outstanding judgements | true | true, false |
| primary_borrower[party_to_lawsuit] | Boolean value is party to a lawsuit | true | true, false |
| primary_borrower[presently_delinquent] | Boolean value is presently delinquient | true | true, false |
| primary_borrower[prior_property_title_type] | Prior property title type | JointWithOtherThanSpouse | Sole, JointWithSpouse, JointWithOtherThanSpouse |
| primary_borrower[prior_property_usage_type] | Prior property usage type | FhaSecondaryResidence | PrimaryResidence, SecondHome, Investment, FhaSecondaryResidence |
| primary_borrower[race_designation_other_asian_desc] | Other Asian description | Hmong | |
| primary_borrower[race_designation_other_pacific_islander_desc] | Other Pacific Islander description | Fijian | |
| primary_borrower[race_designation_type] | Race designation type | Vietnamese | AsianIndian, Chinese, Filipino, Japanese, Korean, Vietnamese, NativeHawaiian, GuamanianOrChamorro, Samoan |
| primary_borrower[race_refused] | Boolean value does not provide race | true | true, false |
| primary_borrower[race_type] | Race type | BlackOrAfricanAmerican | AmericanIndianOrAlaskaNative, Asian, NativeHawaiianOrOtherPacificIslander, BlackOrAfricanAmerican, White |
| primary_borrower[race_type_additional_desc] | Enrolled/principal tribe | Tribe Name | |
| primary_borrower[residences_past_2yrs] | Integer number of borrower residences | 1 | |
| primary_borrower[self_employed] | Boolean value is self employed | true | true, false |
| primary_borrower[ssn] | Borrower social security number | 123-45-6789 | |
| primary_borrower[suffix] | Borrower name suffix | Esq. | |
| primary_borrower[time_in_property] | Integer years borrower has owned refinance property | 3 | |
| primary_borrower[undisclosed_borrowed_funds] | Boolean value has undisclosed funds | true | true, false |
| primary_borrower[undisclosed_borrowed_funds_amount] | Integer amount of undisclosed funds | 10000 | |
| primary_borrower[undisclosed_comaker_of_note] | Boolean value is comaker of note | true | true, false |
| primary_borrower[occupy_as_primary_residence] | Boolean value occupies home as primary residence | true | true, false |
| primary_borrower[special_seller_relationship] | Boolean value has special relationship to seller | true | true, false |
| primary_borrower[undisclosed_mortgage_application] | Boolean value has undisclosed mortgage application | true | true, false |
| primary_borrower[undisclosed_credit_application] | Boolean value has undisclosed credit application | true | true, false |
| primary_borrower[conveyed_title] | Boolean value has conveyed title | true | true, false |
| primary_borrower[incomes][start_on] | Date format MM-YYYY | 02-2012 | |
| primary_borrower[incomes][end_on] | Date format MM-YYYY | 02-2012 | |
| primary_borrower[incomes][income_type] | Type of income | retirement | employment, self-employed, social-security, retirement |
| primary_borrower[incomes][name] | Name of the employment or employer | My Great Company | |
| primary_borrower[incomes][yearly_income] | Integer yearly income | 60000 | |
| primary_borrower[properties][address] | Refinance property street address | 123 Main St. | |
| primary_borrower[properties][city] | Refinance property city | Denver | |
| primary_borrower[properties][state] | Refinance property state | Colorado | |
| primary_borrower[properties][zip] | Refinance property zip code | 55555 | |
| primary_borrower[properties][move_in_on] | MM-YYYY Move in on date for this property | 04-2012 |
Request
Route
POST /v2/refinance_applications
Headers
Content-Type: application/json
Host: https://www.americanfinancing.net
Cookie: None
Authorization: Token your_private_afc_api_token_hereBody
{
"primary_borrower": {
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@gmail.net",
"phone": "5555555555"
},
"co_borrower": {
"first_name": "Susan",
"last_name": "Anthony",
"email": "susan.b@vote.org",
"phone": "1919191920"
},
"property_zip": "99999",
"property_state": "Colorado",
"property_street": "2061 Apple River Rd.",
"property_city": "Denver",
"collected_at": "2022-09-28T12:47:27.360-06:00",
"source": "OnlineLeadGenerators.com",
"term": "Home Improvement Loan",
"campaign": "Refinance Long Form",
"medium": "Affiliate",
"military_service": false,
"approximate_value": "100000",
"property_type": "Townhome"
}Response
Simulated Response
Status
201Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
ETag: W/"92b7708d2f69db3874ddafb9e86f98f5"
Cache-Control: max-age=0, private, must-revalidate
Content-Security-Policy: connect-src 'self' https: http://localhost:3035 ws://localhost:3035
X-Request-Id: 7ae0818d-54bf-4dbb-9812-fe167cb189be
X-Runtime: 0.043704
Vary: Origin
Content-Length: 3123Body
{
"id": 109,
"internet_protocol": null,
"loan_purpose": "refinance",
"source": "OnlineLeadGenerators.com",
"endorser": "Refinance Long Form",
"internet_source": "Affiliate",
"_ga": null,
"property_type": "Townhome",
"initial_purchase_price": null,
"remaining_balance": null,
"second_mortgage": null,
"second_mortgage_remaining_balance": null,
"borrower_birthdate": null,
"coborrower_birthdate": null,
"borrower_years_on_job": null,
"borrower_marital_status": null,
"borrower_property_intent": null,
"borrower_primary_address": null,
"borrower_primary_city": null,
"borrower_primary_state": null,
"borrower_primary_zip": null,
"reason": null,
"occupancy_type": null,
"multiple_unit_type": null,
"approximate_value": "100000",
"condo_type": null,
"created_at": "2022-09-28T13:47:27.394-06:00",
"updated_at": "2022-09-28T13:47:27.394-06:00",
"session_uuid": null,
"slug": "lIZDB8i4Jo",
"breadcrumbs": [
],
"current_step": "refinance_address",
"military_service": false,
"self_rated_credit": null,
"bankruptcy_date": null,
"bankruptcy_type": null,
"short": false,
"dependents_ages": null,
"dependents_count": 0,
"property_city": "Denver",
"property_state": "Colorado",
"property_street": "2061 Apple River Rd.",
"property_zip": "99999",
"borrower_former_foreclosure": null,
"foreclosure_date": null,
"former_pre_foreclosure": null,
"pre_foreclosure_date": null,
"borrower_consented": null,
"fallout_reason": [
],
"credit_check_consented": null,
"aggregate_id": "61899d1a-3f66-11ed-8f23-0242ac140008",
"dm_call": false,
"ob_loan_option_details": null,
"initial_underwriting_status": null,
"initial_portal_created": null,
"dm_completed_at": null,
"app_complete": false,
"stale_for": null,
"saved_for_later": false,
"original_endorser": "Refinance Long Form",
"loan_already_in_progress": null,
"borrower_timezone_offset": null,
"asset_verification_id": null,
"cash_out_amount": null,
"original_source": "OnlineLeadGenerators.com",
"second_mortgage_type": null,
"heloc_line_amount": null,
"heloc_drawn_amount": null,
"housing_expense_monthly_mortgage_payment": null,
"housing_expense_principal_interest": null,
"housing_expense_taxes": null,
"housing_expense_insurance": null,
"housing_expense_hoa_dues": null,
"housing_expense_second_mortgage": null,
"borrower_ssn_last_four": null,
"converted_at": null,
"test_variation": null,
"gclid": null,
"assisted": false,
"current_interest_rate": null,
"borrower_loan_objective": null,
"coborrower_former_bankruptcy": null,
"coborrower_former_foreclosure": null,
"borrower_former_bankruptcy": null,
"source_ip": null,
"msclkid": null,
"marketing_keyword": null,
"military_active_duty": null,
"military_retired_or_discharged": null,
"military_surviving_spouse": null,
"property_mixed_use": null,
"military_projected_service_end": null,
"borrower_former_pre_foreclosure": null,
"coborrower_former_pre_foreclosure": null,
"borrower_former_bankruptcy_type": null,
"coborrower_former_bankruptcy_type": null,
"military_non_activated_member": null,
"realtor_name": null,
"realtor_phone": null,
"realtor_email": null,
"working_with_realtor": null,
"realtor_introduction": null,
"how_did_you_hear_about_us": null,
"tracking_id": null,
"collected_on": null,
"collected_at": "2022-09-28T12:47:27.360-06:00",
"cid": "Home Improvement Loan",
"nal": false,
"marketing_variant": null,
"campaign_type": "Home Improvement Loan"
}Error: Missing required fields
Endpoint
POST /v2/refinance_applications
Parameters
| Name | Description | Example | Accepted Inputs |
|---|---|---|---|
| property_city required | City of the address of the refinance property | Denver | |
| property_state required | State of the address of the refinance property | Colorado | |
| property_street required | Street address of the refinance property | 123 Main St. | |
| property_zip required | Zip code of the refinance property | 45678 | |
| medium required | Marketing Channel | Affiliate | "Affiliate", "Email", "Display", etc. |
| source required | Marketing parameter | Request this from American Financing | |
| campaign required | Marketing parameter | Request this from American Financing | |
| term | Marketing Campaign Type | Home Improvement Loan | |
| collected_at required | Optimal date format is ISO-8601. Most common UTC date formats, such as YYYY-MM-DD, are also supported. | 2022-09-28 12:47:25 -0600 | |
| primary_borrower[first_name] required | First name of borrower | Frida | |
| primary_borrower[last_name] required | Last name of borrower | Kahlo | |
| primary_borrower[email] required | Valid email address of borrower | frida.kahlo@gmail.com | |
| primary_borrower[phone] required | 10-digit phone number of borrower | 1234567890 | |
| tracking_id | Lead specific tracking id | 12334567865432123456 | |
| property_type | Type of property | Condo | Single Family, Townhome, Condo, Multiple Unit |
| initial_purchase_price | Purchase price of refinance property | 500000 | |
| remaining_balance | Amount left on the current mortgage | 250000 | |
| second_mortgage | Boolean value borrower has a second mortgage | false | true, false |
| second_mortgage_remaining_balance | Amount left on second mortgage | 120000 | |
| borrower_birthdate | YYYY-MM-DD of the borrower date of birth | 1985-11-15 | |
| coborrower_birthdate | YYYY-MM-DD of the coborrower date of birth | 1944-01-30 | |
| borrower_years_on_job | Borrower consecutive years at current employment | 4 | |
| borrower_marital_status | Borrower marital status | Married | Married, Unmarried |
| borrower_property_intent | How will borrower use the property | Investment property | Primary residence, Second home, Investment property |
| borrower_primary_address | Borrower street address | 123 Main St. | |
| borrower_primary_city | Borrower address city | Denver | |
| borrower_primary_state | Borrower address state | Colorado | |
| borrower_primary_zip | Borrower address zip code (5 digits) | 55555 | |
| reason | Why is borrower refinancing | Cash Out For Other Use | Lower Rate/Payment, Shorten Loan Term, Cash Out To Payoff Debts, Cash Out For Other Use |
| occupancy_type | How will borrower occupy residence | Owner Occupied | Owner Occupied, Not Owner Occupied |
| multiple_unit_type | Integer indicating multiplex units: 2, 3, or 4 | 3 | 2, 3, 4 |
| approximate_value | Approximate current value of refinance property | 600000 | |
| condo_type | Type of condo | High Rise Condo | High Rise Condo, Condominium |
| military_service | Boolean value borrower military service | false | true, false |
| self_rated_credit | Borrower credit score | 710 | |
| military_projected_service_end | Date of end of borrower miliary service YYYY-MM-DD | 2025-04-28 | |
| borrower_former_bankruptcy_type | Type of bankruptcy | Chapter13 | Chapter7, Chapter11, Chapter12, Chapter13 |
| coborrower_former_bankruptcy_type | Type of bankruptcy | Chapter13 | Chapter7, Chapter11, Chapter12, Chapter13 |
| dependents_ages | Array of ages of dependents | [1, 3, 13] | |
| dependents_count | Number of dependents borrower has | 3 | |
| borrower_former_foreclosure | Boolean value borrower had a foreclosure | false | true, false |
| foreclosure_date | Date of forclosure YYYY-MM-DD | 2020-04-13 | |
| former_pre_foreclosure | Boolean value borrower had a pre-foreclosure | true | true, false |
| pre_foreclosure_date | Date of pre-forclosure YYYY-MM-DD | 2020-04-13 | |
| cash_out_amount | Amount borrower wants as cash out | 100000 | |
| second_mortgage_type | Type of second mortgage | HELOC | Home Equity, HELOC |
| heloc_drawn_amount | HELOC amount drawn | 30000 | |
| heloc_line_amount | HELOC line amount | 200000 | |
| housing_expense_monthly_mortgage_payment | Monthly mortgage payment amount | 2000 | |
| housing_expense_principal_interest | Monthly interest on mortgage principle | 100 | |
| housing_expense_taxes | Monthly taxes | 400 | |
| housing_expense_insurance | Monthly insurance | 200 | |
| housing_expense_hoa_dues | Monthly HOA dues | 300 | |
| housing_expense_second_mortgage | Monthly expense for a second mortgage | 1000 | |
| current_interest_rate | Monthly interest rate | .04 | |
| borrower_loan_objective | Why does the borrower want to refinance | Cash out for a new kitchen | |
| coborrower_former_bankruptcy | Boolean value coborrower has former bankruptcy | false | true, false |
| coborrower_former_foreclosure | Boolean value coborrower has former foreclosure | false | true, false |
| borrower_former_bankruptcy | Boolean value borrower has former bankruptcy | false | true, false |
| military_active_duty | Boolean value borrower is active military | false | true, false |
| military_retired_or_discharged | Boolean value borrower military or discharged | false | true, false |
| military_surviving_spouse | Boolean value borrower is surviing spouse of military | false | true, false |
| property_mixed_use | Boolean value property will be residential and business | false | true, false |
| borrower_former_pre_foreclosure | Boolean value borrower has former pre-foreclosure | false | true, false |
| coborrower_former_pre_foreclosure | Boolean value coborrower has former pre-foreclosure | false | true, false |
| military_non_activated_member | Boolean value borrower is non-active miliary | false | true, false |
| working_with_realtor | Boolean value borrower currently has a realtor | true | true, false |
| realtor_introduction | Boolean value borrower would like to be introduced to a realtor | true | true, false |
| realtor_name | Name of borrower's realtor | Joan Del Arco | |
| realtor_phone | 10 digit phone number of borrower's realtor | 3334445555 | |
| realtor_email | Valid email of borrower's realtor | joan.del.arco@example.com | |
| primary_borrower[citizenship_residency_type] | Type of citizen residency | USCitizen | USCitizen, PermanentResidentAlien, NonPermanentResidentAlien |
| primary_borrower[continuous_employment] | Boolean value borrower has had two years of continuous employment | true | true, false |
| primary_borrower[dob] | YYYY-MM-DD of the borrower date of birth | 1985-11-15 | |
| primary_borrower[email] | Valid email of borrower | borrower_name@example.com | |
| primary_borrower[ethnicity_origin_type] | Ethnicity origin type | Mexican | Mexican, Puerto Rican, Cuban |
| primary_borrower[ethnicity_origin_type_other_desc] | Description of origin type | Peruvian | |
| primary_borrower[ethnicity_refused] | Boolean value does not provide ethnicity | true | true, false |
| primary_borrower[ethnicity_type] | Ethnicity type | NonHispanicOrLatino | HispanicOrLatino, NonHispanicOrLatino |
| primary_borrower[gender_refused] | Boolean value does not probide gender | true | true, false |
| primary_borrower[gender_type] | Gender type | Female | Female, Male |
| primary_borrower[homeownership_past_3_years] | Boolean value has owned a home in the last three years | true | true, false |
| primary_borrower[income_type] | Employment type | retirement | employment, self-employed, social-security, retirement |
| primary_borrower[outstanding_judgments] | Boolean value has outstanding judgements | true | true, false |
| primary_borrower[party_to_lawsuit] | Boolean value is party to a lawsuit | true | true, false |
| primary_borrower[presently_delinquent] | Boolean value is presently delinquient | true | true, false |
| primary_borrower[prior_property_title_type] | Prior property title type | JointWithOtherThanSpouse | Sole, JointWithSpouse, JointWithOtherThanSpouse |
| primary_borrower[prior_property_usage_type] | Prior property usage type | FhaSecondaryResidence | PrimaryResidence, SecondHome, Investment, FhaSecondaryResidence |
| primary_borrower[race_designation_other_asian_desc] | Other Asian description | Hmong | |
| primary_borrower[race_designation_other_pacific_islander_desc] | Other Pacific Islander description | Fijian | |
| primary_borrower[race_designation_type] | Race designation type | Vietnamese | AsianIndian, Chinese, Filipino, Japanese, Korean, Vietnamese, NativeHawaiian, GuamanianOrChamorro, Samoan |
| primary_borrower[race_refused] | Boolean value does not provide race | true | true, false |
| primary_borrower[race_type] | Race type | BlackOrAfricanAmerican | AmericanIndianOrAlaskaNative, Asian, NativeHawaiianOrOtherPacificIslander, BlackOrAfricanAmerican, White |
| primary_borrower[race_type_additional_desc] | Enrolled/principal tribe | Tribe Name | |
| primary_borrower[residences_past_2yrs] | Integer number of borrower residences | 1 | |
| primary_borrower[self_employed] | Boolean value is self employed | true | true, false |
| primary_borrower[ssn] | Borrower social security number | 123-45-6789 | |
| primary_borrower[suffix] | Borrower name suffix | Esq. | |
| primary_borrower[time_in_property] | Integer years borrower has owned refinance property | 3 | |
| primary_borrower[undisclosed_borrowed_funds] | Boolean value has undisclosed funds | true | true, false |
| primary_borrower[undisclosed_borrowed_funds_amount] | Integer amount of undisclosed funds | 10000 | |
| primary_borrower[undisclosed_comaker_of_note] | Boolean value is comaker of note | true | true, false |
| primary_borrower[occupy_as_primary_residence] | Boolean value occupies home as primary residence | true | true, false |
| primary_borrower[special_seller_relationship] | Boolean value has special relationship to seller | true | true, false |
| primary_borrower[undisclosed_mortgage_application] | Boolean value has undisclosed mortgage application | true | true, false |
| primary_borrower[undisclosed_credit_application] | Boolean value has undisclosed credit application | true | true, false |
| primary_borrower[conveyed_title] | Boolean value has conveyed title | true | true, false |
| primary_borrower[incomes][start_on] | Date format MM-YYYY | 02-2012 | |
| primary_borrower[incomes][end_on] | Date format MM-YYYY | 02-2012 | |
| primary_borrower[incomes][income_type] | Type of income | retirement | employment, self-employed, social-security, retirement |
| primary_borrower[incomes][name] | Name of the employment or employer | My Great Company | |
| primary_borrower[incomes][yearly_income] | Integer yearly income | 60000 | |
| primary_borrower[properties][address] | Refinance property street address | 123 Main St. | |
| primary_borrower[properties][city] | Refinance property city | Denver | |
| primary_borrower[properties][state] | Refinance property state | Colorado | |
| primary_borrower[properties][zip] | Refinance property zip code | 55555 | |
| primary_borrower[properties][move_in_on] | MM-YYYY Move in on date for this property | 04-2012 |
Request
Route
POST /v2/refinance_applications
Headers
Content-Type: application/json
Host: https://www.americanfinancing.net
Cookie: None
Authorization: Token your_private_afc_api_token_hereBody
{
"property_zip": "99999",
"property_state": "Colorado",
"property_street": "2061 Apple River Rd.",
"property_city": "Denver",
"collected_at": "2022-09-28T12:47:27.422-06:00",
"source": "OnlineLeadGenerators.com",
"campaign": "Refinance Long Form",
"medium": "Affiliate"
}Response
Simulated Response
Status
422Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Content-Security-Policy: connect-src 'self' https: http://localhost:3035 ws://localhost:3035
X-Request-Id: 8d0bd3fa-9c1f-47cc-8465-019436999412
X-Runtime: 0.019619
Vary: Origin
Content-Length: 261Body
[
"Primary borrower can't be blank",
"Primary borrower {:first_name=>[\"can't be blank\"], :last_name=>[\"can't be blank\"], :email=>[\"can't be blank\", \"is not an email\"], :phone=>[\"can't be blank\", \"must contain exactly 10 digits\"]}"
]Error: Invalid parameter value
Endpoint
POST /v2/refinance_applications
Parameters
| Name | Description | Example | Accepted Inputs |
|---|---|---|---|
| property_city required | City of the address of the refinance property | Denver | |
| property_state required | State of the address of the refinance property | Colorado | |
| property_street required | Street address of the refinance property | 123 Main St. | |
| property_zip required | Zip code of the refinance property | 45678 | |
| medium required | Marketing Channel | Affiliate | "Affiliate", "Email", "Display", etc. |
| source required | Marketing parameter | Request this from American Financing | |
| campaign required | Marketing parameter | Request this from American Financing | |
| term | Marketing Campaign Type | Home Improvement Loan | |
| collected_at required | Optimal date format is ISO-8601. Most common UTC date formats, such as YYYY-MM-DD, are also supported. | 2022-09-28 12:47:25 -0600 | |
| primary_borrower[first_name] required | First name of borrower | Frida | |
| primary_borrower[last_name] required | Last name of borrower | Kahlo | |
| primary_borrower[email] required | Valid email address of borrower | frida.kahlo@gmail.com | |
| primary_borrower[phone] required | 10-digit phone number of borrower | 1234567890 | |
| tracking_id | Lead specific tracking id | 12334567865432123456 | |
| property_type | Type of property | Condo | Single Family, Townhome, Condo, Multiple Unit |
| initial_purchase_price | Purchase price of refinance property | 500000 | |
| remaining_balance | Amount left on the current mortgage | 250000 | |
| second_mortgage | Boolean value borrower has a second mortgage | false | true, false |
| second_mortgage_remaining_balance | Amount left on second mortgage | 120000 | |
| borrower_birthdate | YYYY-MM-DD of the borrower date of birth | 1985-11-15 | |
| coborrower_birthdate | YYYY-MM-DD of the coborrower date of birth | 1944-01-30 | |
| borrower_years_on_job | Borrower consecutive years at current employment | 4 | |
| borrower_marital_status | Borrower marital status | Married | Married, Unmarried |
| borrower_property_intent | How will borrower use the property | Investment property | Primary residence, Second home, Investment property |
| borrower_primary_address | Borrower street address | 123 Main St. | |
| borrower_primary_city | Borrower address city | Denver | |
| borrower_primary_state | Borrower address state | Colorado | |
| borrower_primary_zip | Borrower address zip code (5 digits) | 55555 | |
| reason | Why is borrower refinancing | Cash Out For Other Use | Lower Rate/Payment, Shorten Loan Term, Cash Out To Payoff Debts, Cash Out For Other Use |
| occupancy_type | How will borrower occupy residence | Owner Occupied | Owner Occupied, Not Owner Occupied |
| multiple_unit_type | Integer indicating multiplex units: 2, 3, or 4 | 3 | 2, 3, 4 |
| approximate_value | Approximate current value of refinance property | 600000 | |
| condo_type | Type of condo | High Rise Condo | High Rise Condo, Condominium |
| military_service | Boolean value borrower military service | false | true, false |
| self_rated_credit | Borrower credit score | 710 | |
| military_projected_service_end | Date of end of borrower miliary service YYYY-MM-DD | 2025-04-28 | |
| borrower_former_bankruptcy_type | Type of bankruptcy | Chapter13 | Chapter7, Chapter11, Chapter12, Chapter13 |
| coborrower_former_bankruptcy_type | Type of bankruptcy | Chapter13 | Chapter7, Chapter11, Chapter12, Chapter13 |
| dependents_ages | Array of ages of dependents | [1, 3, 13] | |
| dependents_count | Number of dependents borrower has | 3 | |
| borrower_former_foreclosure | Boolean value borrower had a foreclosure | false | true, false |
| foreclosure_date | Date of forclosure YYYY-MM-DD | 2020-04-13 | |
| former_pre_foreclosure | Boolean value borrower had a pre-foreclosure | true | true, false |
| pre_foreclosure_date | Date of pre-forclosure YYYY-MM-DD | 2020-04-13 | |
| cash_out_amount | Amount borrower wants as cash out | 100000 | |
| second_mortgage_type | Type of second mortgage | HELOC | Home Equity, HELOC |
| heloc_drawn_amount | HELOC amount drawn | 30000 | |
| heloc_line_amount | HELOC line amount | 200000 | |
| housing_expense_monthly_mortgage_payment | Monthly mortgage payment amount | 2000 | |
| housing_expense_principal_interest | Monthly interest on mortgage principle | 100 | |
| housing_expense_taxes | Monthly taxes | 400 | |
| housing_expense_insurance | Monthly insurance | 200 | |
| housing_expense_hoa_dues | Monthly HOA dues | 300 | |
| housing_expense_second_mortgage | Monthly expense for a second mortgage | 1000 | |
| current_interest_rate | Monthly interest rate | .04 | |
| borrower_loan_objective | Why does the borrower want to refinance | Cash out for a new kitchen | |
| coborrower_former_bankruptcy | Boolean value coborrower has former bankruptcy | false | true, false |
| coborrower_former_foreclosure | Boolean value coborrower has former foreclosure | false | true, false |
| borrower_former_bankruptcy | Boolean value borrower has former bankruptcy | false | true, false |
| military_active_duty | Boolean value borrower is active military | false | true, false |
| military_retired_or_discharged | Boolean value borrower military or discharged | false | true, false |
| military_surviving_spouse | Boolean value borrower is surviing spouse of military | false | true, false |
| property_mixed_use | Boolean value property will be residential and business | false | true, false |
| borrower_former_pre_foreclosure | Boolean value borrower has former pre-foreclosure | false | true, false |
| coborrower_former_pre_foreclosure | Boolean value coborrower has former pre-foreclosure | false | true, false |
| military_non_activated_member | Boolean value borrower is non-active miliary | false | true, false |
| working_with_realtor | Boolean value borrower currently has a realtor | true | true, false |
| realtor_introduction | Boolean value borrower would like to be introduced to a realtor | true | true, false |
| realtor_name | Name of borrower's realtor | Joan Del Arco | |
| realtor_phone | 10 digit phone number of borrower's realtor | 3334445555 | |
| realtor_email | Valid email of borrower's realtor | joan.del.arco@example.com | |
| primary_borrower[citizenship_residency_type] | Type of citizen residency | USCitizen | USCitizen, PermanentResidentAlien, NonPermanentResidentAlien |
| primary_borrower[continuous_employment] | Boolean value borrower has had two years of continuous employment | true | true, false |
| primary_borrower[dob] | YYYY-MM-DD of the borrower date of birth | 1985-11-15 | |
| primary_borrower[email] | Valid email of borrower | borrower_name@example.com | |
| primary_borrower[ethnicity_origin_type] | Ethnicity origin type | Mexican | Mexican, Puerto Rican, Cuban |
| primary_borrower[ethnicity_origin_type_other_desc] | Description of origin type | Peruvian | |
| primary_borrower[ethnicity_refused] | Boolean value does not provide ethnicity | true | true, false |
| primary_borrower[ethnicity_type] | Ethnicity type | NonHispanicOrLatino | HispanicOrLatino, NonHispanicOrLatino |
| primary_borrower[gender_refused] | Boolean value does not probide gender | true | true, false |
| primary_borrower[gender_type] | Gender type | Female | Female, Male |
| primary_borrower[homeownership_past_3_years] | Boolean value has owned a home in the last three years | true | true, false |
| primary_borrower[income_type] | Employment type | retirement | employment, self-employed, social-security, retirement |
| primary_borrower[outstanding_judgments] | Boolean value has outstanding judgements | true | true, false |
| primary_borrower[party_to_lawsuit] | Boolean value is party to a lawsuit | true | true, false |
| primary_borrower[presently_delinquent] | Boolean value is presently delinquient | true | true, false |
| primary_borrower[prior_property_title_type] | Prior property title type | JointWithOtherThanSpouse | Sole, JointWithSpouse, JointWithOtherThanSpouse |
| primary_borrower[prior_property_usage_type] | Prior property usage type | FhaSecondaryResidence | PrimaryResidence, SecondHome, Investment, FhaSecondaryResidence |
| primary_borrower[race_designation_other_asian_desc] | Other Asian description | Hmong | |
| primary_borrower[race_designation_other_pacific_islander_desc] | Other Pacific Islander description | Fijian | |
| primary_borrower[race_designation_type] | Race designation type | Vietnamese | AsianIndian, Chinese, Filipino, Japanese, Korean, Vietnamese, NativeHawaiian, GuamanianOrChamorro, Samoan |
| primary_borrower[race_refused] | Boolean value does not provide race | true | true, false |
| primary_borrower[race_type] | Race type | BlackOrAfricanAmerican | AmericanIndianOrAlaskaNative, Asian, NativeHawaiianOrOtherPacificIslander, BlackOrAfricanAmerican, White |
| primary_borrower[race_type_additional_desc] | Enrolled/principal tribe | Tribe Name | |
| primary_borrower[residences_past_2yrs] | Integer number of borrower residences | 1 | |
| primary_borrower[self_employed] | Boolean value is self employed | true | true, false |
| primary_borrower[ssn] | Borrower social security number | 123-45-6789 | |
| primary_borrower[suffix] | Borrower name suffix | Esq. | |
| primary_borrower[time_in_property] | Integer years borrower has owned refinance property | 3 | |
| primary_borrower[undisclosed_borrowed_funds] | Boolean value has undisclosed funds | true | true, false |
| primary_borrower[undisclosed_borrowed_funds_amount] | Integer amount of undisclosed funds | 10000 | |
| primary_borrower[undisclosed_comaker_of_note] | Boolean value is comaker of note | true | true, false |
| primary_borrower[occupy_as_primary_residence] | Boolean value occupies home as primary residence | true | true, false |
| primary_borrower[special_seller_relationship] | Boolean value has special relationship to seller | true | true, false |
| primary_borrower[undisclosed_mortgage_application] | Boolean value has undisclosed mortgage application | true | true, false |
| primary_borrower[undisclosed_credit_application] | Boolean value has undisclosed credit application | true | true, false |
| primary_borrower[conveyed_title] | Boolean value has conveyed title | true | true, false |
| primary_borrower[incomes][start_on] | Date format MM-YYYY | 02-2012 | |
| primary_borrower[incomes][end_on] | Date format MM-YYYY | 02-2012 | |
| primary_borrower[incomes][income_type] | Type of income | retirement | employment, self-employed, social-security, retirement |
| primary_borrower[incomes][name] | Name of the employment or employer | My Great Company | |
| primary_borrower[incomes][yearly_income] | Integer yearly income | 60000 | |
| primary_borrower[properties][address] | Refinance property street address | 123 Main St. | |
| primary_borrower[properties][city] | Refinance property city | Denver | |
| primary_borrower[properties][state] | Refinance property state | Colorado | |
| primary_borrower[properties][zip] | Refinance property zip code | 55555 | |
| primary_borrower[properties][move_in_on] | MM-YYYY Move in on date for this property | 04-2012 |
Request
Route
POST /v2/refinance_applications
Headers
Content-Type: application/json
Host: https://www.americanfinancing.net
Cookie: None
Authorization: Token your_private_afc_api_token_hereBody
{
"primary_borrower": {
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@gmail.net",
"phone": "5555555555"
},
"foreclosure_date": "1890-9-20",
"property_zip": "9999",
"property_state": "Colorado",
"property_street": "2061 Apple River Rd.",
"property_city": "Denver",
"collected_at": "2022-09-28T12:47:27.459-06:00",
"source": "OnlineLeadGenerators.com",
"campaign": "Refinance Long Form",
"medium": "Affiliate"
}Response
Simulated Response
Status
422Headers
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Content-Security-Policy: connect-src 'self' https: http://localhost:3035 ws://localhost:3035
X-Request-Id: edc6c7e5-a159-4e53-bb23-5374b6333a57
X-Runtime: 0.018490
Vary: Origin
Content-Length: 117Body
[
"Property zip must contain 5 digits in format XXXXX",
"Foreclosure date must be a valid date no older than 1900-1-1"
]