---
title: "Get service provider onboarding templates"
method: GET
path: "/service-providers/{sp_id}/onboarding-templates"
tags: ["Service Provider"]
---

# Get service provider onboarding templates

`GET /service-providers/{sp_id}/onboarding-templates`

## Request

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

Get all onboarding templates

## Path parameters

- `sp_id` string, required

## Response `200`

Ok

- OnboardingTemplate[]
  - `template_id` string, required: ID of this template
  - `date_created` string, required
  - `date_updated` string, required
  - `updated_by` string, required
  - `created_by` string, required
  - `published_date` string
  - `published_by` string
  - `version` string, required: Current template version. Will be "draft" if unpublished changes
  - `name` string, required: Template name. Internal only
  - `description` string, required: Template description. Internal only
  - `custom_field_sections` object[], required: Custom fields array. These are a list of freeform questions to collect any information from your clients.
    - `smart_rule` SmartRule
      - `action` 'Show' | 'Hide', required: The desired action to take on the field if all conditions are true
      - `conditions` SmartRuleConditionStatement[], required: 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
        - `operator` 'Is Equal To' | 'Is Not Equal To' | 'Is Empty' | 'Is Filled', required: The different condition operators to use
        - `targetFieldId` string, required: The field to check the value of against the target value
        - `targetValue` string: The value upon which the operator checks against the target field's value
    - `fields` object[], required
      - `attachments` object[]: List of file names and document IDs of files attached to this field. Used in File and Display Content fields
        - `id` string, required
        - `file_name` string, required
      - `paragraph` string: Paragraph of text. Used in Display Content
      - `smart_rule` SmartRule
        - `action` 'Show' | 'Hide', required: The desired action to take on the field if all conditions are true
        - `conditions` SmartRuleConditionStatement[], required: 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
          - `operator` 'Is Equal To' | 'Is Not Equal To' | 'Is Empty' | 'Is Filled', required: The different condition operators to use
          - `targetFieldId` string, required: The field to check the value of against the target value
          - `targetValue` string: The value upon which the operator checks against the target field's value
      - `required` boolean: Set to true if this field should be required in the form
      - `helpText` string: Tooltip text
      - `label` string, required
      - `type` 'textSingleLine' | 'textMultiLine' | 'radio' | 'select' | 'checkbox' | 'date' | 'file' | 'fileDownload' | 'displayContent' | 'hyperlink', required
      - `id` string, required
    - `order` number, double, required
    - `description` string
    - `label` string, required
    - `section_id` string, required
  - `document_requirements` object[], required
    - `type` union, required
      - 'bank_custom'
      - 'business_license'
      - 'employee_license'
      - 'gcv_standard'
    - `archived` boolean
    - `required` boolean, required
    - `attachments` object[]
      - `id` string, required
      - `file_name` string, required
    - `category` 'financial' | 'insurance' | 'legal' | 'license' | 'operational', required
    - `description` string, required
    - `name` string, required
    - `requirement_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)