Requests

Generate a prequalified offer

Changed on
post/Requests

Request

  • Base URL
    https://partners.staging-youlendapi.com/prequalification
  • URL
    https://partners.staging-youlendapi.com/prequalification/Requests
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://youlend-stag.eu.auth0.com/oauth/token

Headers

api-versionstring

Request body

companyType'Ltd' | 'Plc' | 'Llp' | 'SoleTrader' | 'Partnership' | 'DAC' | 'Eenmanszaak' | 'Bv' | 'Cv' | 'Nv' | 'Vof' | 'NaamlozeVennootschap' | 'SpZoo' | 'SpkSpj' | 'Scspp' | 'SaSKA' | 'Jdg' | 'GmbhUg' | 'EK' | 'Gewerbebetrieb' | 'GbrOhg' | 'Gbr' | 'EGbr' | 'Ohg' | 'Kg' | 'Aktiengesellschaft' | 'SlSlne' | 'SociedadColectiva' | 'SociedadComanditaria' | 'EIAutonomo' | 'SociedadCivil' | 'SociedadCooperativa' | 'Llc' | 'BusinessCorporation' | 'SNC' | 'EINomPropre' | 'SARL' | 'SocieteCooperative' | 'SA' | 'SAS' | 'EURL' | 'SCP' | 'SCS' | 'SASU' | 'AS' | 'ApS' | 'KS' | 'PS' | 'Fmba' | 'Andelsselskab' | 'Amba' | 'ErhvervsdrivendeFond' | 'IS' | 'Smba' | 'SI' | 'SelvstændigOffentligVirksomhed' | 'Partrederi' | 'Filial' | 'Enkeltmandsvirksomhed' | 'PMV' | 'Forening' required
countryISOCode'GBR' | 'IRE' | 'NLD' | 'POL' | 'BEL' | 'ESP' | 'DEU' | 'FRA' | 'DNK' | 'USA' required
loanCurrencyISOCode'GBP' | 'EUR' | 'PLN' | 'USD' required
thirdPartyMerchantIdstring nullable

Gets or sets the third party's id for a merchant.

midstring nullable

Gets or sets the merchant ID

companyNamestring nullable

Gets or sets the company name

companyNumberstring nullable

Gets or sets the company number

companyWebsitestring nullable

Gets or sets the company website

contactEmailAddressstring nullable

Gets or sets a contact email address for the merchant

sicCodestring nullable

Gets or sets the SIC code

mccCodestring nullable

Gets or sets the MCC code

monthsTradinginteger

Gets or sets the number of months the merchant has been trading for

Response

Returns PreQualificationResultDocument.

thirdPartyMerchantIdstring nullable
midstring nullable
companyNamestring nullable
overallCreditRiskScorenumber double
overrideCreditRiskScorenumber double

Changes

    • breaking

      removed the enum value Dac of the request property

    • breaking

      removed the enum value EnterpriseIndividuelle of the request property

    • breaking

      removed the enum value SComm of the request property

    • breaking

      removed the enum value SRL of the request property

    • breaking

      removed the enum value SocieteAnonyme of the request property

    • breaking

      the // request property's minLength was increased from 0 to 1

    • breaking

      the // request property type changed from object to string, and format from no format to date-time

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • warning

      removed the request property //

    • info

      added the new DAC enum value to the request property

    • info

      added the new DNK enum value to the request property