Table of contentsContents
| Table of Contents |
|---|
🔢 Endpoints (in a sequence of process)
...
Endpoint
...
Description
...
POST /v2/company-reports/company-reports-search
...
🛒 How to order and get a report
1️⃣ Call to
| Status | ||||
|---|---|---|---|---|
|
/v1/legal/reports/available to get a list of available reports...
POST /v2/company-reports
...
order a report by id based on the previous report
...
GET /v2/company-reports/{id}/status
...
check ordered report status
...
.
2️⃣ Use id of the selected report as key to call
| Status | ||||
|---|---|---|---|---|
|
/v1/legal/reports and place a report order.3️⃣ Call
| Status | ||||
|---|---|---|---|---|
|
/v1/legal/reports/{id} with the id received from the | Status | ||||
|---|---|---|---|---|
|
/v1/legal/reports response to get the report order status and other details.Once the order status is Finished, a request to download the report can be made.
4️⃣ To get a report file once it is delivered call
| Status | ||||
|---|---|---|---|---|
|
/v1/legal/reports/{id}/file...
get the report that was delivered
...
POST /v2/company-reports/status/filter
...
list all the ordered reports (the same as list of reports in OS)
| Info |
|---|
In the request header, |
How to get a report
...
with id of the order.
...
🔢 Endpoints (in a sequence of process)
Endpoint | Description | ||||||
|---|---|---|---|---|---|---|---|
| 1 |
/v1/ |
...
|
...
|
...
| Get a list of available reports |
...
. | |||||||
| 2 |
/v1/legal/reports |
...
Order a report |
...
by its id in the list of available reports. | |||||||
| 3 |
/v1/legal/reports/{id} |
...
Check the status of the ordered report. | ||||
| 4 |
|
...
|
...
/v1/legal/reports |
...
Once
statusisFinished
☁️ API
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
… |
| Get the report that has been delivered. | |||||||
| 5 |
/v1/legal/reports/filter | List all the ordered reports (the same as the list of reports in OS). |
| Info |
|---|
In the request header, |
...
☁️ Swagger
| Swagger open api macro | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
...