Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsAttach Dispute Evidence
Search the full API reference Esc to close

Attach Dispute Evidence

Payments · REST API reference

Get support
POST/v1/disputes/{dispute_id}/evidence
Send one of the disputing tenant's documents to the processor as evidence. Needs dispute.write on the dispute and document.read on the document. 409 DISPUTE_RESOLVED, DISPUTE_RESPONSE_CLOSED (respond_by has passed), EVIDENCE_TYPE_NOT_ACCEPTED (not PDF, JPEG, PNG or TIFF), EVIDENCE_TOO_LARGE (10 MB or more) or EVIDENCE_ALREADY_ATTACHED, all before the processor is called; 404 for a document that is not the tenant's or is in another facility.

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request example

Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.

cURL
curl --request POST \
  --url 'https://api.staging.facily.ai/v1/disputes/<DISPUTE_ID>/evidence' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "document_id": "00000000-0000-4000-8000-000000000001",
  "name": "string"
}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

dispute_idpath · stringrequired

Format: uuid

Request body

application/json · Required

document_idstringrequired

A document in the dispute's facility: a PDF, JPEG, PNG or TIFF smaller than 10 MB.

Format: uuid

namestring | null

The name the processor shows. Defaults to the document's title.

Max length: 255

Show name schema
string | null

The name the processor shows. Defaults to the document's title.

Variant 1: string
string
Variant 2: null
null

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

201Successful Response
JSON · generated example
{
  "data": {
    "created_at": "2026-10-29T12:00:00Z",
    "dispute_id": "00000000-0000-4000-8000-000000000001",
    "file_size_bytes": 0,
    "id": "00000000-0000-4000-8000-000000000001",
    "mime_type": "string",
    "name": "string",
    "document_id": "00000000-0000-4000-8000-000000000001",
    "submitted_at": "2026-10-29T12:00:00Z"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataDisputeEvidenceResponserequired

One evidence file Facily sent to the processor for a dispute.

Show data schema
created_atstringrequired

When it was sent to the processor.

Format: date-time

dispute_idstringrequired

Format: uuid

document_idstring | null

The Facily document it was sent from. Null once that document is removed.

Format: uuid

Show document_id schema
string | null

The Facily document it was sent from. Null once that document is removed.

Variant 1: string
string
Variant 2: null
null
file_size_bytesintegerrequired
idstringrequired

Format: uuid

mime_typestringrequired
namestringrequired
submitted_atstring | null

When it was submitted for review. Submitted evidence cannot be removed.

Format: date-time

Show submitted_at schema
string | null

When it was submitted for review. Submitted evidence cannot be removed.

Variant 1: string
string
Variant 2: null
null
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll payments operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Attach Dispute Evidence | Facily Developers