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

# Fetch the business credential's type metadata

> SD-JWT VC Type Metadata for the business credential: its display name and, per claim, a label, whether the claim is selectively disclosable, and whether it is mandatory. The URL is the credential's `vct`, served only on the production registry host. Unauthenticated; cacheable for one hour.



## OpenAPI

````yaml /api-reference/openapi.json get /vct/kya/business/v1
openapi: 3.1.0
info:
  title: baselayer-api-service
  version: 0.1.0
servers:
  - url: https://api.baselayer.com/
security: []
paths:
  /vct/kya/business/v1:
    servers:
      - url: https://registry.baselayer.com
        description: >-
          Public credential registry. These routes are served here, not on
          api.baselayer.com.
    get:
      tags:
        - Registry
      summary: Fetch the business credential's type metadata
      description: >-
        SD-JWT VC Type Metadata for the business credential: its display name
        and, per claim, a label, whether the claim is selectively disclosable,
        and whether it is mandatory. The URL is the credential's `vct`, served
        only on the production registry host. Unauthenticated; cacheable for one
        hour.
      operationId: vct_kya_business_get
      responses:
        '200':
          description: The Type Metadata document.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TypeMetadata'
        '400':
          description: The request's Host is missing, repeated or malformed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                title: InvalidHostHeader
                description: >-
                  The request's Host header is missing, repeated or malformed;
                  send exactly one Host of the form host[:port].
                examples:
                  - type: invalid_host_header
                    code: 6317
                    message: >-
                      The request's Host header is missing, repeated or
                      malformed; send exactly one Host of the form host[:port].
                    metadata: {}
        '404':
          description: The request's Host is not the production registry host.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                title: ResourceNotFound
                description: Could not locate the resource for the given URI.
                examples:
                  - type: resource_not_found
                    code: 1
                    message: Could not locate the resource for the given URI.
                    metadata: {}
        '422':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
                title: ValidationFailed
                description: The request is invalid.
                examples:
                  - type: validation_failed
                    code: 7112
                    message: The request is invalid.
                    metadata: {}
components:
  schemas:
    TypeMetadata:
      properties:
        vct:
          type: string
          title: Vct
        name:
          type: string
          title: Name
        description:
          type: string
          title: Description
        display:
          items:
            $ref: '#/components/schemas/TypeDisplay'
          type: array
          title: Display
        claims:
          items:
            $ref: '#/components/schemas/ClaimMetadata'
          type: array
          title: Claims
      additionalProperties: false
      type: object
      required:
        - vct
        - name
        - description
        - display
        - claims
      title: TypeMetadata
      description: A Type Metadata document (§5.2), served at its ``vct`` URL.
    Error:
      properties:
        type:
          type: string
          title: Type
          description: >-
            Stable snake_case name of the error. Branch on this, never on
            `message`.
        code:
          type: integer
          title: Code
          description: Integer catalog code of the error.
        message:
          type: string
          title: Message
          description: For a human reading a log; not stable and not localized.
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
          description: Context documented per `type`.
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
          description: The `X-Request-ID` of the failed request.
      type: object
      required:
        - type
        - code
        - message
      title: Error
      description: The one body of every error a KYA route answers.
    TypeDisplay:
      properties:
        locale:
          type: string
          title: Locale
          default: en-US
        name:
          type: string
          title: Name
        description:
          type: string
          title: Description
      additionalProperties: false
      type: object
      required:
        - name
        - description
      title: TypeDisplay
    ClaimMetadata:
      properties:
        path:
          items:
            type: string
          type: array
          minItems: 1
          title: Path
        display:
          items:
            $ref: '#/components/schemas/ClaimDisplay'
          type: array
          title: Display
        sd:
          $ref: '#/components/schemas/SelectiveDisclosure'
        mandatory:
          type: boolean
          title: Mandatory
          default: false
      additionalProperties: false
      type: object
      required:
        - path
        - display
        - sd
      title: ClaimMetadata
      description: |-
        One ``claims`` entry (§5.6). ``sd`` is always explicit, because an
        omitted ``sd`` means ``allowed``.
    ClaimDisplay:
      properties:
        locale:
          type: string
          title: Locale
          default: en-US
        label:
          type: string
          title: Label
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
      additionalProperties: false
      type: object
      required:
        - label
      title: ClaimDisplay
    SelectiveDisclosure:
      type: string
      enum:
        - always
        - allowed
        - never
      title: SelectiveDisclosure
      description: Whether the issuer makes a claim selectively disclosable (§5.6.4).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.