Skip to content

Green Check Access (1.0.0)

Green Check Access

Overview
Languages
Servers
Mock server
https://developer.greencheckverified.com/_mock/apis/swagger
Sandbox server
https://sandbox-api.greencheckverified.com
Production server
https://prod-api.greencheckverified.com

Authentication

Operations

Service Provider

Operations

CRB Info

Operations

CRB Customers

Operations

CRB Documents

Operations

CRB Inventory

Operations

CRB Inventory Locations

Operations

CRB Products

Operations

CRB Sales

Operations

CRB Templates

Operations

CRB

Operations

Customers

Operations

Get CRB customers

Request

Security
access_auth
Path
crb_idstring^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required

CRB Id

Query
limitinteger(int32)[ 1 .. 1000 ]

The page size

Default 1000
offsetinteger(int32)>= 0

The page offset

Default 0
last_updated_fromstring^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|...

Last updated from date: yyyy-MM-dd

last_updated_tostring^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|...

Last updated to date: yyyy-MM-dd

curl -i -X GET \
  'https://developer.greencheckverified.com/_mock/apis/swagger/crbs/{crb_id}/customers?limit=1000&offset=0&last_updated_from=string&last_updated_to=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
metadataobjectrequired
metadata.​totalinteger(int32)>= 0required
metadata.​countstringrequired

Range of items returned

dataArray of objectsrequired
data[].​crb_idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
data[].​idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
data[].​pos_typestringrequired
Enum"Alleaves""Apex Trading Wholesale""Dutchie""Dutchie Wholesale""Cova""Meadow""MJ Freeway""MJ Freeway Wholesale""Greenbits""GrowFlow"
data[].​pos_customer_idstringrequired

ID of the customer in the POS

data[].​first_namestring or nullrequired

Hashed first name

data[].​last_namestring or nullrequired

Hashed last name

data[].​middle_namestring or nullrequired

Hashed middle name

data[].​dobstring or nullrequired

Plain date field for customer date of birth

data[].​address_1string or nullrequired

Customer address

data[].​address_2string or nullrequired

Additional Customer address

data[].​citystring or nullrequired

City

data[].​statestring or nullrequired

State

data[].​zip_codestring or nullrequired

Zip code

data[].​phonestring or nullrequired

Hashed phone number

data[].​cell_phonestring or nullrequired

Hashed cell phone number

data[].​email_addressstring or nullrequired

Hashed email address

data[].​genderstring or nullrequired

Gender

Enum"Male""Female""Other"
data[].​pos_identification_typestring or nullrequired

Main form of identification used by the customer

data[].​pos_customer_typestring or nullrequired

Raw POS value for customer type, used to determine if medical or recreational

data[].​gc_customer_typestring or nullrequired

Customer type determined by GCV, Medical or Recreational

Enum"medical""rec"
data[].​medical_idstring or nullrequired

Hashed medical ID

data[].​medical_id_expiration_datestring or nullrequired

Medical ID expiration date

data[].​drivers_license_idstring or nullrequired

Hashed drivers license ID

data[].​drivers_license_expiration_datestring or nullrequired

Drivers license expiration date

data[].​other_idstring or nullrequired

Hashed other license ID

data[].​other_id_expiration_datestring or nullrequired

Other ID expiration

data[].​caregiverboolean or nullrequired

True if this customer is a caregiver

data[].​loyalty_memberboolean or nullrequired

True if this customer is a loyalty member

data[].​loyalty_pointsstring or nullrequired

Number of accrued loyalty points

data[].​anonymousboolean or nullrequired

True if this is an anonymous customer, can depend on the state

data[].​pos_updated_datestring or nullrequired

the timestamp reported by the pos for the last update to this record in UTC

data[].​pos_updated_date_localstring or nullrequired

the timestamp reported by the pos for the last update to this record in the crb local time

data[].​gc_updated_datestring or nullrequired

the timestamp of this records insertion/updates in UTC

data[].​gc_created_datestring or nullrequired
Response
application/json
{
  "data": [
    {
      "crb_id": "ae8ea67E-FE5E-bb8E-166F-DA1d2d838918",
      "id": "baCf7E28-fEbb-75Cd-d3C8-482F5Da72CbE",
      "pos_type": "IndicaOnline",
      "pos_customer_id": "velit nostrud",
      "first_name": "amet magna",
      "last_name": "dolor aute id fugiat",
      "middle_name": null,
      "dob": null,
      "address_1": null,
      "address_2": "officia",
      "city": "non",
      "state": "occaecat nulla eu amet laboris",
      "zip_code": null,
      "phone": "amet nulla",
      "cell_phone": null,
      "email_address": null,
      "gender": null,
      "pos_identification_type": "tempor",
      "pos_customer_type": "aliquip ut",
      "gc_customer_type": null,
      "medical_id": null,
      "medical_id_expiration_date": null,
      "drivers_license_id": null,
      "drivers_license_expiration_date": null,
      "other_id": null,
      "other_id_expiration_date": "qui",
      "caregiver": null,
      "loyalty_member": false,
      "loyalty_points": null,
      "anonymous": false,
      "pos_updated_date": "in voluptate cupidatat nostrud",
      "pos_updated_date_local": "eu magna ea Lorem aute",
      "gc_updated_date": "officia deserunt fugiat nisi irure",
      "gc_created_date": "pariatur magna nulla elit"
    },
    {
      "crb_id": "F1C05B14-E405-2CfD-3EBD-CFa8B07e9e2d",
      "id": "Fc8ADAf7-7E43-0a24-Ea46-1a1cd7389bd6",
      "pos_type": "Dutchie Wholesale",
      "pos_customer_id": "et magna fugiat Excepteur",
      "first_name": null,
      "last_name": null,
      "middle_name": "ipsum commodo",
      "dob": null,
      "address_1": null,
      "address_2": "anim ex cillum",
      "city": null,
      "state": "dolor ipsum",
      "zip_code": "Ut ea velit nostrud",
      "phone": null,
      "cell_phone": null,
      "email_address": null,
      "gender": "Other",
      "pos_identification_type": "ea deserunt aliquip ut est",
      "pos_customer_type": "nulla adipisicing consequat dolor",
      "gc_customer_type": null,
      "medical_id": "dolore in proident labore",
      "medical_id_expiration_date": null,
      "drivers_license_id": null,
      "drivers_license_expiration_date": null,
      "other_id": null,
      "other_id_expiration_date": "sint in ipsum ea dolore",
      "caregiver": true,
      "loyalty_member": null,
      "loyalty_points": 93104291.96721986,
      "anonymous": null,
      "pos_updated_date": null,
      "pos_updated_date_local": "ullamco enim",
      "gc_updated_date": "aliqua enim ut dolore",
      "gc_created_date": "aliqua laboris"
    },
    {
      "crb_id": "AC2BcDbb-Bbeb-28E0-be1C-d88eEcF3Bf8A",
      "id": "0f731f1F-BF4d-Cd65-F0b0-0D8f1f86FceD",
      "pos_type": "Blaze",
      "pos_customer_id": "ipsum est dolore",
      "first_name": "minim",
      "last_name": null,
      "middle_name": "nostrud et in nulla Duis",
      "dob": "nostrud minim occaecat magna",
      "address_1": "in nostrud reprehenderit elit dolore",
      "address_2": null,
      "city": null,
      "state": "minim",
      "zip_code": "sed nostrud irure est laborum",
      "phone": "in",
      "cell_phone": null,
      "email_address": null,
      "gender": null,
      "pos_identification_type": null,
      "pos_customer_type": "nostrud qui officia",
      "gc_customer_type": "rec",
      "medical_id": "exercitation ea ex",
      "medical_id_expiration_date": null,
      "drivers_license_id": null,
      "drivers_license_expiration_date": null,
      "other_id": "culpa",
      "other_id_expiration_date": null,
      "caregiver": false,
      "loyalty_member": null,
      "loyalty_points": null,
      "anonymous": null,
      "pos_updated_date": "pariatur irure amet",
      "pos_updated_date_local": "cupidatat Lorem occaecat dolore commodo",
      "gc_updated_date": null,
      "gc_created_date": null
    }
  ],
  "metadata": {
    "count": "1 - 100",
    "total": 10376620
  }
}

Get CRB customer record by ID

Request

Security
access_auth
Path
crb_idstring^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required

CRB Id

customer_idstring^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required

Customer Id

curl -i -X GET \
  'https://developer.greencheckverified.com/_mock/apis/swagger/crbs/{crb_id}/customers/{customer_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
crb_idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
pos_typestringrequired
Enum"Alleaves""Apex Trading Wholesale""Dutchie""Dutchie Wholesale""Cova""Meadow""MJ Freeway""MJ Freeway Wholesale""Greenbits""GrowFlow"
pos_customer_idstringrequired

ID of the customer in the POS

first_namestring or nullrequired

Hashed first name

last_namestring or nullrequired

Hashed last name

middle_namestring or nullrequired

Hashed middle name

dobstring or nullrequired

Plain date field for customer date of birth

address_1string or nullrequired

Customer address

address_2string or nullrequired

Additional Customer address

citystring or nullrequired

City

statestring or nullrequired

State

zip_codestring or nullrequired

Zip code

phonestring or nullrequired

Hashed phone number

cell_phonestring or nullrequired

Hashed cell phone number

email_addressstring or nullrequired

Hashed email address

genderstring or nullrequired

Gender

Enum"Male""Female""Other"
pos_identification_typestring or nullrequired

Main form of identification used by the customer

pos_customer_typestring or nullrequired

Raw POS value for customer type, used to determine if medical or recreational

gc_customer_typestring or nullrequired

Customer type determined by GCV, Medical or Recreational

Enum"medical""rec"
medical_idstring or nullrequired

Hashed medical ID

medical_id_expiration_datestring or nullrequired

Medical ID expiration date

drivers_license_idstring or nullrequired

Hashed drivers license ID

drivers_license_expiration_datestring or nullrequired

Drivers license expiration date

other_idstring or nullrequired

Hashed other license ID

other_id_expiration_datestring or nullrequired

Other ID expiration

caregiverboolean or nullrequired

True if this customer is a caregiver

loyalty_memberboolean or nullrequired

True if this customer is a loyalty member

loyalty_pointsstring or nullrequired

Number of accrued loyalty points

anonymousboolean or nullrequired

True if this is an anonymous customer, can depend on the state

pos_updated_datestring or nullrequired

the timestamp reported by the pos for the last update to this record in UTC

pos_updated_date_localstring or nullrequired

the timestamp reported by the pos for the last update to this record in the crb local time

gc_updated_datestring or nullrequired

the timestamp of this records insertion/updates in UTC

gc_created_datestring or nullrequired
Response
application/json
{
  "crb_id": "AFddb33E-5aBE-5Df7-9dfA-Ec2E37988972",
  "id": "6Cd0dEc0-8DDD-65A2-1eCF-aEb5FCa7241F",
  "pos_type": "Unsupported",
  "pos_customer_id": "mollit ullamco",
  "first_name": "in elit amet Duis",
  "last_name": null,
  "middle_name": null,
  "dob": "adipisicing aliquip eiusmod",
  "address_1": "proident tempor",
  "address_2": null,
  "city": null,
  "state": null,
  "zip_code": "aliqua cillum in aute",
  "phone": null,
  "cell_phone": null,
  "email_address": null,
  "gender": "Male",
  "pos_identification_type": null,
  "pos_customer_type": "ullamco Duis",
  "gc_customer_type": "rec",
  "medical_id": null,
  "medical_id_expiration_date": null,
  "drivers_license_id": "cillum nulla",
  "drivers_license_expiration_date": "deserunt dolore eiusmod Excepteur",
  "other_id": "occaecat",
  "other_id_expiration_date": "Ut dolore eu",
  "caregiver": false,
  "loyalty_member": false,
  "loyalty_points": null,
  "anonymous": true,
  "pos_updated_date": "ipsum anim in",
  "pos_updated_date_local": null,
  "gc_updated_date": null,
  "gc_created_date": null
}

Documents

Operations

Inventory

Operations

Inventory Locations

Operations

Products

Operations

Sales

Operations