---
title: "Get document"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sureshake.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sureshake API › reports

`GET /v2/reports/{id}/document`

## Path parameters

- `id` (`report-get-document.path.id`; string, required)
  - format `uuid`

## Query parameters

- `intent` (`report-get-document.query.intent`; string, optional)
  - one of `"download"`

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sureshake.com/v2/reports/<id>/document'
```

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/reports/<id>/document';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sureshake.com/v2/reports/<id>/document"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": {
    "type": "string",
    "content": null,
    "metadata": null,
    "view_delivery": {
      "status": "ready",
      "receiptId": "4937ce52-e283-4321-b00f-c29b6dd5d0e9",
      "source": "share",
      "expiresAt": "2019-08-24T14:15:22Z",
      "policyVersion": "report-view-delivery-v2"
    }
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`report-get-document.response.200.data`; object, required)
  - `type` (`report-get-document.response.200.data.type`; string, required)
  - `content` (`report-get-document.response.200.data.content`; unknown, optional)
  - `metadata` (`report-get-document.response.200.data.metadata`; unknown, optional)
  - `view_delivery` (`report-get-document.response.200.data.view_delivery`; any of, optional)
    - any of:
      - `object`
        - `status` (`report-get-document.response.200.data.view_delivery.1.status`; string, required)
          - one of `"ready"`
        - `receiptId` (`report-get-document.response.200.data.view_delivery.1.receiptId`; string, required)
          - format `uuid`
        - `source` (`report-get-document.response.200.data.view_delivery.1.source`; string, required)
          - one of `"share"`, `"vault"`, `"direct"`, `"api"`
        - `expiresAt` (`report-get-document.response.200.data.view_delivery.1.expiresAt`; string, required)
          - format `date-time`
        - `policyVersion` (`report-get-document.response.200.data.view_delivery.1.policyVersion`; string, required)
          - one of `"report-view-delivery-v2"`
      - `object`
        - `status` (`report-get-document.response.200.data.view_delivery.2.status`; string, required)
          - one of `"policyExcluded"`
        - `reason` (`report-get-document.response.200.data.view_delivery.2.reason`; string, required)
          - one of `"owner_self"`, `"blocked"`, `"non_external_traffic"`
        - `policyVersion` (`report-get-document.response.200.data.view_delivery.2.policyVersion`; string, required)
          - one of `"report-view-delivery-v2"`
      - `object`
        - `status` (`report-get-document.response.200.data.view_delivery.3.status`; string, required)
          - one of `"unavailable"`
        - `reason` (`report-get-document.response.200.data.view_delivery.3.reason`; string, required)
          - one of `"viewer_policy_unavailable"`, `"lineage_unavailable"`, `"tracking_unavailable"`
        - `policyVersion` (`report-get-document.response.200.data.view_delivery.3.policyVersion`; string, required)
          - one of `"report-view-delivery-v2"`
- `meta` (`report-get-document.response.200.meta`; object, optional)
  - `timestamp` (`report-get-document.response.200.meta.timestamp`; string, required)
    - format `date-time`

### 400

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`report-get-document.response.400.error`; object, required)
  - `code` (`report-get-document.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`report-get-document.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`report-get-document.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`report-get-document.response.400.error.traceId`; string, optional) — Unique ID for log correlation

### 401

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`report-get-document.response.401.error`; object, required)
  - `code` (`report-get-document.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`report-get-document.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`report-get-document.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`report-get-document.response.401.error.traceId`; string, optional) — Unique ID for log correlation

### 403

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`report-get-document.response.403.error`; object, required)
  - `code` (`report-get-document.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`report-get-document.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`report-get-document.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`report-get-document.response.403.error.traceId`; string, optional) — Unique ID for log correlation

### 404

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`report-get-document.response.404.error`; object, required)
  - `code` (`report-get-document.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`report-get-document.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`report-get-document.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`report-get-document.response.404.error.traceId`; string, optional) — Unique ID for log correlation

### 410

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`report-get-document.response.410.error`; object, required)
  - `code` (`report-get-document.response.410.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`report-get-document.response.410.error.message`; string, required) — Human-readable error message
  - `details` (`report-get-document.response.410.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`report-get-document.response.410.error.traceId`; string, optional) — Unique ID for log correlation

### 500

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`report-get-document.response.500.error`; object, required)
  - `code` (`report-get-document.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`report-get-document.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`report-get-document.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`report-get-document.response.500.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/report-get-document/index.md