Skip to main content

Upload Documents

To share a single document follow the steps below guiding you through on how to use the /v1/upload-documents endpoint for uploading documents and then utilizing them across the platform.

Uploading Documents​

  1. Initiate Upload: Begin by posting the document to the POST /v1/upload-documents endpoint. This is your first step towards sharing documents via our API.

  2. Retrieve Document ID: Upon successful upload, the API will return a unique document ID. This ID is crucial as it represents the document in the system and will be used in subsequent steps.

  3. Use Document ID: With the document ID in hand, you can now pass this identifier to other API endpoints where the document needs to be shared or processed. This seamless integration allows for easy document management and sharing across different parts of the platform.

Managing Documents​

In addition to uploading documents, our API provides methods for retrieving and managing your documents efficiently:

  • Retrieve All Documents: To get a list of all uploaded documents, use the GET /v1/upload-documents method. This is particularly useful for managing and accessing your documents in a centralized manner.

  • Retrieve Document by ID: If you need to access a specific document, you can use the GET /v1/upload-documents/{id} method by replacing {id} with the actual document ID. This allows for easy retrieval of individual documents as needed.

These features are designed to provide a comprehensive solution for document management, ensuring that your documents are easily uploadable, accessible, and manageable through our API.