Add documents
The Documents tab in the customer view serves as a central file storage. Here you can manage documents that are relevant to the business relationship with the customer.
When do I need this function?
Section titled “When do I need this function?”Particularly in the B2B environment, certain order processes or subscriptions may require legal proof. You can use this function to manually upload the following documents, for example:
- Signed framework agreements
- ID copies
- Business registrations or commercial register extracts
- Special credentials
Requirements
Section titled “Requirements”- You are logged in to the tebio business portal.
- You have opened the detailed view of the customer for whom you want to store the document.
Step-by-step instructions
Section titled “Step-by-step instructions”The document overview
Section titled “The document overview”To view existing files:
- In the customer’s detailed view, navigate to the Documents tab.
- You will now see the Required Documents table.
- The table lists existing files and shows their type, name, optional description and upload date.
- You can download a file via Download or delete it via the trash icon.
Upload a new document
Section titled “Upload a new document”If you would like to add a new file to the customer profile:
- Click Add Document above the table.
- The upload dialog opens.
- Document Type: Select the appropriate category for your file in the dropdown, for example Other Document.
[!NOTE] The available document types are specified on the platform in tebio. You do not need to configure these document types administratively in advance.
- Upload document: Click the upload icon to open your computer’s file browser, or drag and drop the file into the highlighted field.
- Document description: Optionally enter a short free text that describes the contents of the file, for example a copy of your student ID card.
- Click on the Add button.
Result
Section titled “Result”tebio uploads the file, links it to the customer and then displays it with a time stamp in the overview table.
Notes and typical errors
Section titled “Notes and typical errors”- Limited file size: Make sure your files do not exceed the allowed file size.
- Incorrect document type: Select an appropriate document type from the dropdown. This makes later searches and automations easier.
API Notes
Section titled “API Notes”Files can also be uploaded via the Document API. When uploaded, the document is linked to a reference to the respective entity, for example the customer UUID.
The following endpoints are available:
| End point | Method | Description | OperationId |
|---|---|---|---|
/v1/document | POST | Upload document | uploadDocument |
/v1/document/search | POST | Search documents using search criteria | searchDocument |
/v1/document/{id} | GET | Get document details | getDocument |
/v1/document/{id} | DELETE | Delete document | deleteDocument |
/v1/document/{id} | PATCH | Update document data | patchDocument |
/v1/document/{id}/download | GET | Download document file | downloadDocument |