---
title: "Get Document Metadata"
method: GET
path: "/documents/{documentKey}"
tags: ["Documents"]
---

# Get Document Metadata

`GET /documents/{documentKey}`

## Request

- Base URL: `https://eu-west-1.api.silverflow.com/v1`
- URL: `https://eu-west-1.api.silverflow.com/v1/documents/{documentKey}`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
- TypeScript: <https://skmtc.dev/silverflow/apis/silverflow-api/docs/documents/:documentKey/get.ts> (a function with typed inputs; its response is checked against the schema)

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

Requires `disputes:GetDocument` or `documents:Get` permissions.

## Path parameters

- `documentKey` string, required: Uniquely identifies a document

## Response `200`

A Document metadata object.

- Document: A Document
  - `key` string, required: Uniquely identifies a document
  - `agentKey` string, required: Uniquely identifies an Agent
  - `merchantKey` string: Uniquely identifies a Merchant
  - `disputeKey` string: Uniquely identifies a Dispute.
  - `disputeStage` 'rapidDisputeResolution' | 'collaboration' | 'requestForInformation' | 'requestForInformationResponse' | 'collaborationResponse' | 'chargeback' | 'chargebackResponse' | 'preArbitration' | 'preArbitrationResponse' | 'arbitration': The current stage of a Dispute
  - `originalFilename` string, required: Name of the file. Allows letters, numbers, whitespaces and characters _()
  - `filename` string
  - `contentLength` number
  - `contentType` 'image/jpeg' | 'application/pdf' | 'image/tiff': Accepted Content-Types
  - `owner` 'issuer' | 'acquirer' | 'merchant' | 'card-network', required: The owner of a Dispute Document
  - `description` string
  - `status` 'pending' | 'active' | 'archived', required: The current status of the document.
  - `created` string, date-time, required: The date and time this object was created
  - `lastModified` string, date-time: The date and time this object was last modified
  - `version` integer, required: The version of this object

## Other responses

- `401`: Authentication information is missing or invalid
- `403`: The authenticated client is forbidden to make the request for the resource identified.
- `404`: The requested resource was not found
- `429`: The number of requests (per minute) has exceeded the configured maximum

---

[API](https://skmtc.dev/silverflow/apis/silverflow-api.md) - [All operations](https://skmtc.dev/silverflow/apis/silverflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/silverflow/apis/silverflow-api/revisions/43ecbe4fd6ea?raw)