Get list of UW tasks of the merchant

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

Get List of UW Tasks of the Merchant

Returns a list of all underwriting task tickets (UW tasks) associated with a specific merchant. Each UW task represents a discrete action or document requirement that must be completed as part of the merchant's underwriting review. The response includes task titles, descriptions, due dates, statuses, and whether an updated merchant agreement signature is required.

Endpoint

GET /api/v1/uwTasks/getByMerchantId

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 at the start of any UW task workflow to discover which tickets exist for a merchant. The ticketId values returned here are required by all other UW task ticket endpoints (addAttachment, addComment, getCommentsByTicketId, getAttachmentsByTicketId, setStatusInReview). This is the natural entry point when an ISO is checking what outstanding tasks need to be addressed for a merchant in UnderwritingPending status.

Query Parameters

ParameterTypeRequiredDescription
idinteger (int32)YesMerchant profile ID whose UW tasks to retrieve

Response

200 OK

FieldTypeDescription
dataarrayList of UW task objects
data[].ticketIdintegerUnique ID of the UW task ticket
data[].titlestringShort title of the task
data[].descriptionstringDetailed description of what is required
data[].dueDatestring (date-time)ISO 8601 deadline for task completion
data[].createdDatestring (date-time)ISO 8601 timestamp when the task was created
data[].statusstringCurrent task status (e.g., "Open", "InReview", "Completed")
data[].updatedMerchantAgreementSignatureRequiredbooleanWhether an updated MPA signature is required to close this task
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": [
    {
      "ticketId": 1073,
      "title": "Upload Driver's License",
      "description": "Please provide a clear copy of the principal owner's government-issued photo ID.",
      "dueDate": "2026-06-05T23:59:00Z",
      "createdDate": "2026-05-15T10:00:00Z",
      "status": "Open",
      "updatedMerchantAgreementSignatureRequired": false
    },
    {
      "ticketId": 1074,
      "title": "Submit 3 Months Bank Statements",
      "description": "Provide business bank statements for April, May, and June 2026.",
      "dueDate": "2026-06-05T23:59:00Z",
      "createdDate": "2026-05-15T10:00:00Z",
      "status": "InReview",
      "updatedMerchantAgreementSignatureRequired": false
    }
  ],
  "status": "OK",
  "error": null,
  "warning": null,
  "validationResults": [],
  "requestId": 88650
}

Error Codes

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

Common Mistakes

  • Using the wrong ID type — the id parameter is the merchant profile ID, not the merchant's external MID or DBA name.
  • Expecting this endpoint to return general support tickets — UW tasks are a separate system used exclusively for underwriting workflow.
  • Not checking updatedMerchantAgreementSignatureRequired; tasks that require a new MPA signature need additional steps beyond document upload.

Related Endpoints

  • POST /api/v1/uwTasks/ticket/addAttachment — upload a document to a specific ticket
  • POST /api/v1/uwTasks/ticket/addComment — post a comment to a ticket
  • POST /api/v1/uwTasks/setStatusInReview — mark a ticket as ready for UW team review

Example

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