The API consists of two generations that operate side by side: one legacy set (the classic .jsp-endpoints for existing Outlook plugins) and a modern REST-variant below /FileCap/api/..., which returns structured JSON responses. New integrations should preferably use the modern endpoints.

Key features:

• Transfer – securely upload and send files, with options for passwords, SMS verification, and expiration dates
• Invite – Invite external users to send you files
• Validation & DLP – Checking files, domains, and messages based on security rules
• Settings – View password policy and email plugin configuration
• Block & Devices – Revoke Sent Transfers and Register External Devices Using Your Own API Key

Each call is secured with an API key for each portal; selected endpoints also support a device-specific key or JWT token.

‍

Getting Started

1. Set the Base URL – all endpoints run on /FileCap. Use your server URL without a trailing slash, for example https://filecap.example.com. Calls are then constructed as {basis-URL}/FileCap/<pad>.
2. Add an API key – Ask the APIKey Request your FileCap tenant from your administrator and include it in every request (except for the public validate/*- and password policy endpoints).
3. Make the first call —preferably using the modern JSON endpoints. A successful response looks like this:

json

  {
    "success": true,
    "value": { },
    "errorMessage": null
  }

If an error occurs, success equal to false and the reason is stated in errorMessage.

4. Register Device (optional) – If you want to use your own device key, please register your system via /api/user/devices/register, confirm the code sent to you by email via /api/user/devices/verify and use the token you received in your calls.

Please note: Some endpoints are subject to rate limiting. If there are too many requests, the server returns a 429-status restored.

‍

‍