Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Embat Files API

`File` represents a banking file exchanged between Embat and a bank: either a file **received** from a bank (a reception, e.g. an account statement or a confirmation file) or a file **submitted** to a bank (an emission, e.g. a payment order file). Files are identified by an Embat-generated `id` and, when the bank could be identified, carry the related `Bank`.Files list endpoints are not scoped by `companyId`: they return the files across every company accessible to the authenticated user. `companyId` is only used when creating a file emission.**Typical flow:**1. **Discover new receptions.** Poll `GET /files/receptions` periodically; each entry reports whether it has already been `downloaded`. Use `nextPageToken` to page through results.2. **Download a reception's content.** Once you have identified a file of interest, fetch its raw content with `GET /files/receptions/{fileId}`.3. **Submit a file to a bank.** To send a file to a bank on behalf of a company (e.g. a payment order), call `POST /files/{companyId}/{bankId}` with the file content and its format.4. **Track emissions.** List the files you have submitted, and any submitted on your behalf, with `GET /files/emissions`.

Embat Files API is one of 22 APIs that Embat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Files. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 4 operations across 4 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 2.120.3.

Requests are made against the base URL https://api.embat.io.

4 operations 4 paths 12 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.120.3
Base URL
https://api.embat.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Embat Files API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Files 4

File represents a banking file exchanged between Embat and a bank: either a file received from a bank (a reception, e.g. an account statement or a confirmation file) or a file sub…

GET
/files/receptions
List file receptions
list_files_receptions_files_receptions_get 2 params → 200401422
GET
/files/receptions/{fileId}
Download file reception
download_receptions_file_files_receptions__fileId__get 1 param → 200401404422
GET
/files/emissions
List file emissions
list_files_emissions_files_emissions_get 2 params → 200401422
POST
/files/{companyId}/{bankId}
Create file emission
create_file_emission_files__companyId___bankId__post 2 params body → 200401404500422

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are GetFilesEmissionResponseSchema (11 properties), GetFilesReceptionResponseSchema (10 properties), ValidationError (5 properties), BankFileSchema (4 properties). Each schema is shown below with its type and property counts.

GetFilesEmissionResponseSchema
object
Files response data schema
11 properties 7 required
ErrorResponse
object
Error payload returned by the API (FastAPI detail convention).
1 property 1 required
HTTPValidationError
object
1 property
ValidationError
object
5 properties 3 required
UserFileSchema
object
3 properties 2 required
BankFileSchema
object
4 properties
FileFormatsEnum
string
Body_create_file_emission_files__companyId___bankId__post
object
2 properties 2 required
PostFilesEmissionResponseSchema
object
1 property 1 required
ListFilesReceptionsResponseSchema
object
2 properties 1 required
ListFilesEmissionsResponseSchema
object
2 properties 1 required
GetFilesReceptionResponseSchema
object
Files response data schema
10 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

embat-files-api-openapi.yml Raw ↑

Other APIs Embat publishes across the network.

Embat AccountingAccounts API
Embat AccountingEntries API
Embat Attributes API
Embat Authentication API
Embat Balances API
Embat Banks API
Embat Categories API
Embat Companies API
Embat Contacts API
Embat DebtScheduleConfigs API
Embat Forecasts API
Embat ForeignExchangeRates API