---
title: "Generate a prequalified offer"
method: POST
path: "/Requests"
tags: ["Requests"]
---

# Generate a prequalified offer

`POST /Requests`

## Headers

- `api-version` string

## Request body

- PreQualificationModel — Third party prequalification model for receiving offers
  - `companyType` 'Ltd' | 'Plc' | 'Llp' | 'SoleTrader' | 'Partnership' | 'Llc' | 'BusinessCorporation' | 'Dac' | 'Eenmanszaak' | 'NaamlozeVennootschap' | 'Bv' | 'Cv' | 'Nv' | 'Vof' | 'SpZoo' | 'SpkSpj' | 'Scspp' | 'SaSKA' | 'Jdg' | 'GmbhUg' | 'EK' | 'Gewerbebetrieb' | 'GbrOhg' | 'Gbr' | 'EGbr' | 'Ohg' | 'Kg' | 'Aktiengesellschaft' | 'SlSlne' | 'SociedadColectiva' | 'SociedadComanditaria' | 'EIAutonomo' | 'SociedadCivil' | 'SociedadCooperativa' | 'SNC' | 'EINomPropre' | 'SARL' | 'SocieteCooperative' | 'SA' | 'SAS' | 'EURL' | 'SCP' | 'SCS' | 'SASU' | 'EnterpriseIndividuelle' | 'SocieteAnonyme' | 'SRL' | 'SComm' | 'AS' | 'ApS' | 'KS' | 'PS' | 'Fmba' | 'Andelsselskab' | 'Amba' | 'ErhvervsdrivendeFond' | 'IS' | 'Smba' | 'SI' | 'SelvstændigOffentligVirksomhed' | 'Partrederi' | 'Filial' | 'Enkeltmandsvirksomhed' | 'PMV' | 'Forening', required
  - `financialData` FinancialDataModel, required — Financial model for receiving offers
    - `paymentData` PaymentDataRowModel[], required — Gets or sets the payment data
      - `paymentDate` string, date-time, required — Gets or sets the date of the payment.
      - `amount` number, double — Gets or sets the amount of the payment.
      - `currencyISOCode` string, required — Gets or sets the currency of the payment.
      - `chargeback` number, double — Gets or sets the Chargeback of the payment.
      - `merchantId` string, nullable — Gets or sets the MerchantId of the payment.
      - `processor` 'IZETTLE' | 'Paypal' | 'StichtingCustodia' | 'Etsy' | 'ADYEN' | 'eBay' | 'Flipdish' | 'Shopify' | 'HOPT' | 'YOELLO' | 'Stripe' | 'UberEats' | 'WORLDPAY' | 'FDMS' | 'Dojo' | 'Deliveroo' | 'AIB' | 'AmericanExpress' | 'BarclayCard' | 'Elavon' | 'Youlend' | 'EvoPayments' | 'GOCARDLESS' | 'JustEat' | 'SagePayments' | 'AIRBNB' | 'Amazon' | 'Borgun' | 'GlobalPayments' | 'CARDNET' | 'Checkout' | 'Clearhaus' | 'Clearpay' | 'EMERCHANTPAY' | 'Fruugo' | 'Klarna' | 'Payables' | 'Payoneer' | 'SQUARE' | 'Sumup' | 'TrustPayments' | 'Valitor' | 'Venmo' | 'Afterpay' | 'Modulo' | 'Cashflows' | 'Datman' | 'Ecomm365' | 'EnixServices' | 'FantasticServices' | 'Globepay' | 'VivaWallet' | 'HungryPanda' | 'Clubwise' | 'MYPAY' | 'OrderYoYo' | 'Saltpay' | 'SixPayments' | 'Streamline' | 'Payacard' | 'Creditcall' | 'Dejavoo' | 'EposNow' | 'Optomany' | 'ValorPay' | 'Bol' | 'Brainpoint' | 'Mollie' | 'Thuisbezorgd' | 'Sisow' | 'Buckaroo' | 'EtenZoBesteld' | 'Multisafepay' | 'PayFastForward' | 'Sepay' | 'Bezorgland' | 'paynl' | 'INGDDC' | 'DerdengeldenCCV' | 'RaboOmniKassa' | 'AuthoriseNet' | 'Bancontact' | 'BlueSnap' | 'CyberSourceDirect' | 'MyVirtualMerchant' | 'NMI' | 'Paymetric' | 'myPOSGo' | 'Yomani' | 'Yoximo' | 'SEPA' | 'HiPay' | 'PayPlug' | 'IcePay' | 'WorldLine' | 'Ogone' | 'IngenicoEpayments' | 'Belfius' | 'Payconiq' | 'SmilePay' | 'Yavin' | 'KBC' | 'PayU' | 'CréditAgricole' | 'PayLane' | 'DotPay' | 'PayByNet' | 'Prezelewy24' | 'eCard' | 'myPOS' | 'mPOS' | 'Blik' | 'eService' | 'XEPAY' | 'Rapyd' | 'PolskieEPłatności' | 'BlueMedia' | 'iKasa' | 'Okto' | 'ManagePay' | 'PolCard' | 'tPay' | 'PlanetPay' | 'SORBNET' | 'DinersClub' | 'Discover' | 'UnionPay' | 'PeoPay' | 'JCB' | 'ProtxVPSDirect' | 'Globalcollect' | 'Wirecard' | 'Bitpay' | 'AlliedWallet' | 'Skrill' | 'BBVA' | 'Santander' | 'Bankia' | 'Sabadell' | 'TPV' | 'Moloni' | 'Addonpayments' | 'Braintree' | 'SEPADirectDebit' | 'KlikPay' | 'UniversalPay' | 'Payxpert' | 'Paymill' | 'Neteller' | 'Payretailers' | 'Securionpay' | 'Monei' | 'Redsys' | 'Cecabank' | 'Fasterpay' | 'Thryn' | 'Paysimple' | 'TwoCheckout' | 'PasarelaDePago' — Gets or sets processor.
    - `monthlyCardRevenue` number, double — Gets or sets the monthly card revenue
    - `monthlyValueOfPurchaseTransactions` number, double — Gets or sets the monthly vaule of purchase transactions
    - `purchaseData` PurchaseDataRowModel[], nullable — Gets or sets the purchase data
      - `purchaseDate` string, date-time, required — Gets or sets the date of the purchase
      - `amount` number, double, required — Gets or sets the amount
      - `currencyISOCode` string, required — Gets or sets the currency
      - `category` string, nullable — Gets or sets the category
    - `monthlyRevenueFromInvoices` number, double — Gets or sets the monthly revenue from invoices
    - `invoiceData` InvoiceDataRowModel[], nullable — Gets or sets the invoice data for the company
      - `invoiceDate` string, date-time, required — Gets or sets the date of the invoice
      - `amount` number, double, required — Gets or sets the amount
      - `currencyISOCode` string, required — Gets or sets the currencdy
      - `daysDurationOfInvoice` integer, required — Gets or sets the duration of the invoice in days
      - `category` string, nullable — Gets or sets thecategory
  - `countryISOCode` 'GBR' | 'IRE' | 'NLD' | 'POL' | 'BEL' | 'ESP' | 'DEU' | 'FRA' | 'USA', required
  - `loanCurrencyISOCode` 'GBP' | 'EUR' | 'PLN' | 'USD', required
  - `thirdPartyMerchantId` string, nullable — Gets or sets the third party's id for a merchant.
  - `mid` string, nullable — Gets or sets the merchant ID
  - `companyName` string, nullable — Gets or sets the company name
  - `companyNumber` string, nullable — Gets or sets the company number
  - `companyWebsite` string, nullable — Gets or sets the company website
  - `contactEmailAddress` string, nullable — Gets or sets a contact email address for the merchant
  - `sicCode` string, nullable — Gets or sets the SIC code
  - `mccCode` string, nullable — Gets or sets the MCC code
  - `monthsTrading` integer — Gets or sets the number of months the merchant has been trading for
  - `significantPersons` SignificantPersonModel[], nullable — Gets or sets the significant persons of the company (directors)
    - `firstName` string, required — Gets or sets significant person's first name.
    - `surname` string, required — Gets or sets significant person's surname.
    - `typeOfPerson` 'Director' | 'BeneficialOwner' | 'DirectorAndBeneficialOwner' | 'ExecutiveOfficer' | 'ExecutiveOfficerAndOwner' | 'Owner', required — Gets or sets the type of significant person (Director and Beneficial Owner for UK & Europe, Executive Officer and Owner for the USA).
    - `address` AddressModel, required — Address Data Model.
      - `line1` string, required — Gets or sets Address Line 1.
      - `line2` string, nullable — Gets or sets Address Line 2.
      - `line3` string, nullable — Gets or sets Address Line 3.
      - `city` string, required — Gets or sets the City.
      - `region` string, nullable — Gets or sets the Region.
      - `areaCode` string, required — Gets or sets the Area Code.
      - `country` string, nullable — Gets or sets the Country. Cannot be null or empty if YL.Web.Api.ThirdParty.Onboarding.Models.AddressModel.CountryISOCode is not set. If both are set, we use YL.Web.Api.ThirdParty.Onboarding.Models.AddressModel.Country.
      - `countryISOCode` 'GBR' | 'IRL' | 'NLD' | 'BEL' | 'POL' | 'USA' | 'DEU' | 'FRA' | 'ESP' | 'DNK' — Gets or sets the CountryISOCode. Cannot be null or empty if YL.Web.Api.ThirdParty.Onboarding.Models.AddressModel.Country is not set. If both are set, we use YL.Web.Api.ThirdParty.Onboarding.Models.AddressModel.Country.
    - `dateOfBirth` DateModel, required — Date Model.
      - `year` integer, required — Gets or sets Year.
      - `month` integer, required — Gets or sets Month.
      - `day` integer — Gets or sets Day.
    - `emailAddress` string, email, required — Gets or sets significant person's email address.
    - `mobilePhoneNumber` string, required — Gets or sets significant person's mobile phone number (international format, example +447586312453).
    - `percentageOwned` number, double — Gets or sets the percentage of ownership the significant person has.
    - `nationality` string, nullable — Gets or sets significant person's nationality.
    - `niNumber` string, nullable — Gets or sets significant person's NI number.
    - `socialSecurityNumber` string, nullable — Gets or sets the social security number (required for owners in the USA).
    - `placeOfBirth` string, nullable — Gets or sets significant person's place of birth.

## Response `200`

Returns PreQualificationResultDocument.

- PreQualificationResultDocument
  - `thirdPartyMerchantId` string, nullable
  - `mid` string, nullable
  - `companyName` string, nullable
  - `overallCreditRiskScore` number, double
  - `overrideCreditRiskScore` number, double
  - `loanOptions` LoanOptionDocument[], nullable
    - `currencyISOCode` string, nullable
    - `fee` number, double
    - `fundedAmount` number, double
    - `loanAmount` number, double
    - `sweep` number, double

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.dev/youlend/apis/prequalification.md) · [All operations](https://skmtc.dev/youlend/apis/prequalification/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/youlend/prequalification/revisions/a76313c6cc3d/schema)