Getting started
Get Access to APIAuthenticationMaking your first requestGuides
Generate Doc X-RayGenerate Bank X-RayGenerate Financial X-RayGenerate ESG X-RayGenerate Manager X-RayConcepts
OverviewRequestReportsMediumDoc X-RayBank X-RayFinancial X-RayESG X-RayManager X-RayResources
API versioningWebhooksUploading a mediaAdd a creator to your requestTesting environmentOrganization & MembersSecuritySupportMedium
To complete a request, you must upload required documents, called “medium” (plural: “media”).
For a complete list of fields, checkout the API Reference (Media API Reference)
Here are the explanations of the most important fields:
Name
This is the name of the document from the following list:
certified_financial_statement
bank_statement
interim_financial_statement
other
Status
The status of a medium can be one of the following:
Name | Description |
draft | The medium was created, but the file wasn’t uploaded yet. |
online | The file has been uploaded and is available to October. |
pending_extraction | The file content is being extracted by our tools. |
Url
You can use the url
field of the medium to retrieve the file.
Prepend the url with our CDN domain:
- staging-cdn.october.eu - Staging
- cdn.october.eu - Production
Example:
https://cdn.october.eu/${medium.url}
https://cdn.october.eu/requests/5d16015c3dc18900699cb9d9/image-3f3db639bb445c3732d8e799d72f0912.jpg
Meta - Name
The meta.name
field is the original filename of the document.
Meta - Period & Date
For some type of documents, the medium will also have its meta.period
and meta.date
For a certified_financial_statement
medium, the period will be:
year
For a bank_statement
medium, the period can be one of the following:
month
quarter
semester
See Uploading a media for more informations on how to upload a medium to our platform.
← Previous
Next →