Step by step guide
This guide will drive you through the end to end functionality that our platform provides as it is depicted in the figure below.
Create a "Case File"
The first thing to do to be able to start in the Legal Platform is to create a "Case File". To do so you have to do the following:
- Create "Case File" API call:
POST /api/v1/private/case-files. See the create "Case file" docs for full information about this HTTP request.
Create an "Evidence Group"
The next step will be to create an "Evidence Group" within the "Case File" that we created previously. To do so you have to do the following:
- Create "Evidence Group" API call:
POST /api/v1/private/case-files/{caseFileId}/evidence-groups. See the create "Evidence Group" docs for full information about this HTTP request. - You can create as many "Evidence groups" as you want within this "Case file".
Create an "Evidence"
The next step will be to create an "Evidence" within the "Evidence Group" and "Case file" that we created previously. To do so you have to do the following:
- Create "Evidence" API call:
POST /api/v1/private/case-files/{caseFileId}/evidence-groups/{evidenceGroupId}/evidences. See the create "Evidence" docs for full information about this HTTP request. - You can create as many "Evidences" as you want within each "Evidence group".
Upload file of an "Evidence"
The next step is to upload the "Evidence" file with the pre-signed URL that we obtained in the previous step.For example, it can be uploaded with the following CURL command:
curl -v -H "x-amz-checksum-sha256: GeVzSCAm8YTwvKbEgdmKY0nj+EQhH4i5ZtSpxy+oNR4=" -T "IMG_20230505_191824.jpeg" "https://<bucket>.s3.eu-west-1.amazonaws.com/<tenant>/evidences/da3a498c-0184-4b57-8e5a-9b0ddcb560003/resource/IMG_20230505_191824.jpeg?X-Amz-Security-Token=<token>"
Where:
- GeVzSCAm8YTwvKbEgdmKY0nj+EQhH4i5ZtSpxy+oNR4= is the evidence sha256 hash converted from hex format to base64 representation.
- "IMG_20230505_191824.jpeg" is the same name with which the evidence was created in the previous step.
- "https://<bucket>.s3.eu-west-1.amazonaws.com/<tenant>/evidences/da3a498c-0184-4b57-8e5a-9b0ddcb560003/resource/IMG_20230505_191824.jpeg?X-Amz-Security-Token=<token>" is the presigned URL returned in the previous step.
Close the "Evidence Group"
Before generating a report, the "Evidence Group" containing the evidences must be closed. To do so you have to do the following:
- Close "Evidence Group" API call:
POST /api/v1/private/case-files/{caseFileId}/evidence-groups/{evidenceGroupId}/close. See the close "Evidence Group" docs for full information about this HTTP request. - Closing an "Evidence Group" starts an asynchronous process: the "Evidence Group" moves from
OPENtoCLOSINGand, once the process finishes, toCLOSED. A webhook notification is sent to you when the "Evidence Group" reaches theCLOSEDstatus (see Webhook notifications).
Report preview
The last step to complete the entire process is the generation of a Report. For this there is an option to preview a report. The result will be an HTML. To do so you have to do the following:
- Report preview API call:
POST /api/v1/private/case-files/{caseFileId}/report-preview. See the Generate report preview docs for full information about this HTTP request.
Generate signed report
And to complete the entire process, we will be able to generate a time-stamped Report. To do so you have to do the following:
- Generate signed Report API call:
POST /api/v1/private/case-files/{caseFileId}/reports. See the Generate signed report docs for full information about this HTTP request. - This operation is asynchronous: you will be notified when the report has been generated and signed (see Webhook notifications).