POST api/ConsumerBorrower/v1/InsertConsumerLoanApplication

Inserts new loan application. As result returns credit decision and approved loan amount, loan duration etc.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
application	LoanApplication	None.
OrganizationCode	string	None.
UserName	string	None.
Password	string	None.

Request Formats

application/json, text/json

Sample:

{
  "application": {
    "ApplicationTime": "2025-05-02T02:02:33.1621221+00:00",
    "ExternalApplicationNumber": "sample string 2",
    "ChannelCode": "sample string 3",
    "BrandCode": "sample string 4",
    "LoanAmount": 5.0,
    "LoanDurationInMonths": 6,
    "DueDate": 7,
    "CreditBureauCheckConsentTime": "2025-05-02T02:02:33.1621221+00:00",
    "PurposeEnum": 0,
    "Applicants": [
      {
        "ApplicantTypeEnum": 0,
        "SsnBic": "sample string 1",
        "IdentityCode": "sample string 2",
        "Name": "sample string 3",
        "FirstName": "sample string 4",
        "RepresentativeSsn": "sample string 5",
        "RepresentativeLastName": "sample string 6",
        "RepresentativeFirstName": "sample string 7",
        "AddressStreet": "sample string 8",
        "AddressCity": "sample string 9",
        "AddressZip": "sample string 10",
        "AddressCountryCode": "sample string 11",
        "PlaceOfBirth": "sample string 12",
        "DateOfBirth": "2025-05-02T02:02:33.1621221+00:00",
        "Email": "sample string 13",
        "Phone": "sample string 14",
        "BankAccountNumber": "sample string 15",
        "ReferenceNumber": "sample string 16",
        "MaritalStatusEnum": 0,
        "NumberOfChildrenInHousehold": 17,
        "NationalityCode": "sample string 18",
        "NativeLanguageEnum": 0,
        "GenderEnum": 0,
        "EducationLevelEnum": 0,
        "BusinessTypeEnum": 0,
        "Employer": "sample string 19",
        "Profession": "sample string 20",
        "EmploymentStatusEnum": 0,
        "EmploymentStartDate": "2025-05-02T02:02:33.1777481+00:00",
        "EmploymentTerminationDate": "2025-05-02T02:02:33.1777481+00:00",
        "ResidenceOwnershipEnum": 0,
        "ResidenceTypeEnum": 0,
        "RecidenceStartDate": "2025-05-02T02:02:33.1777481+00:00",
        "GrossIncomePerMonth": 22.0,
        "OtherIncomePerMonth": 23.0,
        "CostOfHousingPerMonth": 24.0,
        "OtherExpencesPerMonth": 25.0,
        "OtherIncomeSpecification": "sample string 26",
        "CreditCardCount": 27,
        "Title": "sample string 28"
      },
      {
        "ApplicantTypeEnum": 0,
        "SsnBic": "sample string 1",
        "IdentityCode": "sample string 2",
        "Name": "sample string 3",
        "FirstName": "sample string 4",
        "RepresentativeSsn": "sample string 5",
        "RepresentativeLastName": "sample string 6",
        "RepresentativeFirstName": "sample string 7",
        "AddressStreet": "sample string 8",
        "AddressCity": "sample string 9",
        "AddressZip": "sample string 10",
        "AddressCountryCode": "sample string 11",
        "PlaceOfBirth": "sample string 12",
        "DateOfBirth": "2025-05-02T02:02:33.1621221+00:00",
        "Email": "sample string 13",
        "Phone": "sample string 14",
        "BankAccountNumber": "sample string 15",
        "ReferenceNumber": "sample string 16",
        "MaritalStatusEnum": 0,
        "NumberOfChildrenInHousehold": 17,
        "NationalityCode": "sample string 18",
        "NativeLanguageEnum": 0,
        "GenderEnum": 0,
        "EducationLevelEnum": 0,
        "BusinessTypeEnum": 0,
        "Employer": "sample string 19",
        "Profession": "sample string 20",
        "EmploymentStatusEnum": 0,
        "EmploymentStartDate": "2025-05-02T02:02:33.1777481+00:00",
        "EmploymentTerminationDate": "2025-05-02T02:02:33.1777481+00:00",
        "ResidenceOwnershipEnum": 0,
        "ResidenceTypeEnum": 0,
        "RecidenceStartDate": "2025-05-02T02:02:33.1777481+00:00",
        "GrossIncomePerMonth": 22.0,
        "OtherIncomePerMonth": 23.0,
        "CostOfHousingPerMonth": 24.0,
        "OtherExpencesPerMonth": 25.0,
        "OtherIncomeSpecification": "sample string 26",
        "CreditCardCount": 27,
        "Title": "sample string 28"
      }
    ],
    "ExternalLoans": [
      {
        "LoanBalance": 1.0,
        "MonthlyInstallment": 2.0,
        "Provider": "sample string 3",
        "RepaymentBankAccountNumber": "sample string 4",
        "CreditTypeEnum": 0,
        "IsToBeRepaid": true
      },
      {
        "LoanBalance": 1.0,
        "MonthlyInstallment": 2.0,
        "Provider": "sample string 3",
        "RepaymentBankAccountNumber": "sample string 4",
        "CreditTypeEnum": 0,
        "IsToBeRepaid": true
      }
    ],
    "SourcePartnerUserCode": "sample string 8",
    "CreditTypeEnum": 0
  },
  "OrganizationCode": "sample string 1",
  "UserName": "sample string 2",
  "Password": "sample string 3"
}

application/xml, text/xml

Sample:

<InsertConsumerLoanApplicationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers.ConsumerBorrower">
  <OrganizationCode xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 1</OrganizationCode>
  <Password xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 3</Password>
  <UserName xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 2</UserName>
  <application>
    <Applicants>
      <Applicant>
        <AddressCity>sample string 9</AddressCity>
        <AddressCountryCode>sample string 11</AddressCountryCode>
        <AddressStreet>sample string 8</AddressStreet>
        <AddressZip>sample string 10</AddressZip>
        <ApplicantTypeEnum>Null</ApplicantTypeEnum>
        <BankAccountNumber>sample string 15</BankAccountNumber>
        <BusinessTypeEnum>Null</BusinessTypeEnum>
        <CostOfHousingPerMonth>24</CostOfHousingPerMonth>
        <CreditCardCount>27</CreditCardCount>
        <DateOfBirth>2025-05-02T02:02:33.1621221+00:00</DateOfBirth>
        <EducationLevelEnum>Null</EducationLevelEnum>
        <Email>sample string 13</Email>
        <Employer>sample string 19</Employer>
        <EmploymentStartDate>2025-05-02T02:02:33.1777481+00:00</EmploymentStartDate>
        <EmploymentStatusEnum>Null</EmploymentStatusEnum>
        <EmploymentTerminationDate>2025-05-02T02:02:33.1777481+00:00</EmploymentTerminationDate>
        <FirstName>sample string 4</FirstName>
        <GenderEnum>Null</GenderEnum>
        <GrossIncomePerMonth>22</GrossIncomePerMonth>
        <IdentityCode>sample string 2</IdentityCode>
        <MaritalStatusEnum>Null</MaritalStatusEnum>
        <Name>sample string 3</Name>
        <NationalityCode>sample string 18</NationalityCode>
        <NativeLanguageEnum>Null</NativeLanguageEnum>
        <NumberOfChildrenInHousehold>17</NumberOfChildrenInHousehold>
        <OtherExpencesPerMonth>25</OtherExpencesPerMonth>
        <OtherIncomePerMonth>23</OtherIncomePerMonth>
        <OtherIncomeSpecification>sample string 26</OtherIncomeSpecification>
        <Phone>sample string 14</Phone>
        <PlaceOfBirth>sample string 12</PlaceOfBirth>
        <Profession>sample string 20</Profession>
        <RecidenceStartDate>2025-05-02T02:02:33.1777481+00:00</RecidenceStartDate>
        <ReferenceNumber>sample string 16</ReferenceNumber>
        <RepresentativeFirstName>sample string 7</RepresentativeFirstName>
        <RepresentativeLastName>sample string 6</RepresentativeLastName>
        <RepresentativeSsn>sample string 5</RepresentativeSsn>
        <ResidenceOwnershipEnum>Null</ResidenceOwnershipEnum>
        <ResidenceTypeEnum>Null</ResidenceTypeEnum>
        <SsnBic>sample string 1</SsnBic>
        <Title>sample string 28</Title>
      </Applicant>
      <Applicant>
        <AddressCity>sample string 9</AddressCity>
        <AddressCountryCode>sample string 11</AddressCountryCode>
        <AddressStreet>sample string 8</AddressStreet>
        <AddressZip>sample string 10</AddressZip>
        <ApplicantTypeEnum>Null</ApplicantTypeEnum>
        <BankAccountNumber>sample string 15</BankAccountNumber>
        <BusinessTypeEnum>Null</BusinessTypeEnum>
        <CostOfHousingPerMonth>24</CostOfHousingPerMonth>
        <CreditCardCount>27</CreditCardCount>
        <DateOfBirth>2025-05-02T02:02:33.1621221+00:00</DateOfBirth>
        <EducationLevelEnum>Null</EducationLevelEnum>
        <Email>sample string 13</Email>
        <Employer>sample string 19</Employer>
        <EmploymentStartDate>2025-05-02T02:02:33.1777481+00:00</EmploymentStartDate>
        <EmploymentStatusEnum>Null</EmploymentStatusEnum>
        <EmploymentTerminationDate>2025-05-02T02:02:33.1777481+00:00</EmploymentTerminationDate>
        <FirstName>sample string 4</FirstName>
        <GenderEnum>Null</GenderEnum>
        <GrossIncomePerMonth>22</GrossIncomePerMonth>
        <IdentityCode>sample string 2</IdentityCode>
        <MaritalStatusEnum>Null</MaritalStatusEnum>
        <Name>sample string 3</Name>
        <NationalityCode>sample string 18</NationalityCode>
        <NativeLanguageEnum>Null</NativeLanguageEnum>
        <NumberOfChildrenInHousehold>17</NumberOfChildrenInHousehold>
        <OtherExpencesPerMonth>25</OtherExpencesPerMonth>
        <OtherIncomePerMonth>23</OtherIncomePerMonth>
        <OtherIncomeSpecification>sample string 26</OtherIncomeSpecification>
        <Phone>sample string 14</Phone>
        <PlaceOfBirth>sample string 12</PlaceOfBirth>
        <Profession>sample string 20</Profession>
        <RecidenceStartDate>2025-05-02T02:02:33.1777481+00:00</RecidenceStartDate>
        <ReferenceNumber>sample string 16</ReferenceNumber>
        <RepresentativeFirstName>sample string 7</RepresentativeFirstName>
        <RepresentativeLastName>sample string 6</RepresentativeLastName>
        <RepresentativeSsn>sample string 5</RepresentativeSsn>
        <ResidenceOwnershipEnum>Null</ResidenceOwnershipEnum>
        <ResidenceTypeEnum>Null</ResidenceTypeEnum>
        <SsnBic>sample string 1</SsnBic>
        <Title>sample string 28</Title>
      </Applicant>
    </Applicants>
    <ApplicationTime>2025-05-02T02:02:33.1621221+00:00</ApplicationTime>
    <BrandCode>sample string 4</BrandCode>
    <ChannelCode>sample string 3</ChannelCode>
    <CreditBureauCheckConsentTime>2025-05-02T02:02:33.1621221+00:00</CreditBureauCheckConsentTime>
    <CreditTypeEnum>Null</CreditTypeEnum>
    <DueDate>7</DueDate>
    <ExternalApplicationNumber>sample string 2</ExternalApplicationNumber>
    <ExternalLoans>
      <ExternalLoanData>
        <CreditTypeEnum>Null</CreditTypeEnum>
        <IsToBeRepaid>true</IsToBeRepaid>
        <LoanBalance>1</LoanBalance>
        <MonthlyInstallment>2</MonthlyInstallment>
        <Provider>sample string 3</Provider>
        <RepaymentBankAccountNumber>sample string 4</RepaymentBankAccountNumber>
      </ExternalLoanData>
      <ExternalLoanData>
        <CreditTypeEnum>Null</CreditTypeEnum>
        <IsToBeRepaid>true</IsToBeRepaid>
        <LoanBalance>1</LoanBalance>
        <MonthlyInstallment>2</MonthlyInstallment>
        <Provider>sample string 3</Provider>
        <RepaymentBankAccountNumber>sample string 4</RepaymentBankAccountNumber>
      </ExternalLoanData>
    </ExternalLoans>
    <LoanAmount>5</LoanAmount>
    <LoanDurationInMonths>6</LoanDurationInMonths>
    <PurposeEnum>Null</PurposeEnum>
    <SourcePartnerUserCode>sample string 8</SourcePartnerUserCode>
  </application>
</InsertConsumerLoanApplicationRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'InsertConsumerLoanApplicationRequest'.

Response Information

Resource Description

InsertConsumerLoanApplicationReply

Name	Type	Additional information
Reply	LoanApplicationResult	None.
Ok	boolean	None.
ErrorMessage	string	None.
ErrorCode	string	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Reply": {
    "MaxLoanAmountWithoutIncomeVerification": 1.0,
    "LoanAmount": 2.0,
    "InstallmentCount": 3,
    "InstallmentAmount": 4.0,
    "InterestRate": 5.0,
    "ActualYearlyInterestRate": 6.0,
    "OpeningFee": 7.0,
    "InstallmentFee": 8.0,
    "IsValid": true,
    "ValidationMessage": "sample string 10",
    "IsApproved": true,
    "RejectionReasonMessage": "sample string 12",
    "RejectionReasonCode": "sample string 13",
    "ApplicationId": "sample string 14",
    "ExternalApplicationNumber": "sample string 15",
    "IsTaxDocumentRequired": true,
    "IsIncomeDocumentRequired": true,
    "CustomerNumber": "sample string 18",
    "FirstDueDate": "2025-05-02T02:02:33.2714995+00:00"
  },
  "Ok": true,
  "ErrorMessage": "sample string 2",
  "ErrorCode": "sample string 3",
  "Message": "sample string 4"
}

application/xml, text/xml

Sample:

<InsertConsumerLoanApplicationReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers.ConsumerBorrower">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 3</ErrorCode>
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 2</ErrorMessage>
  <Message xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 4</Message>
  <Ok xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">true</Ok>
  <Reply>
    <ActualYearlyInterestRate>6</ActualYearlyInterestRate>
    <ApplicationId>sample string 14</ApplicationId>
    <CustomerNumber>sample string 18</CustomerNumber>
    <ExternalApplicationNumber>sample string 15</ExternalApplicationNumber>
    <InstallmentAmount>4</InstallmentAmount>
    <InstallmentCount>3</InstallmentCount>
    <InstallmentFee>8</InstallmentFee>
    <InterestRate>5</InterestRate>
    <IsApproved>true</IsApproved>
    <IsIncomeDocumentRequired>true</IsIncomeDocumentRequired>
    <IsTaxDocumentRequired>true</IsTaxDocumentRequired>
    <IsValid>true</IsValid>
    <LoanAmount>2</LoanAmount>
    <MaxLoanAmountWithoutIncomeVerification>1</MaxLoanAmountWithoutIncomeVerification>
    <OpeningFee>7</OpeningFee>
    <RejectionReasonCode>sample string 13</RejectionReasonCode>
    <RejectionReasonMessage>sample string 12</RejectionReasonMessage>
    <ValidationMessage>sample string 10</ValidationMessage>
  </Reply>
</InsertConsumerLoanApplicationReply>