Get Attachment by ID from UW Task

API Method: GET /api/v1/uwTasks/ticket/getAttachmentById

Description:

This API endpoint is used to retrieve a specific attachment by its unique identifier (attachId) from an Underwriting (UW) task ticket. Underwriting tasks often require various documents, and this method allows users to download or view a specific file associated with a task. This can be useful for reviewing specific documentation, such as identification or financial statements, that were previously uploaded to the task.

Request:

• HTTP Method: GET
• Endpoint: /api/v1/uwTasks/ticket/getAttachmentById
• Content-Type: application/json

Request Parameters:

The following parameters are required in the request:

• ID (required):
  The unique identifier of the merchant whose UW task attachment is being retrieved.

  • Type: int32
  • Example: ID=12345

• ticketId (required):
  The identifier of the specific underwriting task (ticket) to which the attachment belongs.

  • Type: int32
  • Example: ticketId=67890

• attachId (required):
  The unique identifier of the attachment to be retrieved. This is the specific file within the underwriting task that you want to access.

  • Type: int32
  • Example: attachId=54321

Response:

• Status Code:

  • 200 OK: If the attachment is successfully retrieved.
  • 400 Bad Request: If the ID, ticketId, or attachId is missing or invalid.
  • 404 Not Found: If the specified attachment does not exist.
  • 500 Internal Server Error: If there is an issue processing the request.

• Response Body:
  The response will return the requested attachment file, typically in base64 format, along with metadata such as the file name and type.

Example Request:

GET /api/v1/uwTasks/ticket/getAttachmentById?ID=12345&ticketId=67890&attachId=54321

Use Case:

This API method is used by merchants, administrators, or underwriting teams to retrieve a specific attachment by its ID from a particular UW task. It is helpful for downloading or reviewing a single document from the underwriting process, such as a driver's license, SSN, or bank statement.