Skip to content
/
Get service provider

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

Get service provider

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

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

Responses

Ok

Bodyapplication/json
idstringrequired

ID

namestringrequired

Organization name

street_addressstringrequired

Street Address

citystringrequired

City

einstringrequired

Employer Identification Number

phone_numberstringrequired

Phone Number

postal_codestringrequired

Postal Code

countrystringrequired

Country

statestringrequired

Enumeration of all of the United States

Enum"AL""AK""AZ""AR""AS""CA""CO""CT""DE""DC"
websitestringrequired

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"
primary_point_of_contactobject
primary_point_of_contact.​phoneNumberstringrequired
primary_point_of_contact.​emailAddressstringrequired
primary_point_of_contact.​titlestringrequired
primary_point_of_contact.​lastNamestringrequired
primary_point_of_contact.​firstNamestringrequired
Response
application/json
{
  "id": "string",
  "name": "string",
  "street_address": "string",
  "city": "string",
  "ein": "string",
  "phone_number": "string",
  "postal_code": "string",
  "country": "string",
  "state": "AL",
  "website": "string",
  "timezone": "America/New_York",
  "primary_point_of_contact": {
    "phoneNumber": "string",
    "emailAddress": "string",
    "title": "string",
    "lastName": "string",
    "firstName": "string"
  }
}

Get service provider CRBs

Request

Get all CRBs for service provider

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

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

Responses

Ok

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

Organization name

property name*.​street_addressstringrequired

Street Address

property name*.​street_address_2string or nullrequired

Street Address 2

property name*.​citystring or null^[a-zA-Z\s]+$required

City

property name*.​einstring or null^\d{2}-\d{7}$required

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

property name*.​phone_numberstring or null^\(\d{3}\)\s\d{3}-\d{4}$required

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

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

Postal Code

property name*.​countrystring or nullrequired

Country

property name*.​statestringrequired

Enumeration of all of the United States

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

Website

property name*.​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"
property name*.​mailing_street_addressstring or nullrequired

Mailing Street Address

property name*.​mailing_citystring or null^[a-zA-Z\s]+$required

Mailing City

property name*.​mailing_statestring or nullrequired

Mailing State

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

Mailing Postal Code

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

Date the dispensary was established

property name*.​ftEmployeesinteger or null(int32)>= 0required
property name*.​ptEmployeesinteger or null(int32)>= 0required
property name*.​entityTypestring or nullrequired

Type of business entity

Enum"sole""partnership""corporation""llc"
property name*.​dbastring or nullrequired

Doing Business As

property name*.​monthlySalesstring or nullrequired

Estimated amouunt of monthly sales

property name*.​monthlyCustomersinteger or null(int32)>= 0required
property name*.​org_typestringrequired
Enum"bank""dispensary""gcv""transport_vendor""muo""data_integrator_client"
property name*.​business_typestring or nullrequired
Enum"retail""wholesale"
property name*.​template_idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
property name*.​template_result_idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...required
property name*.​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"
property name*.​pos_configsArray of objectsrequired
property name*.​pos_configs[].​namestringrequired
Enum"Alleaves""Dutchie""Dutchie Wholesale""Cova""Meadow""MJ Freeway""MJ Freeway Wholesale""Greenbits""GrowFlow""GrowFlow Wholesale"
property name*.​pos_configs[].​updated_datestring(date-time)required
property name*.​pos_configs[].​statusstring
Enum"Connected""Not Connected""Needs Attention""Pending"
Response
application/json
{
  "et4": {
    "pos_configs": [
      {
        "name": "Manual Upload Wholesale",
        "updated_date": "2023-10-31T15:18:22.000Z"
      },
      {
        "name": "MJ Freeway Wholesale",
        "updated_date": "2023-10-31T15:18:22.000Z"
      },
      {
        "name": "Dutchie",
        "status": "Pending",
        "updated_date": "2023-10-31T15:18:22.000Z"
      },
      {
        "name": "Proteus420",
        "status": "Not Connected",
        "updated_date": "2023-10-31T15:18:22.000Z"
      },
      {
        "name": "Treez IO Test Account",
        "updated_date": "2023-02-28T14:01:33.000Z"
      }
    ],
    "org_type": "muo",
    "business_type": null,
    "template_id": "1E24CE5A-Fd29-6e59-EFCD-c3F6068b6Cd9",
    "template_result_id": "c8cc1dcb-095e-2dFa-0a26-0fBc37e3ECFe",
    "status": "bank_awaiting_review",
    "mailing_street_address": "123 Main St",
    "mailing_city": "Denver",
    "mailing_state": "MT",
    "mailing_postal_code": "85001",
    "established_date": "2020-05-05T00:00:00.000Z",
    "ftEmployees": 22,
    "ptEmployees": 43,
    "entityType": "sole",
    "dba": "Green Checks",
    "monthlySales": "1000",
    "monthlyCustomers": 84207616,
    "id": "46D04CAD-30F8-dFfC-dee9-60fE985dF96f",
    "name": "Dispensary1",
    "street_address": "22920 Lake Road",
    "street_address_2": "Suite 317",
    "city": null,
    "ein": "12-3456789",
    "phone_number": "(555) 555-5555",
    "postal_code": null,
    "country": "unitedstates",
    "state": "MN",
    "website": null,
    "timezone": "America/Metlakatla"
  }
}

Create CRB

Request

Create a new CRB and associate with service provider.

There are two supported onboarding workflows:

  1. Provide POS Credentials Up Front (pos_info)

    • Use when the CRB has already provided their POS credentials.
    • Include the pos_info object in your request.
    • Inviting users is optional.

  2. Invite the CRB for In-App Onboarding

    • Use when you don't have the CRB's POS credentials yet.
    • Do NOT include pos_info.
    • MUST include at least one user in the users array to send an invite.

Note: You MUST provide either pos_info OR users with at least one entry. You may also provide both.

Validation Rules

If pos_info is provided:

  • Org business_type must match pos_type (e.g. wholesale org must use a wholesale POS like "Dutchie Wholesale").
  • Credentials must be valid; a test POS call is made.
  • If the POS requires a location_id, it must be valid.
    • If missing or invalid, a validation error is returned with valid options.
  • The org must not already be connected to your account.

If pos_info is NOT provided:

  • At least one user must be included in the users array.

Testing Scenarios (Sandbox Only)

  1. Provide pos_info with a wholesale POS, but business_type = "retail" → Expect validation error.
  2. Provide pos_info with:
    • pos_type = "Greenbits"
    • username = "testing"
    • password = "invalid_testing" → Simulates invalid credentials
    • password = "testing" → Simulates valid credentials
  3. Leave location_id empty → Simulates missing required location, returns available options.
  4. Set location_id = "invalidLocation" → Simulates invalid location, returns available options.
  5. Set location_id = "testing" → Simulates successful connection (no actual POS connection made).
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

Bodyapplication/jsonrequired
orgobjectrequired
org.​business_typestringrequired
Enum"retail""wholesale"
org.​statestringrequired

Enumeration of all of the United States

Enum"AL""AK""AZ""AR""AS""CA""CO""CT""DE""DC"
org.​namestringrequired
org.​monthlyCustomersinteger(int32)>= 0
org.​monthlySalesinteger(int32)>= 0
org.​dbastring

DBA (Doing Business As)

org.​entityTypestring
Enum"sole""partnership""corporation""llc"
org.​ptEmployeesinteger(int32)>= 0
org.​ftEmployeesinteger(int32)>= 0
org.​established_datestring^[2][0][0-9]{2}[-]([0][0-9]|[1][0-2])[-]([0-2...
org.​websitestring^(https?:\/\/)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\...

Website

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

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

org.​einstring^\d{2}-\d{7}$

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

org.​mailing_postal_codestring^\d{5}(?:[-\s]?\d{4})?$

Postal Code

org.​mailing_statestring

Enumeration of all of the United States

Enum"AL""AK""AZ""AR""AS""CA""CO""CT""DE""DC"
org.​mailing_citystring^[a-zA-Z\s]+$

City

org.​mailing_street_addressstring

Mailing Street Address

org.​countrystring

Enumeration of all of the countries on Earth

Enum"Afghanistan""Albania""Algeria""American Samoa""Andorra""Angola""Anguilla""Antigua & Barbuda""Argentina""Armenia"
org.​postal_codestring^\d{5}(?:[-\s]?\d{4})?$

Postal Code

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

City

org.​street_address_2string

Street Address 2

org.​street_addressstring

Street Address

org.​primary_contact_emailstring

Primary contact email of the CRB to help facilitate notification emails. If not provided, default to support

org.​template_idstring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...
org.​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"
pos_infoobject
pos_info.​pos_credentialsobjectrequired
Any of:

You can connect your Alleaves account to Green Check by simply using your Alleaves username and password. First, you'll want to ensure that your user has the proper API access permissions in order for the integration to succeed. If your user has admin permissions, it should have the proper access by default.

https://support.greencheckverified.com/knowledge/connect-alleaves-to-green-check

pos_info.​pos_credentials.​usernamestringrequired
pos_info.​pos_credentials.​passwordstringrequired
pos_info.​pos_typestringrequired
Enum"Alleaves""BioTrack""BioTrack Wholesale""Blaze""Canix""Dutchie""Dutchie Wholesale""Flourish Wholesale""Flowhub""Greenbits"
pos_info.​location_idstring or number

Location ID to specify which specific location within the POS is related to this CRB. Optional. If not provided and the selected POS requires location ID, we will return an error message with available locations so that you can provide one and call again

Any of:

Location ID to specify which specific location within the POS is related to this CRB. Optional. If not provided and the selected POS requires location ID, we will return an error message with available locations so that you can provide one and call again

string
usersArray of objects

CRB users to invite

users[].​emailstringrequired
users[].​lastNamestringrequired
users[].​firstNamestringrequired
users[].​phonestring
optionsobject
options.​onboarding_requiredboolean

True to leave this CRB in pending state. Requires users to be present so that we can invite them to complete onboarding on-app. Defaults to false and CRBs are auto-approved.

curl -i -X POST \
  'https://developer.greencheckverified.com/_mock/apis/swagger/service-providers/{sp_id}/crbs' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "org": {
      "monthlyCustomers": 0,
      "monthlySales": 0,
      "dba": "string",
      "entityType": "sole",
      "ptEmployees": 0,
      "ftEmployees": 0,
      "established_date": "string",
      "website": "string",
      "phone_number": "string",
      "ein": "string",
      "mailing_postal_code": "string",
      "mailing_state": "AL",
      "mailing_city": "string",
      "mailing_street_address": "string",
      "country": "Afghanistan",
      "postal_code": "string",
      "city": "string",
      "street_address_2": "string",
      "street_address": "string",
      "primary_contact_email": "string",
      "business_type": "retail",
      "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
      "timezone": "America/New_York",
      "state": "AL",
      "name": "string"
    },
    "pos_info": {
      "location_id": "string",
      "pos_credentials": {
        "username": "string",
        "password": "string"
      },
      "pos_type": "Alleaves"
    },
    "users": [
      {
        "phone": "string",
        "email": "string",
        "lastName": "string",
        "firstName": "string"
      }
    ],
    "options": {
      "onboarding_required": true
    }
  }'

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
Response
application/json
{
  "mailing_street_address": "131 Main St",
  "mailing_city": "Los Angeles",
  "mailing_state": "MI",
  "mailing_postal_code": "80202",
  "established_date": "2021-06-06T00:00:00.000Z",
  "ftEmployees": null,
  "ptEmployees": 43,
  "entityType": "llc",
  "dba": "Green Check Dispensary",
  "monthlySales": "20000",
  "monthlyCustomers": null,
  "id": "6c1E91E6-1ffA-C89D-E2Be-7f48EeF58DCd",
  "name": "Dispensary2",
  "street_address": "30776 Berge Mountain",
  "street_address_2": null,
  "city": null,
  "ein": "55-5555555",
  "phone_number": "(555) 555-5555",
  "postal_code": null,
  "country": "unitedstates",
  "state": "NM",
  "website": "https://genuine-parsley.name/",
  "timezone": "Pacific/Guam"
}

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

Documents

Operations

Inventory

Operations

Inventory Locations

Operations

Products

Operations

Sales

Operations