Schemas

List schemas

get

Returns a list of schemas available created and managed by the Wallet. The list can be filtered, sorted, and paginated by using the available query parameters.

Authorizations

AuthorizationstringOptional

Bearer authentication header of the form Bearer <token>.

Query parameters

orderstring · enumOptionalPossible values:

order_bystringOptional

per_pageinteger · min: 1 · max: 50Optional

pageinteger · min: 1Optional

searchstringOptional

Responses

200

Schemas successfully loaded

application/json

400

Invalid query params

application/json

get/issuer/schemas

GET /issuer/schemas HTTP/1.1
Host: zyfla-wallet-sandbox.meeco.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "schemas": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "format": "jwt_vc_json",
      "schema_json": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "created_at": "2026-07-14T00:26:47.952Z"
    }
  ],
  "meta": {
    "order_by": "name",
    "order": "ASC",
    "order_from_params": true,
    "per_page": 10,
    "per_page_from_params": true,
    "records_count": 100,
    "page": 1,
    "page_count": 10
  }
}

Create schema

post

schema_json must comply with the specification.

Schema validity can be checked by using one of the web validators listed at the JSON Schema tooling page.

schema_json.$id is not expected in the payload. The API assigns its own internal value even if one is provided.

There are additional restrictions for the dc+sd-jwt format.

There are registered JWT claims for this credential format (SD-JWT VC spec).

They are used internally and cannot be included as claims or defined as claims in the schema_json

The following claims cannot be icluded in schema_json.properties:

iss
nbf
exp
cnf
vct
vct#integrity
extends#integrity
schema_uri#integrity
sub
aud
jti
iat
_sd
_sd_alg

status is also a registered JWT claims. However currently SVX Wallet does not support status list for dc+sd-jwt. So this claim can be included in a dc+sd-jwt credential schema for users to manually set an externally maintained Status List. But status MUST always be shown and cannot be set as selectively disclosable.

For example, Status List:

  "status": {
    "status_list": {
      "idx": 0,
      "uri": "https://example.com/statuslists/1"
    }
  }

There are no restrictions for jwt_vc_json or mso_mdoc formats.

Example (jwt_vc_json format):

{
  "schema": {
    "name": "EmailCredential",
    "format": "jwt_vc_json",
    "schema_json": {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "description": "EmailCredential using JsonSchema",
      "type": "object",
      "properties": {
        "credentialSubject": {
          "type": "object",
          "properties": {
            "emailAddress": {
              "type": "string",
              "format": "email"
            }
          },
          "required": ["emailAddress"]
        }
      }
    }
  }
}

Example (dc+sd-jwt format):

{
  "schema": {
    "name": "SelectiveDisclosableCredential",
    "format": "dc+sd-jwt",
    "schema_json": {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "type": "object",
      "properties": {
        "iss": { "type": "string" },
        "email": { "type": "string" },
        "is_over_18": { "type": "boolean" }
      },
      "required": ["iss", "email", "is_over_18"]
    }
  }
}

Example (mso_mdoc format):

{
  "schema": {
    "name": "MobileDriverLicense",
    "format": "mso_mdoc",
    "schema_json": {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "type": "object",
      "properties": {
        "org.iso.18013.5.1": {
          "type": "object",
          "properties": {
            "email": { "type": "string" },
            "portrait": {
              "type": "string",
              "description": "jpeg as base64url encoded",
              "x-cbor-encoding": "bstr"
            }
          }
        }
      },
      "required": ["email", "portrait"]
    }
  }
}

Authorizations

AuthorizationstringOptional

Bearer authentication header of the form Bearer <token>.

Body

Responses

201

Schema successfully created

application/json

400

Invalid request payload

application/json

post/issuer/schemas

POST /issuer/schemas HTTP/1.1
Host: zyfla-wallet-sandbox.meeco.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 410

{
  "schema": {
    "name": "text",
    "format": "jwt_vc_json",
    "schema_json": {
      "$id": "text",
      "$schema": "http://json-schema.org/draft-07/schema#",
      "$comment": "text",
      "$defs": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "name": "text",
      "description": "text",
      "title": "text",
      "type": "text",
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "required": [
        "text"
      ],
      "additionalProperties": true,
      "examples": [],
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

{
  "schema": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "format": "jwt_vc_json",
    "schema_json": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "created_at": "2026-07-14T00:26:47.952Z"
  }
}

Get schema

get

Returns schema information for a given schema id. The schema information includes the JSON schema definition and metadata such as supported credential formats.

Authorizations

AuthorizationstringOptional

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

Responses

200

Schema successfully loaded

application/json

400

Invalid path param

application/json

500

Schema could not be loaded

application/json

get/issuer/schemas/{id}

GET /issuer/schemas/{id} HTTP/1.1
Host: zyfla-wallet-sandbox.meeco.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "schema": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "format": "jwt_vc_json",
    "schema_json": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "created_at": "2026-07-14T00:26:47.952Z"
  }
}

Update schema

put

Update schema information for a given schema id.

Note: Updating a schema may have implications on existing credential templates linked to the schema and issued credentials based on those templates. Ensure to review the changes carefully before updating a schema.

Authorizations

AuthorizationstringOptional

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

Body

Responses

200

Schema successfully updated

application/json

400

Invalid path param or payload

application/json

404

Schema not found

application/json

put/issuer/schemas/{id}

PUT /issuer/schemas/{id} HTTP/1.1
Host: zyfla-wallet-sandbox.meeco.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 387

{
  "schema": {
    "name": "text",
    "schema_json": {
      "$id": "text",
      "$schema": "http://json-schema.org/draft-07/schema#",
      "$comment": "text",
      "$defs": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "name": "text",
      "description": "text",
      "title": "text",
      "type": "text",
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "required": [
        "text"
      ],
      "additionalProperties": true,
      "examples": [],
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

{
  "schema": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "format": "jwt_vc_json",
    "schema_json": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "created_at": "2026-07-14T00:26:47.952Z"
  }
}

Delete schema

delete

Deletes a schema by its ID. Schemas that are linked to active credential templates or issued credentials cannot be deleted. Ensure to review the implications before deleting a schema.

Authorizations

AuthorizationstringOptional

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

Responses

204

Schema deleted

No content

400

Invalid path param

application/json

404

Schema not found

application/json

delete/issuer/schemas/{id}

DELETE /issuer/schemas/{id} HTTP/1.1
Host: zyfla-wallet-sandbox.meeco.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Retrieve credential schema definition

get

Returns credential schema (schema_json attribute value) in a format described by the specification.

Authorizations

AuthorizationstringOptional

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · uuidRequired

Responses

200

Schema definition loaded

application/json

$idstringOptional

$schemastring · enumRequiredPossible values:

$commentstringOptional

namestringOptional

descriptionstringOptional

titlestringOptional

typestringRequired

requiredstring[]Optional

additionalPropertiesbooleanOptional

Other propertiesanyOptional

400

Invalid path param

application/json

500

Unsupported schema credential type

application/json

get/issuer/schemas/{id}/schema.json

GET /issuer/schemas/{id}/schema.json HTTP/1.1
Host: zyfla-wallet-sandbox.meeco.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "$id": "text",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$comment": "text",
  "$defs": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "name": "text",
  "description": "text",
  "title": "text",
  "type": "text",
  "properties": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "required": [
    "text"
  ],
  "additionalProperties": true,
  "examples": [],
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Last updated 5 days ago