API Reference

Retrieves Personal Loan Application details from the Loan Origination System. This data includes details regarding the specific consumer loan application and may vary depending on the target Loan Origination System.

{
    "success": true,
    "payload":{
        "applicant": {
            "borrower_id": "123456789",
            "first_name": "John",
            "last_name": "Kroft",
            "middle_name": "Armistead",
            "suffix": "Jr",
            "ssn": "333331000",
            "dob": "1980-01-01",
            "citizenship": "USA",
            "applicant_type": "Individual",
            "id_card":{
                "card_number": "11122333",
                "card_type": "DL",
                "country": "USA",
                "date_issued": "2015-01-01",
                "exp_date": "2025-01-01",
                "state": "MA"
            },
            "current_address":{
                "occupancy_duration": "10",
                "occupancy_status": "string",
                "street_address_1": "18 Roberts Rd",
                "city": "Medford",
                "state": "MA",
                "zip": "02155",
                "county": "Medford"
            },
            "previous_address":{
                "street_address_1": "595 East 2nd St",
                "city": "Boston",
                "state": "MA",
                "zip": "02111"
            },
            "mailing_address":{
                "is_current": "true",
                "street_address_1": "18 Roberts Rd",
                "city": "Medford",
                "state": "MA",
                "zip": "02155",
                "county": "Medford"
            },
            "financial_data":{
                "current_employment":{
                    "employment_start_date": "2015-01-01",
                    "employed_months": "112",
                    "occupation": "Software Engineer",
                    "employer": "Sandbox Banking",
                    "employment_phone": "1230001234",
                    "employment_status": "string",
                    "pay_grade": "string"
                },
                "previous_employment":{
                    "employed_months": "200",
                    "occupation": "Camera Operator",
                    "employer": "ABC Corporation",
                    "employment_status": "string"
                },
                "income":{
                    "base_salary": "100000",
                    "monthly_income": "8333",
                    "monthly_income_description": "Payroll"
                },
                "debt":{
                    "monthly_rent": "0",
                    "monthly_mortgage_payment": "2000"
                }
            },
            "contact_data": {
                "preferred_contact_method": "Phone",
                "cell_phone": "1445554444",
                "email": "[email protected]",
                "home_phone": "1445554444",
                "work_phone": "2335559292"
            },
            "spouse_data":{
                "borrower_id": "234567890",
                "first_name": "Mary",
                "last_name": "Kroft",
                "middle_name": "",
                "suffix": "",
                "ssn": "444559999",
                "dob": "1980-05-01",
                "citizenship": "USA",
                "applicant_type": "Individual",
                "spouse_id_card":{
                    "card_number": "11122444",
                    "card_type": "DL",
                    "country": "USA",
                    "date_issued": "2015-01-01",
                    "exp_date": "2025-01-01",
                    "state": "MA"
                },
                "spouse_current_address":{
                    "occupancy_duration": "10",
                    "occupancy_status": "string",
                    "street_address_1": "18 Roberts Rd",
                    "city": "Medford",
                    "state": "MA",
                    "zip": "02155",
                    "county": "Medford"
                },
                "spouse_previous_address":{
                    "street_address_1": "595 East 2nd St",
                    "city": "Boston",
                    "state": "MA",
                    "zip": "02111"
                },
                "spouse_mailing_address":{
                    "is_current": "true",
                    "street_address_1": "18 Roberts Rd",
                    "city": "Medford",
                    "state": "MA",
                    "zip": "02155",
                    "county": "Medford"
                },
                "spouse_financial_data":{
                    "spouse_current_employment":{
                        "employment_start_date": "2013-01-05",
                        "employed_months": "135",
                        "occupation": "Account Manager",
                        "employer": "Sandbox Banking",
                        "employment_phone": "3334445555",
                        "employment_status": "string",
                        "pay_grade": "string"
                    },
                    "spouse_previous_employment":{
                        "employed_months": "60",
                        "occupation": "Sales Representative",
                        "employer": "ABC Corporation",
                        "employment_status": "string"
                    },
                    "spouse_income":{
                        "base_salary": "100000",
                        "monthly_income": "8333",
                        "monthly_income_description": "Payroll and Commission"
                    },
                    "spouse_debt":{
                        "monthly_rent": "0",
                        "monthly_mortgage_payment": "2000"
                    }
                },
                "spouse_contact_data":{
                    "preferred_contact_method": "Email",
                    "cell_phone": "5690948829",
                    "email": "[email protected]",
                    "home_phone": "5690948829",
                    "work_phone": "6679928839"
                }
            }
        },
        "loan_data": {
            "record_id": "123456",
            "personal_loan_type": "Personal",
            "purpose_type": "Home Improvement",
            "amount_requested": "25000",
            "loan_term_requested": "5",
            "loan_term": "60",
            "purpose_description": "Personal Loan to fund home improvement project",
            "extra_collateral_owner_1": "Mary Kroft",
            "extra_collateral_owner_2": "",
            "is_LOC": "true",
            "is_overdraft": "false",
            "is_addon": "false",
            "loan_status": "submission",
            "is_locked": "false",
            "insurance_options": "",
            "comments": "Fund for home improvement project",
            "external_comments": "",
            "source": "Online Banking",
            "external_source": "Online Banking",
            "branch_reference_id": "1234",
            "lender_code": "C45",
            "organization_code": "SNDBX123",
            "loan_number": "999888777777"
        }
    }
}
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!