OnboardingTemplateResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/green-check-verified/main/json-schema/green-check-verified-onboarding-template-response-schema.json",
  "title": "OnboardingTemplateResponse",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/green-check-verified-crb-templates-api-openapi.yml#/components/schemas/OnboardingTemplateResponse",
  "properties": {
    "id": {
      "$ref": "#/$defs/UUID",
      "description": "Record ID"
    },
    "org_id": {
      "$ref": "#/$defs/UUID",
      "description": "Crb Organization ID"
    },
    "template_id": {
      "$ref": "#/$defs/UUID",
      "description": "Template ID"
    },
    "template_version": {
      "type": "string",
      "description": "Template Version"
    },
    "name": {
      "type": "string",
      "description": "Template Name"
    },
    "description": {
      "type": "string",
      "description": "Template Description"
    },
    "last_updated": {
      "type": "string",
      "description": "Last Updated"
    },
    "start_date": {
      "type": "string",
      "description": "Start Date"
    },
    "submitted_date": {
      "type": "string",
      "description": "Submitted Date"
    },
    "submitted_by": {
      "$ref": "#/$defs/UUID",
      "description": "Submitted By"
    },
    "status": {
      "$ref": "#/$defs/DueDiligenceStatus",
      "description": "Due Diligence Status"
    },
    "reviewed_by": {
      "$ref": "#/$defs/UUID",
      "description": "Reviewed By"
    },
    "review_start_date": {
      "type": [
        "string",
        "null"
      ],
      "description": "Review Start Date"
    },
    "review_date": {
      "type": "string",
      "description": "Review Date"
    },
    "disconnected_on": {
      "type": [
        "string",
        "null"
      ],
      "description": "Disconnected On"
    },
    "standard_requirements": {
      "items": {
        "$ref": "#/$defs/DocumentRequirementResponse"
      },
      "type": "array",
      "description": "All Onboarding template document data"
    },
    "custom_requirements": {
      "items": {
        "$ref": "#/$defs/CustomRequirementResponse"
      },
      "type": "array",
      "description": "Custom field data"
    }
  },
  "required": [
    "id",
    "org_id",
    "template_id",
    "template_version",
    "name",
    "last_updated",
    "status",
    "review_start_date",
    "disconnected_on",
    "standard_requirements",
    "custom_requirements"
  ],
  "type": "object",
  "additionalProperties": false,
  "$defs": {
    "CRBLicenseStatus": {
      "description": "This enum is used within our UI to display the license status.\n1:1 with CRBMUniformLicenseStatusDescription + Unchecked",
      "enum": [
        "Active",
        "Approved/Pending",
        "Inactive",
        "Pre-License",
        "Unknown",
        "Unlicensed",
        "Unmatched"
      ],
      "type": "string"
    },
    "CRBMUniformLicenseTypeDescription": {
      "enum": [
        "Caregiver",
        "CBD",
        "Corporate Officer",
        "Cultivation",
        "Delivery/Transporter",
        "Event Organizer",
        "Hemp",
        "Illicit Establishment",
        "Management Company",
        "Manufacturer/Processor",
        "Owner/Investor",
        "Research",
        "Retail/Dispensary",
        "Senior Manager",
        "Social Use Club",
        "Storage",
        "Testing",
        "Unknown",
        "Vertically Integrated",
        "Waste Disposal",
        "Wholesale/Distribution"
      ],
      "type": "string"
    },
    "CustomRequirementResponse": {
      "properties": {
        "id": {
          "type": "string",
          "description": "Field ID"
        },
        "label": {
          "type": "string",
          "description": "Custom Field Name"
        },
        "value": {
          "type": [
            "string",
            "null"
          ],
          "description": "Custom Field Value"
        },
        "doc_metadata": {
          "items": {
            "properties": {
              "upload_date": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "file_name": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "id": {
                "type": "string"
              }
            },
            "required": [
              "upload_date",
              "file_name",
              "id"
            ],
            "type": "object"
          },
          "type": "array",
          "description": "Additional metadata about documents uploaded"
        }
      },
      "required": [
        "id",
        "label",
        "value"
      ],
      "type": "object",
      "additionalProperties": false
    },
    "DocumentRequirementResponse": {
      "properties": {
        "requirement_id": {
          "type": "string",
          "description": "Requirement ID"
        },
        "date_updated": {
          "type": "string",
          "description": "Date Updated"
        },
        "date_created": {
          "type": "string",
          "description": "Date Created"
        },
        "requirement_version": {
          "type": "string",
          "description": "Requirement Version"
        },
        "status": {
          "type": "string",
          "description": "Status"
        },
        "documents": {
          "items": {
            "$ref": "#/$defs/RequirementDocumentResponse"
          },
          "type": "array",
          "description": "Custom field data"
        },
        "name": {
          "type": "string",
          "description": "Requirement Name"
        },
        "description": {
          "type": "string",
          "description": "Requirement Description"
        },
        "category": {
          "type": "string",
          "description": "Category"
        },
        "archived": {
          "type": "boolean",
          "description": "Archived"
        },
        "required": {
          "type": "boolean",
          "description": "Required"
        }
      },
      "required": [
        "name"
      ],
      "type": "object",
      "additionalProperties": false
    },
    "DueDiligenceDocumentStatus": {
      "enum": [
        "approved",
        "archived",
        "pending"
      ],
      "type": "string"
    },
    "DueDiligenceStatus": {
      "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",
        "update_required"
      ],
      "type": "string"
    },
    "RequirementDocumentResponse": {
      "properties": {
        "id": {
          "type": "string",
          "description": "Document ID"
        },
        "internal_note": {
          "type": "string",
          "description": "Service provider Internal Note"
        },
        "friendly_name": {
          "type": "string",
          "description": "Service provider friendly file name"
        },
        "expiration_date": {
          "type": "string",
          "description": "Expiration Date"
        },
        "license_name": {
          "type": "string",
          "description": "License Name"
        },
        "license_number": {
          "type": "string",
          "description": "License Number"
        },
        "state": {
          "$ref": "#/$defs/USStates",
          "description": "State"
        },
        "reviewed_by": {
          "$ref": "#/$defs/UUID",
          "description": "Reviewed By"
        },
        "review_date": {
          "$ref": "#/$defs/UtcDateTime",
          "description": "Review Date",
          "type": "string",
          "format": "date-time"
        },
        "status": {
          "$ref": "#/$defs/DueDiligenceDocumentStatus",
          "description": "Due Diligence Document Status"
        },
        "file_name": {
          "type": "string",
          "description": "File Name"
        },
        "uploaded_by": {
          "type": "string",
          "description": "Uploaded By"
        },
        "upload_date": {
          "$ref": "#/$defs/UtcDateTime",
          "description": "Uploaded Date",
          "type": "string",
          "format": "date-time"
        },
        "tribal_nation": {
          "$ref": "#/$defs/TribalNation",
          "description": "Tribal Nation"
        },
        "tribal_nation_license_type": {
          "$ref": "#/$defs/TribalNationLicenseType",
          "description": "Tribal Nation licenses type"
        },
        "license_status": {
          "$ref": "#/$defs/CRBLicenseStatus",
          "description": "License status for CRB Monitor, only for business licenses"
        },
        "date_verified": {
          "type": "string",
          "description": "Date that GCV Verified the license in CRB Monitor"
        },
        "verified_expiration_date": {
          "type": "string",
          "description": "Confirmed expiration date from CRB Monitor data"
        },
        "business_name": {
          "type": "string",
          "description": "Legal business name on the license from CRB Monitor data"
        },
        "licensing_authority": {
          "type": "string",
          "description": "Licensing Authority of the license from CRB Monitor data"
        },
        "license_identifier": {
          "type": "string",
          "description": "License Number in CRB Monitor"
        },
        "uniform_license_type_description": {
          "$ref": "#/$defs/CRBMUniformLicenseTypeDescription",
          "description": "License type"
        },
        "reported_license_type_description": {
          "type": "string",
          "description": "Reported license type description"
        },
        "licensing_authority_state": {
          "type": "string",
          "description": "State of the Licensing Authority"
        }
      },
      "required": [
        "id",
        "status",
        "uploaded_by",
        "upload_date"
      ],
      "type": "object",
      "additionalProperties": false
    },
    "TribalNation": {
      "type": "string"
    },
    "TribalNationLicenseType": {
      "enum": [
        "Cultivator",
        "Processor",
        "Lab",
        "Dispensary (Adult / Medical)",
        "Social Consumption / Events",
        "Delivery / Transport",
        "Combined License",
        "Other"
      ],
      "type": "string"
    },
    "USStates": {
      "description": "Enumeration of all of the United States",
      "enum": [
        "AL",
        "AK",
        "AZ",
        "AR",
        "AS",
        "CA",
        "CO",
        "CT",
        "DE",
        "DC",
        "FM",
        "FL",
        "GA",
        "GU",
        "HI",
        "ID",
        "IL",
        "IN",
        "IA",
        "KS",
        "KY",
        "LA",
        "ME",
        "MD",
        "MA",
        "MH",
        "MI",
        "MN",
        "MS",
        "MO",
        "MT",
        "NE",
        "NV",
        "NH",
        "NJ",
        "NM",
        "NY",
        "NC",
        "ND",
        "MP",
        "OH",
        "OK",
        "OR",
        "PW",
        "PA",
        "PR",
        "RI",
        "SC",
        "SD",
        "TN",
        "TX",
        "UM",
        "UT",
        "VT",
        "VA",
        "VI",
        "WA",
        "WV",
        "WI",
        "WY",
        "AA",
        "AE",
        "AP"
      ],
      "type": "string"
    },
    "UUID": {
      "type": "string",
      "format": "uuid",
      "pattern": "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$"
    },
    "UtcDateTime": {
      "type": "string",
      "format": "date-time"
    }
  }
}