Paperbox Integration API
Introduction
This API provides a RESTful interface to interact with Paperbox’ storage component on the inbox level. The ingestion API is hosted on the domain https://integration.{ENV}.paperbox.ai/v2, where ENV can be either acc for our Acceptance environment or prd for our Production environment.
The ingestion API provides POST endpoints on two routes, parameterized by the inbox ID. A distinction is made between a route to post historical data intended for the initial onboarding and setup, and a route for provisioning documents that should be processed during the operational phase.
Security
Paperbox provisions a Google Cloud service account to the API consumer which is used to sign secure JSON Web Tokens (JWT) on the consumer side, which are then sent in the requests to our API. This approach is further described here.
As an additional layer of security, our API also requires an API key, which we provision for each consumer.
Please follow this guide on how to Authenticate and Authorize your requests
Authentication
- API Key
- Bearer Auth
| Security Scheme Type: | apiKey |
|---|---|
| Header parameter name: | key |
| Security Scheme Type: | http |
|---|---|
| HTTP Authorization Scheme: | bearer |
| Bearer format: | JWT |