• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Create dispute evidence file

POST /v2/disputes/{dispute_id}/evidence-files

Uploads a file to use as evidence in a dispute challenge.

The endpoint accepts HTTP multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF formats.

Permissions
DISPUTES_WRITE
Guide
Challenge a dispute Try in API Explorer

Path Parameters

Example code
Name Description
dispute_id
string
Required

The ID of the dispute for which you want to upload evidence.

Request Body
Name Description
idempotency_key
string
Required

A unique key identifying the request. For more information, see Idempotency.

Min Length 1 Max Length 45
evidence_type
string

The type of evidence you are uploading.
content_type
string

The MIME type of the uploaded file. The type can be image/heic, image/heif, image/jpeg, application/pdf, image/png, or image/tiff.

Min Length 1 Max Length 40

Response Fields
Name Description
errors
Error [ ]

Any errors that occurred during the request.
evidence
DisputeEvidence

The metadata of the newly uploaded dispute evidence.

Examples

You are viewing an old version of the API
POST /v2/disputes/{dispute_id}/evidence-files
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js 
curl https://connect.squareup.com/v2/disputes/bVTprrwk0gygTLZ96VX1oB/evidence-files \
  -X POST \
  -H 'Square-Version: 2022-11-16' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Accept: application/json' \
  -F 'file=@/local/path/to/file.jpg' \
  -F 'request={}'
Response JSON 
{
  "evidence": {
    "dispute_id": "bVTprrwk0gygTLZ96VX1oB",
    "evidence_file": {
      "filename": "customer-interaction.jpg",
      "filetype": "image/jpeg"
    },
    "uploaded_at": "2022-05-18T16:01:10.000Z",
    "id": "TOomLInj6iWmP3N8qfCXrB"
  }
}