Get POS Credentials Schema

Securityaccess_auth
Request
path Parameters

sp_id
required
string
Responses
200
401
Unauthorized
403
Forbidden
404
Not Found
422
Validation Failed
get/service-providers/{sp_id}/pos-credentials-schema
Response samples
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": "retail",
"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"
]
}
},
"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": "retail",
"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"
]
}
}
}