Crossmint Verifiable Credentials Types API

openapi: 3.2.0
info:
  contact:
    email: support@crossmint.com
    name: Crossmint Support
    url: https://www.crossmint.com
  description: Generated from Crossmint's published product API specifications. Do not edit by hand.
  title: Crossmint Verifiable Credentials Types API
  version: 1.0.0
servers:
- description: Staging environment (testnets)
  url: https://staging.crossmint.com/api
- description: Production environment (mainnets)
  url: https://www.crossmint.com/api
tags:
- name: Verifiable Credentials Types
paths:
  /v1-alpha1/credentials/types:
    post:
      description: 'Creates a credential type: the JSON Schema that every credential issued from it must match. Send the schema to create a type, or `$id` with a public URL to import an existing one. The type gets a generated ID, `crossmint::`; templates reference it by that ID.


        **API scope required**: `credentials.create`


        **Related**: Create credential types'
      operationId: credentials.types.create
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TypeDto'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedTypeResponseDto'
          description: The credential type with its `id` and the JSON Schema it enforces.
      security:
      - apiKey: []
      summary: Create Credential Type
      tags:
      - Verifiable Credentials Types
  /v1-alpha1/credentials/types/{typeId}:
    get:
      description: 'Returns a credential type with the JSON Schema its credentials must match.


        **API scope required**: `credentials.read`'
      operationId: credentials.types.get
      parameters:
      - description: The type's ID, `crossmint:<projectId>:<name>`.
        in: path
        name: typeId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedTypeResponseDto'
          description: The credential type with its `id` and the JSON Schema it enforces.
      security:
      - apiKey: []
      summary: Get Credential Type
      tags:
      - Verifiable Credentials Types
    put:
      description: 'Creates a credential type under a name you choose, so its ID is known in advance: `crossmint::`. Send the schema to create a type, or `$id` with a public URL to import an existing one.


        **API scope required**: `credentials.create`


        **Related**: Create credential types'
      operationId: credentials.types.createWithId
      parameters:
      - description: The name to create the type under.
        in: path
        name: typeId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TypeDto'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedTypeResponseDto'
          description: The credential type with its `id` and the JSON Schema it enforces.
      security:
      - apiKey: []
      summary: Create Credential Type with Name
      tags:
      - Verifiable Credentials Types
components:
  schemas:
    CreatedTypeResponseDto:
      properties:
        id:
          description: The type's ID, `crossmint:<projectId>:<name>`. Templates reference the type by this ID.
          type: string
        typeSchema:
          additionalProperties: {}
          description: The JSON Schema every credential of this type must match. `$id` is the URL the schema resolves at.
          propertyNames:
            type: string
          type: object
      required:
      - id
      - typeSchema
      title: Credential type
      type: object
    TypeDto:
      anyOf:
      - description: An existing JSON Schema to import by URL
        properties:
          $id:
            description: The schema URI to be imported, needs to be a public URL that resolves to a valid schema
            type: string
        required:
        - $id
        type: object
      - description: The type creation schema, in JSON SCHEMA format
        properties:
          $id:
            description: Should not be defined, will be generated automatically
            type: string
          $schema:
            const: https://json-schema.org/draft/2020-12/schema
            description: The JSON Schema version
            type: string
          description:
            description: The description of the schema
            type: string
          properties:
            description: The properties of the schema
            properties:
              credentialSubject:
                additionalProperties: {}
                description: The credential subject properties
                propertyNames:
                  type: string
                type: object
            required:
            - credentialSubject
            type: object
          title:
            description: The title of the schema
            type: string
          type:
            const: object
            description: Type needs to be `object`
            type: string
        required:
        - $schema
        - properties
        - title
        - type
        type: object
      description: The type schema, can be created or imported
  securitySchemes:
    apiKey:
      description: API key required for authentication
      in: header
      name: X-API-KEY
      type: apiKey
    orderClientSecret:
      description: The `clientSecret` returned when the order was created, sent as the raw `Authorization` header value. Lets a browser or mobile client read and continue its own order without a server-side API key.
      in: header
      name: Authorization
      type: apiKey
    userJwt:
      bearerFormat: JWT
      description: 'The end user''s JWT, sent as `Authorization: Bearer <JWT>` together with a client-side API key. Validated against the project''s external JWT configuration.'
      scheme: bearer
      type: http
x-provenance:
  method: harvested
  publisher: Crossmint
  source: https://www.crossmint.com/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)