Get comment from UW task

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

Get Comments by Ticket ID

Returns all comments associated with a specific underwriting task (UW ticket) for a merchant. Each comment includes the message text, the name of the person who posted it, and the timestamp. This provides a full audit trail of the communication thread between the ISO, the merchant, and the underwriting team for a given task.

Endpoint

GET /api/v1/uwTasks/ticket/getCommentsByTicketId

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 to read the communication history on a specific UW task ticket — for example, to display the comment thread in a merchant portal, or to programmatically check whether the underwriting team has left new instructions since the last visit. This is particularly useful after the UW team has changed a merchant's status to UnderwritingPending, as they often post comments explaining what documentation is needed.

Query Parameters

ParameterTypeRequiredDescription
idinteger (int32)YesMerchant profile ID that owns the UW task
ticketIdinteger (int32)YesID of the UW task ticket whose comments to retrieve

Response

200 OK

FieldTypeDescription
dataarrayList of comment objects in chronological order
data[].createdDatestring (date-time)ISO 8601 timestamp when the comment was posted
data[].createdBystringUsername or display name of the comment author
data[].textstringThe comment message content
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": [
    {
      "createdDate": "2026-05-15T10:05:00Z",
      "createdBy": "[email protected]",
      "text": "Please upload a clear copy of the principal owner's driver's license and the last 3 months of business bank statements."
    },
    {
      "createdDate": "2026-05-20T14:30:00Z",
      "createdBy": "[email protected]",
      "text": "Documents have been uploaded. Please review at your earliest convenience."
    }
  ],
  "status": "OK",
  "error": null,
  "warning": null,
  "validationResults": [],
  "requestId": 88712
}

Error Codes

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

Common Mistakes

  • Confusing the UW ticket comment thread with general merchant notes — these comments are scoped to a specific UW task ticket and are separate from other messaging systems.
  • Not polling this endpoint periodically — the UW team may add new instructions at any time, and there is no push notification unless you have subscribed via POST /api/v1/uwTasks/subscribe.

Related Endpoints

  • POST /api/v1/uwTasks/ticket/addComment — post a reply to the comment thread
  • GET /api/v1/uwTasks/getByMerchantId — list all UW task tickets for a merchant (to get valid ticketId values)
  • POST /api/v1/uwTasks/subscribe — subscribe to webhook notifications for UW task events

Example

curl -X GET "https://hq.staging.netevia.dev/api/v1/uwTasks/ticket/getCommentsByTicketId?id=48201&ticketId=1073" \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)"
Query Params
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