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

CRB Customers

Operations

CRB Documents

Operations

CRB Inventory

Operations

CRB Inventory Locations

Operations

CRB Products

Operations

CRB Sales

Operations

CRB Templates

Operations

Get CRB's onboarding template for 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

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

Responses

Created

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

Template Version

namestringrequired

Template Name

last_updatedstringrequired

Last Updated

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"
review_start_datestring or nullrequired

Review Start Date

disconnected_onstring or nullrequired

Disconnected On

standard_requirementsArray of objectsrequired

All Onboarding template document data

standard_requirements[].​namestringrequired

Requirement Name

standard_requirements[].​requirement_idstring

Requirement ID

standard_requirements[].​date_updatedstring

Date Updated

standard_requirements[].​date_createdstring

Date Created

standard_requirements[].​requirement_versionstring

Requirement Version

standard_requirements[].​statusstring

Status

standard_requirements[].​documentsArray of objects

Custom field data

standard_requirements[].​documents[].​idstringrequired

Document ID

standard_requirements[].​documents[].​statusstringrequired
Enum"approved""archived""pending"
standard_requirements[].​documents[].​uploaded_bystringrequired

Uploaded By

standard_requirements[].​documents[].​upload_datestring(date-time)required
standard_requirements[].​documents[].​internal_notestring

Service provider Internal Note

standard_requirements[].​documents[].​friendly_namestring

Service provider friendly file name

standard_requirements[].​documents[].​expiration_datestring

Expiration Date

standard_requirements[].​documents[].​license_namestring

License Name

standard_requirements[].​documents[].​license_numberstring

License Number

standard_requirements[].​documents[].​statestring

Enumeration of all of the United States

Enum"AL""AK""AZ""AR""AS""CA""CO""CT""DE""DC"
standard_requirements[].​documents[].​reviewed_bystring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...
standard_requirements[].​documents[].​review_datestring(date-time)
standard_requirements[].​documents[].​file_namestring

File Name

standard_requirements[].​documents[].​tribal_nationstring
standard_requirements[].​documents[].​tribal_nation_license_typestring
Enum"Cultivator""Processor""Lab""Dispensary (Adult / Medical)""Social Consumption / Events""Delivery / Transport""Combined License""Other"
standard_requirements[].​documents[].​license_statusstring

This enum is used within our UI to display the license status. 1:1 with CRBMUniformLicenseStatusDescription + Unchecked

Enum"Active""Approved/Pending""Inactive""Pre-License""Unknown""Unlicensed""Unmatched"
standard_requirements[].​documents[].​date_verifiedstring

Date that GCV Verified the license in CRB Monitor

standard_requirements[].​documents[].​verified_expiration_datestring

Confirmed expiration date from CRB Monitor data

standard_requirements[].​documents[].​business_namestring

Legal business name on the license from CRB Monitor data

standard_requirements[].​documents[].​licensing_authoritystring

Licensing Authority of the license from CRB Monitor data

standard_requirements[].​documents[].​license_identifierstring

License Number in CRB Monitor

standard_requirements[].​documents[].​uniform_license_type_descriptionstring
Enum"Caregiver""CBD""Corporate Officer""Cultivation""Delivery/Transporter""Event Organizer""Hemp""Illicit Establishment""Management Company""Manufacturer/Processor"
standard_requirements[].​documents[].​reported_license_type_descriptionstring

Reported license type description

standard_requirements[].​documents[].​licensing_authority_statestring

State of the Licensing Authority

standard_requirements[].​descriptionstring

Requirement Description

standard_requirements[].​categorystring

Category

standard_requirements[].​archivedboolean

Archived

standard_requirements[].​requiredboolean

Required

custom_requirementsArray of objectsrequired

Custom field data

custom_requirements[].​idstringrequired

Field ID

custom_requirements[].​labelstringrequired

Custom Field Name

custom_requirements[].​valuestring or nullrequired

Custom Field Value

custom_requirements[].​doc_metadataArray of objects

Additional metadata about documents uploaded

custom_requirements[].​doc_metadata[].​upload_datestring or nullrequired
custom_requirements[].​doc_metadata[].​file_namestring or nullrequired
custom_requirements[].​doc_metadata[].​idstringrequired
descriptionstring

Template Description

start_datestring

Start Date

submitted_datestring

Submitted Date

submitted_bystring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...
reviewed_bystring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...
review_datestring

Review Date

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
  "template_id": "c6d67e98-83ea-49f0-8812-e4abae2b68bc",
  "template_version": "string",
  "name": "string",
  "description": "string",
  "last_updated": "string",
  "start_date": "string",
  "submitted_date": "string",
  "submitted_by": "6703ac2f-9eb5-40e9-9fde-511b2dbf4be5",
  "status": "bank_disconnected",
  "reviewed_by": "92ab4dbc-1b27-40ce-b24b-7dde8f4709be",
  "review_start_date": "string",
  "review_date": "string",
  "disconnected_on": "string",
  "standard_requirements": [
    {
      "requirement_id": "string",
      "date_updated": "string",
      "date_created": "string",
      "requirement_version": "string",
      "status": "string",
      "documents": [
        {
          "id": "string",
          "internal_note": "string",
          "friendly_name": "string",
          "expiration_date": "string",
          "license_name": "string",
          "license_number": "string",
          "state": "AL",
          "reviewed_by": "92ab4dbc-1b27-40ce-b24b-7dde8f4709be",
          "review_date": "2019-08-24T14:15:22Z",
          "status": "approved",
          "file_name": "string",
          "uploaded_by": "string",
          "upload_date": "2019-08-24T14:15:22Z",
          "tribal_nation": "string",
          "tribal_nation_license_type": "Cultivator",
          "license_status": "Active",
          "date_verified": "string",
          "verified_expiration_date": "string",
          "business_name": "string",
          "licensing_authority": "string",
          "license_identifier": "string",
          "uniform_license_type_description": "Caregiver",
          "reported_license_type_description": "string",
          "licensing_authority_state": "string"
        }
      ],
      "name": "string",
      "description": "string",
      "category": "string",
      "archived": true,
      "required": true
    }
  ],
  "custom_requirements": [
    {
      "id": "string",
      "label": "string",
      "value": "string",
      "doc_metadata": [
        {
          "upload_date": "string",
          "file_name": "string",
          "id": "string"
        }
      ]
    }
  ]
}

Add a document to a requirement in a CRB's onboarding template response

Request

Add a document to a requirement in a CRB's onboarding template response.

Note - Only documents up to 5MB are supported

You always must include:

  • file_name - Full file name, including the file extension (ex: "statment.pdf")
  • file_type - File mime type, to ensure only allowed types are uploaded. See AllowedS3FileMimeTypes
  • base64 - A base 64 encoded string of the file contents.
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

requirement_idstringrequired

Requirement Id

Bodyapplication/jsonrequired
file_namestring^[^./\\]+\.(csv|docx?|gif|jpe?g|json|odp|ods|...required

Full file name, including the file extension

file_typestringrequired
Enum"text/csv""application/msword""application/vnd.openxmlformats-officedocument.wordprocessingml.document""image/gif""image/jpeg""application/json""application/vnd.oasis.opendocument.presentation""application/vnd.oasis.opendocument.spreadsheet""application/vnd.oasis.opendocument.text""image/png"
base64stringrequired

A base 64 encoded string of the file contents.

curl -i -X PUT \
  'https://developer.greencheckverified.com/_mock/apis/swagger/service-providers/{sp_id}/crbs/{crb_id}/onboarding-template/requirements/{requirement_id}/documents' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "file_name": "string",
    "file_type": "text/csv",
    "base64": "string"
  }'

Responses

Ok

Bodyapplication/json
document_idstringrequired
updated_requirement_responseobjectrequired
updated_requirement_response.​namestringrequired

Requirement Name

updated_requirement_response.​requirement_idstring

Requirement ID

updated_requirement_response.​date_updatedstring

Date Updated

updated_requirement_response.​date_createdstring

Date Created

updated_requirement_response.​requirement_versionstring

Requirement Version

updated_requirement_response.​statusstring

Status

updated_requirement_response.​documentsArray of objects

Custom field data

updated_requirement_response.​documents[].​idstringrequired

Document ID

updated_requirement_response.​documents[].​statusstringrequired
Enum"approved""archived""pending"
updated_requirement_response.​documents[].​uploaded_bystringrequired

Uploaded By

updated_requirement_response.​documents[].​upload_datestring(date-time)required
updated_requirement_response.​documents[].​internal_notestring

Service provider Internal Note

updated_requirement_response.​documents[].​friendly_namestring

Service provider friendly file name

updated_requirement_response.​documents[].​expiration_datestring

Expiration Date

updated_requirement_response.​documents[].​license_namestring

License Name

updated_requirement_response.​documents[].​license_numberstring

License Number

updated_requirement_response.​documents[].​statestring

Enumeration of all of the United States

Enum"AL""AK""AZ""AR""AS""CA""CO""CT""DE""DC"
updated_requirement_response.​documents[].​reviewed_bystring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...
updated_requirement_response.​documents[].​review_datestring(date-time)
updated_requirement_response.​documents[].​file_namestring

File Name

updated_requirement_response.​documents[].​tribal_nationstring
updated_requirement_response.​documents[].​tribal_nation_license_typestring
Enum"Cultivator""Processor""Lab""Dispensary (Adult / Medical)""Social Consumption / Events""Delivery / Transport""Combined License""Other"
updated_requirement_response.​documents[].​license_statusstring

This enum is used within our UI to display the license status. 1:1 with CRBMUniformLicenseStatusDescription + Unchecked

Enum"Active""Approved/Pending""Inactive""Pre-License""Unknown""Unlicensed""Unmatched"
updated_requirement_response.​documents[].​date_verifiedstring

Date that GCV Verified the license in CRB Monitor

updated_requirement_response.​documents[].​verified_expiration_datestring

Confirmed expiration date from CRB Monitor data

updated_requirement_response.​documents[].​business_namestring

Legal business name on the license from CRB Monitor data

updated_requirement_response.​documents[].​licensing_authoritystring

Licensing Authority of the license from CRB Monitor data

updated_requirement_response.​documents[].​license_identifierstring

License Number in CRB Monitor

updated_requirement_response.​documents[].​uniform_license_type_descriptionstring
Enum"Caregiver""CBD""Corporate Officer""Cultivation""Delivery/Transporter""Event Organizer""Hemp""Illicit Establishment""Management Company""Manufacturer/Processor"
updated_requirement_response.​documents[].​reported_license_type_descriptionstring

Reported license type description

updated_requirement_response.​documents[].​licensing_authority_statestring

State of the Licensing Authority

updated_requirement_response.​descriptionstring

Requirement Description

updated_requirement_response.​categorystring

Category

updated_requirement_response.​archivedboolean

Archived

updated_requirement_response.​requiredboolean

Required

Response
application/json
{
  "document_id": "string",
  "updated_requirement_response": {
    "requirement_id": "string",
    "date_updated": "string",
    "date_created": "string",
    "requirement_version": "string",
    "status": "string",
    "documents": [
      {
        "id": "string",
        "internal_note": "string",
        "friendly_name": "string",
        "expiration_date": "string",
        "license_name": "string",
        "license_number": "string",
        "state": "AL",
        "reviewed_by": "92ab4dbc-1b27-40ce-b24b-7dde8f4709be",
        "review_date": "2019-08-24T14:15:22Z",
        "status": "approved",
        "file_name": "string",
        "uploaded_by": "string",
        "upload_date": "2019-08-24T14:15:22Z",
        "tribal_nation": "string",
        "tribal_nation_license_type": "Cultivator",
        "license_status": "Active",
        "date_verified": "string",
        "verified_expiration_date": "string",
        "business_name": "string",
        "licensing_authority": "string",
        "license_identifier": "string",
        "uniform_license_type_description": "Caregiver",
        "reported_license_type_description": "string",
        "licensing_authority_state": "string"
      }
    ],
    "name": "string",
    "description": "string",
    "category": "string",
    "archived": true,
    "required": true
  }
}

Update a document's status

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

requirement_idstringrequired

Requirement Id

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

Document Id

Bodyapplication/jsonrequired
statusstringrequired
Enum"approved""archived""pending"
curl -i -X PUT \
  'https://developer.greencheckverified.com/_mock/apis/swagger/service-providers/{sp_id}/crbs/{crb_id}/onboarding-template/requirements/{requirement_id}/documents/{document_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "approved"
  }'

Responses

Ok

Bodyapplication/json
namestringrequired

Requirement Name

requirement_idstring

Requirement ID

date_updatedstring

Date Updated

date_createdstring

Date Created

requirement_versionstring

Requirement Version

statusstring

Status

documentsArray of objects

Custom field data

documents[].​idstringrequired

Document ID

documents[].​statusstringrequired
Enum"approved""archived""pending"
documents[].​uploaded_bystringrequired

Uploaded By

documents[].​upload_datestring(date-time)required
documents[].​internal_notestring

Service provider Internal Note

documents[].​friendly_namestring

Service provider friendly file name

documents[].​expiration_datestring

Expiration Date

documents[].​license_namestring

License Name

documents[].​license_numberstring

License Number

documents[].​statestring

Enumeration of all of the United States

Enum"AL""AK""AZ""AR""AS""CA""CO""CT""DE""DC"
documents[].​reviewed_bystring(uuid)^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F...
documents[].​review_datestring(date-time)
documents[].​file_namestring

File Name

documents[].​tribal_nationstring
documents[].​tribal_nation_license_typestring
Enum"Cultivator""Processor""Lab""Dispensary (Adult / Medical)""Social Consumption / Events""Delivery / Transport""Combined License""Other"
documents[].​license_statusstring

This enum is used within our UI to display the license status. 1:1 with CRBMUniformLicenseStatusDescription + Unchecked

Enum"Active""Approved/Pending""Inactive""Pre-License""Unknown""Unlicensed""Unmatched"
documents[].​date_verifiedstring

Date that GCV Verified the license in CRB Monitor

documents[].​verified_expiration_datestring

Confirmed expiration date from CRB Monitor data

documents[].​business_namestring

Legal business name on the license from CRB Monitor data

documents[].​licensing_authoritystring

Licensing Authority of the license from CRB Monitor data

documents[].​license_identifierstring

License Number in CRB Monitor

documents[].​uniform_license_type_descriptionstring
Enum"Caregiver""CBD""Corporate Officer""Cultivation""Delivery/Transporter""Event Organizer""Hemp""Illicit Establishment""Management Company""Manufacturer/Processor"
documents[].​reported_license_type_descriptionstring

Reported license type description

documents[].​licensing_authority_statestring

State of the Licensing Authority

descriptionstring

Requirement Description

categorystring

Category

archivedboolean

Archived

requiredboolean

Required

Response
application/json
{
  "requirement_id": "string",
  "date_updated": "string",
  "date_created": "string",
  "requirement_version": "string",
  "status": "string",
  "documents": [
    {
      "id": "string",
      "internal_note": "string",
      "friendly_name": "string",
      "expiration_date": "string",
      "license_name": "string",
      "license_number": "string",
      "state": "AL",
      "reviewed_by": "92ab4dbc-1b27-40ce-b24b-7dde8f4709be",
      "review_date": "2019-08-24T14:15:22Z",
      "status": "approved",
      "file_name": "string",
      "uploaded_by": "string",
      "upload_date": "2019-08-24T14:15:22Z",
      "tribal_nation": "string",
      "tribal_nation_license_type": "Cultivator",
      "license_status": "Active",
      "date_verified": "string",
      "verified_expiration_date": "string",
      "business_name": "string",
      "licensing_authority": "string",
      "license_identifier": "string",
      "uniform_license_type_description": "Caregiver",
      "reported_license_type_description": "string",
      "licensing_authority_state": "string"
    }
  ],
  "name": "string",
  "description": "string",
  "category": "string",
  "archived": true,
  "required": true
}

CRB

Operations

Customers

Operations

Documents

Operations

Inventory

Operations

Inventory Locations

Operations

Products

Operations

Sales

Operations