Company

Create company

Create a company. All companies created with 'parent' company specified are considered a subsidiary of the parent company.

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

state

required

string

Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating.

Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"

header Parameters

x-api-key required	string Trace API key header Example: b123x21wbHlkYXBpa2V5
Authorization required	string Company and user credentials authentication Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5

Request Body schema: application/json

name

required

string

name of company.

parent_id

string or null

This parameter allows building the company's network of peer and child/branch companies.

required

Array of objects

The main contact for this company

Array

first_name required	string Contact's first name
last_name required	string Contact's last name
email_address required	string Unique contact email address.
phone_number required	string Contact's phone number

web_site

string

The website url of the company.

Responses

200

Response Schema: application/json

object

type

string

Value: "object"

object

string

Trace reference (entity_id) for the company.

name

string

Location name.

parent_id

string or null

This parameter allows building the company's network of peer and child/branch companies.

Array of objects

The main contacts for this company

Array

first_name	string Contact's first name
last_name	string Contact's last name
email_address	string Contact’s unique email address.
phone_number	string Contact's phone number

web_site

string

The website url of the company.

Array of objects

A list of state changes made to the entity. Entity states for Company [active, inactive, deleted].

Array

state	string state of the entity.
date	string timestamp when the state was recorded ISO 8601 UTC format.
reason	string additional information for the 'state' change.
actioned_by	string username of the person who updated the state of the entity (if applicable).

Array of objects

Array

type	string
detail	string

400

Bad Request

post/{state}/v1/config/companies

Request samples

Payload

application/json

{"name": "GCV Cannabis",
"parent_id": "a06a7a59e8b74545a960b7c026c0e433",
"contacts": [{"first_name": "Yuki",
"last_name": "Mori",
"email_address": "ymori@Trace.com",
"phone_number": "408-123-4567"
}
],
"web_site": "https://GCVcannabis.com"
}

Response samples

application/json

{"results": {"type": "object",
"data": {"company_id": "1296656d615b4c3e8e20a21fb6ca5771",
"parent_id": "7dd2bd95b9c947248bf8b3e23691b0c7",
"name": "My First Trace Company",
"contacts": [{"first_name": "Kevin",
"last_name": "Hart",
"email_address": "Support@greencheckverified.com",
"phone_number": "123-456-7890"
}
],
"web_site": "https://www.greencheckverified.com/",
"entity_state": [{"state": "active",
"date": "2023-12-14T15:47:26Z",
"reason": "company creation",
"actioned_by": "system generated"
},
{"state": "updated",
"date": "2023-12-14T15:47:26Z",
"reason": "company updated",
"actioned_by": "system generated"
}
]
}
},
"warnings": [ ]
}

Retrieve company list

Gets a list of companies associated to your api key.

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

state

required

string

Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating.

Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"

query Parameters

entity_state

string

Queryable entity states for company.

Enum: "active" "inactive" "deleted"

header Parameters

x-api-key required	string Trace API key header Example: b123x21wbHlkYXBpa2V5
Authorization required	string Company and user credentials authentication Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5

Responses

200

Response Schema: application/json

object

type

string

Value: "array"

Array of objects

Array

string

Trace reference (entity_id) for the company.

name

string

Company name.

parent_id

string or null

This parameter allows building the company's network of peer and child/branch companies.

Array of objects

List of physical resources managed by this company (e.g. Facilities and Vehicles)

Array

	Array of objects List of facilities belonging to the company
	Array of objects List of vehicles belonging to the company

Array of objects

List of employees managed by this company (e.g. Employees).

Array

id	string Reference (entity_ID) for the employee.
name	string Employee name

Array of objects

The main contacts for this company

Array

first_name	string Contact's first name
last_name	string Contact's last name
email_address	string Contact’s unique email address.
phone_number	string Contact's phone number

web_site

string

The website url of the company.

Array of objects

A list of state changes made to the entity. Entity states for Company [active, inactive, deleted].

Array

state	string state of the entity.
date	string timestamp when the state was recorded ISO 8601 UTC format.
reason	string additional information for the 'state' change.
actioned_by	string username of the person who updated the state of the entity (if applicable).

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/config/companies

Response samples

application/json

{"results": {"type": "array",
"data": [{"id": "6ba36fba946d4de583b2f994f6297fd8",
"name": "KMP Massachussets",
"parent_id": null,
"physical_resources": [{"facilities": [{"id": "3bf530427baa4621a914f93c4a53005c",
"reference_id": "7",
"name": "Independent Lab",
"display_name": "Independent Lab",
"identifier_code": "7",
"phone_number": "312-123-4567",
"timezone": "America/New_York",
"deleted": false,
"licenses": [{"license_number": "LABLIC123",
"type": {"name": "MA - Independent Testing Laboratory"
},
"start_date": "2023-01-14T00:00:00Z",
"end_date": "2025-07-14T00:00:00Z"
}
],
"address": {"address_line_1": "123 Easy St",
"address_line_2": "Suite 100",
"address_line_3": null,
"country": "USA",
"county": "Suffolk",
"city": "Boston",
"state": "MA",
"zip": "12345",
"gps": "42.95597245897259, -85.49981968100619"
}
},
{"id": "c4719e95aca14fdc822e707e0706ae0c",
"reference_id": "8",
"name": "Cultivator",
"display_name": "Cultivator",
"identifier_code": "8",
"phone_number": "312-123-4567",
"timezone": "America/New_York",
"deleted": false,
"licenses": [{"license_number": "CLTLIC123",
"type": {"name": "MA - Marijuana Cultivator"
},
"start_date": "2023-01-14T00:00:00Z",
"end_date": "2025-07-14T00:00:00Z"
}
],
"address": {"address_line_1": "123 Easy St",
"address_line_2": "Suite 100",
"address_line_3": null,
"country": "USA",
"county": "Suffolk",
"city": "Boston",
"state": "MA",
"zip": "12345",
"gps": "42.95597245897259, -85.49981968100619"
}
},
{"id": "37ce5ebd98364bb1aa21c30f4d114610",
"reference_id": "9",
"name": "Retailer",
"display_name": "Retailer",
"identifier_code": "9",
"phone_number": "312-123-4567",
"timezone": "America/New_York",
"deleted": false,
"licenses": [{"license_number": "MR000000",
"type": {"name": "MA - Marijuana Retailer"
},
"start_date": "2023-01-14T00:00:00Z",
"end_date": "2025-07-14T00:00:00Z"
}
],
"address": {"address_line_1": "123 Easy St",
"address_line_2": "Suite 100",
"address_line_3": null,
"country": "USA",
"county": "Suffolk",
"city": "Boston",
"state": "MA",
"zip": "12345",
"gps": "42.95597245897259, -85.49981968100619"
}
},
{"id": "c4bad28f868f4e2cb426e95f786370f4",
"reference_id": "10",
"name": "Product Manufacturer",
"display_name": "Product Manufacturer",
"identifier_code": "10",
"phone_number": "312-123-4567",
"timezone": "America/New_York",
"deleted": false,
"licenses": [{"license_number": "MP00000",
"type": {"name": "MA - Marijuana Product Manufacturer"
},
"start_date": "2023-01-14T00:00:00Z",
"end_date": "2025-07-14T00:00:00Z"
}
],
"address": {"address_line_1": "123 Easy St",
"address_line_2": "Suite 100",
"address_line_3": null,
"country": "USA",
"county": "Suffolk",
"city": "Boston",
"state": "MA",
"zip": "12345",
"gps": "42.95597245897259, -85.49981968100619"
}
}
]
}
],
"employees": [{"name": {"first_name": "Charles",
"last_name": "Bodick"
}
},
{"name": {"first_name": "Brock",
"last_name": "Johnson"
}
},
{"name": {"first_name": "Andrew",
"last_name": "Stedenko"
}
},
{"name": {"first_name": "Zipper",
"last_name": "Anderson"
}
},
{"name": {"first_name": "Joey",
"last_name": "Smith"
}
},
{"name": {"first_name": "Apple",
"last_name": "Carlson"
}
},
{"name": {"first_name": "Tabatha",
"last_name": "Olsen"
}
},
{"name": {"first_name": "Ron",
"last_name": "Popiel"
}
},
{"name": {"first_name": "Rachel",
"last_name": "Christensen"
}
}
],
"contacts": [{"first_name": "Scotty",
"last_name": "Pippen",
"email_address": "spippen@kmpma.com",
"phone_number": "773-123-4567"
}
],
"web_site": "https://www.kmpma.com",
"entity_state": [{"state": "active",
"date": "2023-03-24T14:59:16Z",
"reason": "company creation",
"actioned_by": "system generated"
},
{"state": "updated",
"date": "2023-03-24T14:59:16Z",
"reason": "company updated",
"actioned_by": "system generated"
}
]
},
{"id": "1d398e6954734389970b76066ea3c520",
"name": "KMP Massachussets TEST1697672398 UPDATED",
"parent_id": null,
"physical_resources": [{"facilities": [{"id": "3c9d2b629f394b75aca75cd797b85c99",
"reference_id": "10149",
"name": "Independent Lab TEST",
"display_name": "Independent Lab",
"identifier_code": "10149",
"phone_number": "312-123-4567",
"timezone": "America/New_York",
"deleted": false,
"licenses": [{"license_number": "IL000000",
"type": {"name": "MA - Independent Testing Laboratory"
},
"start_date": "2023-01-14T00:00:00Z",
"end_date": "2025-07-14T00:00:00Z"
}
],
"address": {"address_line_1": "123 Easy St",
"address_line_2": "Suite 100",
"address_line_3": null,
"country": "USA",
"county": "Suffolk",
"city": "Boston",
"state": "MA",
"zip": "12345",
"gps": "42.95597245897259, -85.49981968100619"
}
}
]
}
]
}
]
},
"warnings": [ ]
}

Retrieve company by {id}

Get the company details for the company {id} path parameter.

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

id required	string Reference (entity_ID) for the company you are retrieving. Example: 1234
state required	string Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating. Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"

header Parameters

x-api-key required	string Trace API key header Example: b123x21wbHlkYXBpa2V5
Authorization required	string Company and user credentials authentication Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5

Responses

200

Response Schema: application/json

object

type

string

Value: "object"

object

string

Trace reference (entity_id) for the company.

name

string

Company name.

parent_id

string or null

This parameter allows building the company's network of peer and child/branch companies.

Array of objects

The main contacts for this company

Array

first_name	string Contact's first name
last_name	string Contact's last name
email_address	string Contact’s unique email address.
phone_number	string Contact's phone number

web_site

string

The website url of the company.

Array of objects

A list of state changes made to the entity. Entity states for Company [active, inactive, deleted].

Array

state	string state of the entity.
date	string timestamp when the state was recorded ISO 8601 UTC format.
reason	string additional information for the 'state' change.
actioned_by	string username of the person who updated the state of the entity (if applicable).

Array of objects

Array

type	string
detail	string

400

Bad Request

get/{state}/v1/config/companies/{id}

Response samples

application/json

{"results": {"type": "object",
"data": {"id": "KMPL001234",
"name": "KMPL Cannabis",
"parent_id": "",
"physical_resources": [{"facilities": [{"id": "12345",
"reference_id": "WASTATE1.MM24R",
"name": "KMPL Manufacturing",
"display_name": "KMPL Mfg",
"identifier_code": "JALLCT1",
"phone_number": "408-123-4567",
"deleted": false,
"licenses": [{"license_number": "KMPL20200815",
"type": {"name": "M-Type 1"
},
"start_date": "2021-01-12T00:00:00Z",
"end_date": "2022-01-12T00:00:00Z"
}
],
"address": {"address_line_1": "577 Stoneybrook Road",
"address_line_2": "Suite 100",
"address_line_3": null,
"country": "USA",
"county": "Los Angeles",
"city": "WEST HOLLYWOOD",
"state": "CA",
"zip": "92069",
"gps": "37.33250383310398, -121.90493842065254"
}
}
]
},
{"vehicles": [{"id": "75",
"reference_id": "75",
"color": "red",
"make": "Mini",
"model": "2 Door Hard Top",
"plate_number": "JY1343",
"license_plate_issuing_state": "CA",
"vin": "TY1234358X",
"year": "2020",
"deleted": false
}
]
}
],
"employees": [{"id": "asdfa25689",
"name": "Yuki Mori"
}
],
"contacts": [{"first_name": "Yuki",
"last_name": "Mori",
"email_address": "ymori@Trace.com",
"phone_number": "408-123-4567"
}
],
"web_site": "https://kmplcannabis.com",
"entity_state": [{"state": "active",
"date": "2021-01-12T05:27:39Z",
"reason": "company creation",
"actioned_by": "admin@kmp.com"
}
]
}
},
"warnings": [ ]
}

Update company

Update a company.

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

id required	string reference (entity_ID) for the company you are updating. Example: 6ba36fba946d4de583b2f994f6297fd8
state required	string Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating. Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"

header Parameters

x-api-key required	string Trace API key header Example: b123x21wbHlkYXBpa2V5
Authorization required	string Company and user credentials authentication Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5

Request Body schema: application/json

update_date

string

The UTC datetime in which the values sent in were physically changed and put into effect.

name

string

Location name.

parent_id

string or null

This parameter allows building the company's network of peer and child/branch companies.

Array of objects

The main contact for this company.

Array

first_name	string Contact's first name
last_name	string Contact's last name
email_address	string Contact’s unique email address.
phone_number	string Contact's phone number

web_site

string

The website url of the company.

Responses

200

Response Schema: application/json

object

type

string

Value: "object"

object

string

Trace reference (entity_id) for the company.

name

string

Company name.

parent_id

string or null

This parameter allows building the company's network of peer and child/branch companies.

Array of objects

The main contacts for this company

Array

first_name	string Contact's first name
last_name	string Contact's last name
email_address	string Contact’s unique email address.
phone_number	string Contact's phone number

web_site

string

The website url of the company.

Array of objects

A list of state changes made to the entity. Entity states for Company [active, inactive, deleted].

Array

state	string state of the entity.
date	string timestamp when the state was recorded ISO 8601 UTC format.
reason	string additional information for the 'state' change.
actioned_by	string username of the person who updated the state of the entity (if applicable).

Array of objects

Array

type	string
detail	string

400

Bad Request

put/{state}/v1/config/companies/{id}

Request samples

Payload

application/json

{"update_date": "2023-12-14T05:27:39Z",
"name": "Trace Updated Company Name",
"contacts": [{"first_name": "New User",
"last_name": "Last Name",
"email_address": "new_email@test.com",
"phone_number": "123-456-7890"
}
]
}

Response samples

application/json

{"results": {"type": "object",
"data": {"id": "6ba36fba946d4de583b2f994f6297fd8",
"name": "Trace Updated Company Name",
"parent_id": "",
"contacts": [{"first_name": "Yuki",
"last_name": "Mori",
"email_address": "ymori@Trace.com",
"phone_number": "408-123-4567"
},
{"first_name": "New User",
"last_name": "Last Name",
"email_address": "new_email@test.com",
"phone_number": "123-456-7890"
}
],
"web_site": "https://kmplcannabis.com",
"entity_state": [{"state": "active",
"date": "2021-01-12T11:42:12Z",
"reason": "company created",
"actioned_by": "jpp@kmp.com"
},
{"state": "updated",
"date": "2023-12-14T05:27:39Z",
"reason": "company updated",
"actioned_by": "user@greencheckverified.com"
},
{"state": "field updates",
"date": "2023-12-14T05:27:39Z",
"reason": "company.name, contacts updated",
"actioned_by": "user@greencheckverified.com"
}
]
}
},
"warnings": [ ]
}

Delete company

Delete the company details.

SecurityApiKeyAuth and CustomAuth

Request

path Parameters

id required	string Reference (entity_ID) for the company you are deleting. Example: 1234
state required	string Lower case ANSI standard 38:2009 USPS codes of the US state where licensee is operating. Enum: "ca" "or" "nv" "mt" "co" "mi" "il" "ma" "ri" "nj" "md" "de" "va" "oh" "ky" "al" "ms" "mn" "la" "ok" "sd" "me"

header Parameters

x-api-key required	string Trace API key header Example: b123x21wbHlkYXBpa2V5
Authorization required	string Company and user credentials authentication Example: KMP-JSON token=dmVuZG9yLWFwaS1rZXk6dX12312sdfs2V5

Responses

200

Response Schema: application/json

object

type

string

Value: "object"

object

Trace

id	string Reference (entity_ID) for the company.
deleted	boolean True if the company was deleted successfully, otherwise false.

Array of objects

Array

type	string
detail	string

400

Bad Request

delete/{state}/v1/config/companies/{id}

Response samples

application/json

{"results": {"type": "object",
"data": {"id": "234",
"deleted": true
}
},
"warnings": [ ]
}

➔ Next to Facility