Skip to main content
POST
/
v1beta
/
documents
/
{document_id}
/
access-requests
TypeScript
import { Factify } from "@factify/sdk";

const factify = new Factify({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await factify.accessRequests.createAccessRequest({
    documentId: "<id>",
    body: {
      permission: "view",
    },
  });

  console.log(result);
}

run();
{
  "access_request": {
    "created_at": "2023-11-07T05:31:56Z",
    "document_id": "doc_01h2xcejqtf2nbrexx3vqjhp41",
    "id": "acr_01h2xcejqtf2nbrexx3vqjhp41",
    "permission": "view",
    "request_status": "pending",
    "subject": {
      "id": "user_01h2xcejqtf2nbrexx3vqjhp41",
      "name": "<string>",
      "type": "user"
    },
    "updated_at": "2023-11-07T05:31:56Z",
    "message": "<string>",
    "subject_email": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer , where is your auth token.

Path Parameters

document_id
string
required

Document ID.

Pattern: ^doc_[0-9a-hjkmnp-tv-z]{26}$

Body

application/json

CreateAccessRequestRequest creates a new access request.

permission
enum<string>
required

Permission level being requested.

Available options:
view,
edit,
comment
message
string | null

Optional message from the requester.

Maximum string length: 1024

Response

Success

CreateAccessRequestResponse contains the created access request.

access_request
access_request · object
required

AccessRequest represents a request for access to a document.