POST api/Kfi
Create a new Key Facts Illustration document
Request Information
URI Parameters
None.
Body Parameters
KfiRequestName | Description | Type | Additional information |
---|---|---|---|
LicenseKey | string |
None. |
|
CompanyId | string |
None. |
|
SiteId | string |
None. |
|
IsRegulated | boolean |
None. |
|
IsAdvised | boolean |
None. |
|
IsAdverseDeclared | boolean |
None. |
|
FeeWaiverText | string |
None. |
|
IllustrationHeaderText | string |
None. |
|
InducementText | string |
None. |
|
LenderFeeFooterText | string |
None. |
|
ProcFeeAdditionalText | string |
None. |
|
PostErcText | string |
None. |
|
ErcNoteText | string |
None. |
|
RightsOfTheBorrowerDuration | string |
None. |
|
RightsOfTheBorrowerText | string |
None. |
|
BrokerDetails | KfiBrokerDetails |
None. |
|
ProductDetails | KfiProductDetails |
None. |
|
LoanDetails | KfiLoanDetails |
None. |
|
Applicants | Collection of KfiApplicant |
None. |
|
PaymentScheduleType | PaymentScheduleType |
None. |
|
TotalProductFees | decimal number |
None. |
|
InitialRatePeriodMonths | integer |
None. |
|
MortgageClass | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "LicenseKey": "sample string 1", "CompanyId": "sample string 2", "SiteId": "sample string 3", "IsRegulated": true, "IsAdvised": true, "IsAdverseDeclared": true, "FeeWaiverText": "sample string 7", "IllustrationHeaderText": "sample string 8", "InducementText": "sample string 9", "LenderFeeFooterText": "sample string 10", "ProcFeeAdditionalText": "sample string 11", "PostErcText": "sample string 12", "ErcNoteText": "sample string 13", "RightsOfTheBorrowerDuration": "sample string 14", "RightsOfTheBorrowerText": "sample string 15", "BrokerDetails": { "IntroducerName": "sample string 1", "BrokerCompanyName": "sample string 2", "PackagerCompanyName": "sample string 3", "BrokerPhoneNumber": "sample string 4", "BrokerName": "sample string 5", "BrokerAddressLine1": "sample string 6", "BrokerAddressLine2": "sample string 7", "BrokerAddressLine3": "sample string 8", "BrokerAddressTown": "sample string 9", "BrokerAddressCounty": "sample string 10", "BrokerAddressPostCode": "sample string 11", "BrokerAddressCountry": "sample string 12" }, "ProductDetails": { "ProductCode": "sample string 1", "BaseProductCode": "sample string 2", "LenderProductReference": "sample string 3", "ProductName": "sample string 4", "LenderCode": "sample string 5", "LenderName": "sample string 6", "LenderNameOverride": "sample string 7", "PackagerName": "sample string 8", "Rates": [ { "Rate": 1.0, "Loading": 2.0, "DurationMonths": 3, "DurationEndDate": "sample string 4", "RateClass": 0, "RateType": 0, "RateDescription": "sample string 5" }, { "Rate": 1.0, "Loading": 2.0, "DurationMonths": 3, "DurationEndDate": "sample string 4", "RateClass": 0, "RateType": 0, "RateDescription": "sample string 5" } ], "Apr": 9.0, "Aprc": 10.0, "TheoreticalAprc": "sample string 11", "TheoreticalMonthlyPayment": "sample string 12", "CappedRate": 13.0, "CollarRate": 14.0, "MaxLTV": 15.0, "MinLoan": 16.0, "CashbackAmount": 17.0, "OverpayAnnualPercentage": 18.0, "ValuationFeeMaxRefund": 19.0, "MaxEarlyRepaymentCharge": 20.0, "OverpaymentsDescription": "sample string 21", "OverpaymentsNoErcText": "sample string 22", "FreeConveyancing": true, "PortabilityText": "sample string 24", "TiedInsuranceText": "sample string 25", "ConditionalInsuranceText": "sample string 26", "OptionalInsuranceText": "sample string 27", "LenderRateName1": "sample string 28", "LenderRateName2": "sample string 29", "LenderRateName3": "sample string 30", "CompletionDate": "sample string 31", "ProductFeatures": [ { "Title": "sample string 1", "Type": 0, "IsIncentive": true, "Description": "sample string 3" }, { "Title": "sample string 1", "Type": 0, "IsIncentive": true, "Description": "sample string 3" } ], "Fees": [ { "Name": "sample string 1", "Description": "sample string 2", "Type": 0, "PayableTo": 0, "WhenPayable": 0, "WhenRefundable": 0, "AddToLoanCondition": 0, "AddToLoan": true, "IsSubjectToChange": true, "IsEstimate": true, "AdditionalFeatures": "sample string 6", "Amount": 7.0, "AmountRefundable": 8.0, "PayableToCustomName": "sample string 9" }, { "Name": "sample string 1", "Description": "sample string 2", "Type": 0, "PayableTo": 0, "WhenPayable": 0, "WhenRefundable": 0, "AddToLoanCondition": 0, "AddToLoan": true, "IsSubjectToChange": true, "IsEstimate": true, "AdditionalFeatures": "sample string 6", "Amount": 7.0, "AmountRefundable": 8.0, "PayableToCustomName": "sample string 9" } ], "ProcFees": [ { "Type": 0, "Amount": 1.0, "Company": "sample string 2" }, { "Type": 0, "Amount": 1.0, "Company": "sample string 2" } ], "ErcDetails": [ { "LoanAmount": 1.0, "InterestOnlyLoanAmount": 2.0, "Description": "sample string 3", "PeriodPayable": "sample string 4", "DurationMonths": 5, "DurationEndDate": "sample string 6", "ErcPercentage": 7.0, "ExampleAmount": 8.0, "InterestOnlyExampleAmount": 9.0 }, { "LoanAmount": 1.0, "InterestOnlyLoanAmount": 2.0, "Description": "sample string 3", "PeriodPayable": "sample string 4", "DurationMonths": 5, "DurationEndDate": "sample string 6", "ErcPercentage": 7.0, "ExampleAmount": 8.0, "InterestOnlyExampleAmount": 9.0 } ], "DirectExclusive": "sample string 32" }, "LoanDetails": { "LoanAmount": 1.0, "ExpectedValuation": 2.0, "LoanRequiredInvestmentPart": 3.0, "Term": 4, "TermUnit": 0, "PaymentMethod": 0, "IsRemortgage": true, "MortgageType": 0, "PaymentSchedule": { "MonthlyPayments": [ { "PaymentNumber": 1, "Date": "sample string 2", "Rate": 3.0, "RateType": 0, "RateClass": 0, "Amount": 4.0, "InterestOnlyAmount": 5.0, "Interest": 6.0, "Repayment": 7.0, "Principal": 8.0, "TotalInterest": 9.0, "TotalRepayment": 10.0, "TotalCost": 11.0 }, { "PaymentNumber": 1, "Date": "sample string 2", "Rate": 3.0, "RateType": 0, "RateClass": 0, "Amount": 4.0, "InterestOnlyAmount": 5.0, "Interest": 6.0, "Repayment": 7.0, "Principal": 8.0, "TotalInterest": 9.0, "TotalRepayment": 10.0, "TotalCost": 11.0 } ], "InitialMonthlyPayment": 1.0, "RevertMonthlyPayment": 2.0, "RevertMonthlyPaymentPlus1Percent": 3.0, "TrueCostFullTerm": 4.0, "TotalInterest": 5.0 }, "BuyToLetDetails": { "ConsumerBuyToLet": 0, "LimitedCompany": 0, "LimitedCompanySPV": 0, "LimitedCompanyName": "sample string 1" } }, "Applicants": [ { "Title": "sample string 1", "FirstName": "sample string 2", "MiddleName": "sample string 3", "LastName": "sample string 4" }, { "Title": "sample string 1", "FirstName": "sample string 2", "MiddleName": "sample string 3", "LastName": "sample string 4" } ], "PaymentScheduleType": 0, "TotalProductFees": 1.0, "InitialRatePeriodMonths": 16, "MortgageClass": "sample string 17" }
application/xml, text/xml
Sample:
<KfiRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Twenty7Tec.Common"> <Applicants> <KfiApplicant> <FirstName>sample string 2</FirstName> <LastName>sample string 4</LastName> <MiddleName>sample string 3</MiddleName> <Title>sample string 1</Title> </KfiApplicant> <KfiApplicant> <FirstName>sample string 2</FirstName> <LastName>sample string 4</LastName> <MiddleName>sample string 3</MiddleName> <Title>sample string 1</Title> </KfiApplicant> </Applicants> <BrokerDetails> <BrokerAddressCountry>sample string 12</BrokerAddressCountry> <BrokerAddressCounty>sample string 10</BrokerAddressCounty> <BrokerAddressLine1>sample string 6</BrokerAddressLine1> <BrokerAddressLine2>sample string 7</BrokerAddressLine2> <BrokerAddressLine3>sample string 8</BrokerAddressLine3> <BrokerAddressPostCode>sample string 11</BrokerAddressPostCode> <BrokerAddressTown>sample string 9</BrokerAddressTown> <BrokerCompanyName>sample string 2</BrokerCompanyName> <BrokerName>sample string 5</BrokerName> <BrokerPhoneNumber>sample string 4</BrokerPhoneNumber> <IntroducerName>sample string 1</IntroducerName> <PackagerCompanyName>sample string 3</PackagerCompanyName> </BrokerDetails> <CompanyId>sample string 2</CompanyId> <ErcNoteText>sample string 13</ErcNoteText> <FeeWaiverText>sample string 7</FeeWaiverText> <IllustrationHeaderText>sample string 8</IllustrationHeaderText> <InducementText>sample string 9</InducementText> <InitialRatePeriodMonths>16</InitialRatePeriodMonths> <IsAdverseDeclared>true</IsAdverseDeclared> <IsAdvised>true</IsAdvised> <IsRegulated>true</IsRegulated> <LenderFeeFooterText>sample string 10</LenderFeeFooterText> <LicenseKey>sample string 1</LicenseKey> <LoanDetails> <BuyToLetDetails> <ConsumerBuyToLet>Yes</ConsumerBuyToLet> <LimitedCompany>Yes</LimitedCompany> <LimitedCompanyName>sample string 1</LimitedCompanyName> <LimitedCompanySPV>Yes</LimitedCompanySPV> </BuyToLetDetails> <ExpectedValuation>2</ExpectedValuation> <IsRemortgage>true</IsRemortgage> <LoanAmount>1</LoanAmount> <LoanRequiredInvestmentPart>3</LoanRequiredInvestmentPart> <MortgageType>Standard</MortgageType> <PaymentMethod>Repayment</PaymentMethod> <PaymentSchedule xmlns:d3p1="http://schemas.datacontract.org/2004/07/Twenty7Tec.Common.Documents"> <d3p1:InitialMonthlyPayment>1</d3p1:InitialMonthlyPayment> <d3p1:MonthlyPayments> <d3p1:DocsAmortPayment> <d3p1:Amount>4</d3p1:Amount> <d3p1:Date>sample string 2</d3p1:Date> <d3p1:Interest>6</d3p1:Interest> <d3p1:InterestOnlyAmount>5</d3p1:InterestOnlyAmount> <d3p1:PaymentNumber>1</d3p1:PaymentNumber> <d3p1:Principal>8</d3p1:Principal> <d3p1:Rate>3</d3p1:Rate> <d3p1:RateClass>Fixed</d3p1:RateClass> <d3p1:RateType>BoE</d3p1:RateType> <d3p1:Repayment>7</d3p1:Repayment> <d3p1:TotalCost>11</d3p1:TotalCost> <d3p1:TotalInterest>9</d3p1:TotalInterest> <d3p1:TotalRepayment>10</d3p1:TotalRepayment> </d3p1:DocsAmortPayment> <d3p1:DocsAmortPayment> <d3p1:Amount>4</d3p1:Amount> <d3p1:Date>sample string 2</d3p1:Date> <d3p1:Interest>6</d3p1:Interest> <d3p1:InterestOnlyAmount>5</d3p1:InterestOnlyAmount> <d3p1:PaymentNumber>1</d3p1:PaymentNumber> <d3p1:Principal>8</d3p1:Principal> <d3p1:Rate>3</d3p1:Rate> <d3p1:RateClass>Fixed</d3p1:RateClass> <d3p1:RateType>BoE</d3p1:RateType> <d3p1:Repayment>7</d3p1:Repayment> <d3p1:TotalCost>11</d3p1:TotalCost> <d3p1:TotalInterest>9</d3p1:TotalInterest> <d3p1:TotalRepayment>10</d3p1:TotalRepayment> </d3p1:DocsAmortPayment> </d3p1:MonthlyPayments> <d3p1:RevertMonthlyPayment>2</d3p1:RevertMonthlyPayment> <d3p1:RevertMonthlyPaymentPlus1Percent>3</d3p1:RevertMonthlyPaymentPlus1Percent> <d3p1:TotalInterest>5</d3p1:TotalInterest> <d3p1:TrueCostFullTerm>4</d3p1:TrueCostFullTerm> </PaymentSchedule> <Term>4</Term> <TermUnit>Years</TermUnit> </LoanDetails> <MortgageClass>sample string 17</MortgageClass> <PaymentScheduleType>None</PaymentScheduleType> <PostErcText>sample string 12</PostErcText> <ProcFeeAdditionalText>sample string 11</ProcFeeAdditionalText> <ProductDetails> <Apr>9</Apr> <Aprc>10</Aprc> <BaseProductCode>sample string 2</BaseProductCode> <CappedRate>13</CappedRate> <CashbackAmount>17</CashbackAmount> <CollarRate>14</CollarRate> <CompletionDate>sample string 31</CompletionDate> <ConditionalInsuranceText>sample string 26</ConditionalInsuranceText> <DirectExclusive>sample string 32</DirectExclusive> <ErcDetails> <KfiErcDetail> <Description>sample string 3</Description> <DurationEndDate>sample string 6</DurationEndDate> <DurationMonths>5</DurationMonths> <ErcPercentage>7</ErcPercentage> <ExampleAmount>8</ExampleAmount> <InterestOnlyExampleAmount>9</InterestOnlyExampleAmount> <InterestOnlyLoanAmount>2</InterestOnlyLoanAmount> <LoanAmount>1</LoanAmount> <PeriodPayable>sample string 4</PeriodPayable> </KfiErcDetail> <KfiErcDetail> <Description>sample string 3</Description> <DurationEndDate>sample string 6</DurationEndDate> <DurationMonths>5</DurationMonths> <ErcPercentage>7</ErcPercentage> <ExampleAmount>8</ExampleAmount> <InterestOnlyExampleAmount>9</InterestOnlyExampleAmount> <InterestOnlyLoanAmount>2</InterestOnlyLoanAmount> <LoanAmount>1</LoanAmount> <PeriodPayable>sample string 4</PeriodPayable> </KfiErcDetail> </ErcDetails> <Fees> <KfiFee> <AddToLoan>true</AddToLoan> <AddToLoanCondition>CanAddToLoan</AddToLoanCondition> <AdditionalFeatures>sample string 6</AdditionalFeatures> <Amount>7</Amount> <AmountRefundable>8</AmountRefundable> <Description>sample string 2</Description> <IsEstimate>true</IsEstimate> <IsSubjectToChange>true</IsSubjectToChange> <Name>sample string 1</Name> <PayableTo>Lender</PayableTo> <PayableToCustomName>sample string 9</PayableToCustomName> <Type>BrokerApplicationFee</Type> <WhenPayable>OnApplication</WhenPayable> <WhenRefundable>NotRefundable</WhenRefundable> </KfiFee> <KfiFee> <AddToLoan>true</AddToLoan> <AddToLoanCondition>CanAddToLoan</AddToLoanCondition> <AdditionalFeatures>sample string 6</AdditionalFeatures> <Amount>7</Amount> <AmountRefundable>8</AmountRefundable> <Description>sample string 2</Description> <IsEstimate>true</IsEstimate> <IsSubjectToChange>true</IsSubjectToChange> <Name>sample string 1</Name> <PayableTo>Lender</PayableTo> <PayableToCustomName>sample string 9</PayableToCustomName> <Type>BrokerApplicationFee</Type> <WhenPayable>OnApplication</WhenPayable> <WhenRefundable>NotRefundable</WhenRefundable> </KfiFee> </Fees> <FreeConveyancing>true</FreeConveyancing> <LenderCode>sample string 5</LenderCode> <LenderName>sample string 6</LenderName> <LenderNameOverride>sample string 7</LenderNameOverride> <LenderProductReference>sample string 3</LenderProductReference> <LenderRateName1>sample string 28</LenderRateName1> <LenderRateName2>sample string 29</LenderRateName2> <LenderRateName3>sample string 30</LenderRateName3> <MaxEarlyRepaymentCharge>20</MaxEarlyRepaymentCharge> <MaxLTV>15</MaxLTV> <MinLoan>16</MinLoan> <OptionalInsuranceText>sample string 27</OptionalInsuranceText> <OverpayAnnualPercentage>18</OverpayAnnualPercentage> <OverpaymentsDescription>sample string 21</OverpaymentsDescription> <OverpaymentsNoErcText>sample string 22</OverpaymentsNoErcText> <PackagerName>sample string 8</PackagerName> <PortabilityText>sample string 24</PortabilityText> <ProcFees> <KfiProcFee> <Amount>1</Amount> <Company>sample string 2</Company> <Type>Broker</Type> </KfiProcFee> <KfiProcFee> <Amount>1</Amount> <Company>sample string 2</Company> <Type>Broker</Type> </KfiProcFee> </ProcFees> <ProductCode>sample string 1</ProductCode> <ProductFeatures> <KfiProductFeature> <Description>sample string 3</Description> <IsIncentive>true</IsIncentive> <Title>sample string 1</Title> <Type>Underpay</Type> </KfiProductFeature> <KfiProductFeature> <Description>sample string 3</Description> <IsIncentive>true</IsIncentive> <Title>sample string 1</Title> <Type>Underpay</Type> </KfiProductFeature> </ProductFeatures> <ProductName>sample string 4</ProductName> <Rates> <KfiRateStep> <DurationEndDate>sample string 4</DurationEndDate> <DurationMonths>3</DurationMonths> <Loading>2</Loading> <Rate>1</Rate> <RateClass>Fixed</RateClass> <RateDescription>sample string 5</RateDescription> <RateType>BoE</RateType> </KfiRateStep> <KfiRateStep> <DurationEndDate>sample string 4</DurationEndDate> <DurationMonths>3</DurationMonths> <Loading>2</Loading> <Rate>1</Rate> <RateClass>Fixed</RateClass> <RateDescription>sample string 5</RateDescription> <RateType>BoE</RateType> </KfiRateStep> </Rates> <TheoreticalAprc>sample string 11</TheoreticalAprc> <TheoreticalMonthlyPayment>sample string 12</TheoreticalMonthlyPayment> <TiedInsuranceText>sample string 25</TiedInsuranceText> <ValuationFeeMaxRefund>19</ValuationFeeMaxRefund> </ProductDetails> <RightsOfTheBorrowerDuration>sample string 14</RightsOfTheBorrowerDuration> <RightsOfTheBorrowerText>sample string 15</RightsOfTheBorrowerText> <SiteId>sample string 3</SiteId> <TotalProductFees>1</TotalProductFees> </KfiRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
A Kfi document id
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |