| PUT | /CreateOCAv2/ |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Username | body | string | No | |
| Timestamp | body | string | No | |
| Token | body | string | No | |
| GeneralDetails | body | GeneralDetailsv2 | No | |
| FinanceDetails | body | FinanceDetailsv2 | No | |
| VehicleDetails | body | VehicleDetailsv2 | No | |
| DeliveryDetails | body | DeliveryDetailsv2 | No | |
| ExistingVehicleDetails | body | ExistingVehicleDetailsv2 | No | |
| InsuranceDetails | body | InsuranceDetails | No | |
| CreditApplicationIndividual | body | CreditApplicationIndividualV2 | No | |
| CreditApplicationBusiness | body | CreditApplicationBusinessV2 | No | |
| PaymentDetails | body | PaymentDetails | No | |
| Notes | body | NoteDetails[] | No | |
| DiPDetails | body | DiPDetails | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OCAApprovalNumber | form | string | No | |
| EnquiryDateTime | form | string | No | |
| Brand | form | int | No | |
| CustomerReferenceNumber | form | string | No | |
| CustomerType | form | string | No | |
| SourceofBusiness | form | string | No | |
| TagURL | form | string | No | |
| RequestSource | form | int | No | |
| FormID | form | string | No | |
| ProposalCreated | form | string | No | |
| LoadFullData | form | string | No | |
| ProposalNumber | form | string | No | |
| POSSystem | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FinancialProduct | form | string | No | |
| CampaignCode | form | string | No | |
| PhoenixFinanceProductCode | form | string | No | |
| Fixed | form | string | No | |
| FleetNonFleet | form | string | No | |
| RFLCover | form | string | No | |
| Duration | form | int | No | |
| PaymentRentalAmount | form | decimal | No | |
| RentalAmountExcVAT | form | decimal? | No | |
| AdvanceArrears | form | string | No | |
| AnnualMileage | form | int | No | |
| ExcessMileageRate | form | decimal | No | |
| CustomerDepositContribution | form | decimal? | No | |
| RetailerDepositContribution | form | decimal? | No | |
| RetailerDepositContributionNet | form | decimal? | No | |
| ManufacturerDepositContribution | form | decimal? | No | |
| ManufacturerDepositContributionNet | form | decimal? | No | |
| TotalDepositContribution | form | decimal? | No | |
| LumpSum | form | decimal? | No | |
| CostForCredit | form | decimal? | No | |
| PurchaseActivationFee | form | decimal? | No | |
| TotalAmountPayable | form | decimal? | No | |
| FixedInterestRate | form | decimal? | No | |
| RepresentativeAPR | form | decimal? | No | |
| TrueFlatRate | form | string | No | |
| RVReferenceNumber | form | string | No | |
| OptionalPurchasePayment | form | decimal? | No | |
| AdvancedRentalAmount | form | decimal | No | |
| NumberofAdvanceRentals | form | string | No | |
| PaymentProfile | form | string | No | |
| RandMIncluded | form | string | No | |
| RandMLevel | form | string | No | |
| ProductType | form | string | No | |
| Frequency | form | string | No | |
| PauseType | form | string | No | |
| EqualsFinance | form | decimal? | No | |
| AcceptanceFee | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OnlineCode | form | string | No | |
| ModelClass | form | string | No | |
| ModelBody | form | string | No | |
| ModelDerivative | form | string | No | |
| TotalPrice | form | decimal | No | |
| OTRPrice | form | decimal | No | |
| VIN | form | string | No | |
| RegNo | form | string | No | |
| CommissionNumber | form | string | No | |
| EngineNumber | form | string | No | |
| CurrentMileage | form | int | No | |
| MilesKilometers | form | string | No | |
| FirstRegistrationDate | form | string | No | |
| NewUsedFlag | form | string | No | |
| NewVehicleModelOptionDetails | form | ModelOptionDetailsv2[] | No | |
| VID | form | string | No | |
| Baumuster | form | string | No | |
| VehiclePrice | form | decimal? | No | |
| TotalVAT | form | decimal? | No | |
| OLEVGrant | form | decimal? | No | |
| ExtrasTotalExcVAT | form | decimal? | No | |
| CombinedCO2 | form | string | No | |
| VehicleVATTickBox | form | string | No | |
| FirstYearRFLIncluded | form | string | No | |
| FirstYearRFLAmount | form | decimal? | No | |
| FirstRegFeeIncludedFlag | form | string | No | |
| FirstRegFeeAmount | form | decimal? | No | |
| HighLowVEDSupplementFlag | form | string | No | |
| LeaseRFLSubsequentYears | form | string | No | |
| LeaseRFLSubsequentYearsAmount | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Seq | form | int | No | |
| Type | form | string | No | |
| Code | form | string | No | |
| Description | form | string | No | |
| Price | form | decimal | No | |
| PriceGross | form | decimal? | No | |
| VATCategory | form | string | No | |
| VATAmount | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DealerCode | form | string | No | |
| DeliveryPreference | form | string | No | |
| DeliveryDate | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TradeInFlag | form | string | No | |
| TradeInIncludedInCalc | form | string | No | |
| TradeInValue | form | decimal | No | |
| TradeInValueNet | form | decimal? | No | |
| TradeInRegNo | form | string | No | |
| TradeInVIN | form | string | No | |
| TradeInMileage | form | int? | No | |
| TradeInCondition | form | string | No | |
| SettlementFlag | form | string | No | |
| SettlementIncludedInCalc | form | string | No | |
| SettlementValue | form | decimal | No | |
| SettlementValueNet | form | decimal | No | |
| SettlementRegNo | form | string | No | |
| SettlementVIN | form | string | No | |
| SettlementMileage | form | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InterestedInFirstCoverFlag | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Title | form | string | No | |
| Initial | form | string | No | |
| FirstName | form | string | No | |
| Surname | form | string | No | |
| DateofBirth | form | string | No | |
| Gender | form | string | No | |
| MaritalStatus | form | string | No | |
| ResidentialStatus | form | string | No | |
| CurrentAddress | form | AddressWithTimeLinev2 | No | |
| PreviousAddresses | form | PreviousAddressv2[] | No | |
| HomePhone | form | string | No | |
| MobilePhone | form | string | No | |
| WorkPhone | form | string | No | |
| ContactAtWork | form | string | No | |
| form | string | No | ||
| BankSortCode | form | string | No | |
| BankAccountNumber | form | string | No | |
| BankAccountName | form | string | No | |
| BankName | form | string | No | |
| BankAddress | form | Address | No | |
| BankPaymentType | form | string | No | |
| DrivingLicenceNumber | form | string | No | |
| CurrentEmploymentDetails | form | CurrentEmploymentDetailsv2 | No | |
| PreviousEmploymentDetails | form | PreviousEmploymentv2[] | No | |
| MarketingPreference | form | MarketingPreference | No | |
| CreditCheckConsent | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AddressLine1 | form | string | No | |
| AddressLine2 | form | string | No | |
| AddressLine3 | form | string | No | |
| Town | form | string | No | |
| County | form | string | No | |
| Country | form | string | No | |
| Postcode | form | string | No | |
| Duration | form | string | No | |
| DateStarted | form | string | No | |
| TotalNumberOfMonths | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Seq | form | int | No | |
| Address | form | AddressWithTimeLinev2 | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AddressLine1 | form | string | No | |
| AddressLine2 | form | string | No | |
| AddressLine3 | form | string | No | |
| AddressLine4 | form | string | No | |
| AddressLine5 | form | string | No | |
| Postcode | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EmployerDetails | form | EmployerDetailsv2 | No | |
| MonthsAtEmployer | form | string | No | |
| DateEmploymentCommenced | form | string | No | |
| AnnualIncome | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EmploymentType | form | string | No | |
| EmployersName | form | string | No | |
| Occupation | form | string | No | |
| EmployersAddress | form | AddressWithTimeLinev2 | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Seq | form | int | No | |
| previousEmployment | form | EmployerDetailsv2 | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OptInMail | form | string | No | |
| OptInTelephone | form | string | No | |
| OptInEmail | form | string | No | |
| OptInSMS | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TypeOfBusiness | form | string | No | |
| BusinessContactPosition | form | string | No | |
| Title | form | string | No | |
| Initial | form | string | No | |
| FirstName | form | string | No | |
| Surname | form | string | No | |
| CurrentHomeAddress | form | AddressWithTimeLinev2 | No | |
| HomePhone | form | string | No | |
| WorkPhone | form | string | No | |
| MobilePhone | form | string | No | |
| form | string | No | ||
| CompanyName | form | string | No | |
| CompanyRegistrationNumber | form | string | No | |
| TradingAs | form | string | No | |
| BusinessActivity | form | string | No | |
| NumberOfEmployees | form | int | No | |
| YearsTrading | form | int | No | |
| Position | form | string | No | |
| BankSortCode | form | string | No | |
| BankAccountNumber | form | string | No | |
| BankAccountName | form | string | No | |
| BankName | form | string | No | |
| BankAddress | form | Address | No | |
| NumberofPartners | form | int | No | |
| BusinessPartners | form | BusinessPartnerv2[] | No | |
| MarketingPreference | form | MarketingPreference | No | |
| PreviousAddresses | form | PreviousAddressv2[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Seq | form | int | No | |
| Title | form | string | No | |
| Initial | form | string | No | |
| FirstName | form | string | No | |
| Surname | form | string | No | |
| DateofBirth | form | string | No | |
| Gender | form | string | No | |
| MaritalStatus | form | string | No | |
| ResidentialStatus | form | string | No | |
| CurrentAddress | form | AddressWithTimeLinev2 | No | |
| PreviousAddresses | form | PreviousAddressv2[] | No | |
| HomePhone | form | string | No | |
| MobilePhone | form | string | No | |
| BusinessPhone | form | string | No | |
| Relationship | form | string | No | |
| form | string | No | ||
| CurrentEmploymentDetails | form | CurrentEmploymentDetailsv2 | No | |
| PreviousEmploymentDetails | form | PreviousEmploymentv2[] | No | |
| PartnerType | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| paymentDetails | form | PaymentDetail[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Seq | form | int | No | |
| PaymentType | form | string | No | |
| AmountPaid | form | decimal | No | |
| PaymentTransactionID | form | string | No | |
| Description | form | string | No | |
| PaymentDateTime | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Seq | form | int | No | |
| Note | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DiPCustomerId | form | string | No | |
| DiPTimestamp | form | string | No | |
| DiPRequestID | form | string | No | |
| DiPDecisionType | form | string | No | |
| DiPPrimaryDecisionCode | form | string | No | |
| DiPDecisionDescription | form | string | No | |
| DipDecisionDescriptionCode | form | string | No | |
| DipPrimaryDecisionReason | form | string | No | |
| DiPPrimaryDecisionReasonDealerMessage | form | string | No | |
| diPReasons | form | DiPReasons[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DipReasonSeq | form | int | No | |
| DipDecisionCode | form | string | No | |
| DiPDecisionReason | form | string | No | |
| DiPDealerMessage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Code | form | string | No | |
| Message | form | string | No | |
| URN | form | int | No |
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
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}