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

Get POS Credentials Schema

Request

Security
access_auth
Path
sp_idstringrequired
curl -i -X GET \
  'https://developer.greencheckverified.com/_mock/apis/swagger/service-providers/{sp_id}/pos-credentials-schema' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
Alleavesobjectrequired
Alleaves.​pos_credentials_schemaobjectrequired
Alleaves.​pos_credentials_schema.​credentials_namestringrequired
Alleaves.​pos_credentials_schema.​credentials_descriptionstringrequired
Alleaves.​pos_credentials_schema.​credentials_propertiesobjectrequired
Alleaves.​pos_credentials_schema.​required_propertiesArray of stringsrequired
Alleaves.​location_requiredbooleanrequired
Alleaves.​business_typestringrequired
Enum"retail""wholesale"
Alleaves.​pos_typestringrequired
Enum"Alleaves""BioTrack""BioTrack Wholesale""Blaze""Canix""Dutchie""Dutchie Wholesale""Flourish Wholesale""Flowhub""Greenbits"
Dutchieobjectrequired
Dutchie.​pos_credentials_schemaobjectrequired
Dutchie.​pos_credentials_schema.​credentials_namestringrequired
Dutchie.​pos_credentials_schema.​credentials_descriptionstringrequired
Dutchie.​pos_credentials_schema.​credentials_propertiesobjectrequired
Dutchie.​pos_credentials_schema.​required_propertiesArray of stringsrequired
Dutchie.​location_requiredbooleanrequired
Dutchie.​business_typestringrequired
Enum"retail""wholesale"
Dutchie.​pos_typestringrequired
Enum"Alleaves""BioTrack""BioTrack Wholesale""Blaze""Canix""Dutchie""Dutchie Wholesale""Flourish Wholesale""Flowhub""Greenbits"
Dutchie Wholesaleobjectrequired
Dutchie Wholesale.​pos_credentials_schemaobjectrequired
Dutchie Wholesale.​pos_credentials_schema.​credentials_namestringrequired
Dutchie Wholesale.​pos_credentials_schema.​credentials_descriptionstringrequired
Dutchie Wholesale.​pos_credentials_schema.​credentials_propertiesobjectrequired
Dutchie Wholesale.​pos_credentials_schema.​required_propertiesArray of stringsrequired
Dutchie Wholesale.​location_requiredbooleanrequired
Dutchie Wholesale.​business_typestringrequired
Enum"retail""wholesale"
Dutchie Wholesale.​pos_typestringrequired
Enum"Alleaves""BioTrack""BioTrack Wholesale""Blaze""Canix""Dutchie""Dutchie Wholesale""Flourish Wholesale""Flowhub""Greenbits"
Meadowobjectrequired
Meadow.​pos_credentials_schemaobjectrequired
Meadow.​pos_credentials_schema.​credentials_namestringrequired
Meadow.​pos_credentials_schema.​credentials_descriptionstringrequired
Meadow.​pos_credentials_schema.​credentials_propertiesobjectrequired
Meadow.​pos_credentials_schema.​required_propertiesArray of stringsrequired
Meadow.​location_requiredbooleanrequired
Meadow.​business_typestringrequired
Enum"retail""wholesale"
Meadow.​pos_typestringrequired
Enum"Alleaves""BioTrack""BioTrack Wholesale""Blaze""Canix""Dutchie""Dutchie Wholesale""Flourish Wholesale""Flowhub""Greenbits"
Greenbitsobjectrequired
Greenbits.​pos_credentials_schemaobjectrequired
Greenbits.​pos_credentials_schema.​credentials_namestringrequired
Greenbits.​pos_credentials_schema.​credentials_descriptionstringrequired
Greenbits.​pos_credentials_schema.​credentials_propertiesobjectrequired
Greenbits.​pos_credentials_schema.​required_propertiesArray of stringsrequired
Greenbits.​location_requiredbooleanrequired
Greenbits.​business_typestringrequired
Enum"retail""wholesale"
Greenbits.​pos_typestringrequired
Enum"Alleaves""BioTrack""BioTrack Wholesale""Blaze""Canix""Dutchie""Dutchie Wholesale""Flourish Wholesale""Flowhub""Greenbits"
GrowFlowobjectrequired
GrowFlow.​pos_credentials_schemaobjectrequired
GrowFlow.​pos_credentials_schema.​credentials_namestringrequired
GrowFlow.​pos_credentials_schema.​credentials_descriptionstringrequired
GrowFlow.​pos_credentials_schema.​credentials_propertiesobjectrequired
GrowFlow.​pos_credentials_schema.​required_propertiesArray of stringsrequired
GrowFlow.​location_requiredbooleanrequired
GrowFlow.​business_typestringrequired
Enum"retail""wholesale"
GrowFlow.​pos_typestringrequired
Enum"Alleaves""BioTrack""BioTrack Wholesale""Blaze""Canix""Dutchie""Dutchie Wholesale""Flourish Wholesale""Flowhub""Greenbits"
Flourish Wholesaleobjectrequired
Flourish Wholesale.​pos_credentials_schemaobjectrequired
Flourish Wholesale.​pos_credentials_schema.​credentials_namestringrequired
Flourish Wholesale.​pos_credentials_schema.​credentials_descriptionstringrequired
Flourish Wholesale.​pos_credentials_schema.​credentials_propertiesobjectrequired
Flourish Wholesale.​pos_credentials_schema.​required_propertiesArray of stringsrequired
Flourish Wholesale.​location_requiredbooleanrequired
Flourish Wholesale.​business_typestringrequired
Enum"retail""wholesale"
Flourish Wholesale.​pos_typestringrequired
Enum"Alleaves""BioTrack""BioTrack Wholesale""Blaze""Canix""Dutchie""Dutchie Wholesale""Flourish Wholesale""Flowhub""Greenbits"
Flowhubobjectrequired
Flowhub.​pos_credentials_schemaobjectrequired
Flowhub.​pos_credentials_schema.​credentials_namestringrequired
Flowhub.​pos_credentials_schema.​credentials_descriptionstringrequired
Flowhub.​pos_credentials_schema.​credentials_propertiesobjectrequired
Flowhub.​pos_credentials_schema.​required_propertiesArray of stringsrequired
Flowhub.​location_requiredbooleanrequired
Flowhub.​business_typestringrequired
Enum"retail""wholesale"
Flowhub.​pos_typestringrequired
Enum"Alleaves""BioTrack""BioTrack Wholesale""Blaze""Canix""Dutchie""Dutchie Wholesale""Flourish Wholesale""Flowhub""Greenbits"
BioTrackobjectrequired
BioTrack.​pos_credentials_schemaobjectrequired
BioTrack.​pos_credentials_schema.​credentials_namestringrequired
BioTrack.​pos_credentials_schema.​credentials_descriptionstringrequired
BioTrack.​pos_credentials_schema.​credentials_propertiesobjectrequired
BioTrack.​pos_credentials_schema.​required_propertiesArray of stringsrequired
BioTrack.​location_requiredbooleanrequired
BioTrack.​business_typestringrequired
Enum"retail""wholesale"
BioTrack.​pos_typestringrequired
Enum"Alleaves""BioTrack""BioTrack Wholesale""Blaze""Canix""Dutchie""Dutchie Wholesale""Flourish Wholesale""Flowhub""Greenbits"
BioTrack Wholesaleobjectrequired
BioTrack Wholesale.​pos_credentials_schemaobjectrequired
BioTrack Wholesale.​pos_credentials_schema.​credentials_namestringrequired
BioTrack Wholesale.​pos_credentials_schema.​credentials_descriptionstringrequired
BioTrack Wholesale.​pos_credentials_schema.​credentials_propertiesobjectrequired
BioTrack Wholesale.​pos_credentials_schema.​required_propertiesArray of stringsrequired
BioTrack Wholesale.​location_requiredbooleanrequired
BioTrack Wholesale.​business_typestringrequired
Enum"retail""wholesale"
BioTrack Wholesale.​pos_typestringrequired
Enum"Alleaves""BioTrack""BioTrack Wholesale""Blaze""Canix""Dutchie""Dutchie Wholesale""Flourish Wholesale""Flowhub""Greenbits"
Treezobjectrequired
Treez.​pos_credentials_schemaobjectrequired
Treez.​pos_credentials_schema.​credentials_namestringrequired
Treez.​pos_credentials_schema.​credentials_descriptionstringrequired
Treez.​pos_credentials_schema.​credentials_propertiesobjectrequired
Treez.​pos_credentials_schema.​required_propertiesArray of stringsrequired
Treez.​location_requiredbooleanrequired
Treez.​business_typestringrequired
Enum"retail""wholesale"
Treez.​pos_typestringrequired
Enum"Alleaves""BioTrack""BioTrack Wholesale""Blaze""Canix""Dutchie""Dutchie Wholesale""Flourish Wholesale""Flowhub""Greenbits"
Blazeobjectrequired
Blaze.​pos_credentials_schemaobjectrequired
Blaze.​pos_credentials_schema.​credentials_namestringrequired
Blaze.​pos_credentials_schema.​credentials_descriptionstringrequired
Blaze.​pos_credentials_schema.​credentials_propertiesobjectrequired
Blaze.​pos_credentials_schema.​required_propertiesArray of stringsrequired
Blaze.​location_requiredbooleanrequired
Blaze.​business_typestringrequired
Enum"retail""wholesale"
Blaze.​pos_typestringrequired
Enum"Alleaves""BioTrack""BioTrack Wholesale""Blaze""Canix""Dutchie""Dutchie Wholesale""Flourish Wholesale""Flowhub""Greenbits"
Sage Intacctobjectrequired
Sage Intacct.​pos_credentials_schemaobjectrequired
Sage Intacct.​pos_credentials_schema.​credentials_namestringrequired
Sage Intacct.​pos_credentials_schema.​credentials_descriptionstringrequired
Sage Intacct.​pos_credentials_schema.​credentials_propertiesobjectrequired
Sage Intacct.​pos_credentials_schema.​required_propertiesArray of stringsrequired
Sage Intacct.​location_requiredbooleanrequired
Sage Intacct.​business_typestringrequired
Enum"retail""wholesale"
Sage Intacct.​pos_typestringrequired
Enum"Alleaves""BioTrack""BioTrack Wholesale""Blaze""Canix""Dutchie""Dutchie Wholesale""Flourish Wholesale""Flowhub""Greenbits"
Canixobjectrequired
Canix.​pos_credentials_schemaobjectrequired
Canix.​pos_credentials_schema.​credentials_namestringrequired
Canix.​pos_credentials_schema.​credentials_descriptionstringrequired
Canix.​pos_credentials_schema.​credentials_propertiesobjectrequired
Canix.​pos_credentials_schema.​required_propertiesArray of stringsrequired
Canix.​location_requiredbooleanrequired
Canix.​business_typestringrequired
Enum"retail""wholesale"
Canix.​pos_typestringrequired
Enum"Alleaves""BioTrack""BioTrack Wholesale""Blaze""Canix""Dutchie""Dutchie Wholesale""Flourish Wholesale""Flowhub""Greenbits"
POSaBITobjectrequired
POSaBIT.​pos_credentials_schemaobjectrequired
POSaBIT.​pos_credentials_schema.​credentials_namestringrequired
POSaBIT.​pos_credentials_schema.​credentials_descriptionstringrequired
POSaBIT.​pos_credentials_schema.​credentials_propertiesobjectrequired
POSaBIT.​pos_credentials_schema.​required_propertiesArray of stringsrequired
POSaBIT.​location_requiredbooleanrequired
POSaBIT.​business_typestringrequired
Enum"retail""wholesale"
POSaBIT.​pos_typestringrequired
Enum"Alleaves""BioTrack""BioTrack Wholesale""Blaze""Canix""Dutchie""Dutchie Wholesale""Flourish Wholesale""Flowhub""Greenbits"
Proteus420objectrequired
Proteus420.​pos_credentials_schemaobjectrequired
Proteus420.​pos_credentials_schema.​credentials_namestringrequired
Proteus420.​pos_credentials_schema.​credentials_descriptionstringrequired
Proteus420.​pos_credentials_schema.​credentials_propertiesobjectrequired
Proteus420.​pos_credentials_schema.​required_propertiesArray of stringsrequired
Proteus420.​location_requiredbooleanrequired
Proteus420.​business_typestringrequired
Enum"retail""wholesale"
Proteus420.​pos_typestringrequired
Enum"Alleaves""BioTrack""BioTrack Wholesale""Blaze""Canix""Dutchie""Dutchie Wholesale""Flourish Wholesale""Flowhub""Greenbits"
IndicaOnlineobjectrequired
IndicaOnline.​pos_credentials_schemaobjectrequired
IndicaOnline.​pos_credentials_schema.​credentials_namestringrequired
IndicaOnline.​pos_credentials_schema.​credentials_descriptionstringrequired
IndicaOnline.​pos_credentials_schema.​credentials_propertiesobjectrequired
IndicaOnline.​pos_credentials_schema.​required_propertiesArray of stringsrequired
IndicaOnline.​location_requiredbooleanrequired
IndicaOnline.​business_typestringrequired
Enum"retail""wholesale"
IndicaOnline.​pos_typestringrequired
Enum"Alleaves""BioTrack""BioTrack Wholesale""Blaze""Canix""Dutchie""Dutchie Wholesale""Flourish Wholesale""Flowhub""Greenbits"
Weaveobjectrequired
Weave.​pos_credentials_schemaobjectrequired
Weave.​pos_credentials_schema.​credentials_namestringrequired
Weave.​pos_credentials_schema.​credentials_descriptionstringrequired
Weave.​pos_credentials_schema.​credentials_propertiesobjectrequired
Weave.​pos_credentials_schema.​required_propertiesArray of stringsrequired
Weave.​location_requiredbooleanrequired
Weave.​business_typestringrequired
Enum"retail""wholesale"
Weave.​pos_typestringrequired
Enum"Alleaves""BioTrack""BioTrack Wholesale""Blaze""Canix""Dutchie""Dutchie Wholesale""Flourish Wholesale""Flowhub""Greenbits"
Response
application/json
{ "Alleaves": { "pos_type": "Alleaves", "business_type": "retail", "location_required": false, "pos_credentials_schema": { "credentials_name": "AlleavesTestAuth", "credentials_description": "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.\n\nhttps://support.greencheckverified.com/knowledge/connect-alleaves-to-green-check", "credentials_properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "required_properties": [ "password", "username" ] } }, "BioTrack": { "pos_type": "BioTrack", "business_type": "retail", "location_required": true, "pos_credentials_schema": { "credentials_name": "BiotrackTestAuth", "credentials_description": "BioTrack enables its users to connect to other systems like Green Check with something called a SQL to SQL Pipeline. This simply means that Green Check will have read-only access to your BioTrack data. First, you'll need to ask BioTrack to email you the necessary credentials for the integration. Copy and paste the email below and send it to Support@biotrackthc.com. Then, you'll need to configure BioTrack to grant Green Check access, follow the instructions found here: https://f.hubspotusercontent20.net/hubfs/5237927/Connect%20BioTrack%20to%20Green%20Check.pdf. If your Network Connection requires you to whitelist Green Check's IP, please add these IP addresses to your whitelist: 52.4.48.232 and 35.169.209.100\n\nHello,\nI need some assistance. I would like to integrate our system with the Green Check system. Please provide me with the necessary information about our database that the Green Check team needs for Read Only access.\n\nhttps://support.greencheckverified.com/knowledge/connect-biotrack-to-green-check\nhttps://support.greencheckverified.com/knowledge/how-to-handle-biotrack-connection-refusal-errors\nhttps://support.greencheckverified.com/knowledge/how-to-handle-biotrack-pg_hba.conf-errors", "credentials_properties": { "port": { "type": "number" }, "username": { "type": "string" }, "password": { "type": "string" }, "server_ip": { "type": "string" }, "database_name": { "type": "string" } }, "required_properties": [ "database_name", "password", "port", "server_ip", "username" ] } }, "BioTrack Wholesale": { "pos_type": "BioTrack Wholesale", "business_type": "wholesale", "location_required": true, "pos_credentials_schema": { "credentials_name": "BiotrackTestAuth", "credentials_description": "BioTrack enables its users to connect to other systems like Green Check with something called a SQL to SQL Pipeline. This simply means that Green Check will have read-only access to your BioTrack data. First, you'll need to ask BioTrack to email you the necessary credentials for the integration. Copy and paste the email below and send it to Support@biotrackthc.com. Then, you'll need to configure BioTrack to grant Green Check access, follow the instructions found here: https://f.hubspotusercontent20.net/hubfs/5237927/Connect%20BioTrack%20to%20Green%20Check.pdf. If your Network Connection requires you to whitelist Green Check's IP, please add these IP addresses to your whitelist: 52.4.48.232 and 35.169.209.100\n\nHello,\nI need some assistance. I would like to integrate our system with the Green Check system. Please provide me with the necessary information about our database that the Green Check team needs for Read Only access.\n\nhttps://support.greencheckverified.com/knowledge/connect-biotrack-to-green-check\nhttps://support.greencheckverified.com/knowledge/how-to-handle-biotrack-connection-refusal-errors\nhttps://support.greencheckverified.com/knowledge/how-to-handle-biotrack-pg_hba.conf-errors", "credentials_properties": { "port": { "type": "number" }, "username": { "type": "string" }, "password": { "type": "string" }, "server_ip": { "type": "string" }, "database_name": { "type": "string" } }, "required_properties": [ "database_name", "password", "port", "server_ip", "username" ] } }, "Blaze": { "pos_type": "Blaze", "business_type": "retail", "location_required": false, "pos_credentials_schema": { "credentials_name": "BlazeTestAuth", "credentials_description": "Blaze provides its users with a unique Developer Key that can be used to integrate with other systems like Green Check. In order to connect with third party applications, you will need to generate a developer key from the backend of BLAZE Retail. Follow the instructions in the link below to generate a key.\n\nhttps://support.greencheckverified.com/knowledge/connect-blaze-to-green-check", "credentials_properties": { "Authorization": { "type": "string" } }, "required_properties": [ "Authorization" ] } }, "Canix": { "pos_type": "Canix", "business_type": "wholesale", "location_required": true, "pos_credentials_schema": { "credentials_name": "CanixTestAuth", "credentials_description": "Canix provides its users with a unique API key that can be used to integrate with other systems like Green Check. Go to your Canix settingsToggle the switch next to Green Check Verified to the on position. Copy your client API key.\n\nhttps://support.greencheckverified.com/knowledge/connect-canix-to-green-check", "credentials_properties": { "key": { "type": "string" } }, "required_properties": [ "key" ] } }, "Dutchie": { "pos_type": "Dutchie", "business_type": "retail", "location_required": false, "pos_credentials_schema": { "credentials_name": "DutchieTestAuth", "credentials_description": "Leaf Logix/Dutchie provides its users with unique API keys that can be used to integrate with other systems like Green Check. First, you'll need to ask Leaf Logix to email you your API credentials. Copy and paste the email below and send it to possupport@dutchie.com. Please note: If your location is licensed for both medical and recreational sales, you will have two separate API keys for this location.\n\nHello,\nI need some assistance. I would like to integrate our system with the Green Check system. Please help me locate my API key(s) so that I can provide this to the Green Check team to set up the integration.\n\nhttps://support.greencheckverified.com/knowledge/connect-leaf-logix-to-green-check", "credentials_properties": { "medApiKey": { "type": "string" }, "recApiKey": { "type": "string" } }, "required_properties": [] } }, "Dutchie Wholesale": { "pos_type": "Dutchie Wholesale", "business_type": "wholesale", "location_required": false, "pos_credentials_schema": { "credentials_name": "DutchieTestAuth", "credentials_description": "Leaf Logix/Dutchie provides its users with unique API keys that can be used to integrate with other systems like Green Check. First, you'll need to ask Leaf Logix to email you your API credentials. Copy and paste the email below and send it to possupport@dutchie.com. Please note: If your location is licensed for both medical and recreational sales, you will have two separate API keys for this location.\n\nHello,\nI need some assistance. I would like to integrate our system with the Green Check system. Please help me locate my API key(s) so that I can provide this to the Green Check team to set up the integration.\n\nhttps://support.greencheckverified.com/knowledge/connect-leaf-logix-to-green-check", "credentials_properties": { "medApiKey": { "type": "string" }, "recApiKey": { "type": "string" } }, "required_properties": [] } }, "Flowhub": { "pos_type": "Flowhub", "business_type": "retail", "location_required": true, "pos_credentials_schema": { "credentials_name": "FlowhubTestAuth", "credentials_description": "Flowhub provides its users with a unique API key that can be used to integrate with other systems like Green Check. First, you'll need to ask Flowhub to email you your API credentials. Please initiate the process by following this link to the Flowhub Integration Request form: https://flowhub.com/api-integration-request. Please fill out all fields and select Green Check as the desired partner and Submit.\n\nhttps://support.greencheckverified.com/knowledge/connecting-flowhub-to-green-check", "credentials_properties": { "key": { "type": "string" }, "clientId": { "type": "string" } }, "required_properties": [ "clientId", "key" ] } }, "Flourish Wholesale": { "pos_type": "Flourish Wholesale", "business_type": "wholesale", "location_required": true, "pos_credentials_schema": { "credentials_name": "FlourishTestAuth", "credentials_description": "To connect this integration, you’ll need your Flourish Username and API Key. Go to the following URL for a full guide on how to do this: https://docs.flourishsoftware.com/article/xsefgb8b0s-external-api-generate-or-reset-api-key\n\nhttps://support.greencheckverified.com/knowledge/connect-flourish-to-green-check", "credentials_properties": { "username": { "type": "string" }, "api_key": { "type": "string" } }, "required_properties": [ "api_key", "username" ] } }, "Greenbits": { "pos_type": "Greenbits", "business_type": "retail", "location_required": true, "pos_credentials_schema": { "credentials_name": "GreenbitsTestAuth", "credentials_description": "To share your API token with Green Check, you will need to set up a new Role and User account in Greenbits that Green Check will use to access the token. Ensure this role has the following permissions: View Products, Access Backoffice, View product types, View brands, View strains, View suppliers. Follow the instructions in the link below to set this up.\n\nhttps://support.greencheckverified.com/en/knowledge/connect-greenbits-to-green-check", "credentials_properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "required_properties": [ "password", "username" ] } }, "GrowFlow": { "pos_type": "GrowFlow", "business_type": "retail", "location_required": true, "pos_credentials_schema": { "credentials_name": "GrowFlowTestAuth", "credentials_description": "First, you'll need to ask GrowFlow to enable the Green Check integration. Log into your GrowFlow account. Using the chat bubble, ask their Support team to enable the Green Check integration for all of your locations. Then use your client ID, found in the URL of any growflow page, like: https://retail.growflow.com/c/CLIENT_ID/\n\nhttps://support.greencheckverified.com/knowledge/connect-growflow-to-green-check", "credentials_properties": { "client_id_name": { "type": "string" } }, "required_properties": [ "client_id_name" ] } }, "IndicaOnline": { "pos_type": "IndicaOnline", "business_type": "retail", "location_required": false, "pos_credentials_schema": { "credentials_name": "IndicaOnlineTestAuth", "credentials_description": "To connect this integration, you’ll need your IndicaOnline API Key", "credentials_properties": { "apiKey": { "type": "string" }, "officeId": { "type": "number" } }, "required_properties": [ "apiKey", "officeId" ] } }, "Meadow": { "pos_type": "Meadow", "business_type": "retail", "location_required": false, "pos_credentials_schema": { "credentials_name": "MeadowTestAuth", "credentials_description": "You can connect your Meadow account to Green Check by simply using your Meadow API Key. Generate a key by navigating to your organization's API Settings page at https://admin.getmeadow.com/settings/api. Click the \"Add Integration\" button. Click the Company drop-down and select \"Green Check Verified\". Select the \"Analytics Access\" checkbox.\n\nhttps://support.greencheckverified.com/knowledge/connect-meadow-to-green-check", "credentials_properties": { "clientKey": { "type": "string" } }, "required_properties": [ "clientKey" ] } }, "POSaBIT": { "pos_type": "POSaBIT", "business_type": "retail", "location_required": false, "pos_credentials_schema": { "credentials_name": "POSaBITTestAuth", "credentials_description": "POSaBIT provides its users with a unique API Token that can be used to integrate with other systems like Green Check. Please contact POSaBIT for help in creating an api key.\n\nhttps://support.greencheckverified.com/knowledge/connect-posabit-to-green-check", "credentials_properties": { "apiToken": { "type": "string" } }, "required_properties": [ "apiToken" ] } }, "Proteus420": { "pos_type": "Proteus420", "business_type": "retail", "location_required": false, "pos_credentials_schema": { "credentials_name": "Proteus420TestAuth", "credentials_description": "To configure this integration, you’ll need your Proteus420 Client Name and API Key. The Client Name will be the Proteus420 account name that shows on the top of the Proteus420 homepage when logged in. The API Key can be accessed and generated on the web services page (Settings>webservices). There will be a unique API Key for each location.\n\nhttps://support.greencheckverified.com/knowledge/connect-proteus420-to-green-check", "credentials_properties": { "clientName": { "type": "string" }, "apiKey": { "type": "string" } }, "required_properties": [ "apiKey", "clientName" ] } }, "Sage Intacct": { "pos_type": "Sage Intacct", "business_type": "wholesale", "location_required": true, "pos_credentials_schema": { "credentials_name": "IntacctTestAuth", "credentials_description": "To configure this integration, you’ll need to enable access for the Green Check Web Sender ID in your Sage Intacct system and create a Green Check Web Services User. You will then need to gather the credentials listed below. Follow the steps in the following link to help you facilitate this setup.\n\nhttps://support.greencheckverified.com/knowledge/connect-sage-intacct-to-green-check", "credentials_properties": { "user_id": { "description": "The username of the Web Services user created by the customer", "type": "string" }, "company_id": { "description": "The company of the customer as assigned by Sage", "type": "string" }, "user_password": { "description": "The password of the Web Services user created by the customer", "type": "string" } }, "required_properties": [ "company_id", "user_id", "user_password" ] } }, "Treez": { "pos_type": "Treez", "business_type": "retail", "location_required": false, "pos_credentials_schema": { "credentials_name": "TreezTestAuth", "credentials_description": "Treez provides its users with a unique API key that can be used to integrate with other systems like Green Check. First, you'll need to ask Treez to email you your API credentials. Copy and paste the email below and send it to support@treez.io. You will also need the organization's name, found in the portal URL like: https://sampleorgname.treez.io\n\nHello,\nI need some assistance. I would like to integrate our system with the Green Check system. Please provide my API credentials so that I can provide them to the Green Check team to set up the integration.\n\nhttps://support.greencheckverified.com/knowledge/connect-treez-to-green-check", "credentials_properties": { "apiKey": { "type": "string" }, "dispensaryName": { "type": "string" } }, "required_properties": [ "apiKey", "dispensaryName" ] } }, "Weave": { "pos_type": "Weave", "business_type": "retail", "location_required": false, "pos_credentials_schema": { "credentials_name": "WeaveTestAuth", "credentials_description": "To configure this integration, you’ll need your Weave API Key. To generate your Weave API Key, you’ll navigate to https://retail.weaveiq.com/location/overview/api-integrations then click the checkbox to enable Greencheck.\n\nhttps://support.greencheckverified.com/knowledge/connect-weave-to-green-check", "credentials_properties": { "apiKey": { "type": "string" } }, "required_properties": [ "apiKey" ] } } }

Get service provider onboarding templates

Request

Get all onboarding templates

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}/onboarding-templates' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/jsonArray [
template_idstringrequired

ID of this template

date_createdstringrequired
date_updatedstringrequired
updated_bystringrequired
created_bystringrequired
versionstringrequired

Current template version. Will be "draft" if unpublished changes

namestringrequired

Template name. Internal only

descriptionstringrequired

Template description. Internal only

custom_field_sectionsArray of objectsrequired

Custom fields array. These are a list of freeform questions to collect any information from your clients.

custom_field_sections[].​fieldsArray of objectsrequired
custom_field_sections[].​fields[].​labelstringrequired
custom_field_sections[].​fields[].​typestringrequired
Enum"textSingleLine""textMultiLine""radio""select""checkbox""date""file""fileDownload""displayContent""hyperlink"
custom_field_sections[].​fields[].​idstringrequired
custom_field_sections[].​fields[].​attachmentsArray of objects

List of file names and document IDs of files attached to this field. Used in File and Display Content fields

custom_field_sections[].​fields[].​attachments[].​idstringrequired
custom_field_sections[].​fields[].​attachments[].​file_namestringrequired
custom_field_sections[].​fields[].​paragraphstring

Paragraph of text. Used in Display Content

custom_field_sections[].​fields[].​smart_ruleobject
custom_field_sections[].​fields[].​smart_rule.​actionstringrequired

The desired action to take on the field if all conditions are true

Enum"Show""Hide"
custom_field_sections[].​fields[].​smart_rule.​conditionsArray of objectsrequired

Array of conditions that must all be met in order for the rule to evaluate true. Currently limited to one condition but using an array to make it easier to extend

custom_field_sections[].​fields[].​smart_rule.​conditions[].​operatorstringrequired

The different condition operators to use

Enum"Is Equal To""Is Not Equal To""Is Empty""Is Filled"
custom_field_sections[].​fields[].​smart_rule.​conditions[].​targetFieldIdstringrequired

The field to check the value of against the target value

custom_field_sections[].​fields[].​smart_rule.​conditions[].​targetValuestring

The value upon which the operator checks against the target field's value

custom_field_sections[].​fields[].​requiredboolean

Set to true if this field should be required in the form

custom_field_sections[].​fields[].​helpTextstring

Tooltip text

custom_field_sections[].​ordernumber(double)required
custom_field_sections[].​labelstringrequired
custom_field_sections[].​section_idstringrequired
custom_field_sections[].​smart_ruleobject
custom_field_sections[].​smart_rule.​actionstringrequired

The desired action to take on the field if all conditions are true

Enum"Show""Hide"
custom_field_sections[].​smart_rule.​conditionsArray of objectsrequired

Array of conditions that must all be met in order for the rule to evaluate true. Currently limited to one condition but using an array to make it easier to extend

custom_field_sections[].​smart_rule.​conditions[].​operatorstringrequired

The different condition operators to use

Enum"Is Equal To""Is Not Equal To""Is Empty""Is Filled"
custom_field_sections[].​smart_rule.​conditions[].​targetFieldIdstringrequired

The field to check the value of against the target value

custom_field_sections[].​smart_rule.​conditions[].​targetValuestring

The value upon which the operator checks against the target field's value

custom_field_sections[].​descriptionstring
document_requirementsArray of objectsrequired
document_requirements[].​typestringrequired
Any of:
string
Value"bank_custom"
document_requirements[].​requiredbooleanrequired
document_requirements[].​categorystringrequired
Enum"financial""legal""license""operational"
document_requirements[].​descriptionstringrequired
document_requirements[].​namestringrequired
document_requirements[].​requirement_idstringrequired
document_requirements[].​archivedboolean
document_requirements[].​attachmentsArray of objects
document_requirements[].​attachments[].​idstringrequired
document_requirements[].​attachments[].​file_namestringrequired
published_datestring
published_bystring
]
Response
application/json
[ { "template_id": "string", "date_created": "string", "date_updated": "string", "updated_by": "string", "created_by": "string", "published_date": "string", "published_by": "string", "version": "string", "name": "string", "description": "string", "custom_field_sections": [ { "smart_rule": { "action": "Show", "conditions": [ { "operator": "Is Equal To", "targetFieldId": "string", "targetValue": "string" } ] }, "fields": [ { "attachments": [ {} ], "paragraph": "string", "smart_rule": { "action": "Show", "conditions": [null] }, "required": true, "helpText": "string", "label": "string", "type": "textSingleLine", "id": "string" } ], "order": 0.1, "description": "string", "label": "string", "section_id": "string" } ], "document_requirements": [ { "type": "bank_custom", "archived": true, "required": true, "attachments": [ { "id": "string", "file_name": "string" } ], "category": "financial", "description": "string", "name": "string", "requirement_id": "string" } ] } ]

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