---
title: "Get CRB's onboarding template for service provider"
method: GET
path: "/service-providers/{sp_id}/crbs/{crb_id}/onboarding-template"
tags: ["CRB Templates"]
---

# Get CRB's onboarding template for service provider

`GET /service-providers/{sp_id}/crbs/{crb_id}/onboarding-template`

## Request

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

## Path parameters

- `sp_id` string, required
- `crb_id` string, required

## Response `201`

Created

- OnboardingTemplateResponse
  - `id` string, uuid, required
  - `org_id` string, uuid, required
  - `template_id` string, uuid, required
  - `template_version` string, required: Template Version
  - `name` string, required: Template Name
  - `description` string: Template Description
  - `last_updated` string, required: Last Updated
  - `start_date` string: Start Date
  - `submitted_date` string: Submitted Date
  - `submitted_by` string, uuid
  - `status` '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', required
  - `reviewed_by` string, uuid
  - `review_start_date` string, nullable, required: Review Start Date
  - `review_date` string: Review Date
  - `disconnected_on` string, nullable, required: Disconnected On
  - `standard_requirements` DocumentRequirementResponse[], required: All Onboarding template document data
    - `requirement_id` string: Requirement ID
    - `date_updated` string: Date Updated
    - `date_created` string: Date Created
    - `requirement_version` string: Requirement Version
    - `status` string: Status
    - `documents` RequirementDocumentResponse[]: Custom field data
      - `id` string, required: Document ID
      - `internal_note` string: Service provider Internal Note
      - `friendly_name` string: Service provider friendly file name
      - `expiration_date` string: Expiration Date
      - `license_name` string: License Name
      - `license_number` string: License Number
      - `state` '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': Enumeration of all of the United States
      - `reviewed_by` string, uuid
      - `review_date` string, date-time
      - `status` 'approved' | 'archived' | 'pending', required
      - `file_name` string: File Name
      - `uploaded_by` string: Uploaded By
      - `upload_date` string, date-time
      - `tribal_nation` string
      - `tribal_nation_license_type` 'Cultivator' | 'Processor' | 'Lab' | 'Dispensary (Adult / Medical)' | 'Social Consumption / Events' | 'Delivery / Transport' | 'Combined License' | 'Other'
      - `license_status` union: License status reported by Access: the verification statuses plus `Pending` for documents the nightly verification job has not run on yet.
        - 'Active' | 'Approved/Pending' | 'Inactive' | 'Pre-License' | 'Unknown' | 'Unlicensed' | 'Unmatched': This enum is used within our UI to display the license status. 1:1 with CRBMUniformLicenseStatusDescription + Unchecked
        - 'Pending'
      - `date_verified` string: Date that GCV verified the license through the license verification process
      - `verified_expiration_date` string: Confirmed expiration date from the license verification process
      - `business_name` string: Legal business name on the license from the license verification process
      - `licensing_authority` string: Licensing Authority of the license from the license verification process
      - `license_identifier` string: License identifier string
      - `uniform_license_type_description` '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'
      - `reported_license_type_description` string: Reported license type description
      - `licensing_authority_state` string: State of the Licensing Authority
    - `name` string, required: Requirement Name
    - `description` string: Requirement Description
    - `category` string: Category
    - `archived` boolean: Archived
    - `required` boolean: Required
  - `custom_requirements` CustomRequirementResponse[], required: Custom field data
    - `id` string, required: Field ID
    - `label` string, required: Custom Field Name
    - `value` string, nullable, required: Custom Field Value
    - `doc_metadata` object[]: Additional metadata about documents uploaded
      - `upload_date` string, nullable, required
      - `file_name` string, nullable, required
      - `id` string, 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)