Brifle
Introduction
This documentation is intended for developers who want to interact directly with the Brifle system.
Brifle follows national German laws. In case of international deliveries you are responsible for compliance with the law.
Terminology
Account
An account is associated with a legal person or company. There are two main types of account: personal and business.
User
A user is required to authorise and log into the system. Each user has at least one account. Corporate accounts can have multiple users.
Tenant
A tenant is defined as a sender. Each personal account is associated with one private tenant, while each business account is associated with at least one public tenant. It is possible for an account to be associated with multiple tenants, which is useful for companies that have different departments, each of which may send different types of documents, such as HR and Sales.
Limitations
The maximum request size is currently 3MB.
Conventions
Dates
All dates are returned in UTC time zone in iso8601 format.
iso8601 format: yyyy-mm-ddThh:mm:ss.sZ.
Error Codes
| Code | Status | Message |
|---|---|---|
| 40000 | 400 | bad request |
| 40100 | 401 | unauthorized |
| 40101 | 401 | login Failed |
| 40102 | 401 | No access to tenant |
| 40103 | 401 | access not granted |
| 40105 | 401 | Not Access to Account |
| 40300 | 403 | forbidden |
| 40400 | 404 | not found |
| 40401 | 404 | receiver not found |
| 40402 | 404 | tenant not found |
| 40403 | 404 | account not found |
| 40405 | 404 | document not found |
| 42200 | 422 | unprocessable entity |
| 42201 | 422 | content type not supported |
| 42202 | 422 | document has wrong encoding |
| 42203 | 422 | invalid iban |
| 50000 | 500 | internal error |
Authorization API
In order to operate with the system you need to authorize with the system. For authentication we use oauth2. The account owner needs to setup an api key and generate an api secret. As ventor you can add the x-vendor header to mark that the process was initiated by you.
Authentication
- HTTP: Bearer Auth
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |