Leads

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.

Submit a lead

Endpoint

POST /v2/leads

Parameters

Name Description Example
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 parameter Internet
source required Marketing parameter Your Company Name
campaign required Marketing parameter AFC Leads Campaign
term Marketing campaign type Campaign ABC
collected_at required ISO8601 format DateTime (preferred) or Date 2022-02-08 15:11:58 -0700
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_here

Body

{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane.doe@gmail.net",
  "phone": "+15555555555",
  "us_state": "co",
  "loan_type": "purchase",
  "collected_at": "2022-02-08T15:11:58.279-07:00",
  "source": "OnlineLeadGenerators.com",
  "campaign": "The Jane Doe Radio Show",
  "medium": "Internet Leads"
}

Response

Simulated Response

Status

201

Headers

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/"d0633837bcda3e1efcec73123d762d92"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 70536dcf-0cd2-4662-a1a7-98906dba2e80
X-Runtime: 0.943592
Content-Length: 691

Body

{
  "id": 1,
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane.doe@gmail.net",
  "phone": "5555555555",
  "zip": null,
  "type": "purchase",
  "source": "OnlineLeadGenerators.com",
  "endorser": "The Jane Doe Radio Show",
  "internet_source": "Internet Leads",
  "created_at": "2022-02-08T16:11:59.194-07:00",
  "updated_at": "2022-02-08T16:11:59.194-07:00",
  "session_uuid": null,
  "original_endorser": "The Jane Doe Radio Show",
  "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-02-08T15:11:58.279-07:00",
  "state": "Colorado",
  "cid": null,
  "nal": false,
  "campaign_type": null
}

Error: Missing required fields

Endpoint

POST /v2/leads

Parameters

Name Description Example
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 parameter Internet
source required Marketing parameter Your Company Name
campaign required Marketing parameter AFC Leads Campaign
term Marketing campaign type Campaign ABC
collected_at required ISO8601 format DateTime (preferred) or Date 2022-02-08 15:11:58 -0700
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_here

Body

{
  "first_name": "Jane",
  "last_name": "Doe",
  "phone": "5555555555",
  "zip_code": "99999",
  "us_state": "Colorado",
  "loan_type": "purchase",
  "collected_at": "2022-02-08T15:11:59.311-07:00",
  "source": "OnlineLeadGenerators.com",
  "campaign": "The Jane Doe Radio Show",
  "medium": "Internet Leads"
}

Response

Simulated Response

Status

422

Headers

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
X-Request-Id: 16be94ac-7043-4407-9d54-e1ede3b2e3f1
X-Runtime: 1.252113
Content-Length: 48

Body

[
  "Email can't be blank",
  "Email is not an email"
]

Error: Invalid parameter value

Endpoint

POST /v2/leads

Parameters

Name Description Example
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 parameter Internet
source required Marketing parameter Your Company Name
campaign required Marketing parameter AFC Leads Campaign
term Marketing campaign type Campaign ABC
collected_at required ISO8601 format DateTime (preferred) or Date 2022-02-08 15:11:58 -0700
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_here

Body

{
  "first_name": "Jane",
  "last_name": "Doe",
  "phone": "5555555555",
  "email": "jane.doe@gmail.net",
  "us_state": "Ontario",
  "loan_type": "refinance",
  "collected_at": "2022-02-08T15:12:00.582-07:00",
  "source": "OnlineLeadGenerators.com",
  "campaign": "The Jane Doe Radio Show",
  "medium": "Internet Leads"
}

Response

Simulated Response

Status

422

Headers

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
X-Request-Id: 410049bf-4d05-493e-99c5-ec67bce5f4f4
X-Runtime: 0.026525
Content-Length: 65

Body

[
  "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 Internet
source required Marketing parameter Your Company Name
campaign required Marketing parameter AFC Leads Campaign
term Marketing campaign type Campaign ABC
collected_at required Optimal date format is ISO-8601. Most common UTC date formats, such as YYYY-MM-DD, are also supported. 2022-02-08 15:11:58 -0700
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_here

Body

{
  "primary_borrower": {
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane.doe@gmail.net",
    "phone": "5555555555"
  },
  "area_state": "Colorado",
  "endorser": "Mycompany",
  "collected_at": "2022-02-08T15:12:00.627-07:00",
  "source": "OnlineLeadGenerators.com",
  "campaign": "The Jane Doe Radio Show",
  "medium": "Internet Leads"
}

Response

Simulated Response

Status

201

Headers

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/"681e3de25cbac7d0b7fa7b19cf512be4"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c7d790f9-59a5-4457-8a9d-43f709a601ff
X-Runtime: 0.604020
Content-Length: 2548

Body

{
  "id": 1,
  "internet_protocol": null,
  "loan_purpose": "purchase",
  "source": "OnlineLeadGenerators.com",
  "endorser": "The Jane Doe Radio Show",
  "internet_source": "Internet Leads",
  "_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-02-08T16:12:01.026-07:00",
  "updated_at": "2022-02-08T16:12:01.026-07:00",
  "condo_type": null,
  "multiple_unit_type": null,
  "session_uuid": null,
  "slug": "ZqyrhiY46F",
  "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": "855b79a4-8934-11ec-bd24-0242ac140006",
  "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": "Mycompany",
  "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-02-08T15:12:00.627-07: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 Internet
source required Marketing parameter Your Company Name
campaign required Marketing parameter AFC Leads Campaign
term Marketing campaign type Campaign ABC
collected_at required Optimal date format is ISO-8601. Most common UTC date formats, such as YYYY-MM-DD, are also supported. 2022-02-08 15:11:58 -0700
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_here

Body

{
  "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",
  "endorser": "Mycompany",
  "collected_at": "2022-02-08T15:12:01.253-07:00",
  "source": "OnlineLeadGenerators.com",
  "campaign": "The Jane Doe Radio Show",
  "medium": "Internet Leads",
  "military_service": false,
  "property_type": "Townhome"
}

Response

Simulated Response

Status

201

Headers

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/"022253f1a55e355340e341bcc8ff3d42"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c3e95e7b-06f1-4a6d-8975-2cdc8dbf9534
X-Runtime: 0.052919
Content-Length: 2555

Body

{
  "id": 2,
  "internet_protocol": null,
  "loan_purpose": "purchase",
  "source": "OnlineLeadGenerators.com",
  "endorser": "The Jane Doe Radio Show",
  "internet_source": "Internet Leads",
  "_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-02-08T16:12:01.297-07:00",
  "updated_at": "2022-02-08T16:12:01.297-07:00",
  "condo_type": null,
  "multiple_unit_type": null,
  "session_uuid": null,
  "slug": "YRby4jT5Uc",
  "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": "8584c9b2-8934-11ec-bd24-0242ac140006",
  "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": "Mycompany",
  "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-02-08T15:12:01.253-07:00",
  "cid": null,
  "nal": false,
  "marketing_variant": null,
  "campaign_type": null
}

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 Internet
source required Marketing parameter Your Company Name
campaign required Marketing parameter AFC Leads Campaign
term Marketing campaign type Campaign ABC
collected_at required Optimal date format is ISO-8601. Most common UTC date formats, such as YYYY-MM-DD, are also supported. 2022-02-08 15:11:58 -0700
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_here

Body

{
  "area_state": "Colorado",
  "endorser": "Mycompany",
  "collected_at": "2022-02-08T15:12:01.328-07:00",
  "source": "OnlineLeadGenerators.com",
  "campaign": "The Jane Doe Radio Show",
  "medium": "Internet Leads"
}

Response

Simulated Response

Status

422

Headers

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
X-Request-Id: bbacf7f5-d95d-43d4-aa67-8009c889f368
X-Runtime: 0.039076
Content-Length: 261

Body

[
  "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 Internet
source required Marketing parameter Your Company Name
campaign required Marketing parameter AFC Leads Campaign
term Marketing campaign type Campaign ABC
collected_at required Optimal date format is ISO-8601. Most common UTC date formats, such as YYYY-MM-DD, are also supported. 2022-02-08 15:11:58 -0700
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_here

Body

{
  "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",
  "endorser": "Mycompany",
  "collected_at": "2022-02-08T15:12:01.392-07:00",
  "source": "OnlineLeadGenerators.com",
  "campaign": "The Jane Doe Radio Show",
  "medium": "Internet Leads"
}

Response

Simulated Response

Status

422

Headers

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
X-Request-Id: 2da87ece-298b-4add-98af-32fd2fb3336c
X-Runtime: 0.020472
Content-Length: 117

Body

[
  "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 parameter Internet
source required Marketing parameter Your Company Name
campaign required Marketing parameter AFC Leads Campaign
term Marketing campaign type Campaign ABC
collected_at required Optimal date format is ISO-8601. Most common UTC date formats, such as YYYY-MM-DD, are also supported. 2022-02-08 15:11:58 -0700
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_here

Body

{
  "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",
  "endorser": "Mycompany",
  "collected_at": "2022-02-08T15:12:01.433-07:00",
  "source": "OnlineLeadGenerators.com",
  "campaign": "The Jane Doe Radio Show",
  "medium": "Internet Leads"
}

Response

Simulated Response

Status

201

Headers

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/"a26b28c4b1a787f45e57f150d816aa58"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 501a733d-b673-4209-a079-3484471ef91d
X-Runtime: 0.304791
Content-Length: 3071

Body

{
  "id": 1,
  "internet_protocol": null,
  "loan_purpose": "refinance",
  "source": "OnlineLeadGenerators.com",
  "endorser": "The Jane Doe Radio Show",
  "internet_source": "Internet Leads",
  "_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-02-08T16:12:01.643-07:00",
  "updated_at": "2022-02-08T16:12:01.643-07:00",
  "session_uuid": null,
  "slug": "1WjDKad0Ju",
  "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": "85b9af42-8934-11ec-bd24-0242ac140006",
  "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": "Mycompany",
  "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-02-08T15:12:01.433-07: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 parameter Internet
source required Marketing parameter Your Company Name
campaign required Marketing parameter AFC Leads Campaign
term Marketing campaign type Campaign ABC
collected_at required Optimal date format is ISO-8601. Most common UTC date formats, such as YYYY-MM-DD, are also supported. 2022-02-08 15:11:58 -0700
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_here

Body

{
  "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",
  "endorser": "Mycompany",
  "collected_at": "2022-02-08T15:12:01.758-07:00",
  "source": "OnlineLeadGenerators.com",
  "campaign": "The Jane Doe Radio Show",
  "medium": "Internet Leads",
  "military_service": false,
  "approximate_value": "100000",
  "property_type": "Townhome"
}

Response

Simulated Response

Status

201

Headers

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/"c7feb27e068a113e86e1508e6501f9c1"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 1d62803d-4215-4d28-b5eb-1bee50532f2f
X-Runtime: 0.048732
Content-Length: 3082

Body

{
  "id": 2,
  "internet_protocol": null,
  "loan_purpose": "refinance",
  "source": "OnlineLeadGenerators.com",
  "endorser": "The Jane Doe Radio Show",
  "internet_source": "Internet Leads",
  "_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-02-08T16:12:01.796-07:00",
  "updated_at": "2022-02-08T16:12:01.796-07:00",
  "session_uuid": null,
  "slug": "eK2NkhzsOG",
  "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": "85d0e4f0-8934-11ec-bd24-0242ac140006",
  "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": "Mycompany",
  "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-02-08T15:12:01.758-07:00",
  "cid": null,
  "nal": false,
  "marketing_variant": null,
  "campaign_type": null
}

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 parameter Internet
source required Marketing parameter Your Company Name
campaign required Marketing parameter AFC Leads Campaign
term Marketing campaign type Campaign ABC
collected_at required Optimal date format is ISO-8601. Most common UTC date formats, such as YYYY-MM-DD, are also supported. 2022-02-08 15:11:58 -0700
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_here

Body

{
  "property_zip": "99999",
  "property_state": "Colorado",
  "property_street": "2061 Apple River Rd.",
  "property_city": "Denver",
  "endorser": "Mycompany",
  "collected_at": "2022-02-08T15:12:01.827-07:00",
  "source": "OnlineLeadGenerators.com",
  "campaign": "The Jane Doe Radio Show",
  "medium": "Internet Leads"
}

Response

Simulated Response

Status

422

Headers

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
X-Request-Id: 6e1e6a94-6daf-454e-b903-cbd97c109e66
X-Runtime: 0.024174
Content-Length: 261

Body

[
  "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 parameter Internet
source required Marketing parameter Your Company Name
campaign required Marketing parameter AFC Leads Campaign
term Marketing campaign type Campaign ABC
collected_at required Optimal date format is ISO-8601. Most common UTC date formats, such as YYYY-MM-DD, are also supported. 2022-02-08 15:11:58 -0700
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_here

Body

{
  "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",
  "endorser": "Mycompany",
  "collected_at": "2022-02-08T15:12:01.871-07:00",
  "source": "OnlineLeadGenerators.com",
  "campaign": "The Jane Doe Radio Show",
  "medium": "Internet Leads"
}

Response

Simulated Response

Status

422

Headers

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
X-Request-Id: 9a8c65a7-d7e4-4adc-a787-45b6dfcaf265
X-Runtime: 0.024199
Content-Length: 117

Body

[
  "Property zip must contain 5 digits in format XXXXX",
  "Foreclosure date must be a valid date no older than 1900-1-1"
]