Delete Dispute Document

DELETEhttps://api.omise.co/disputes/:id/documents/:document_id

Delete a document from a dispute. This action removes an evidence file that was previously uploaded. Documents can only be deleted while the dispute is still open.

---

Request Parameters

Required - 2 fieldsRequired Parameters

▼

`id`STRING(required)

Dispute ID (path parameter). The dispute must have status "open" to allow document deletion.

Example:"dspt_test_5xuy4w91xqz7d1w9u0t"

`document_id`STRING(required)

Document ID to delete (path parameter). Format: docu_test_ or docu_live_ followed by alphanumeric string.

Example:"docu_test_5xuy4w91xqz7d1w9u0t"

---

Responses

200

Document deleted

Document deleted successfully. Returns the deleted document object with deleted set to true.

Response includes:

• object - Always "document"
• id - Document ID (docu_*)
• deleted - Set to true indicating successful deletion
• livemode - Whether this was a live mode document

After deletion:

• Document is permanently removed from the dispute
• Download URL will no longer work
• Action cannot be undone - you must re-upload if needed

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Invalid dispute ID format
• Invalid document ID format

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

404

Not found

Dispute or document not found.

Common causes:

• Incorrect dispute ID
• Incorrect document ID
• Document does not belong to this dispute
• Document was already deleted
• Dispute or document belongs to different account

422

Unprocessable entity

Document cannot be deleted.

Common causes:

• Dispute status is not "open" (already pending, won, or lost)
• Dispute is closed - documents cannot be modified
• Document has already been submitted to the bank for review

5xx

Server error

Server-side error occurred. These are rare but should be handled gracefully.

How to handle:

• Retry the request with exponential backoff
• Check status.omise.co for service incidents
• See Error Handling for detailed guidance

---

Code samples

cURL

curl https://api.omise.co/disputes/dspt_test_5xuy4w91xqz7d1w9u0t/documents/docu_test_5xuy4w91xqz7d1w9u0t \
  -X DELETE \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

document = Omise::Dispute.delete_document(
  'dspt_test_5xuy4w91xqz7d1w9u0t',
  'docu_test_5xuy4w91xqz7d1w9u0t'
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

document = omise.Dispute.delete_document(
    'dspt_test_5xuy4w91xqz7d1w9u0t',
    'docu_test_5xuy4w91xqz7d1w9u0t'
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const document = await omise.disputes.deleteDocument(
  'dspt_test_5xuy4w91xqz7d1w9u0t',
  'docu_test_5xuy4w91xqz7d1w9u0t'
);

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$document = OmiseDispute::deleteDocument(
    'dspt_test_5xuy4w91xqz7d1w9u0t',
    'docu_test_5xuy4w91xqz7d1w9u0t'
);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Document document = client.disputes().deleteDocument(
    "dspt_test_5xuy4w91xqz7d1w9u0t",
    "docu_test_5xuy4w91xqz7d1w9u0t"
);

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var document = await client.Disputes.DeleteDocument(
    "dspt_test_5xuy4w91xqz7d1w9u0t",
    "docu_test_5xuy4w91xqz7d1w9u0t"
);

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

document, _ := client.DeleteDisputeDocument(
    "dspt_test_5xuy4w91xqz7d1w9u0t",
    "docu_test_5xuy4w91xqz7d1w9u0t",
)

---

Error and result codes

Common Error Codes

Code	Description	Resolution
authentication_failure	Invalid API key	Verify your secret key is correct
not_found	Dispute or document not found	Check both dispute ID and document ID are correct
dispute_not_open	Dispute is not open	Documents can only be deleted from open disputes
document_already_submitted	Document already sent to bank	Cannot delete documents already in review

When to Delete Documents

Consider deleting a document when:

• File was uploaded in error (wrong document)
• File contains incorrect or outdated information
• Duplicate document was uploaded
• Replacing with a better quality version (delete first, then re-upload)

Important Notes

Note	Description
Timing	Documents can only be deleted while dispute is "open"
Permanence	Deletion is permanent and cannot be undone
Re-upload	To replace a document, delete it first then upload the new version
Pending disputes	Once dispute is pending, documents cannot be modified

---

🔑API Credentials

▼

Try it out

Required - 2 fields

▼

id(Required)

document_id(Required)

Your IP: ...Loading...