> ## Documentation Index
> Fetch the complete documentation index at: https://docs.toku.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Onboarding Config

> Resolves the onboarding step configuration for a worker's country and employment type.

Required scope: `people:read`. With an API key, `roleInOrgId` must be set: a key has no person of its own.

## OpenAPI

````yaml api-reference/openapi.json GET /hris/get-onboarding-config
openapi: 3.1.0
info:
  title: Toku API
  version: 1.0.0
servers:
  - url: https://api.toku.com
security:
  - bearerAuth: []
paths:
  /hris/get-onboarding-config:
    get:
      operationId: getOnboardingConfig
      summary: Get Onboarding Config
      x-toku-required-scope: people:read
      description: >-
        Resolves the onboarding step configuration for a worker's country and
        employment type.


        Required scope: `people:read`. With an API key, `roleInOrgId` must be
        set: a key has no person of its own.
      parameters:
        - name: roleInOrgId
          in: query
          required: false
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOnboardingConfigResponse'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
        '409':
          description: Conflict
        '429':
          description: Response 429
components:
  schemas:
    GetOnboardingConfigResponse:
      type: object
      properties:
        countryCode:
          type: string
        countryName:
          type: string
        steps:
          type: array
          items:
            type: object
            properties:
              stepId:
                type: string
              label:
                type: string
              description:
                type: string
              order:
                type: number
              fields:
                type: array
                items:
                  type: object
                  properties:
                    fieldId:
                      type: string
                    label:
                      type: string
                    type:
                      type: string
                      enum:
                        - text
                        - email
                        - phone
                        - date
                        - select
                        - multi_select
                        - checkbox
                        - ssn
                        - address
                        - file_upload
                        - payment_split
                        - textarea
                        - number
                        - currency
                        - info_text
                    required:
                      type: boolean
                    excludeFromPayrollOnly:
                      type: boolean
                    placeholder:
                      type: string
                    helpText:
                      type: string
                    options:
                      type: array
                      items:
                        type: object
                        properties:
                          value:
                            type: string
                          label:
                            type: string
                        required:
                          - value
                          - label
                    conditionalOn:
                      type: object
                      properties:
                        fieldId:
                          type: string
                        values:
                          type: array
                          items:
                            type: string
                      required:
                        - fieldId
                        - values
                    retainWhenHidden:
                      type: boolean
                    encrypted:
                      type: boolean
                    masked:
                      type: boolean
                    validationMessage:
                      type: string
                    validationPattern:
                      type: string
                    maxFileSizeBytes:
                      type: number
                    acceptedFileTypes:
                      type: array
                      items:
                        type: string
                    legacyUploadFieldIds:
                      type: array
                      items:
                        type: string
                    documentCategory:
                      type: string
                    width:
                      type: string
                      enum:
                        - full
                        - half
                        - third
                    externalLinks:
                      type: array
                      items:
                        type: object
                        properties:
                          label:
                            type: string
                          url:
                            type: string
                        required:
                          - label
                          - url
                    persistence:
                      oneOf:
                        - type: object
                          properties:
                            kind:
                              const: skip
                          required:
                            - kind
                        - type: object
                          properties:
                            kind:
                              const: typed_column
                            column:
                              type: string
                            valueType:
                              type: string
                              enum:
                                - string
                                - boolean
                                - date
                                - decimal
                          required:
                            - kind
                            - column
                        - type: object
                          properties:
                            kind:
                              const: extension
                            extensionKey:
                              type: string
                            valueType:
                              type: string
                              enum:
                                - string
                                - boolean
                                - date
                                - decimal
                          required:
                            - kind
                            - extensionKey
                        - type: object
                          properties:
                            kind:
                              const: encrypted_typed_column
                            encryptedColumn:
                              type: string
                            lastFourColumn:
                              type: string
                            lastFourStrategy:
                              type: string
                              enum:
                                - digits
                                - alphanumeric
                          required:
                            - kind
                            - encryptedColumn
                            - lastFourColumn
                        - type: object
                          properties:
                            kind:
                              const: encrypted_extension
                            encryptedKey:
                              type: string
                            lastFourKey:
                              type: string
                            lastFourStrategy:
                              type: string
                              enum:
                                - digits
                                - alphanumeric
                          required:
                            - kind
                            - encryptedKey
                            - lastFourKey
                    citizenAnswer:
                      type: object
                      properties:
                        countryCode:
                          type: string
                        values:
                          type: array
                          items:
                            type: string
                          minItems: 1
                      required:
                        - countryCode
                        - values
                  required:
                    - fieldId
                    - label
                    - type
                    - required
              isBlocking:
                type: boolean
              isSkippable:
                type: boolean
              category:
                type: string
                enum:
                  - consent
                  - personal
                  - emergency
                  - work_auth
                  - tax_identity
                  - documents
                  - employment
                  - banking
                  - benefits
                  - review
                  - insurance
                  - statutory
                  - professional
                  - declarations
                  - provident_fund
                  - country_specific
              icon:
                type: string
            required:
              - stepId
              - label
              - description
              - order
              - fields
              - isBlocking
              - isSkippable
              - category
        isContractor:
          type: boolean
      required:
        - countryCode
        - countryName
        - steps
        - isContractor
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
````
