All pages
Powered by GitBook
1 of 3

Loading...

Loading...

Loading...

Inquiries API

Create Inquiries

API to create new inquiries in Monolith

Create an inquiry

POST /api/v1/inquiries

Create a new inquiry in Monolith vai HTTPS

Headers

Name
Type
Description

Request Body

Name
Type
Description

Create Inquiry Example

description

String

A description of the inquiry - usually the details of the request being made.

inquiry_type

String

Type of inquiry - should map to the case types in your Monolith database.

referred_by

String

Source of inquiry - defaults to "API Request"

evidence

Array

This is an array of evidence objects.

client.name*

String

Name of the requestor.

client.email*

String

Email of requesting client.

client.org

String

Organization of requestor.

client.phone

String

Office phone number of requestor.

client.mobile

String

Mobile phone number of requestor.

client.address

String

Address of requestor.

client.city

String

City of requestor.

client.region

String

State or province of requestor.

client.postal_code

String

Postal code for requestor.

client.type

String

Type of client

evidence.evidence_number

String

Evidence number for requestor

evidence.item_name*

String

Name of evidence item.

evidence.provider

String

Manufacturer or service provider.

evidence.evidence_type

String

Type of evidence - should map to evidence types in Monolith.

evidence.unique_id

String

Serial number or account identifier for evidence item.

evidence.description

String

Description of evidence.

contacts

Array

Array of contact objects

contacts.name*

String

Name of person.

contacts.type

String

Type of contact/person.

contacts.unique_id

String

Identifier of person.

contacts.description

String

Description or notes related to person.

documents

Array

Array of document objects

documents.name*

String

Filename of document

documents.data*

String

Base64 encoded string of file data.

x-api-key*

String

Monolith API Key

client*

JSON

A JSON object with client info.

request_name

String

A name for this inquiry.

request_id

String

This is the request_id of the inquiry. This value is usually associated with a Relay request, but can also be associated with external request systems if utilized via API when creating an inquiry.

client_ref_number

String

A case or matter number related to the requestor.

# Using uuid as URL path param

import requests

# set your Monolith API key into a variable
api_key = "qucuqwqg5q3rve28ehfh" # this is a fake API key

# Set the api key in the header of the request
headers = {
	"x-api-key": api_key
}

data = {
    "request_name": "My New Request/Inquiry",
    "inquiry_type": "Incident Response",
    "description": "this is an api test",
    "client": { # client is required for this API
        "name": "dev forensics", # required
        "email": "[email protected]" # required
    },
    "contacts": [
        {
            "name": "Rick Sanchez" # required when contacts is provided
        }
    ],
    "documents": [
        # 25 MB file size limit
        {
           # name is required when documents is provided
            "name": "Important Document.pdf",
            # data is also required
            "data": "JVBERi0xLjQKJfbk/N8KMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovVmVyc2lvbiAvMS40Ci9QYWdlcyAyIDAgUgovU3RydWN0VHJlZVJvb3QgMyAwIFIKL01hcmtJbmZvIDQgMCBSCi9MYW5nIChlbikKL1ZpZXdlclByZWZlcmVuY2VzIDUgMCBSCj4+CmVuZG9iago2IDAgb2JqCjw8Ci9DcmVhdG9yIChDYW52YSkKL1Byb2R1Y2VyIChDYW52YSkKL0NyZWF0aW9uRGF0ZSAoRDoyMDIzMDkyNTIwMTAwNSswMCcwMCcpCi9Nb2REYXRlIChEOjIwMjMwOTI1MjAxMDA1KzAwJzAwJykKL0tleXdvcmRzIChEQUZ2ZWlFajFBOCxCQUU0aklBMXU2VSkKL0F1dGhvciAoTWF0dCBEYW5uZXIpCi9UaXRsZSAoTmVwdHVuZSBQcm9kdWN0IEZseWVyKQo+PgplbmRvYmoKMiAwIG9iago8PAovVHlwZSAvUGFnZXMKL0tpZHMgWzcgMCBSXQovQ291bnQgMQo+PgplbmRvYmoKMyAwIG9iago8PAovVHlwZSAvU3RydWN0VHJlZVJvb3QKL1BhcmVudFRyZWUgOCAwIFIKL1BhcmVudFRyZWVOZXh0S2V5IDEKL0sgWzkgMCBSXQovSURUcmVlIDEwIDAgUgo+"
        }
    ],
    "evidence": [
        {
            "evidence_number": "123456", 
            "evidence_type": "Smartphone",
            "item_name": "iPhone 15",  # required when evidence array is provided
            "provider": "Apple",
            "unique_id": "55485415241", 
            "description": "This is test evidence"
        }
    ]
}

# Use the appropriate API endpoint for your region
api_url = f"https://monolith-app.monolithforensics.com/api/v1/inquiries"

# Execute the POST request
# returns a JSON object with inquiry_id and uuid values
response = requests.post(api_url, headers=headers, json=data)

# print the JSON response to console
print(response.json())

Get Inquiries

API endpoint to manage inquiries and incoming requests.

Get Inquiries

GET /api/v1/inquiries/:uuid?

Retrieve a list of inquiries from your Monolith database.

Path Parameters

Name
Type
Description

Query Parameters

Name
Type
Description

Headers

Name
Type
Description

Get Inquiries Examples

Using uuid as URL path param:

Using Query Params:

uuid

String

Unique value that identifies a specific inquiry.

uuid

String

Unique value that identifies a specific inquiry. This value will take precedence over the UUID URL param if passed.

inquiry_id

String

This is a unique integer value that identifies a specific inquiry. \nThis serves the same purpose as the uuid value.

status

String

This is the status of an inquiry.

request_id

Integer

This is the request_id of the inquiry. This value is usually associated with a Relay request, but can also be associated with external request systems if utilized via API when creating an inquiry.

x-api-key*

String

Monolith API Key

# Using uuid as URL path param

import requests

# set your Monolith API key into a variable
api_key = "qucuqwqg5q3rve28ehfh" # this is a fake API key

# Set the api key in the header of the request
headers = {
	"x-api-key": api_key
}

uuid = "asd8hasdgadc67w5we7wd"

# Use the appropriate API endpoint for your region
api_url = f"https://monolith-app.monolithforensics.com/api/v1/inquiries/" + uuid

# Execute the GET request
response = requests.get(api_url, headers=headers)

# print the JSON response to console
print(response.json())
// TODO
import requests

# set your Monolith API key into a variable
api_key = "qucuqwqg5q3rve28ehfh" # this is a fake API key

# Set the api key in the header of the request
headers = {
	"x-api-key": api_key
}

uuid = "asd8hasdgadc67w5we7wd"

# Use the appropriate API endpoint for your region
api_url = f"https://monolith-app.monolithforensics.com/api/v1/inquiries?uuid=" + uuid

# Execute the GET request
response = requests.get(api_url, headers=headers)

# print the JSON response to console
print(response.json())
// TODO