---
title: "Grant document access"
method: POST
path: "/v1beta/documents/{document_id}/share"
tags: ["Sharings"]
---

# Grant document access

`POST /v1beta/documents/{document_id}/share`

Grant access to one or more recipients.

## Path parameters

- `document_id` string, required — Document ID.

## Request body

- object — GrantDocumentAccessRequest grants access to one or more recipients.
  - `custom_message` string, nullable — Custom message to include in the notification email.
  - `recipients` RecipientGrant[] — Recipients to grant access to (1-50).
    - `recipient` string — Recipient email address or TypeID (user_xxx, bot_xxx).
    - `role` 'viewer' | 'commenter' | 'collaborator' | 'admin' | 'owner', required
  - `should_send_notification` boolean, nullable — Whether to send email notifications.

## Response `200`

Success

- GrantDocumentAccessResponse — GrantDocumentAccessResponse contains the results of granting access.
  - `document_id` string — Document ID.
  - `failed` integer — Number of failed grants.
  - `results` AccessGrantResult[] — Results for each recipient.
    - `error` string — Error message if the grant failed.
    - `recipient` string — The recipient that was granted access.
    - `success` boolean — Whether the grant succeeded.
  - `successful` integer — Number of successful grants.
  - `total` integer — Total number of recipients processed.

## Other responses

- `400` — Invalid request parameters
- `401` — Authentication failed - missing or invalid API key
- `403` — Authorization failed - valid key but insufficient permissions
- `404` — Resource not found
- `429` — Too many requests
- `500` — Internal server error

---

[API](https://skmtc.net/factify-inc/apis/factify-api.md) · [All operations](https://skmtc.net/factify-inc/apis/factify-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/factify-inc/factify-api/revisions/8baabdfb82bf/schema)