Jump to

• Request
• Response

Fetch contents of a document in Base 64 format

get

/obcr-correspondence-services/inboundDocument/downloadDocument

This endpoint is used to fetch contents of a document in Base 64 format.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• accountId(required): string
  Account Id
• caseId(required): string
  Case Id
• docRefId(required): string
  Document Reference Id associated with document to be downloaded.

Header Parameters

• appId(required): string
  The application ID of host service.
• branchCode(required): string
  The branch code of requesting branch.
• contentType: string
  The content type of request or response body.
• userId(required): string
  The user ID of requesting user.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns message of success or failure

Body ()

Root Schema : DocContentDto

Type: object

Show Source

• fileContent: string
  File content in Base 64 format
• fileName: string
  File name of the uploaded document

{
    "type":"object",
    "properties":{
        "fileName":{
            "type":"string",
            "description":"File name of the uploaded document"
        },
        "fileContent":{
            "type":"string",
            "description":"File content in Base 64 format"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top