Access Requests

Create an access request

Changed on

Creates a new access request for the specified document.

post/v1beta/documents/{document_id}/access-requests

Request

  • Base URL
    https://api.factify.com
  • URL
    https://api.factify.com/v1beta/documents/{document_id}/access-requests
  • Auth
    HTTP bearer

Path parameters

document_idstring required

Document ID.

Example:doc_01h2xcejqtf2nbrexx3vqjhp41

Request body

messagestring nullable

Optional message from the requester.

permission'view' | 'edit' | 'comment' required

Example request

{
  "message": "Need access for quarterly review"
}

Response

Success

Example response

{
  "access_request": {
    "document_id": "doc_01h2xcejqtf2nbrexx3vqjhp41",
    "id": "acr_01h2xcejqtf2nbrexx3vqjhp41",
    "message": "Need access for quarterly review",
    "subject": {
      "id": "user_01h2xcejqtf2nbrexx3vqjhp41"
    },
    "subject_email": "dwight@dundermifflin.com"
  }
}

Changes