Getting started

Get Access to API

Authentication

Making your first request

Guides

Generate Doc X-Ray

Generate Bank X-Ray

Generate Financial X-Ray

Generate ESG X-Ray

Generate Manager X-Ray

Concepts

Overview

Request

Reports

Medium

Doc X-Ray

Bank X-Ray

Financial X-Ray

ESG X-Ray

Manager X-Ray

Resources

API versioning

Webhooks

Uploading a media

Add a creator to your request

October x Financial X-Ray

<aside> ⚠️ WARNING In order to follow this guide, you will first need to get access to our API (Get Access to API) and be able to send requests using our Authentication method

</aside>

In this page, you will find a step-by-step guide that will walk you through the generation of a Financial X-Ray using the October Connect API.

In this guide, you will generate your first Financial X-Ray using the following steps:

• Create a request
• Generate financial statement
• Retrieve Financial X-Ray
• Review the analysis

1. Create a request

For the first step of the analysis, create a request with a POST call to /requests

<aside> ℹ️ To learn how to assign this request to a specific user from an email address, consult : Add a creator to your request

</aside>

In the example below, all fields are mandatory except if mentioned otherwise:

POST /requests
{
  "code": {
    "type": "siren",
    "id": "514673987"
  }
}

The API will answer with additional fields on the request:

{
  "request": {
    "id": "[requestId]", // Unique ID of the request
    "code": {
      "type": "siren",
      "id": "514673987"
  }
  "status": "pending_analysis",
  "stage": "1.1",
  ...
  }
}

<aside> ℹ️ For more information about the requests end-points, please refer to the API reference (Request API Reference)

</aside>

If you wish to re-fetch the data of a request, you can make a GET call to /requests/[id].

2. Generating the Financial X-Ray

We currently have two ways to generate a financial X-Ray which are also complementary to one another. Indeed, you can either upload a medium or add notes to the request

2.1 Upload a medium

The upload of a document is done in 3 steps:

1. POST /media to our API with the type and metadata of the file you wish to send us. You will receive data needed to upload to S3.

   • Use the following name in order to categorise the document

   certified_financial_statement, interim_financial_statement, other
   

2. Upload the file to AWS S3 using the data received from the previous step.

3. Once the upload is successful, call POST /media/[id] to set the status to online and optionally add the period and date of the document.

To read a detailed step-by-step guide, please read Resource: Uploading a media

<aside> 📦 Note: The maximum allowed file size is 20MB.

</aside>

<aside> ℹ️ For more information about the allowed file formats, please refer to the API reference (Media API Reference)

</aside>

2.2 Notes

The notes field of the request will hold all the business information and financial data that you will send us.

To update a request:

1. POST /requests/[requestId] to our API with the body containing a notes object.
2. Include the fields tagged “mandatory” in the notes object

<aside> 📦 Note: All those notes are that are tagged “mandatory” are required in order to provide an accurate financial X-Ray.

</aside>

If there are no labels or certification, use none | | esgEmployeeProtection | Number of current employees that, thanks to the your financing, the company would be able to retain instead of potentially laying off (e.g. ability to pay wages, continue operations, etc.) | enum | No | 0, 1, 2-5, 6-10, 10+ | | esgJobCreation | Number of new workers that the your financing would allow the company or require the company to hire (e.g. by enlarging existing teams, creating new teams or new single positions, etc.) | enum | No | 0, 1, 2-5, 6-10, 10+ |

3. Retrieve Financial X-Ray

Once you have uploaded a media, our Financial X-Ray will be launched automatically and will return an analysis within a few minutes. However, if our OCR fails, we use an alternative extraction method that can take up to 48h.

To wait for the end of the request analysis, you have two options:

1. Poll regularly the API to check when a new report is available; or
2. Use webhooks to be notified when a new report has been created. (Our recommendation)

When the report has been created, refer to the cases below to know the next steps.

Polling the API

Make GET HTTP requests to /requests/[requestId] to receive the latest data of the request.

Make GET HTTP requests to /reports?source=magpie&request=[requestId] to receive the Financial X-Ray reports associated to the request

Using webhooks

<aside> 🪝 If you choose to use webhooks, start by checking out our Resource Webhooks

</aside>

We provide a webhook that will update you when a new report is generated:

• new_report when a new report has been created

{
	"event": "new_report",
	"requestId": "[requestId]",
	"reportId": "[reportId]"
}

After receiving webhooks, retrieve the data of the request or offer using the following GET HTTP calls:

• GET /requests/[requestId]
• GET /reports/[reportId]

4. Review the analysis

Once you have received the update using either the API calls or webhooks from the previous section, you can retrieve the Financial X-Ray report using the following GET HTTP call:

• GET /reports/[reportId]

The API will answer with additional fields on the report:

{
  "report": {
  "id": "[reportId]",
  "request": "[requestId]",
  "source": "magpie",
  "raw": {
    "criterias": {
      "totalFixedAssetsTotalAssets": {
        "value": 0.0867204257133327,
        "source": "magpie"
      }
    },
    "probabilityOfDefault": 0.039524826661933084,
    "riskClass": 3,
    "reasons": [
      {
        "typeCode": "trafficLight",
        "sentiment": "good",
        "weight": 0.039524826661933084,
        "criteria": {
          "supplierScore": "yellow"
        }
      },
      ...
    ]
  }
}

<aside> ℹ️ For more information about the reports end-points, please refer to the API reference (Report API Reference)

</aside>