Get Attachment by ID from UW Task

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Get Attachment by ID from UW Task

Retrieves the full file content of a single attachment from a UW task ticket, identified by its attachment ID. The response includes the Base64-encoded file data along with the file name and MIME type, allowing the caller to reconstruct and display or save the original document.

Endpoint

GET /api/v1/uwTasks/ticket/getAttachmentById

Authentication

Basic HTTP Authentication required.
Encode username:password in Base64 and pass in the Authorization header:

Authorization: Basic {base64(username:password)}

When to use

Use this endpoint when you need to download or display a specific document that was previously uploaded to a UW task ticket. Typically, you first call GET /api/v1/uwTasks/ticket/getAttachmentsByTicketId to get the list of attachment IDs for a ticket, then use this endpoint to fetch the content of a particular file. Useful for reviewing a driver's license, bank statement, or any other document submitted during the underwriting process.

Query Parameters

ParameterTypeRequiredDescription
idinteger (int32)YesMerchant profile ID that owns the UW task
ticketIdinteger (int32)YesID of the UW task ticket that contains the attachment
attachIdinteger (int32)YesID of the specific attachment to retrieve

Response

200 OK

FieldTypeDescription
data.contentstring (byte/base64)Base64-encoded file content
data.fileNamestringOriginal file name including extension
data.mimeTypestringMIME type of the file (e.g., application/pdf)
statusstring (enum)HTTP status name, e.g., "OK"
errorstringError message if the operation failed
warningstringNon-fatal warning message
validationResultsarrayField-level validation errors, if any
requestIdintegerUnique identifier for this API request
{
  "data": {
    "content": "JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9...",
    "fileName": "john_smith_dl.pdf",
    "mimeType": "application/pdf"
  },
  "status": "OK",
  "error": null,
  "warning": null,
  "validationResults": [],
  "requestId": 88512
}

Error Codes

CodeWhen it happens
400One or more of id, ticketId, or attachId is missing or not a valid integer
401Invalid or missing Basic Auth credentials
403User does not have permission for this operation
404Merchant, ticket, or attachment not found
500Internal server error

Common Mistakes

  • Confusing attachId with ticketId — these are distinct identifiers; attachId is the ID of a specific file, not the task itself.
  • Not first listing attachments via GET /api/v1/uwTasks/ticket/getAttachmentsByTicketId to find valid attachId values.
  • Forgetting to Base64-decode the data.content field before writing or displaying the file.

Related Endpoints

  • GET /api/v1/uwTasks/ticket/getAttachmentsByTicketId — list all attachment metadata for a ticket (provides valid attachId values)
  • POST /api/v1/uwTasks/ticket/addAttachment — upload a new attachment to a ticket
  • GET /api/v1/uwTasks/getByMerchantId — get the list of UW tickets for a merchant

Example

curl -X GET "https://hq.staging.netevia.dev/api/v1/uwTasks/ticket/getAttachmentById?id=48201&ticketId=1073&attachId=5519" \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)"
Query Params
int32
required
int32
required
int32
required
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json