Skip to main content
GET
/
v1beta
/
versions
/
{version_id}
TypeScript
import { Factify } from "@factify/sdk";

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

async function run() {
  const result = await factify.versions.get({
    versionId: "<id>",
  });

  console.log(result);
}

run();
{
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": {
    "id": "user_01h2xcejqtf2nbrexx3vqjhp41",
    "name": "John Doe",
    "type": "user_account"
  },
  "document_id": "doc_01h2xcejqtf2nbrexx3vqjhp41",
  "id": "ver_01h2abcd1234efgh5678jkmnpt",
  "processing_status": "processing",
  "url": "https://app.factify.com/d/01h2xcejqtf2nbrexx3vqjhp41/v/1",
  "description": "<string>",
  "title": "Version 2.0"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
version_id
string
required

Version ID to retrieve. Pattern: ver_[0-9a-hjkmnp-tv-z]{26}

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

Response

Success

Version represents a document version.

​
created_at
string<date-time>
required

Timestamp when version was created.

​
created_by
created_by · object
required

User who created the version.

​
document_id
string
required

Parent document ID. Pattern: doc_[0-9a-hjkmnp-tv-z]{26}

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

"doc_01h2xcejqtf2nbrexx3vqjhp41"

​
id
string
required

Unique ID for the version. Pattern: ver_[0-9a-hjkmnp-tv-z]{26}

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

"ver_01h2abcd1234efgh5678jkmnpt"

​
processing_status
enum<string>
required

Processing status.

Available options:
processing,
ready,
failed
​
url
string<uri>
required

URL for accessing this version on Factify.

Example:

"https://app.factify.com/d/01h2xcejqtf2nbrexx3vqjhp41/v/1"

​
description
string | null

Description of changes in this version.

​
title
string | null

Optional version title.

Maximum string length: 255
Example:

"Version 2.0"