Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Use cases API Changelog
  1. API reference
  2. Latest (beta)
  3. Money movement
  4. Disputes

Upload evidence file

Uploads a file as evidence for a dispute.

Read our disputes guide to learn more.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/transfers.write scope.

POST
/accounts/{accountID}/disputes/{disputeID}/evidence-file
cURL Go .NET Java Ruby TypeScript PHP Python 
curl -X POST "https://api.moov.io/accounts/{accountID}/disputes/{disputeID}/evidence-file" \
  -H "Authorization: Bearer {token}" \
  -H "x-moov-version: v2024.01.00" \
  --form \
  -F "file=@/path/to/your/file.txt" \
  -F "evidenceType=proof-of-delivery"

mc, _ := moov.NewClient()

var accountID string
var disputeID string
file, _ := os.Open("path/to/test.pdf")

mc.UploadEvidenceFile(ctx, accountID, disputeID, moov.EvidenceType_CoverLetter, "test.pdf", file, "application/pdf")

using Moov.Sdk;
using Moov.Sdk.Models.Components;

var sdk = new MoovClient(xMoovVersion: "<value>");

var res = await sdk.Disputes.UploadEvidenceFileAsync(
    accountID: "c09fd2f8-75fb-4ed9-be03-f8565d3ddc67",
    disputeID: "ad27f84d-00b1-4db0-8cf5-be001d71251d",
    body: new CreateEvidenceFileMultiPart() {
        File = new CreateEvidenceFileMultiPartFile() {
            FileName = "example.file",
            Content = System.IO.File.ReadAllBytes("example.file"),
        },
        EvidenceType = EvidenceType.CancelationPolicy,
    }
);

// handle response
package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.*;
import io.moov.sdk.models.errors.FileUploadValidationError;
import io.moov.sdk.models.errors.GenericError;
import io.moov.sdk.models.operations.UploadDisputeEvidenceFileResponse;
import io.moov.sdk.utils.Utils;
import java.io.FileInputStream;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws GenericError, FileUploadValidationError, Exception {

        Moov sdk = Moov.builder()
                .xMoovVersion("v2024.01.00")
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        UploadDisputeEvidenceFileResponse res = sdk.disputes().uploadEvidenceFile()
                .accountID("fbed9e03-f856-45d3-8ddc-67dad27f84d0")
                .disputeID("b1db0cf5-be00-41d7-a125-1d2d283c2a62")
                .createEvidenceFileMultiPart(CreateEvidenceFileMultiPart.builder()
                    .file(File.builder()
                        .fileName("example.file")
                        .content(Utils.readBytesAndClose(new FileInputStream("example.file")))
                        .build())
                    .evidenceType(EvidenceType.CANCELATION_POLICY)
                    .build())
                .call();

    }
}
require 'moov_ruby'

Models = ::Moov::Models
s = ::Moov::Client.new(
      x_moov_version: 'v2024.01.00',
    )

res = s.disputes.upload_evidence_file(account_id: 'c09fd2f8-75fb-4ed9-be03-f8565d3ddc67', dispute_id: 'ad27f84d-00b1-4db0-8cf5-be001d71251d', create_evidence_file_multi_part: Models::Components::CreateEvidenceFileMultiPart.new(
  file: Models::Components::CreateEvidenceFileMultiPartFile.new(
    file_name: 'example.file',
    content: File.binread("example.file"),
  ),
  evidence_type: Models::Components::EvidenceType::CANCELATION_POLICY,
))

unless res.evidence_upload_response.nil?
  # handle response
end
import { Moov } from "@moovio/sdk";
import { openAsBlob } from "node:fs";

const moov = new Moov({
  xMoovVersion: "v2024.01.00",
  security: {
    username: "",
    password: "",
  },
});

async function run() {
  const result = await moov.disputes.uploadEvidenceFile({
    accountID: "c09fd2f8-75fb-4ed9-be03-f8565d3ddc67",
    disputeID: "ad27f84d-00b1-4db0-8cf5-be001d71251d",
    createEvidenceFileMultiPart: {
      file: await openAsBlob("example.file"),
      evidenceType: "cancelation-policy",
    },
  });

  console.log(result);
}

run();
declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setXMoovVersion('v2024.01.00')
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$createEvidenceFileMultiPart = new Components\CreateEvidenceFileMultiPart(
    file: new Components\File(
        fileName: 'example.file',
        content: file_get_contents('example.file');,
    ),
    evidenceType: Components\EvidenceType::CancelationPolicy,
);

$response = $sdk->disputes->uploadEvidenceFile(
    accountID: 'fbed9e03-f856-45d3-8ddc-67dad27f84d0',
    disputeID: 'b1db0cf5-be00-41d7-a125-1d2d283c2a62',
    createEvidenceFileMultiPart: $createEvidenceFileMultiPart

);

if ($response->evidenceUploadResponse !== null) {
    // handle response
}
from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    x_moov_version="v2024.01.00",
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.disputes.upload_evidence_file(account_id="c09fd2f8-75fb-4ed9-be03-f8565d3ddc67", dispute_id="ad27f84d-00b1-4db0-8cf5-be001d71251d", file={
        "file_name": "example.file",
        "content": open("example.file", "rb"),
    }, evidence_type=components.EvidenceType.CANCELATION_POLICY)

    # Handle response
    print(res)
201 400 401 403 404 409 422 429 500 504
The resource was successfully created.
application/json
Example
Details of a successfully uploaded evidence file.
{
  "evidenceID": "string",
  "disputeID": "string",
  "filename": "string",
  "mimeType": "string",
  "size": 0,
  "evidenceType": "receipt",
  "createdOn": "2019-08-24T14:15:22Z"
}

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The server could not understand the request due to invalid syntax.
application/json
Example
{
  "error": "string"
}

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The request contained missing or expired authentication.

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The user is not authorized to make the request.

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The requested resource was not found.

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The request conflicted with the current state of the target resource.
application/json
Example
{
  "error": "string"
}

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The request was well-formed, but the contents failed validation. Check the request for missing or invalid fields.
application/json
Example
{
  "evidenceType": "string",
  "file": {
    "filename": "string",
    "mimeType": "string"
  }
}

Response headers

x-request-id

string required
A unique identifier used to trace requests.
Request was refused due to rate limiting.

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

Response headers

x-request-id

string required
A unique identifier used to trace requests.

Headers

X-Moov-Version

string

Specify an API version.

API versioning follows the format vYYYY.QQ.BB, where

  • YYYY is the year
  • QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
  • BB is the build number, starting at .01, for subsequent builds in the same quarter.
    • For example, v2024.01.00 is the initial release of the first quarter of 2024.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release. When no version is specified, the API defaults to v2024.01.00.

Path parameters

accountID

string required

disputeID

string required

Body

multipart/form-data

evidenceType

string<enum> required
Possible values: receipt, proof-of-delivery, cancelation-policy, terms-of-service, customer-communication, generic-evidence, cover-letter, other

file

string<binary> required

The file to upload as evidence. Valid types are [jpeg, tiff, pdf] with a limit of 4MB per file.

The `Content-Type` header for this form part must be one of the following:
  • image/jpeg
  • image/tiff
  • application/pdf

Response

application/json
Details of a successfully uploaded evidence file.

createdOn

string<date-time> required
The date and time the evidence was uploaded.

disputeID

string required
The ID of the dispute the evidence is associated with.

evidenceID

string required
The ID of the evidence.

evidenceType

string<enum> required
Possible values: receipt, proof-of-delivery, cancelation-policy, terms-of-service, customer-communication, generic-evidence, cover-letter, other

filename

string required
The name of the evidence file.

mimeType

string required
The MIME type of the evidence file.

size

integer<int64> required
The size of the evidence file.