Skip to main content

Upload loan document

POST /api/v1/Loans/upload-document

Description​

This endpoint is used to upload a document for a specific loan.

Tags:
Loans

URL:
/api/v{version}/Loans/upload-document

ApiKey:
No API key required

Content-Type:
application/json

Request Body:
UploadLoanDocumentCommand

Query Parameters:
version: string, required
Accept-Language: header, optional, change the default response message language from English (en) to French (fr) or English (en)

Response:
Success, returns the ID of the uploaded document.

Error Codes:
400: Bad Request
404: Resource not found
500: Internal server error

/api/v1/Loans/upload-document

Headers​

Content-TypeValue
Accept-Language

Headers​

Content-TypeValue
Content-Typeapplication/json

Headers​

Content-TypeValue
Accepttext/plain

Body (raw)​

{
  "loanId": `<integer>`,
  "name": `<string>`,
  "description": `<string>`,
  "base64": `<string>`
}

Response: 200​

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": `<integer>`
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request POST \ 
 --url  /api/v1/Loans/upload-document \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!