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 Manager X-Ray using the Risk Assessment API.

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

Create a request
Retrieve Manager X-Ray
Review the analysis results

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",
  ...
  }
}

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

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

</aside>

2. Retrieve Manager X-Ray

Once you have uploaded a media, our Manager X-Ray will be launched automatically and will return an analysis within a few minutes.

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

Poll regularly the API to check when a new report is available; or
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=manager_xray&request=[requestId] to receive the Manager 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]

3. Review of the analysis

Once you have received the update using either the API calls or webhooks from the previous section, you can retrieve the Manager 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]",
    "creation": "2023-07-13T08:17:17.000Z",
    "code": {
      "id": "514673987",
      "type": "siren"
    },
    "source": "doc_xray",
    "raw": {
      "request": {
        "id": "[requestId]",
        "code": {
          "id": "514673987",
          "type": "siren"
        }
      },
      "persons": [ // List of all the managers associated with the company being analysed
        {
          "lastname": "Doe",
          "firstname": "John",
          "birthdate": "1979-01-01",
          "confidencePercentage": 1,  // Confidence level that we have identified the correct person
          "companies": [ // List of all the company associated with the manager
            {
              "name": "Company Name",
              "code": {
                "id": "514673987",
                "type": "siren"
              },
              "jobStartDate": "2002-02-07",
              "jobEndDate": null,
              "alerts": [ // List of all potentiel alerts regarding the company and risk level associated to it
                {
                  "date": "2011-10-31",
                  "name": "Mise en sommeil de la société",
                  "level": "low"
                },
                ...
              ]
            },
            ... // extra information that Manager X-Ray has been able to retrieve
          ]
        }
        ...
      ]
    }
    ...
  }
}

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

</aside>

← Previous

Guides: Generate ESG X-Ray

Concepts: Overview