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

Get Service Provider CRB

Request

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

Service Provider Id

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

CRB Id

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

Responses

Ok

Bodyapplication/json
idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
namestringrequired

Organization name

street_addressstringrequired

Street Address

street_address_2string or nullrequired

Street Address 2

citystring or null^[a-zA-Z\s]+$required

City

einstring or null^\d{2}-\d{7}$required

EIN (Employer Identification Number) - ##-#######

phone_numberstring or null^\(\d{3}\)\s\d{3}-\d{4}$required

Phone Number - (###) ####-####

postal_codestring or null^\d{5}(?:[-\s]?\d{4})?$required

Postal Code

countrystring or nullrequired

Country

statestringrequired

Enumeration of all of the United States

Enum"AL""AK""AZ""AR""AS""CA""CO""CT""DE""DC"
websitestring or null^(https?:\/\/)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\...required

Website

timezonestringrequired
Enum"America/New_York""America/Detroit""America/Kentucky/Louisville""America/Kentucky/Monticello""America/Indiana/Indianapolis""America/Indiana/Vincennes""America/Indiana/Winamac""America/Indiana/Marengo""America/Indiana/Petersburg""America/Indiana/Vevay"
mailing_street_addressstring or nullrequired

Mailing Street Address

mailing_citystring or null^[a-zA-Z\s]+$required

Mailing City

mailing_statestring or nullrequired

Mailing State

Enum"AL""AK""AZ""AR""AS""CA""CO""CT""DE""DC"
mailing_postal_codestring or null^\d{5}(?:[-\s]?\d{4})?$required

Mailing Postal Code

established_datestring or null^[2][0][0-9]{2}[-]([0][0-9]|[1][0-2])[-]([0-2...required

Date the dispensary was established

ftEmployeesinteger or null(int32)>= 0required
ptEmployeesinteger or null(int32)>= 0required
entityTypestring or nullrequired

Type of business entity

Enum"sole""partnership""corporation""llc"
dbastring or nullrequired

Doing Business As

monthlySalesstring or nullrequired

Estimated amouunt of monthly sales

monthlyCustomersinteger or null(int32)>= 0required
org_typestringrequired
Enum"bank""dispensary""gcv""transport_vendor""muo""data_integrator_client"
business_typestring or nullrequired
Enum"retail""wholesale"
template_idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
template_result_idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
statusstringrequired
Enum"bank_disconnected""bank_approved""bank_review_in_progress""bank_awaiting_review""bank_in_progress""bank_pending""gcv_approved""gcv_awaiting_review""gcv_in_progress""gcv_pending"
pos_configsArray of objectsrequired
pos_configs[].​namestringrequired
Enum"Alleaves""Dutchie""Dutchie Wholesale""Cova""Meadow""MJ Freeway""MJ Freeway Wholesale""Greenbits""GrowFlow""GrowFlow Wholesale"
pos_configs[].​updated_datestring(date-time)required
pos_configs[].​statusstring
Enum"Connected""Not Connected""Needs Attention""Pending"
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "street_address": "string",
  "street_address_2": "string",
  "city": "string",
  "ein": "string",
  "phone_number": "string",
  "postal_code": "string",
  "country": "string",
  "state": "AL",
  "website": "string",
  "timezone": "America/New_York",
  "mailing_street_address": "string",
  "mailing_city": "string",
  "mailing_state": "AL",
  "mailing_postal_code": "string",
  "established_date": "string",
  "ftEmployees": 0,
  "ptEmployees": 0,
  "entityType": "sole",
  "dba": "string",
  "monthlySales": "string",
  "monthlyCustomers": 0,
  "org_type": "bank",
  "business_type": "retail",
  "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
  "template_result_id": "5a0d04e4-518d-4127-b0bc-0fd3b21b1173",
  "status": "bank_disconnected",
  "pos_configs": [
    {
      "name": "Alleaves",
      "status": "Connected",
      "updated_date": "2019-08-24T14:15:22Z"
    }
  ]
}

Update business details of a CRB

Request

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

Service Provider Id

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

CRB Id

Bodyapplication/jsonrequired
timezonestring
Enum"America/New_York""America/Detroit""America/Kentucky/Louisville""America/Kentucky/Monticello""America/Indiana/Indianapolis""America/Indiana/Vincennes""America/Indiana/Winamac""America/Indiana/Marengo""America/Indiana/Petersburg""America/Indiana/Vevay"
street_addressstring

Street Address

street_address_2string

Street Address 2

citystring^[a-zA-Z\s]+$

City

postal_codestring^\d{5}(?:[-\s]?\d{4})?$

Postal Code

countrystring

Enumeration of all of the countries on Earth

Enum"Afghanistan""Albania""Algeria""American Samoa""Andorra""Angola""Anguilla""Antigua & Barbuda""Argentina""Armenia"
mailing_street_addressstring

Mailing Street Address

mailing_citystring^[a-zA-Z\s]+$

City

mailing_statestring

Enumeration of all of the United States

Enum"AL""AK""AZ""AR""AS""CA""CO""CT""DE""DC"
mailing_postal_codestring^\d{5}(?:[-\s]?\d{4})?$

Postal Code

einstring^\d{2}-\d{7}$

EIN (Employer Identification Number) - ##-#######

phone_numberstring^\(\d{3}\)\s\d{3}-\d{4}$

Phone Number - (###) ####-####

websitestring^(https?:\/\/)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\...

Website

established_datestring^[2][0][0-9]{2}[-]([0][0-9]|[1][0-2])[-]([0-2...
ftEmployeesinteger(int32)>= 0
ptEmployeesinteger(int32)>= 0
entityTypestring
Enum"sole""partnership""corporation""llc"
dbastring

DBA (Doing Business As)

monthlySalesinteger(int32)>= 0
monthlyCustomersinteger(int32)>= 0
curl -i -X PUT \
  'https://developer.greencheckverified.com/_mock/apis/swagger/service-providers/{sp_id}/crbs/{crb_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "timezone": "America/New_York",
    "street_address": "string",
    "street_address_2": "string",
    "city": "string",
    "postal_code": "string",
    "country": "Afghanistan",
    "mailing_street_address": "string",
    "mailing_city": "string",
    "mailing_state": "AL",
    "mailing_postal_code": "string",
    "ein": "string",
    "phone_number": "string",
    "website": "string",
    "established_date": "string",
    "ftEmployees": 0,
    "ptEmployees": 0,
    "entityType": "sole",
    "dba": "string",
    "monthlySales": 0,
    "monthlyCustomers": 0
  }'

Responses

Ok

Bodyapplication/json
idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
namestringrequired

Organization name

street_addressstringrequired

Street Address

street_address_2string or nullrequired

Street Address 2

citystring or null^[a-zA-Z\s]+$required

City

einstring or null^\d{2}-\d{7}$required

EIN (Employer Identification Number) - ##-#######

phone_numberstring or null^\(\d{3}\)\s\d{3}-\d{4}$required

Phone Number - (###) ####-####

postal_codestring or null^\d{5}(?:[-\s]?\d{4})?$required

Postal Code

countrystring or nullrequired

Country

statestringrequired

Enumeration of all of the United States

Enum"AL""AK""AZ""AR""AS""CA""CO""CT""DE""DC"
websitestring or null^(https?:\/\/)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\...required

Website

timezonestringrequired
Enum"America/New_York""America/Detroit""America/Kentucky/Louisville""America/Kentucky/Monticello""America/Indiana/Indianapolis""America/Indiana/Vincennes""America/Indiana/Winamac""America/Indiana/Marengo""America/Indiana/Petersburg""America/Indiana/Vevay"
mailing_street_addressstring or nullrequired

Mailing Street Address

mailing_citystring or null^[a-zA-Z\s]+$required

Mailing City

mailing_statestring or nullrequired

Mailing State

Enum"AL""AK""AZ""AR""AS""CA""CO""CT""DE""DC"
mailing_postal_codestring or null^\d{5}(?:[-\s]?\d{4})?$required

Mailing Postal Code

established_datestring or null^[2][0][0-9]{2}[-]([0][0-9]|[1][0-2])[-]([0-2...required

Date the dispensary was established

ftEmployeesinteger or null(int32)>= 0required
ptEmployeesinteger or null(int32)>= 0required
entityTypestring or nullrequired

Type of business entity

Enum"sole""partnership""corporation""llc"
dbastring or nullrequired

Doing Business As

monthlySalesstring or nullrequired

Estimated amouunt of monthly sales

monthlyCustomersinteger or null(int32)>= 0required
org_typestringrequired
Enum"bank""dispensary""gcv""transport_vendor""muo""data_integrator_client"
business_typestring or nullrequired
Enum"retail""wholesale"
template_idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
template_result_idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
statusstringrequired
Enum"bank_disconnected""bank_approved""bank_review_in_progress""bank_awaiting_review""bank_in_progress""bank_pending""gcv_approved""gcv_awaiting_review""gcv_in_progress""gcv_pending"
pos_configsArray of objectsrequired
pos_configs[].​namestringrequired
Enum"Alleaves""Dutchie""Dutchie Wholesale""Cova""Meadow""MJ Freeway""MJ Freeway Wholesale""Greenbits""GrowFlow""GrowFlow Wholesale"
pos_configs[].​updated_datestring(date-time)required
pos_configs[].​statusstring
Enum"Connected""Not Connected""Needs Attention""Pending"
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "street_address": "string",
  "street_address_2": "string",
  "city": "string",
  "ein": "string",
  "phone_number": "string",
  "postal_code": "string",
  "country": "string",
  "state": "AL",
  "website": "string",
  "timezone": "America/New_York",
  "mailing_street_address": "string",
  "mailing_city": "string",
  "mailing_state": "AL",
  "mailing_postal_code": "string",
  "established_date": "string",
  "ftEmployees": 0,
  "ptEmployees": 0,
  "entityType": "sole",
  "dba": "string",
  "monthlySales": "string",
  "monthlyCustomers": 0,
  "org_type": "bank",
  "business_type": "retail",
  "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
  "template_result_id": "5a0d04e4-518d-4127-b0bc-0fd3b21b1173",
  "status": "bank_disconnected",
  "pos_configs": [
    {
      "name": "Alleaves",
      "status": "Connected",
      "updated_date": "2019-08-24T14:15:22Z"
    }
  ]
}

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

Documents

Operations

Inventory

Operations

Inventory Locations

Operations

Products

Operations

Sales

Operations