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

Testing environment

Organization & Members

Security

Support

Making your first request

⚠️

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

All communications to the API are done through HTTP Requests.

We provide two environments:

• https://staging-api.october.eu - Staging
• https://api.october.eu - Production

When making an HTTP Request, you must provide 3 headers:

• userId : ID of the user that is making the request
• sessionToken : API key
• October-Version : See current API version on API versioning page

Moreover, when making a POST HTTP Request, you must also provide the following header key/value:

• Content-Type: application/json

1. Create a Request

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

ℹ️

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

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:

{
	"id": "635107e452436f15d3b39d87", // Unique ID of the request
	"status": "pending_analysis",
	"stage": "1.1",
	...
}

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

2. Upload the documents

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.
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

3. Wait for request analysis

Once you have send the request to our API, the analysis of some X-Rays will be launch automatically such as ESG X-Ray and Manager X-Ray. On the other hand, the other X-Rays require extra information to be launched and depending on how this information is processed, it can either take a few minutes or up to 48 hours.

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

1. Poll regularly the API to check when an offer or refusal is available; or
2. Use webhooks to be notified when the status of the request has been updated or a new offer has been created. (Our recommendation)

When the status of the request changes, refer to the cases below to know the next steps.

Polling the API

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

Make GET HTTP requests to /reports?request=[requestId] to receive all the reports associated to the requests

Using webhooks

We provide a webhook:

• new_report when a new report has been created
Copy

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

After receiving the webhook, you can retrieve the data of the report using the following GET HTTP calls:

• GET /requests/[requestId]
• GET /reports?request=[requestId]

On this page

• Making your first request
• 1. Create a Request
• 2. Upload the documents
• 3. Wait for request analysis