Skip to content
/
Search for CRB info by EI...

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 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""insurance""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"
      }
    ]
  }
]

Search for CRB info by EIN.

Request

Checks to see if any CRBs in our system have the provided EIN.

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

Query
einstring^\d{2}-\d{7}$required

EIN of potential CRB in system

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

Responses

Ok

Bodyapplication/jsonArray [
einstringrequired
namestring
mailingstreetaddressstring
mailingstatestring
mailingpostalcodestring
mailingcitystring
streetaddressstring
statestring
postalcodestring
citystring
]
Response
application/json
[
  {
    "ein": "string",
    "name": "string",
    "mailingstreetaddress": "string",
    "mailingstate": "string",
    "mailingpostalcode": "string",
    "mailingcity": "string",
    "streetaddress": "string",
    "state": "string",
    "postalcode": "string",
    "city": "string"
  }
]

Connect a CRB to a SP by CRB_ID.

Request

Connects a CRB to a Service Provider by CRB_ID.

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
idstringrequired
template_idstring
curl -i -X POST \
  'https://developer.greencheckverified.com/_mock/apis/swagger/service-providers/{sp_id}/connect-crb' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "template_id": "string"
  }'

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
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "street_address": "string",
  "street_address_2": "string",
  "city": "string",
  "ein": "string",
  "phone_number": "string",
  "postal_code": "string",
  "country": "string",
  "state": "AL",
  "website": "string",
  "timezone": "America/New_York",
  "mailing_street_address": "string",
  "mailing_city": "string",
  "mailing_state": "AL",
  "mailing_postal_code": "string",
  "established_date": "string",
  "ftEmployees": 0,
  "ptEmployees": 0,
  "entityType": "sole",
  "dba": "string",
  "monthlySales": "string",
  "monthlyCustomers": 0
}

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