Add an Attachment to UW Task Ticket

Uploads a file attachment to a specific underwriting task (UW ticket) associated with a merchant. The file content must be Base64-encoded. Attachments are used to provide supporting documentation — such as driver's licenses, bank statements, or tax returns — that the underwriting team needs to complete their review of a merchant application.

Endpoint

POST /api/v1/uwTasks/ticket/addAttachment

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 the UW team has indicated that additional documentation is required for a merchant's underwriting ticket. After the ISO identifies which documents are needed (via GET /api/v1/merchant/underwritingNotes), this endpoint allows uploading each file directly to the relevant UW task ticket. Call POST /api/v1/uwTasks/setStatusInReview afterward to notify the UW team that new documents are ready.

Request Body

Allowed attachmentType values: CForm501, ACHInformation, AdditionalDocuments, BusinessBankStatements, CancellationLetter, CorporateTaxReturns, CreditReport, DigitalSignatureChange, FinancialStatements, MarketingMaterials, MerchantApplication, Miscellaneous, PCICertificates, PimsDocuments, ProcessingStatements, RiskDocuments, SiteInspectionValidation, VoidCheck, WebSnapshot, Whois, Other, UnderwritingMerchantInformation, CCAuthorizationForm, Invoice, CloverAddendum, CloverGoAddendum, DriversLicense, PosPurchaseForm, ConfirmMpa, PlacementAgreement, CreditProfile, Checklist, PersonalTaxReturns, AddendumForm, ReserveForm, CMSForm, BusinessLicense, PersonalBankStatements, AutomatedGiact, AutomatedMATCH, AutomatedGoogleSearch, AutomatedClear, AutomatedWhois, AutomatedOfac, BankAccountProof, ApplicationSignCertificate

{
  "id": 48201,
  "ticketId": 1073,
  "attachmentType": "DriversLicense",
  "fileName": "john_smith_dl.pdf",
  "data": "JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9...",
  "comment": "Driver's license for principal owner John Smith"
}

Response

200 OK

{
  "status": "OK",
  "error": null,
  "warning": null,
  "validationResults": [],
  "requestId": 88421
}

Error Codes

Common Mistakes

• Forgetting to Base64-encode the file content before placing it in the data field — raw binary will cause a 400 error.
• Using a free-text document type string instead of one of the exact enum values for attachmentType.
• Sending a very large file without checking size limits; extremely large payloads may result in a 413 (RequestEntityTooLarge) from the gateway.
• Not calling POST /api/v1/uwTasks/setStatusInReview after uploading — the UW team will not be notified unless that follow-up call is made.

Related Endpoints

• GET /api/v1/uwTasks/ticket/getAttachmentsByTicketId — list all attachments on a ticket
• GET /api/v1/uwTasks/ticket/getAttachmentById — retrieve a specific attachment by its ID
• POST /api/v1/uwTasks/setStatusInReview — signal to UW team that documents are ready for review

Example

curl -X POST https://hq.staging.netevia.dev/api/v1/uwTasks/ticket/addAttachment \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 48201,
    "ticketId": 1073,
    "attachmentType": "DriversLicense",
    "fileName": "john_smith_dl.pdf",
    "data": "JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9...",
    "comment": "Driver'\''s license for principal owner John Smith"
  }'