API · Manage · Documents
Create a document access grant.
Issues a permissioned access grant on a document, normally scoped to a DataRoom. The grantee can authenticate via a hosted StakeholderPortalSession and read the document according to the granted permissions. Every view and download produces an audit entry.
Last updated
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
data_room_idstringOptionalOptional. When set, the grant is scoped to a data room and inherits its expiry / watermark policy.
grantee_emailstring<email>Requiredgrantee_stakeholder_idstringOptionalpermissionsarray<string>Requiredexpires_atintegerOptionalUnix timestamp at which the grant auto-revokes.
metadataobjectOptionalFlat string-to-string map. Up to 50 keys. Keys: max 40 chars, charset
[A-Za-z0-9_\\-.]. Values: max 500 chars. Keys prefixed matter_ are reserved
for platform use. Metadata is retrievable but not filterable via query params.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
Request
curl -X POST "https://api.mattermode.com/v1/documents/{id}/access_grants" \ -H "Content-Type: application/json" \ -d '{ "data_room_id": "string", "grantee_email": "jane@example.com", "grantee_stakeholder_id": "string", "permissions": [ "view" ], "expires_at": 1745539200, "metadata": {} }'const body = JSON.stringify({ "data_room_id": "string", "grantee_email": "jane@example.com", "grantee_stakeholder_id": "string", "permissions": [ "view" ], "expires_at": 1745539200, "metadata": {}})fetch("https://api.mattermode.com/v1/documents/{id}/access_grants", { method: "POST", headers: { "Content-Type": "application/json" }, body})package mainimport ( "fmt" "net/http" "io/ioutil" "strings")func main() { url := "https://api.mattermode.com/v1/documents/{id}/access_grants" body := strings.NewReader(`{ "data_room_id": "string", "grantee_email": "jane@example.com", "grantee_stakeholder_id": "string", "permissions": [ "view" ], "expires_at": 1745539200, "metadata": {} }`) req, _ := http.NewRequest("POST", url, body) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body))}import requestsheaders = { "Authorization": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc", "Matter-Version": "2026-06-10", "Idempotency-Key": "ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b",}payload = { "data_room_id": "string", "grantee_email": "jane@example.com", "grantee_stakeholder_id": "string", "permissions": [ "view" ], "expires_at": 1745539200, "metadata": {}}resp = requests.post( "https://api.mattermode.com/v1/documents/doc_Z3hRk7Yc/access_grants", headers=headers, json=payload,)resp.raise_for_status()print(resp.json())import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.net.http.HttpResponse.BodyHandlers;import java.time.Duration;import java.net.http.HttpRequest.BodyPublishers;var body = BodyPublishers.ofString("""{ "data_room_id": "string", "grantee_email": "jane@example.com", "grantee_stakeholder_id": "string", "permissions": [ "view" ], "expires_at": 1745539200, "metadata": {}}""");HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .build();HttpRequest.Builder requestBuilder = HttpRequest.newBuilder() .uri(URI.create("https://api.mattermode.com/v1/documents/{id}/access_grants")) .header("Content-Type", "application/json") .POST(body) .build();try { HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString()); System.out.println("Status code: " + response.statusCode()); System.out.println("Response body: " + response.body());} catch (Exception e) { e.printStackTrace();}using System;using System.Net.Http;using System.Text;var body = new StringContent("""{ "data_room_id": "string", "grantee_email": "jane@example.com", "grantee_stakeholder_id": "string", "permissions": [ "view" ], "expires_at": 1745539200, "metadata": {}}""", Encoding.UTF8, "application/json");var client = new HttpClient();var response = await client.PostAsync("https://api.mattermode.com/v1/documents/{id}/access_grants", body);var responseBody = await response.Content.ReadAsStringAsync();curl --request POST 'https://api.mattermode.com/v1/documents/doc_Z3hRk7Yc/access_grants' \ --header 'Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc' \ --header 'Matter-Version: 2026-06-10' \ --header 'Idempotency-Key: ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b' \ --header 'Content-Type: application/json' \ --data '{ "data_room_id": "string", "grantee_email": "jane@example.com", "grantee_stakeholder_id": "string", "permissions": [ "view" ], "expires_at": 1745539200, "metadata": {}}'const response = await fetch("https://api.mattermode.com/v1/documents/doc_Z3hRk7Yc/access_grants", { method: "POST", headers: { "Authorization": "Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc", "Matter-Version": "2026-06-10", "Idempotency-Key": "ee7c3a9b-3f1a-4d8e-9b2a-7c5e1f0a2d4b", "Content-Type": "application/json", }, body: JSON.stringify({ "data_room_id": "string", "grantee_email": "jane@example.com", "grantee_stakeholder_id": "string", "permissions": [ "view" ], "expires_at": 1745539200, "metadata": {} }),});if (!response.ok) { throw new Error(`Matter API ${response.status}: ${await response.text()}`);}const data = await response.json();console.log(data);Response
application/json{
"id": "string",
"object": "document_access_grant",
"document_id": "doc_PwQ7MmLk",
"data_room_id": "string",
"grantee_email": "jane@example.com",
"grantee_stakeholder_id": "string",
"permissions": [
"view"
],
"status": "active",
"expires_at": 1745539200,
"last_accessed_at": 0,
"access_count": 0,
"metadata": {},
"created": 1745539200,
"updated": 1745539200,
"livemode": false
}{
"type": "https://mattermode.com/docs/errors/invalid_request",
"title": "Invalid request",
"status": 400,
"code": "invalid_request",
"detail": "Request body could not be parsed as JSON.",
"doc_url": "https://mattermode.com/docs/guides/errors#invalid_request",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/authentication_required",
"title": "Authentication required",
"status": 401,
"code": "authentication_required",
"detail": "No bearer token was supplied. Pass `Authorization: Bearer sk_live_...` on every request.",
"doc_url": "https://mattermode.com/docs/guides/errors#authentication_required",
"request_id": "req_Qw9xYz8A"
}{
"type": "https://mattermode.com/docs/errors/not_found",
"title": "Not found",
"status": 404,
"code": "not_found",
"detail": "No entity with id `ent_Nq3KcAbc` is visible to this token.",
"doc_url": "https://mattermode.com/docs/guides/errors#not_found",
"request_id": "req_Qw9xYz8A"
}