SIsilverflow
Documents

Get Document Metadata

This operations returns the Document metadata identified by the specified key.

Requires disputes:GetDocument or documents:Get permissions.

get/documents/{documentKey}

Request

Path parameters

documentKeystring required

Uniquely identifies a document

Example:dok-1UF2NafdfrdPMf2XrS2

Uniquely identifies a Document.

Response

A Document metadata object.

keystring required

Uniquely identifies a document

agentKeystring required

Uniquely identifies an Agent

merchantKeystring

Uniquely identifies a Merchant

disputeKeystring

Uniquely identifies a Dispute.

disputeStage'rapidDisputeResolution' | 'collaboration' | 'requestForInformation' | 'requestForInformationResponse' | 'collaborationResponse' | 'chargeback' | 'chargebackResponse' | 'preArbitration' | 'preArbitrationResponse' | 'arbitration'

The current stage of a Dispute

originalFilenamestring required

Name of the file. Allows letters, numbers, whitespaces and characters _()

filenamestring
contentLengthnumber
contentType'image/jpeg' | 'application/pdf' | 'image/tiff'

Accepted Content-Types

owner'issuer' | 'acquirer' | 'merchant' | 'card-network' required

The owner of a Dispute Document

descriptionstring
status'pending' | 'active' | 'archived' required

The current status of the document.

createdstring date-time required

The date and time this object was created

lastModifiedstring date-time

The date and time this object was last modified

versioninteger required

The version of this object

Example response

{
  "key": "dok-1UF2NafdfrdPMf2XrS2",
  "agentKey": "cgt-1UF2NafdfrdPMf2XrS2",
  "merchantKey": "mct-123dinkqFqfq3q2f2adfa",
  "disputeKey": "dsp-1JRadf2ffdfrdPMf2XrS2",
  "version": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.