v1

latestOpenAPI 3.0.12026-07-2487164202.8 KB
Requests

Generate a prequalified offer

post/Requests

Headers

api-versionstring

Request body

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
countryISOCode'GBR' | 'IRE' | 'NLD' | 'POL' | 'BEL' | 'ESP' | 'DEU' | 'FRA' | '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