---
title: "Get POS Credentials Schema"
method: GET
path: "/service-providers/{sp_id}/pos-credentials-schema"
tags: ["Service Provider"]
---

# Get POS Credentials Schema

`GET /service-providers/{sp_id}/pos-credentials-schema`

## Request

- Base URL: `https://sandbox-api.greencheckverified.com`
- URL: `https://sandbox-api.greencheckverified.com/service-providers/{sp_id}/pos-credentials-schema`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/greencheckverified/apis/green-check-access/docs/service-providers/:sp_id/pos-credentials-schema/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `sp_id` string, required

## Response `200`

Ok

- PosCredentialInformation
  - `Alleaves` object, required
    - `pos_credentials_schema` CredentialsSchema, required
      - `credentials_name` string, required
      - `credentials_description` string, required
      - `credentials_properties` object, required
      - `required_properties` string[], required
    - `location_required` boolean, required
    - `business_type` 'retail' | 'wholesale', required
    - `pos_type` 'Alleaves' | 'BioTrack' | 'BioTrack Wholesale' | 'Blaze' | 'Canix' | 'Dutchie' | 'Dutchie Wholesale' | 'Flourish Wholesale' | 'Flowhub' | 'Greenbits' | 'GrowFlow' | 'GrowFlow Wholesale' | 'IndicaOnline' | 'Meadow' | 'POSaBIT' | 'Proteus420' | 'Sage Intacct' | 'Treez' | 'Weave', required
  - `Dutchie` object, required
    - `pos_credentials_schema` CredentialsSchema, required
      - `credentials_name` string, required
      - `credentials_description` string, required
      - `credentials_properties` object, required
      - `required_properties` string[], required
    - `location_required` boolean, required
    - `business_type` 'retail' | 'wholesale', required
    - `pos_type` 'Alleaves' | 'BioTrack' | 'BioTrack Wholesale' | 'Blaze' | 'Canix' | 'Dutchie' | 'Dutchie Wholesale' | 'Flourish Wholesale' | 'Flowhub' | 'Greenbits' | 'GrowFlow' | 'GrowFlow Wholesale' | 'IndicaOnline' | 'Meadow' | 'POSaBIT' | 'Proteus420' | 'Sage Intacct' | 'Treez' | 'Weave', required
  - `Dutchie Wholesale` object, required
    - `pos_credentials_schema` CredentialsSchema, required
      - `credentials_name` string, required
      - `credentials_description` string, required
      - `credentials_properties` object, required
      - `required_properties` string[], required
    - `location_required` boolean, required
    - `business_type` 'retail' | 'wholesale', required
    - `pos_type` 'Alleaves' | 'BioTrack' | 'BioTrack Wholesale' | 'Blaze' | 'Canix' | 'Dutchie' | 'Dutchie Wholesale' | 'Flourish Wholesale' | 'Flowhub' | 'Greenbits' | 'GrowFlow' | 'GrowFlow Wholesale' | 'IndicaOnline' | 'Meadow' | 'POSaBIT' | 'Proteus420' | 'Sage Intacct' | 'Treez' | 'Weave', required
  - `Meadow` object, required
    - `pos_credentials_schema` CredentialsSchema, required
      - `credentials_name` string, required
      - `credentials_description` string, required
      - `credentials_properties` object, required
      - `required_properties` string[], required
    - `location_required` boolean, required
    - `business_type` 'retail' | 'wholesale', required
    - `pos_type` 'Alleaves' | 'BioTrack' | 'BioTrack Wholesale' | 'Blaze' | 'Canix' | 'Dutchie' | 'Dutchie Wholesale' | 'Flourish Wholesale' | 'Flowhub' | 'Greenbits' | 'GrowFlow' | 'GrowFlow Wholesale' | 'IndicaOnline' | 'Meadow' | 'POSaBIT' | 'Proteus420' | 'Sage Intacct' | 'Treez' | 'Weave', required
  - `Greenbits` object, required
    - `pos_credentials_schema` CredentialsSchema, required
      - `credentials_name` string, required
      - `credentials_description` string, required
      - `credentials_properties` object, required
      - `required_properties` string[], required
    - `location_required` boolean, required
    - `business_type` 'retail' | 'wholesale', required
    - `pos_type` 'Alleaves' | 'BioTrack' | 'BioTrack Wholesale' | 'Blaze' | 'Canix' | 'Dutchie' | 'Dutchie Wholesale' | 'Flourish Wholesale' | 'Flowhub' | 'Greenbits' | 'GrowFlow' | 'GrowFlow Wholesale' | 'IndicaOnline' | 'Meadow' | 'POSaBIT' | 'Proteus420' | 'Sage Intacct' | 'Treez' | 'Weave', required
  - `GrowFlow` object, required
    - `pos_credentials_schema` CredentialsSchema, required
      - `credentials_name` string, required
      - `credentials_description` string, required
      - `credentials_properties` object, required
      - `required_properties` string[], required
    - `location_required` boolean, required
    - `business_type` 'retail' | 'wholesale', required
    - `pos_type` 'Alleaves' | 'BioTrack' | 'BioTrack Wholesale' | 'Blaze' | 'Canix' | 'Dutchie' | 'Dutchie Wholesale' | 'Flourish Wholesale' | 'Flowhub' | 'Greenbits' | 'GrowFlow' | 'GrowFlow Wholesale' | 'IndicaOnline' | 'Meadow' | 'POSaBIT' | 'Proteus420' | 'Sage Intacct' | 'Treez' | 'Weave', required
  - `GrowFlow Wholesale` object, required
    - `pos_credentials_schema` CredentialsSchema, required
      - `credentials_name` string, required
      - `credentials_description` string, required
      - `credentials_properties` object, required
      - `required_properties` string[], required
    - `location_required` boolean, required
    - `business_type` 'retail' | 'wholesale', required
    - `pos_type` 'Alleaves' | 'BioTrack' | 'BioTrack Wholesale' | 'Blaze' | 'Canix' | 'Dutchie' | 'Dutchie Wholesale' | 'Flourish Wholesale' | 'Flowhub' | 'Greenbits' | 'GrowFlow' | 'GrowFlow Wholesale' | 'IndicaOnline' | 'Meadow' | 'POSaBIT' | 'Proteus420' | 'Sage Intacct' | 'Treez' | 'Weave', required
  - `Flourish Wholesale` object, required
    - `pos_credentials_schema` CredentialsSchema, required
      - `credentials_name` string, required
      - `credentials_description` string, required
      - `credentials_properties` object, required
      - `required_properties` string[], required
    - `location_required` boolean, required
    - `business_type` 'retail' | 'wholesale', required
    - `pos_type` 'Alleaves' | 'BioTrack' | 'BioTrack Wholesale' | 'Blaze' | 'Canix' | 'Dutchie' | 'Dutchie Wholesale' | 'Flourish Wholesale' | 'Flowhub' | 'Greenbits' | 'GrowFlow' | 'GrowFlow Wholesale' | 'IndicaOnline' | 'Meadow' | 'POSaBIT' | 'Proteus420' | 'Sage Intacct' | 'Treez' | 'Weave', required
  - `Flowhub` object, required
    - `pos_credentials_schema` CredentialsSchema, required
      - `credentials_name` string, required
      - `credentials_description` string, required
      - `credentials_properties` object, required
      - `required_properties` string[], required
    - `location_required` boolean, required
    - `business_type` 'retail' | 'wholesale', required
    - `pos_type` 'Alleaves' | 'BioTrack' | 'BioTrack Wholesale' | 'Blaze' | 'Canix' | 'Dutchie' | 'Dutchie Wholesale' | 'Flourish Wholesale' | 'Flowhub' | 'Greenbits' | 'GrowFlow' | 'GrowFlow Wholesale' | 'IndicaOnline' | 'Meadow' | 'POSaBIT' | 'Proteus420' | 'Sage Intacct' | 'Treez' | 'Weave', required
  - `BioTrack` object, required
    - `pos_credentials_schema` CredentialsSchema, required
      - `credentials_name` string, required
      - `credentials_description` string, required
      - `credentials_properties` object, required
      - `required_properties` string[], required
    - `location_required` boolean, required
    - `business_type` 'retail' | 'wholesale', required
    - `pos_type` 'Alleaves' | 'BioTrack' | 'BioTrack Wholesale' | 'Blaze' | 'Canix' | 'Dutchie' | 'Dutchie Wholesale' | 'Flourish Wholesale' | 'Flowhub' | 'Greenbits' | 'GrowFlow' | 'GrowFlow Wholesale' | 'IndicaOnline' | 'Meadow' | 'POSaBIT' | 'Proteus420' | 'Sage Intacct' | 'Treez' | 'Weave', required
  - `BioTrack Wholesale` object, required
    - `pos_credentials_schema` CredentialsSchema, required
      - `credentials_name` string, required
      - `credentials_description` string, required
      - `credentials_properties` object, required
      - `required_properties` string[], required
    - `location_required` boolean, required
    - `business_type` 'retail' | 'wholesale', required
    - `pos_type` 'Alleaves' | 'BioTrack' | 'BioTrack Wholesale' | 'Blaze' | 'Canix' | 'Dutchie' | 'Dutchie Wholesale' | 'Flourish Wholesale' | 'Flowhub' | 'Greenbits' | 'GrowFlow' | 'GrowFlow Wholesale' | 'IndicaOnline' | 'Meadow' | 'POSaBIT' | 'Proteus420' | 'Sage Intacct' | 'Treez' | 'Weave', required
  - `Treez` object, required
    - `pos_credentials_schema` CredentialsSchema, required
      - `credentials_name` string, required
      - `credentials_description` string, required
      - `credentials_properties` object, required
      - `required_properties` string[], required
    - `location_required` boolean, required
    - `business_type` 'retail' | 'wholesale', required
    - `pos_type` 'Alleaves' | 'BioTrack' | 'BioTrack Wholesale' | 'Blaze' | 'Canix' | 'Dutchie' | 'Dutchie Wholesale' | 'Flourish Wholesale' | 'Flowhub' | 'Greenbits' | 'GrowFlow' | 'GrowFlow Wholesale' | 'IndicaOnline' | 'Meadow' | 'POSaBIT' | 'Proteus420' | 'Sage Intacct' | 'Treez' | 'Weave', required
  - `Blaze` object, required
    - `pos_credentials_schema` CredentialsSchema, required
      - `credentials_name` string, required
      - `credentials_description` string, required
      - `credentials_properties` object, required
      - `required_properties` string[], required
    - `location_required` boolean, required
    - `business_type` 'retail' | 'wholesale', required
    - `pos_type` 'Alleaves' | 'BioTrack' | 'BioTrack Wholesale' | 'Blaze' | 'Canix' | 'Dutchie' | 'Dutchie Wholesale' | 'Flourish Wholesale' | 'Flowhub' | 'Greenbits' | 'GrowFlow' | 'GrowFlow Wholesale' | 'IndicaOnline' | 'Meadow' | 'POSaBIT' | 'Proteus420' | 'Sage Intacct' | 'Treez' | 'Weave', required
  - `Sage Intacct` object, required
    - `pos_credentials_schema` CredentialsSchema, required
      - `credentials_name` string, required
      - `credentials_description` string, required
      - `credentials_properties` object, required
      - `required_properties` string[], required
    - `location_required` boolean, required
    - `business_type` 'retail' | 'wholesale', required
    - `pos_type` 'Alleaves' | 'BioTrack' | 'BioTrack Wholesale' | 'Blaze' | 'Canix' | 'Dutchie' | 'Dutchie Wholesale' | 'Flourish Wholesale' | 'Flowhub' | 'Greenbits' | 'GrowFlow' | 'GrowFlow Wholesale' | 'IndicaOnline' | 'Meadow' | 'POSaBIT' | 'Proteus420' | 'Sage Intacct' | 'Treez' | 'Weave', required
  - `Canix` object, required
    - `pos_credentials_schema` CredentialsSchema, required
      - `credentials_name` string, required
      - `credentials_description` string, required
      - `credentials_properties` object, required
      - `required_properties` string[], required
    - `location_required` boolean, required
    - `business_type` 'retail' | 'wholesale', required
    - `pos_type` 'Alleaves' | 'BioTrack' | 'BioTrack Wholesale' | 'Blaze' | 'Canix' | 'Dutchie' | 'Dutchie Wholesale' | 'Flourish Wholesale' | 'Flowhub' | 'Greenbits' | 'GrowFlow' | 'GrowFlow Wholesale' | 'IndicaOnline' | 'Meadow' | 'POSaBIT' | 'Proteus420' | 'Sage Intacct' | 'Treez' | 'Weave', required
  - `POSaBIT` object, required
    - `pos_credentials_schema` CredentialsSchema, required
      - `credentials_name` string, required
      - `credentials_description` string, required
      - `credentials_properties` object, required
      - `required_properties` string[], required
    - `location_required` boolean, required
    - `business_type` 'retail' | 'wholesale', required
    - `pos_type` 'Alleaves' | 'BioTrack' | 'BioTrack Wholesale' | 'Blaze' | 'Canix' | 'Dutchie' | 'Dutchie Wholesale' | 'Flourish Wholesale' | 'Flowhub' | 'Greenbits' | 'GrowFlow' | 'GrowFlow Wholesale' | 'IndicaOnline' | 'Meadow' | 'POSaBIT' | 'Proteus420' | 'Sage Intacct' | 'Treez' | 'Weave', required
  - `Proteus420` object, required
    - `pos_credentials_schema` CredentialsSchema, required
      - `credentials_name` string, required
      - `credentials_description` string, required
      - `credentials_properties` object, required
      - `required_properties` string[], required
    - `location_required` boolean, required
    - `business_type` 'retail' | 'wholesale', required
    - `pos_type` 'Alleaves' | 'BioTrack' | 'BioTrack Wholesale' | 'Blaze' | 'Canix' | 'Dutchie' | 'Dutchie Wholesale' | 'Flourish Wholesale' | 'Flowhub' | 'Greenbits' | 'GrowFlow' | 'GrowFlow Wholesale' | 'IndicaOnline' | 'Meadow' | 'POSaBIT' | 'Proteus420' | 'Sage Intacct' | 'Treez' | 'Weave', required
  - `IndicaOnline` object, required
    - `pos_credentials_schema` CredentialsSchema, required
      - `credentials_name` string, required
      - `credentials_description` string, required
      - `credentials_properties` object, required
      - `required_properties` string[], required
    - `location_required` boolean, required
    - `business_type` 'retail' | 'wholesale', required
    - `pos_type` 'Alleaves' | 'BioTrack' | 'BioTrack Wholesale' | 'Blaze' | 'Canix' | 'Dutchie' | 'Dutchie Wholesale' | 'Flourish Wholesale' | 'Flowhub' | 'Greenbits' | 'GrowFlow' | 'GrowFlow Wholesale' | 'IndicaOnline' | 'Meadow' | 'POSaBIT' | 'Proteus420' | 'Sage Intacct' | 'Treez' | 'Weave', required
  - `Weave` object, required
    - `pos_credentials_schema` CredentialsSchema, required
      - `credentials_name` string, required
      - `credentials_description` string, required
      - `credentials_properties` object, required
      - `required_properties` string[], required
    - `location_required` boolean, required
    - `business_type` 'retail' | 'wholesale', required
    - `pos_type` 'Alleaves' | 'BioTrack' | 'BioTrack Wholesale' | 'Blaze' | 'Canix' | 'Dutchie' | 'Dutchie Wholesale' | 'Flourish Wholesale' | 'Flowhub' | 'Greenbits' | 'GrowFlow' | 'GrowFlow Wholesale' | 'IndicaOnline' | 'Meadow' | 'POSaBIT' | 'Proteus420' | 'Sage Intacct' | 'Treez' | 'Weave', required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Validation Failed

---

[API](https://skmtc.dev/greencheckverified/apis/green-check-access.md) - [All operations](https://skmtc.dev/greencheckverified/apis/green-check-access/llms.txt) - [OpenAPI document](https://skmtc.dev/greencheckverified/apis/green-check-access/revisions/fb63a7a6151b?raw)