Retrieve pending notes for the merchant application

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

Retrieve Underwriting Notes

Fetches a list of pending underwriting notes for a specific merchant application. Each note includes the note text, the author who created it, and the timestamp. Use this endpoint during the underwriting workflow to review unresolved comments before advancing the application to the next status.

Endpoint

GET /api/v1/merchant/underwritingNotes

Authentication

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

Authorization: Basic {base64(username:password)}

When to use

Call this endpoint after a merchant application enters underwriting (status "UW Level 1") to check whether the underwriter has left notes that require action before the application can be advanced. It is also useful for auditing purposes to confirm all notes have been addressed before calling underwritingReview.

Query Parameters

ParameterTypeRequiredDescription
idinteger (int32)YesThe merchant profile ID for which to retrieve underwriting notes.

Response

200 OK

FieldTypeDescription
dataarrayArray of Note objects representing pending underwriting notes.
data[].textstringThe content of the underwriting note.
data[].authorstringUsername or name of the person who wrote the note.
data[].datestring (date-time)ISO 8601 timestamp when the note was created.
statusstringHTTP status name (e.g., "OK").
errorstringError message if the request failed; otherwise null.
warningstringNon-fatal warning message, if any.
validationResultsarrayValidation errors, if any.
requestIdintegerInternal request tracking ID.
{
  "data": [
    {
      "text": "Missing voided check — please upload bank account proof before approval.",
      "author": "j.underwriter",
      "date": "2026-05-10T14:32:00Z"
    },
    {
      "text": "Federal Tax ID format appears invalid. Confirm EIN with merchant.",
      "author": "j.underwriter",
      "date": "2026-05-11T09:15:00Z"
    }
  ],
  "status": "OK",
  "error": null,
  "warning": null,
  "validationResults": [],
  "requestId": 84712
}

Error Codes

CodeWhen it happens
400The id query parameter is missing or not a valid integer.
401Invalid or missing Basic Auth credentials.
403User does not have permission for this operation.
404No merchant application found with the given ID.
500Internal server error.

Common Mistakes

  • Omitting the id query parameter entirely results in a 400 error.
  • Passing a merchant ID that belongs to a different ISO than the authenticated user returns 403.
  • Expecting notes to be returned when none exist — an empty data array is a valid 200 response indicating no pending notes.

Related Endpoints

  • POST /api/v1/merchant/attachment — Upload supporting documents to address note requests.
  • POST /api/v1/merchant/underwritingReview — Advance the application from "Pending" to "Pending Review" after notes are resolved.
  • POST /api/v1/merchant/underwritingPending — Set the merchant status back to "UW Level 1: Pending".

Example

curl -X GET "https://hq.staging.netevia.dev/api/v1/merchant/underwritingNotes?id=10482" \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)" \
  -H "Content-Type: application/json"
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