PATCH
/
licenses
/
{license_id}
Patch License
curl --request PATCH \
  --url https://api-sandbox.synctera.com/v0/licenses/{license_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "license_number": 10321
}'
{
  "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "id": "7df5c505-b47c-490d-855f-c1b3cd99327f",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "last_verified_time": "2023-05-06T12:23:34.321Z",
  "license_classification": "RECREATIONAL_CANNABIS",
  "license_expiration_date": "2023-01-01",
  "license_issuance_date": "2023-01-01",
  "license_number": 10321,
  "license_type": "MRB",
  "license_type_description": "Limited Marijuana Cultivation Facility",
  "licensee_address": "1064 elm street, New York",
  "licensee_name": "Apex Corp",
  "licensing_authority": "Alcohol & Marijuana Control Office",
  "status": "ACCEPTED",
  "tenant": "abcdef_ghijkl"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
license_id
string<uuid>
required

License record identifier

Example:

"ba4f84d7-fa20-4010-a573-0bbca57ab589"

Body

application/json
​
license_number
string
required

The entity's license number

Minimum length: 1
Example:

10321

Response

Updated License representation.

​
creation_time
string<date-time>
required

The date and time the license resource was created.

Example:

"2010-05-06T12:23:34.321Z"

​
id
string<uuid>
required

License record unique id

Example:

"7df5c505-b47c-490d-855f-c1b3cd99327f"

​
last_updated_time
string<date-time>
required

The date and time the license resource was last updated.

Example:

"2010-05-06T12:23:34.321Z"

​
license_number
string
required

The entity's license number

Minimum length: 1
Example:

10321

​
license_type
enum<string>
required

The type of the license being created. For example, the license being created could be for MRB (Marijuana related business)

Available options:
MRB
Example:

"MRB"

​
status
enum<string>
required

The status of the license

Available options:
ACCEPTED,
REJECTED,
REVIEW,
UNVERIFIED
Example:

"ACCEPTED"

​
tenant
string
required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"

​
business_id
string<uuid>

Unique ID for the business. Exactly one of business_id or person_id must be set.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
customer_id
string<uuid>
Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

​
last_verified_time
string<date-time>

Timestamp of the last time the license was verified

Example:

"2023-05-06T12:23:34.321Z"

​
license_classification
enum<string>

The classification of the license

Available options:
MEDICAL_AND_RECREATIONAL_CANNABIS,
MEDICAL_CANNABIS,
RECREATIONAL_CANNABIS
Example:

"RECREATIONAL_CANNABIS"

​
license_expiration_date
string<date>

The date on which the license will expire

Example:

"2023-01-01"

​
license_issuance_date
string<date>

The date on which the license was issued

Example:

"2023-01-01"

​
license_type_description
string

Free-form text describing the type of the license

Example:

"Limited Marijuana Cultivation Facility"

​
licensee_address
string

The address of the entity that holds the license as reported by the verifying vendor

Example:

"1064 elm street, New York"

​
licensee_name
string

The name of the entity that holds the license that's reported by the verifying vendor

Example:

"Apex Corp"

​
licensing_authority
string

The name of the licensing body that granted the license

Example:

"Alcohol & Marijuana Control Office"