POST api/ConsumerBorrower/v1/GetConsumerLoanApplicationStatus

Returns the current processing status of loan application.

Request Information

URI Parameters

None.

Body Parameters

GetConsumerLoanApplicationStatusRequest
NameDescriptionTypeAdditional information
applicationId

Unique identifier of loan application returned by InsertConsumerLoanApplication. Use this or combination channelCode, brandCode, externalApplicationNumber.

globally unique identifier

None.

channelCode

Code identifying the sender organization. Code to use provided by FF.

string

None.

brandCode

Brand code of loan: FF, FP, LA, FS ...

string

None.

externalApplicationNumber

Sender's unique identifier for loan application given as parameter of InsertConsumerLoanApplication

string

None.

OrganizationCode

string

None.

UserName

string

None.

Password

string

None.

Request Formats

application/json, text/json

Sample:
{
  "applicationId": "0e49d73a-2c09-401b-8e3b-c9bd67f6b6e2",
  "channelCode": "sample string 1",
  "brandCode": "sample string 2",
  "externalApplicationNumber": "sample string 3",
  "OrganizationCode": "sample string 4",
  "UserName": "sample string 5",
  "Password": "sample string 6"
}

application/xml, text/xml

Sample:
<GetConsumerLoanApplicationStatusRequest 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 4</OrganizationCode>
  <Password xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 6</Password>
  <UserName xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">sample string 5</UserName>
  <applicationId>0e49d73a-2c09-401b-8e3b-c9bd67f6b6e2</applicationId>
  <brandCode>sample string 2</brandCode>
  <channelCode>sample string 1</channelCode>
  <externalApplicationNumber>sample string 3</externalApplicationNumber>
</GetConsumerLoanApplicationStatusRequest>

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 'GetConsumerLoanApplicationStatusRequest'.

Response Information

Resource Description

GetConsumerLoanApplicationStatusReply
NameDescriptionTypeAdditional information
Reply

LoanApplicationStatus

None.

Ok

boolean

None.

ErrorMessage

string

None.

ErrorCode

string

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Reply": {
    "StatusEnum": 0,
    "ExternalApplicationNumber": "sample string 1",
    "BrandCode": "sample string 2",
    "ChannelCode": "sample string 3",
    "ApplicationId": "sample string 4",
    "IsIncomeDocumentVerified": true,
    "IncomeDocumentVerificationTime": "2025-05-02T02:39:19.0406619+00:00",
    "IsSigned": true,
    "SignatureTime": "2025-05-02T02:39:19.0406619+00:00",
    "IsLoanApplicationVerified": true,
    "IsLoanApplicationProcessed": true,
    "ProcessedTime": "2025-05-02T02:39:19.0406619+00:00",
    "ExpirationDate": "2025-05-02T02:39:19.0406619+00:00",
    "IsWaitingForDisbursement": true,
    "LoanAmount": 11.0,
    "InstallmentCount": 12,
    "InstallmentAmount": 13.0,
    "InterestRate": 14.0,
    "ActualYearlyInterestRate": 15.0,
    "OpeningFee": 16.0,
    "InstallmentFee": 17.0,
    "IsApproved": true,
    "RejectionReasonMessage": "sample string 19",
    "RejectionReasonCode": "sample string 20",
    "IsIncomeDocumentRequired": true
  },
  "Ok": true,
  "ErrorMessage": "sample string 2",
  "ErrorCode": "sample string 3",
  "Message": "sample string 4"
}

application/xml, text/xml

Sample:
<GetConsumerLoanApplicationStatusReply 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>15</ActualYearlyInterestRate>
    <ApplicationId>sample string 4</ApplicationId>
    <BrandCode>sample string 2</BrandCode>
    <ChannelCode>sample string 3</ChannelCode>
    <ExpirationDate>2025-05-02T02:39:19.0406619+00:00</ExpirationDate>
    <ExternalApplicationNumber>sample string 1</ExternalApplicationNumber>
    <IncomeDocumentVerificationTime>2025-05-02T02:39:19.0406619+00:00</IncomeDocumentVerificationTime>
    <InstallmentAmount>13</InstallmentAmount>
    <InstallmentCount>12</InstallmentCount>
    <InstallmentFee>17</InstallmentFee>
    <InterestRate>14</InterestRate>
    <IsApproved>true</IsApproved>
    <IsIncomeDocumentRequired>true</IsIncomeDocumentRequired>
    <IsIncomeDocumentVerified>true</IsIncomeDocumentVerified>
    <IsLoanApplicationProcessed>true</IsLoanApplicationProcessed>
    <IsLoanApplicationVerified>true</IsLoanApplicationVerified>
    <IsSigned>true</IsSigned>
    <IsWaitingForDisbursement>true</IsWaitingForDisbursement>
    <LoanAmount>11</LoanAmount>
    <OpeningFee>16</OpeningFee>
    <ProcessedTime>2025-05-02T02:39:19.0406619+00:00</ProcessedTime>
    <RejectionReasonCode>sample string 20</RejectionReasonCode>
    <RejectionReasonMessage>sample string 19</RejectionReasonMessage>
    <SignatureTime>2025-05-02T02:39:19.0406619+00:00</SignatureTime>
    <StatusEnum>Null</StatusEnum>
  </Reply>
</GetConsumerLoanApplicationStatusReply>