POST api/ConsumerBorrower/v1/GetConsumerLoanContractDocument

Returns the pdf format contract document for loan application as Base64 coded string.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional 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": "1abee4fe-5343-4985-9ec0-ef1874911d62",
  "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:

<GetConsumerLoanContractDocumentRequest 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>1abee4fe-5343-4985-9ec0-ef1874911d62</applicationId>
  <brandCode>sample string 2</brandCode>
  <channelCode>sample string 1</channelCode>
  <externalApplicationNumber>sample string 3</externalApplicationNumber>
</GetConsumerLoanContractDocumentRequest>

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

Response Information

Resource Description

GetConsumerLoanContractDocumentReply

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

Response Formats

application/json, text/json

Sample:

{
  "Reply": {
    "ContentType": "sample string 1",
    "DocumentType": "sample string 2",
    "DocumentDataBase64": "sample string 3"
  },
  "Ok": true,
  "ErrorMessage": "sample string 2",
  "ErrorCode": "sample string 3",
  "Message": "sample string 4"
}

application/xml, text/xml

Sample:

<GetConsumerLoanContractDocumentReply 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>
    <ContentType>sample string 1</ContentType>
    <DocumentDataBase64>sample string 3</DocumentDataBase64>
    <DocumentType>sample string 2</DocumentType>
  </Reply>
</GetConsumerLoanContractDocumentReply>