Documentation

FileCap API

Available documentation#

Registering a device works differently than the downloads below describe.

  • name is required and is yours to choose. It is the label the device is listed under, so pick something you will recognise.
  • deviceName accepts only Outlook or OutlookWeb. Any other value is rejected, so a description such as “My integration server” does not work.
  • Verifying uses emailAddress, not email. A body with email is rejected with Invalid input.
  • The emailed verification code starts with DVC. Send only the part after those three characters to /user/devices/verify.

Postman Collection :#

Use the Postman Collection to quickly get familiar with the API and run the available requests directly in Postman.
File: FileCap API.postman_collection.json

OpenAPI Specification :#

The OpenAPI specification contains a machine-readable description of the API. This file can be imported into development tools such as Swagger, Postman, and OpenAPI Generator for documentation, testing, and code generation.
File: FileCap_API_OpenAPI_Spec.yml

Swagger documentation :#

View the available endpoints, parameters, request bodies, and responses in a clear Swagger view.
File: FileCap_API_Swagger.html

Public API Reference:#

The Public API Reference contains extensive technical explanations, usage scenarios, and additional information about the FileCap API.
File: FileCap_Public_API_Reference_V6.pdf

Version and support:#

This documentation applies to version 6 of FileCap. When developing an integration, always check that you are using the most recent documentation and API version.
For questions about access, implementation, or error messages, contact support via chat.filecap.com