• controller [string]: 'pl'
• method [string]: 'Userkey'
• apikey [string]: API key of the current user

{
    "status": "ok",
    "controller": "pl",
    "method": "Userkey",
    "nonce": "6b880f95cc"
}

• nonce [string]: Result of calling 'get_nonce' method
• apikey [string]: API key of the current user
• username [string]: Login of the current user
• password [string]: Pasword of the current user

{
    "status": "ok",
    "userkey": "username%7C1713047870%7Cd45f0bd7d03014b0c51cd6d9e0c7f794%7C8a9b0f85e86096973f97f19ad5f4f7275d8e34187adc3b43ed91662921a6de8f",
    "expiration": 1713047870
}

• apikey [string]: API key of the current user
• userkey [string]: Result of calling 'Userkey' method
• loan_id [int]: WLCF loan_id

{
    "status": "ok",
    "borrower_details": {
        "id": 63578,
        "username": "newborrower1",
        "email": "newBorrower1@gmail.com",
        "first_name": "John",
        "last_name": "Doe",
        "dob": "10-01-1983",
        "annual_income": "25000",
        "postcode": "AL11EA",
        "city": "London",
        "street": "Address Line 1",
        "building": "10",
        "building_name": "",
        "flat": "",
        "years_lived": "",
        "previous_address": "",
        "homeowner_status": "",
        "employment_status": "Unemployed",
        "employer_name": "",
        "marketing_opt_in": "",
        "terms_conditions": "",
        "phone_number": "123456789"
    },
    "loan_details": {
        "id": 289037,
        "status": "Live - Performing",
        "purpose": "a holiday",
        "currency": "GBP",
        "amount": 1000,
        "term": 12,
        "interest_rate": 15.5,
        "score": 100,
        "acceptance_code": "2168",
        "gocardless_subscription_id": "SB123456789",
        "gocardless_customer_id": "CU123456789",
        "number_of_times_delinquent": 2,
        "days_delinquent": 74,
        "amount_delinquent": 90.49,
        "payments_delinquent": 1,
        "capital_balance": 922.42,
        "interest_balance": 72.97,
        "utm_source": ""
    },
    "status_updates": [
        {
            "date": "2023-01-31 11:33:34",
            "status": "Live - Performing",
            "user_id": 1761,
            "user_name": "Pawel2 Szewczyk"
        }
    ],
    "invoice_finances": [
        {
            "ID": "3",
            "ref": "Repayments app_id: 288412",
            "application_id": "289037",
            "amount": "100",
            "payment_due": "2022-12-14",
            "status": "paid_out",
            "currency": "GBP",
            "payment_id": "PM006HE7DZZXCM"
        },
        {
            "ID": "25",
            "ref": "Repayments app_id: 288412",
            "application_id": "289037",
            "amount": "100",
            "payment_due": "2023-02-08",
            "status": "failed",
            "currency": "GBP",
            "payment_id": "PM006HE7DZZXCE"
        }
    ],
    "loan_processing": {
        "assigned_to_id": 0,
        "assigned_to_name": "",
        "risk_rating": "",
        "status": "Live - Performing"
    },
    "loan_contract": {
        "url": "",
        "docusign_url": "",
        "docusign_id": "",
        "date_created": "",
        "date_signed": ""
    },
    "loan_completion": {
        "borrower_completion_date": "2023-01-31 11:33:34",
        "admin_completion_date": "2023-01-31 11:33:34",
        "repayments_start_date": "2023-01-10",
        "term_months": 12,
        "total_loan_amount": 1000
    },
    "invoice_schedule": [
        {
            "reference": "Repayments app_id: 288412",
            "amount": "100",
            "date": "2023-02-08",
            "status": "failed",
            "payment_id": "PM006HE7DZZXCE"
        },
        {
            "reference": "Repayments app_id: 288412",
            "amount": "100",
            "date": "2022-12-14",
            "status": "paid_out",
            "payment_id": "PM006HE7DZZXCM"
        }
    ],
    "loan_offers": [
        {
            "bid_id": 948,
            "lender_id": 54252,
            "amount": 1000,
            "capital_outstanding": 1000,
            "repaid_amount": 0,
            "rate": 15.5,
            "date": "2023-01-31 11:33:35",
            "status": 3
        }
    ],
    "repayments_schedule": [
        {
            "term_month": 1,
            "beginning_balance": 1000,
            "repayment_amount": 90.49,
            "capital": 77.58,
            "interest": 12.91,
            "ending_balance": 922.42,
            "date_due": "2022-11-10",
            "repayment_date": "2022-12-01",
            "status": 1,
            "payment_id": "PM006HE7DZZXCM",
            "days_delinquent": 21
        },
        {
            "term_month": 2,
            "beginning_balance": 922.42,
            "repayment_amount": 90.49,
            "capital": 78.58,
            "interest": 11.91,
            "ending_balance": 843.84,
            "date_due": "2022-12-10",
            "repayment_date": "",
            "status": 0,
            "payment_id": "",
            "days_delinquent": 74
        },
        {
            "term_month": 3,
            "beginning_balance": 843.84,
            "repayment_amount": 90.49,
            "capital": 79.59,
            "interest": 10.9,
            "ending_balance": 764.25,
            "date_due": "2023-03-10",
            "repayment_date": "",
            "status": 0,
            "payment_id": "",
            "days_delinquent": 0
        },
        {
            "term_month": 4,
            "beginning_balance": 764.25,
            "repayment_amount": 90.49,
            "capital": 80.62,
            "interest": 9.87,
            "ending_balance": 683.63,
            "date_due": "2023-04-10",
            "repayment_date": "",
            "status": 0,
            "payment_id": "",
            "days_delinquent": 0
        },
        {
            "term_month": 5,
            "beginning_balance": 683.63,
            "repayment_amount": 90.49,
            "capital": 81.66,
            "interest": 8.83,
            "ending_balance": 601.97,
            "date_due": "2023-05-10",
            "repayment_date": "",
            "status": 0,
            "payment_id": "",
            "days_delinquent": 0
        },
        {
            "term_month": 6,
            "beginning_balance": 601.97,
            "repayment_amount": 90.49,
            "capital": 82.72,
            "interest": 7.77,
            "ending_balance": 519.25,
            "date_due": "2023-06-10",
            "repayment_date": "",
            "status": 0,
            "payment_id": "",
            "days_delinquent": 0
        },
        {
            "term_month": 7,
            "beginning_balance": 519.25,
            "repayment_amount": 90.49,
            "capital": 83.79,
            "interest": 6.7,
            "ending_balance": 435.46,
            "date_due": "2023-07-10",
            "repayment_date": "",
            "status": 0,
            "payment_id": "",
            "days_delinquent": 0
        },
        {
            "term_month": 8,
            "beginning_balance": 435.46,
            "repayment_amount": 90.49,
            "capital": 84.87,
            "interest": 5.62,
            "ending_balance": 350.59,
            "date_due": "2023-08-10",
            "repayment_date": "",
            "status": 0,
            "payment_id": "",
            "days_delinquent": 0
        },
        {
            "term_month": 9,
            "beginning_balance": 350.59,
            "repayment_amount": 90.49,
            "capital": 85.97,
            "interest": 4.52,
            "ending_balance": 264.62,
            "date_due": "2023-09-10",
            "repayment_date": "",
            "status": 0,
            "payment_id": "",
            "days_delinquent": 0
        },
        {
            "term_month": 10,
            "beginning_balance": 264.62,
            "repayment_amount": 90.49,
            "capital": 87.08,
            "interest": 3.41,
            "ending_balance": 177.54,
            "date_due": "2023-10-10",
            "repayment_date": "",
            "status": 0,
            "payment_id": "",
            "days_delinquent": 0
        },
        {
            "term_month": 11,
            "beginning_balance": 177.54,
            "repayment_amount": 90.49,
            "capital": 88.2,
            "interest": 2.29,
            "ending_balance": 89.34,
            "date_due": "2023-11-10",
            "repayment_date": "",
            "status": 0,
            "payment_id": "",
            "days_delinquent": 0
        },
        {
            "term_month": 12,
            "beginning_balance": 89.34,
            "repayment_amount": 90.49,
            "capital": 89.34,
            "interest": 1.15,
            "ending_balance": 0,
            "date_due": "2023-12-10",
            "repayment_date": "",
            "status": 0,
            "payment_id": "",
            "days_delinquent": 0
        }
    ],
    "borrower_vulnerabilities": {
        "mental_health": "low",
        "physical_health": "",
        "life_events": "medium",
        "resiliance": "",
        "financial_difficulties": "high",
        "capabilities": ""
    },
    "loan_flags": {
        "payment_holiday": true,
        "token_payments": true,
        "reduced_payments": false,
        "six_month_hold": false,
        "iva_trust_dead": false,
        "debt_management_plan": false,
        "breathing_space": true,
        "cancelled_dd": false,
        "fpnp": true
    },
    "open_banking_status": {
        "bank_account_connected": true,
        "plaid_access_token_received": false,
        "plaid_public_token_sent_to_exposit": true
    },
    "last_update_date": "2023-05-03 09:43:55"
}

• apikey [string]: API key of the current user
• userkey [string]: Result of calling 'Userkey' method
• status [string]: Loan status filter
• offset [int]:Pagination items offset (optional)
• limit [int]: Pagination items limit (optional)
• date_updated_from [string]: Filtering loans by Last Update Date (optional)
• date_updated_to [string]: Filtering loans by Last Update Date (optional)

{
    "status": "ok",
    "total_loans": 4,
    "displayed_loans": 1,
    "loans": [
        {
            "borrower_details": {
                "id": 55031,
                "username": "ialwhjds",
                "email": "heDDllo@mailinator.com",
                "first_name": "uh",
                "last_name": "ioajwd",
                "dob": "13-06-1962",
                "annual_income": "8080890",
                "postcode": "b28 0ru",
                "city": "Lane",
                "street": "0RE Baldwins Lane",
                "building": "",
                "building_name": "",
                "flat": "B28",
                "years_lived": "1+ years",
                "previous_address": "",
                "homeowner_status": "Rent",
                "employment_status": "Part-Time",
                "employer_name": "jsl",
                "marketing_opt_in": "no",
                "terms_conditions": "",
                "phone_number": "077"
            },
            "loan_details": {
                "id": "288787",
                "status": "Declined - Auto-Filters",
                "purpose": "debt consolidation",
                "currency": "GBP",
                "amount": 0,
                "term": 12,
                "interest_rate": 22.51,
                "score": 100,
                "acceptance_code": "1168",
                "gocardless_subscription_id": "",
                "gocardless_customer_id": "",
                "number_of_times_delinquent": 0,
                "days_delinquent": 0,
                "amount_delinquent": 0,
                "payments_delinquent": 0,
                "capital_balance": 0,
                "interest_balance": 0,
                "utm_source": ""
            },
            "status_updates": [
                " "
            ],
            "loan_processing": {
                "assigned_to_id": 0,
                "assigned_to_name": "",
                "risk_rating": "",
                "status": "Declined - Auto-Filters"
            },
            "loan_contract": {
                "url": "",
                "docusign_url": "",
                "docusign_id": "",
                "date_created": "",
                "date_signed": ""
            },
            "loan_completion": {
                "borrower_completion_date": "",
                "admin_completion_date": "",
                "repayments_start_date": "",
                "term_months": 12,
                "total_loan_amount": 0
            },
            "invoice_schedule": [],
            "loan_offers": [],
            "repayments_schedule": [],
            "borrower_vulnerabilities": {
                "mental_health": "",
                "physical_health": "",
                "life_events": "",
                "resiliance": "",
                "financial_difficulties": "",
                "capabilities": "",
                "0": ""
            },
            "loan_flags": {
                "payment_holiday": false,
                "token_payments": false,
                "reduced_payments": false,
                "six_month_hold": false,
                "iva_trust_dead": false,
                "debt_management_plan": false,
                "breathing_space": false,
                "cancelled_dd": false,
                "fpnp": false
            },
            "open_banking_status": {
                "bank_account_connected": true,
                "plaid_access_token_received": false,
                "plaid_public_token_sent_to_exposit": true
            },
            "last_update_date": "2023-05-03 09:43:55"
        }
    ]
}

• apikey [string]: API key of the current user
• userkey [string]: Result of calling 'Userkey' method
• type [string]: Funds transaction type
• offset [int]:Pagination items offset
• limit [int]: Pagination items limit
• date_from [string]: Date filter 'from' Y-m-d
• date_to [string]: Date filter 'to' Y-m-d

{
    "status": "ok",
    "total_number": "45",
    "offset": 0,
    "limit": 1,
    "transactions": [
        {
            "transfer_id": 3789,
            "user_id": 63566,
            "user_name": "borrowerdefaultone borrowerdefaultone",
            "date": "2022-12-20 13:00:56",
            "amount": 1000,
            "currency": "GBP",
            "sort_code": "200000",
            "account_number": "55779911",
            "balance_before": -1000,
            "balance_after": 0,
            "user_status": ""
        }
    ]
}

• apikey [string]: API key of the current user
• userkey [string]: Result of calling 'Userkey' method
• offset [int]:Pagination items offset
• limit [int]: Pagination items limit
• date_from [string]: Date filter 'from' Y-m-d

{
    "status": "ok",
    "total_number": "45",
    "offset": 0,
    "limit": 1,
    "transactions": [
        {
            "transfer_id": 3789,
            "user_id": 63566,
            "user_name": "borrowerdefaultone borrowerdefaultone",
            "date": "2022-12-20 13:00:56",
            "amount": 1000,
            "currency": "GBP",
            "sort_code": "200000",
            "account_number": "55779911",
            "balance_before": -1000,
            "balance_after": 0,
            "user_status": ""
        }
    ]
}

• apikey [string]: API key of the current user
• userkey [string]: Result of calling 'Userkey' method

{
    "status": "ok",
    "options": {
        "Finder": {
            "term": 36,
            "cost": 100
        },
        "USwitch": {
            "term": 24,
            "cost": 200
        },
        "Money": {
            "term": 18,
            "cost": 50
        },
        "Money1": {
            "term": 12,
            "cost": 10
        },
        "Money2": {
            "term": 12,
            "cost": 25
        }
    },
    "date_updated": "2023-02-14 12:07:08"
}

• apikey [string]: API key of the current user
• userkey [string]: Result of calling 'Userkey' method

{
    "status": "ok",
    "types": {
        "A1": {
            "cost": 20
        },
        "A2": {
            "cost": 100
        },
        "B1": {
            "cost": 50
        },
        "B2": {
            "cost": 75
        },
        "C1": {
            "cost": 25
        }
    },
    "date_updated": "2023-02-14 12:07:18"
}

• apikey [string]: API key of the current user
• userkey [string]: Result of calling 'Userkey' method

{
    "status": "ok",
    "amount": 656709.25,
    "lenders": "24"
}

• apikey [string]: API key of the current user
• userkey [string]: Result of calling 'Userkey' method
• loan_id [int]: WLCF loan_id
• loan_status [string]: New loan status

{
    "status": "ok",
    "previous_loan_status": "Live - Performing",
    "new_loan_status": "Declined - Auto-Filters"
}

• apikey [string]: API key of the current user
• userkey [string]: Result of calling 'Userkey' method
• loan_id [int]: WLCF loan_id
• loan_type [string]: New loan type

{
    "status": "ok",
    "previous_loan_type": "B2",
    "new_loan_type": "A1"
}

• apikey [string]: API key of the current user
• userkey [string]: Result of calling 'Userkey' method
• loan_amount [obligatory][int]: 500 ...10000 with 500 step
• loan_term [obligatory][int]: 6...60 with 6 step
• email [obligatory][string]: Valid email address
• first_name [obligatory][string]: allowed only letters, dash and white space
• last_name [obligatory][string]: allowed only letters, dash and white space
• dob [obligatory][string]: d-m-Y formatted
• phone [string]: allowed only numbers
• post_code [obligatory][string]
• town [obligatory][string]
• street [string]
• building_no [string]
• building_name [string]
• flat [string]
• prev_post_code [string]
• prev_town [string]
• prev_street [string]
• prev_building_no [string]
• prev_building_name [string]
• prev_flat [string]
• home_status [obligatory][int]: 18/19/20/21
• employment_status [obligatory][int]: 12/13/14/15/16/17
• employer [string]
• income [obligatory][int]
• salary_payment_date[int]: 1...30
• loan_purpose [obligatory][string]
• loan_purpose_details [string]: may be optionally provided if 'loan_purpose' = 'other' or 'debt consolidation'
• utm_source [string]
• mortgage [int][0/1]
• joint_mortgage [int][0/1]
• email_subscription [int][0/1]
• affiliate_loan_id [string]
• loan_rate [float]: Optional parameter - fixed rate of the loan. If provided will override internal calculations. Available values 0.00...100.00
• loan_apr [float]: Optional parameter - displayed APR of the loan. If provided will override internal calculations. Available values 0.00...100.00
• nominal_rate [float]: Optional parameter. If provided will be used to calculate Fixed rate= Displayed APR = EFFECT(nominal_rate, loan_term / 12). Available values 0.00...100.00

• 18: [Own]
• 19: [Rent]
• 20: [Council Flat]
• 21: [Living with Parents]

• 12: [Full-Time]
• 13: [Part-Time]
• 14: [Unemployed]
• 15: [Self-Employed]
• 16: [On Benefits]
• 17: [Retired Pension]

• a car loan
• debt consolidation
• a holiday
• home furnishings
• home improvement
• legal costs
• a medical bill
• a wedding
• other

• Value of each field (except 'loan_purpose_details') should not exceed 50 characters limit.
• Value of 'loan_purpose_details' field should not exceed 250 characters limit.
• If 'prev_post_code' is provided, 'Length of time at Address' option will be automatically set to '0-1 years'. 'prev_town' and 'prev_street' also should be provided in this case.
• If 'home_status' = 18, 'mortgage' and 'joint_mortgage' can be provided
• If 'loan_purpose' = 'other' or 'debt consolidation', 'loan_purpose_details' may be optionally provided.

200 OK
{
    "status": "ok",
    "loan_url": "https://plend.co.uk/personal-loan?aff_loan_id=8x9cmaw9ev",
    "loan_amount": 5000,
    "loan_term": 12,
    "APR_fixed": 22.51,
    "APR_displayed": 24.99,
    "monthly_repayment": 469.2,
    "total_repayment": 5630.4,
    "eligibility": 55
}

400 Bad Request - Using of GET request instead of POST
{
    "status": "error",
    "error": "This method should use HTTP POST request"
}

400 Bad Request - Missing or empty 'userkey'
{
    "status": "error",
    "error": "No user key found! Please generate one with the UserKey method"
}

400 Bad Request - Invalid 'userkey'
{
    "status": "error",
    "error": "Malformed UserKey, please generate a new one"
}

400 Bad Request - empty 'email'
{
    "status": "error",
    "error": "'email' should be provided"
}

400 Bad Request - invalid 'loan_amount' value
{
    "status": "error",
    "error": "'loan_amount' should be integer between £1000 and £10000 with £500 step"
}

401 Unauthorized - Invalid or empty 'apikey'
{
    "status": "error",
    "error": "Full authentication is required to access this resource"
}

403 Forbidden - user didn't have required capabilities ('use_plend_api', or 'loan_manager') to access API method
{
    "status": "error",
    "error": "Access denied"
}

{
    "content-type": "application/x-www-form-urlencoded",
    "accept": "*/*"
}

{
    "apikey" : "75674a89f885e5677ce756c75677",
    "userkey" : "user%7C1706933880%7Ced9a8c3837273c78145d728",
    "loan_amount" : "2500",
    "loan_term" : "24",
    "email" : "borrower@gmail.com",
    "first_name" : "John",
    "last_name" : "Doe",
    "dob" : "31-12-1990",
    "phone" : "123456790",
    "post_code" : "AL11EA",
    "town" : "London",
    "street" : "Street Name",
    "building_no" : "1",
    "building_name" : "Building Name",
    "flat" : "2",
    "prev_post_code" : "AL22EA",
    "prev_town" : "Leeds",
    "prev_street" : "Prev Street Name",
    "prev_building_no" : "3",
    "prev_building_name" : "Prev Building",
    "prev_flat" : "4",
    "home_status" : "18",
    "employment_status" : "15",
    "employer" : "Employer Name",
    "income" : "50000",
    "loan_purpose" : "other",
    "loan_purpose_details" : "I need a loan for...",
    "utm_source" : "meta",
    "email_subscription" : "1",
    "mortgage" : "1",
    "joint_mortgage" : "1",
    "email_subscription" : "0",
    "affiliate_loan_id" : "1234567890"
}

• apikey [string]: API key of the current user
• userkey [string]: Result of calling 'Userkey' method
• email_address [obligatory][string]: (valid email address of borrower, registered on the site)
• loan_term [obligatory][int]: 6...60 with 6 step
• loan_amount [obligatory][int]: 1000 ...10000 with 100 step. If 'portfolio_type' = SC or SCC, minimal 'loan_amount' = 500
• loan_status [optional][string]: Available values: 'Submitted - Pending Review' (default) or 'Approved - Awaiting Contract'. If loans status is set to the 'Approved - Awaiting Contract', then loan contract will be generated and sent to the borrower.
• portfolio_type [optional][string]: If provided should have A1/A2/B1/B2/SC/SCC value
• loan_rate [obligatory][float]: Should have 0...100 value
• utm_source [optional][string]
• loan_purpose [optional][string]: If provided should have one of the next values: 'a car loan', 'debt consolidation', 'a holiday', 'home furnishings', 'home improvement', 'legal costs', 'a medical bill', 'a wedding', 'other'
• loan_purpose_description [optional][string]

200 OK
{
    "status": "ok",
    "borrower_id": 123456,
    "borrower_name": "John Doe",
    "loan_id": 123456,
    "loan_term": 24,
    "loan_amount": 3500,
    "loan_rate": 0,
    "loan_status": "Submitted - Pending Review",
    "monthly_repayment": 145.83,
    "total_repayment": 3499.92
}

400 Bad Request - Using email address not registered on the site
{
    "status": "error",
    "error": "Borrower with provided 'email_address' not found"
}

400 Bad Request - Using email address of borrower, who already have live/pending loan application or haven't connected his bank account
{
    "status": "error",
    "error": "Loan application can be created only for borrowers, who already have a closed/declined/cancelled loan"
}

• apikey [string]: API key of the current user
• userkey [string]: Result of calling 'Userkey' method
• utm_source [string][optional]: Valid 'utm_source' value for filtering output results. If empty, output will contains links with any non-blank 'utm_source'
• date_from [string][optional]: Date in Y-m-d format for filtering output results. If provided, output will contains only links, generated including and after this date
• date_to [string][optional]: Date in Y-m-d format for filtering output results. If provided, output will contains only links, generated including and before this date
• limit [int][optional]: Maximum number of output results. Links are ordered by generation date, from newest to oldest. Default value = 100.

{
    "status": "ok",
    "date_from": "",
    "date_to": "",
    "utm_source": "",
    "limit": 100,
    "url_clicks": [
        {
            "link": "https://plend.co.uk/personal-loan/?aff_loan_id=4a7e92d8e3",
            "date_created": "2024-01-20 06:02:21",
            "date_clicked": "2024-01-20 06:03:42",
            "utm_source": "creditkarma80",
            "app_id": 0
        },
        {
            "link": "https://plend.co.uk/personal-loan/?aff_loan_id=et2gi0hong",
            "date_created": "2024-01-19 23:34:03",
            "date_clicked": "2024-01-19 23:36:18",
            "utm_source": "totallymoney80",
            "app_id": 320657
        },
}

• apikey [string]: API key of the current user
• userkey [string]: Result of calling 'Userkey' method
• email [string]: Email address of the borrower
• first_name [string]: First Name of the borrower
• last_name [string]: Last Name of the borrower
• dob [string]: Date of birth in Y-m-d format
• phone [string]: Phone number of the borrower
• postcode [string]: Postcode of the borrower's address
• city [string]: City of the borrower's address
• street [string]: Street of the borrower's address
• building [string]: Building of the borrower's address
• income [int]: Annual income of the borrower
• employment_status [int]: 12/13/14/15/16/17
• exposit_borrower_id [string]: ID of the borrower account
• loan_amount [int]: Amount of the loan
• loan_term [int]: Term of the loan in months
• loan_rate [float]: Rate of the loan
• loan_purpose [string]: 'a car loan', 'debt consolidation', 'a holiday', 'home furnishings', 'home improvement', 'legal costs', 'a medical bill', 'a wedding', 'other'
• portfolio_type [string]: Loan portfolio type: A1/A2/B1/B2/SC/SCC
• exposit_loan_id [string]: ID of the loan

{
    "status": "ok",
    "borrower_id": 45678,
    "loan_id": 123456,
}