MBOnlineCreditApplicationService

<back to all web services

CreateOCAv2Request

The following routes are available for this service:
PUT/CreateOCAv2/
CreateOCAv2Request Parameters:
NameParameterData TypeRequiredDescription
UsernamebodystringNo
TimestampbodystringNo
TokenbodystringNo
GeneralDetailsbodyGeneralDetailsv2No
FinanceDetailsbodyFinanceDetailsv2No
VehicleDetailsbodyVehicleDetailsv2No
DeliveryDetailsbodyDeliveryDetailsv2No
ExistingVehicleDetailsbodyExistingVehicleDetailsv2No
InsuranceDetailsbodyInsuranceDetailsNo
CreditApplicationIndividualbodyCreditApplicationIndividualV2No
CreditApplicationBusinessbodyCreditApplicationBusinessV2No
PaymentDetailsbodyPaymentDetailsNo
NotesbodyNoteDetails[]No
DiPDetailsbodyDiPDetailsNo
GeneralDetailsv2 Parameters:
NameParameterData TypeRequiredDescription
OCAApprovalNumberformstringNo
EnquiryDateTimeformstringNo
BrandformintNo
CustomerReferenceNumberformstringNo
CustomerTypeformstringNo
SourceofBusinessformstringNo
TagURLformstringNo
RequestSourceformintNo
FormIDformstringNo
ProposalCreatedformstringNo
LoadFullDataformstringNo
ProposalNumberformstringNo
POSSystemformstringNo
FinanceDetailsv2 Parameters:
NameParameterData TypeRequiredDescription
FinancialProductformstringNo
CampaignCodeformstringNo
PhoenixFinanceProductCodeformstringNo
FixedformstringNo
FleetNonFleetformstringNo
RFLCoverformstringNo
DurationformintNo
PaymentRentalAmountformdecimalNo
RentalAmountExcVATformdecimal?No
AdvanceArrearsformstringNo
AnnualMileageformintNo
ExcessMileageRateformdecimalNo
CustomerDepositContributionformdecimal?No
RetailerDepositContributionformdecimal?No
RetailerDepositContributionNetformdecimal?No
ManufacturerDepositContributionformdecimal?No
ManufacturerDepositContributionNetformdecimal?No
TotalDepositContributionformdecimal?No
LumpSumformdecimal?No
CostForCreditformdecimal?No
PurchaseActivationFeeformdecimal?No
TotalAmountPayableformdecimal?No
FixedInterestRateformdecimal?No
RepresentativeAPRformdecimal?No
TrueFlatRateformstringNo
RVReferenceNumberformstringNo
OptionalPurchasePaymentformdecimal?No
AdvancedRentalAmountformdecimalNo
NumberofAdvanceRentalsformstringNo
PaymentProfileformstringNo
RandMIncludedformstringNo
RandMLevelformstringNo
ProductTypeformstringNo
FrequencyformstringNo
PauseTypeformstringNo
EqualsFinanceformdecimal?No
AcceptanceFeeformdecimal?No
VehicleDetailsv2 Parameters:
NameParameterData TypeRequiredDescription
OnlineCodeformstringNo
ModelClassformstringNo
ModelBodyformstringNo
ModelDerivativeformstringNo
TotalPriceformdecimalNo
OTRPriceformdecimalNo
VINformstringNo
RegNoformstringNo
CommissionNumberformstringNo
EngineNumberformstringNo
CurrentMileageformintNo
MilesKilometersformstringNo
FirstRegistrationDateformstringNo
NewUsedFlagformstringNo
NewVehicleModelOptionDetailsformModelOptionDetailsv2[]No
VIDformstringNo
BaumusterformstringNo
VehiclePriceformdecimal?No
TotalVATformdecimal?No
OLEVGrantformdecimal?No
ExtrasTotalExcVATformdecimal?No
CombinedCO2formstringNo
VehicleVATTickBoxformstringNo
FirstYearRFLIncludedformstringNo
FirstYearRFLAmountformdecimal?No
FirstRegFeeIncludedFlagformstringNo
FirstRegFeeAmountformdecimal?No
HighLowVEDSupplementFlagformstringNo
LeaseRFLSubsequentYearsformstringNo
LeaseRFLSubsequentYearsAmountformdecimal?No
ModelOptionDetailsv2 Parameters:
NameParameterData TypeRequiredDescription
SeqformintNo
TypeformstringNo
CodeformstringNo
DescriptionformstringNo
PriceformdecimalNo
PriceGrossformdecimal?No
VATCategoryformstringNo
VATAmountformdecimal?No
DeliveryDetailsv2 Parameters:
NameParameterData TypeRequiredDescription
DealerCodeformstringNo
DeliveryPreferenceformstringNo
DeliveryDateformstringNo
ExistingVehicleDetailsv2 Parameters:
NameParameterData TypeRequiredDescription
TradeInFlagformstringNo
TradeInIncludedInCalcformstringNo
TradeInValueformdecimalNo
TradeInValueNetformdecimal?No
TradeInRegNoformstringNo
TradeInVINformstringNo
TradeInMileageformint?No
TradeInConditionformstringNo
SettlementFlagformstringNo
SettlementIncludedInCalcformstringNo
SettlementValueformdecimalNo
SettlementValueNetformdecimalNo
SettlementRegNoformstringNo
SettlementVINformstringNo
SettlementMileageformint?No
InsuranceDetails Parameters:
NameParameterData TypeRequiredDescription
InterestedInFirstCoverFlagformstringNo
CreditApplicationIndividualV2 Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
InitialformstringNo
FirstNameformstringNo
SurnameformstringNo
DateofBirthformstringNo
GenderformstringNo
MaritalStatusformstringNo
ResidentialStatusformstringNo
CurrentAddressformAddressWithTimeLinev2No
PreviousAddressesformPreviousAddressv2[]No
HomePhoneformstringNo
MobilePhoneformstringNo
WorkPhoneformstringNo
ContactAtWorkformstringNo
EmailformstringNo
BankSortCodeformstringNo
BankAccountNumberformstringNo
BankAccountNameformstringNo
BankNameformstringNo
BankAddressformAddressNo
BankPaymentTypeformstringNo
DrivingLicenceNumberformstringNo
CurrentEmploymentDetailsformCurrentEmploymentDetailsv2No
PreviousEmploymentDetailsformPreviousEmploymentv2[]No
MarketingPreferenceformMarketingPreferenceNo
CreditCheckConsentformstringNo
AddressWithTimeLinev2 Parameters:
NameParameterData TypeRequiredDescription
AddressLine1formstringNo
AddressLine2formstringNo
AddressLine3formstringNo
TownformstringNo
CountyformstringNo
CountryformstringNo
PostcodeformstringNo
DurationformstringNo
DateStartedformstringNo
TotalNumberOfMonthsformstringNo
PreviousAddressv2 Parameters:
NameParameterData TypeRequiredDescription
SeqformintNo
AddressformAddressWithTimeLinev2No
Address Parameters:
NameParameterData TypeRequiredDescription
AddressLine1formstringNo
AddressLine2formstringNo
AddressLine3formstringNo
AddressLine4formstringNo
AddressLine5formstringNo
PostcodeformstringNo
CurrentEmploymentDetailsv2 Parameters:
NameParameterData TypeRequiredDescription
EmployerDetailsformEmployerDetailsv2No
MonthsAtEmployerformstringNo
DateEmploymentCommencedformstringNo
AnnualIncomeformstringNo
EmployerDetailsv2 Parameters:
NameParameterData TypeRequiredDescription
EmploymentTypeformstringNo
EmployersNameformstringNo
OccupationformstringNo
EmployersAddressformAddressWithTimeLinev2No
PreviousEmploymentv2 Parameters:
NameParameterData TypeRequiredDescription
SeqformintNo
previousEmploymentformEmployerDetailsv2No
MarketingPreference Parameters:
NameParameterData TypeRequiredDescription
OptInMailformstringNo
OptInTelephoneformstringNo
OptInEmailformstringNo
OptInSMSformstringNo
CreditApplicationBusinessV2 Parameters:
NameParameterData TypeRequiredDescription
TypeOfBusinessformstringNo
BusinessContactPositionformstringNo
TitleformstringNo
InitialformstringNo
FirstNameformstringNo
SurnameformstringNo
CurrentHomeAddressformAddressWithTimeLinev2No
HomePhoneformstringNo
WorkPhoneformstringNo
MobilePhoneformstringNo
EmailformstringNo
CompanyNameformstringNo
CompanyRegistrationNumberformstringNo
TradingAsformstringNo
BusinessActivityformstringNo
NumberOfEmployeesformintNo
YearsTradingformintNo
PositionformstringNo
BankSortCodeformstringNo
BankAccountNumberformstringNo
BankAccountNameformstringNo
BankNameformstringNo
BankAddressformAddressNo
NumberofPartnersformintNo
BusinessPartnersformBusinessPartnerv2[]No
MarketingPreferenceformMarketingPreferenceNo
PreviousAddressesformPreviousAddressv2[]No
BusinessPartnerv2 Parameters:
NameParameterData TypeRequiredDescription
SeqformintNo
TitleformstringNo
InitialformstringNo
FirstNameformstringNo
SurnameformstringNo
DateofBirthformstringNo
GenderformstringNo
MaritalStatusformstringNo
ResidentialStatusformstringNo
CurrentAddressformAddressWithTimeLinev2No
PreviousAddressesformPreviousAddressv2[]No
HomePhoneformstringNo
MobilePhoneformstringNo
BusinessPhoneformstringNo
RelationshipformstringNo
EmailformstringNo
CurrentEmploymentDetailsformCurrentEmploymentDetailsv2No
PreviousEmploymentDetailsformPreviousEmploymentv2[]No
PartnerTypeformstringNo
PaymentDetails Parameters:
NameParameterData TypeRequiredDescription
paymentDetailsformPaymentDetail[]No
PaymentDetail Parameters:
NameParameterData TypeRequiredDescription
SeqformintNo
PaymentTypeformstringNo
AmountPaidformdecimalNo
PaymentTransactionIDformstringNo
DescriptionformstringNo
PaymentDateTimeformstringNo
NoteDetails Parameters:
NameParameterData TypeRequiredDescription
SeqformintNo
NoteformstringNo
DiPDetails Parameters:
NameParameterData TypeRequiredDescription
DiPCustomerIdformstringNo
DiPTimestampformstringNo
DiPRequestIDformstringNo
DiPDecisionTypeformstringNo
DiPPrimaryDecisionCodeformstringNo
DiPDecisionDescriptionformstringNo
DipDecisionDescriptionCodeformstringNo
DipPrimaryDecisionReasonformstringNo
DiPPrimaryDecisionReasonDealerMessageformstringNo
diPReasonsformDiPReasons[]No
DiPReasons Parameters:
NameParameterData TypeRequiredDescription
DipReasonSeqformintNo
DipDecisionCodeformstringNo
DiPDecisionReasonformstringNo
DiPDealerMessageformstringNo
CreateOCAv2RequestResponse Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
MessageformstringNo
URNformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /CreateOCAv2/ HTTP/1.1 
Host: webservices.mbukdatabase.co.uk 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Username":"String","Timestamp":"String","Token":"String","GeneralDetails":{"OCAApprovalNumber":"String","EnquiryDateTime":"String","Brand":0,"CustomerReferenceNumber":"String","CustomerType":"String","SourceofBusiness":"String","TagURL":"String","RequestSource":0,"FormID":"String","ProposalCreated":"String","LoadFullData":"String","ProposalNumber":"String","POSSystem":"String"},"FinanceDetails":{"FinancialProduct":"String","CampaignCode":"String","PhoenixFinanceProductCode":"String","Fixed":"String","FleetNonFleet":"String","RFLCover":"String","Duration":0,"PaymentRentalAmount":0,"RentalAmountExcVAT":0,"AdvanceArrears":"String","AnnualMileage":0,"ExcessMileageRate":0,"CustomerDepositContribution":0,"RetailerDepositContribution":0,"RetailerDepositContributionNet":0,"ManufacturerDepositContribution":0,"ManufacturerDepositContributionNet":0,"TotalDepositContribution":0,"LumpSum":0,"CostForCredit":0,"PurchaseActivationFee":0,"TotalAmountPayable":0,"FixedInterestRate":0,"RepresentativeAPR":0,"TrueFlatRate":"String","RVReferenceNumber":"String","OptionalPurchasePayment":0,"AdvancedRentalAmount":0,"NumberofAdvanceRentals":"String","PaymentProfile":"String","RandMIncluded":"String","RandMLevel":"String","ProductType":"String","Frequency":"String","PauseType":"String","EqualsFinance":0,"AcceptanceFee":0},"VehicleDetails":{"OnlineCode":"String","ModelClass":"String","ModelBody":"String","ModelDerivative":"String","TotalPrice":0,"OTRPrice":0,"VIN":"String","RegNo":"String","CommissionNumber":"String","EngineNumber":"String","CurrentMileage":0,"MilesKilometers":"String","FirstRegistrationDate":"String","NewUsedFlag":"String","NewVehicleModelOptionDetails":[{"Seq":0,"Type":"String","Code":"String","Description":"String","Price":0,"PriceGross":0,"VATCategory":"String","VATAmount":0}],"VID":"String","Baumuster":"String","VehiclePrice":0,"TotalVAT":0,"OLEVGrant":0,"ExtrasTotalExcVAT":0,"CombinedCO2":"String","VehicleVATTickBox":"String","FirstYearRFLIncluded":"String","FirstYearRFLAmount":0,"FirstRegFeeIncludedFlag":"String","FirstRegFeeAmount":0,"HighLowVEDSupplementFlag":"String","LeaseRFLSubsequentYears":"String","LeaseRFLSubsequentYearsAmount":0},"DeliveryDetails":{"DealerCode":"String","DeliveryPreference":"String","DeliveryDate":"String"},"ExistingVehicleDetails":{"TradeInFlag":"String","TradeInIncludedInCalc":"String","TradeInValue":0,"TradeInValueNet":0,"TradeInRegNo":"String","TradeInVIN":"String","TradeInMileage":0,"TradeInCondition":"String","SettlementFlag":"String","SettlementIncludedInCalc":"String","SettlementValue":0,"SettlementValueNet":0,"SettlementRegNo":"String","SettlementVIN":"String","SettlementMileage":0},"InsuranceDetails":{"InterestedInFirstCoverFlag":"String"},"CreditApplicationIndividual":{"Title":"String","Initial":"String","FirstName":"String","Surname":"String","DateofBirth":"String","Gender":"String","MaritalStatus":"String","ResidentialStatus":"String","CurrentAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String","TotalNumberOfMonths":"String"},"PreviousAddresses":[{"Seq":0,"Address":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String","TotalNumberOfMonths":"String"}}],"HomePhone":"String","MobilePhone":"String","WorkPhone":"String","ContactAtWork":"String","Email":"String","BankSortCode":"String","BankAccountNumber":"String","BankAccountName":"String","BankName":"String","BankAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","AddressLine4":"String","AddressLine5":"String","Postcode":"String"},"BankPaymentType":"String","DrivingLicenceNumber":"String","CurrentEmploymentDetails":{"EmployerDetails":{"EmploymentType":"String","EmployersName":"String","Occupation":"String","EmployersAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String","TotalNumberOfMonths":"String"}},"MonthsAtEmployer":"String","DateEmploymentCommenced":"String","AnnualIncome":"String"},"PreviousEmploymentDetails":[{"Seq":0,"previousEmployment":{"EmploymentType":"String","EmployersName":"String","Occupation":"String","EmployersAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String","TotalNumberOfMonths":"String"}}}],"MarketingPreference":{"OptInMail":"String","OptInTelephone":"String","OptInEmail":"String","OptInSMS":"String"},"CreditCheckConsent":"String"},"CreditApplicationBusiness":{"TypeOfBusiness":"String","BusinessContactPosition":"String","Title":"String","Initial":"String","FirstName":"String","Surname":"String","CurrentHomeAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String","TotalNumberOfMonths":"String"},"HomePhone":"String","WorkPhone":"String","MobilePhone":"String","Email":"String","CompanyName":"String","CompanyRegistrationNumber":"String","TradingAs":"String","BusinessActivity":"String","NumberOfEmployees":0,"YearsTrading":0,"Position":"String","BankSortCode":"String","BankAccountNumber":"String","BankAccountName":"String","BankName":"String","BankAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","AddressLine4":"String","AddressLine5":"String","Postcode":"String"},"NumberofPartners":0,"BusinessPartners":[{"Seq":0,"Title":"String","Initial":"String","FirstName":"String","Surname":"String","DateofBirth":"String","Gender":"String","MaritalStatus":"String","ResidentialStatus":"String","CurrentAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String","TotalNumberOfMonths":"String"},"PreviousAddresses":[{"Seq":0,"Address":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String","TotalNumberOfMonths":"String"}}],"HomePhone":"String","MobilePhone":"String","BusinessPhone":"String","Relationship":"String","Email":"String","CurrentEmploymentDetails":{"EmployerDetails":{"EmploymentType":"String","EmployersName":"String","Occupation":"String","EmployersAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String","TotalNumberOfMonths":"String"}},"MonthsAtEmployer":"String","DateEmploymentCommenced":"String","AnnualIncome":"String"},"PreviousEmploymentDetails":[{"Seq":0,"previousEmployment":{"EmploymentType":"String","EmployersName":"String","Occupation":"String","EmployersAddress":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String","TotalNumberOfMonths":"String"}}}],"PartnerType":"String"}],"MarketingPreference":{"OptInMail":"String","OptInTelephone":"String","OptInEmail":"String","OptInSMS":"String"},"PreviousAddresses":[{"Seq":0,"Address":{"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","Town":"String","County":"String","Country":"String","Postcode":"String","Duration":"String","DateStarted":"String","TotalNumberOfMonths":"String"}}]},"PaymentDetails":{"paymentDetails":[{"Seq":0,"PaymentType":"String","AmountPaid":0,"PaymentTransactionID":"String","Description":"String","PaymentDateTime":"String"}]},"Notes":[{"Seq":0,"Note":"String"}],"DiPDetails":{"DiPCustomerId":"String","DiPTimestamp":"String","DiPRequestID":"String","DiPDecisionType":"String","DiPPrimaryDecisionCode":"String","DiPDecisionDescription":"String","DipDecisionDescriptionCode":"String","DipPrimaryDecisionReason":"String","DiPPrimaryDecisionReasonDealerMessage":"String","diPReasons":[{"DipReasonSeq":0,"DipDecisionCode":"String","DiPDecisionReason":"String","DiPDealerMessage":"String"}]}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Code":"String","Message":"String","URN":0}