---
title: "Crear esquema mDoc con namespace propio"
---

> Documentation Index
> Fetch the complete documentation index at: https://sovra-id-docs-1044960690985.us-central1.run.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Crear esquema mDoc con namespace propio

Path: Sovra ID API › Esquemas

`POST /api/v1/issuer/schemas`

URL: `https://test-api-sovra.flagonsa.com/api/v1/issuer/schemas`

Crea el esquema. **`format`, `doc_type` y `namespace` son inmutables de por vida**: quedan firmados dentro de cada credencial emitida.

`namespace` propio ⇒ no corre la validación del catálogo ISO, de modo que los claims propios (`curp`, `neighborhood`, `organ_donor`, `blood_type`, `allergies`, `emergency_phone`, `second_family_name`, `street`, `exterior_number`, `interior_number`) son admitidos.

`disclosable: false` es lo que el dashboard rotula **always shared**: el claim viaja en toda presentación y el ciudadano no puede retenerlo.

🔴 `validity_period: null` **no** significa «sin vencimiento» en mDoc: ISO hace obligatorio `validUntil` y la emisión recaería en un año por defecto. De ahí `"4y"`.

Respuesta `201`. El esquema queda `pending` hasta que su credential type se inscriba on-chain; nada se emite antes.

## Authentication

- `apiKey`, http bearer, header `Authorization`

## Request body

_Required._

- `schema_id` (`createSchema.schema_id`; string, optional)
- `credential_type` (`createSchema.credential_type`; string, optional)
- `name` (`createSchema.name`; string, optional)
- `format` (`createSchema.format`; string, optional)
- `namespace` (`createSchema.namespace`; string, optional)
- `validity_period` (`createSchema.validity_period`; string, optional)
- `claims` (`createSchema.claims`; array of object, optional)
  - `key` (`createSchema.claims.key`; string, optional)
  - `label` (`createSchema.claims.label`; string, optional)
  - `type` (`createSchema.claims.type`; string, optional)
  - `required` (`createSchema.claims.required`; boolean, optional)
  - `disclosable` (`createSchema.claims.disclosable`; boolean, optional)

## Example requests

### Crear esquema mDoc con namespace propio

```json
{
  "schema_id": "driving_licence_v2",
  "credential_type": "DrivingLicence",
  "name": "Driving Licence v2",
  "format": "mso_mdoc",
  "namespace": "mx.gob.nl.icv.1",
  "validity_period": "4y",
  "claims": [
    {
      "key": "given_name",
      "label": "Nombre",
      "type": "string",
      "required": true,
      "disclosable": false
    },
    {
      "key": "family_name",
      "label": "Apellido paterno",
      "type": "string",
      "required": true,
      "disclosable": false
    },
    {
      "key": "second_family_name",
      "label": "Apellido materno",
      "type": "string",
      "required": false,
      "disclosable": false
    },
    {
      "key": "birth_date",
      "label": "Fecha de nacimiento",
      "type": "date",
      "required": true,
      "disclosable": true
    },
    {
      "key": "document_number",
      "label": "Folio de licencia",
      "type": "string",
      "required": true,
      "disclosable": false
    },
    {
      "key": "issue_date",
      "label": "Fecha de expedición",
      "type": "date",
      "required": true,
      "disclosable": false
    },
    {
      "key": "expiry_date",
      "label": "Fecha de vencimiento",
      "type": "date",
      "required": true,
      "disclosable": false
    },
    {
      "key": "driving_privileges",
      "label": "Tipo y restricciones",
      "type": "driving_privileges",
      "required": true,
      "disclosable": false
    },
    {
      "key": "portrait",
      "label": "Foto",
      "type": "bytes",
      "required": true,
      "disclosable": false
    },
    {
      "key": "issuing_authority",
      "label": "Autorizado por",
      "type": "string",
      "required": true,
      "disclosable": false
    },
    {
      "key": "signature_usual_mark",
      "label": "Firma",
      "type": "bytes",
      "required": false,
      "disclosable": true
    },
    {
      "key": "street",
      "label": "Calle",
      "type": "string",
      "required": false,
      "disclosable": true
    },
    {
      "key": "exterior_number",
      "label": "Número exterior",
      "type": "string",
      "required": false,
      "disclosable": true
    },
    {
      "key": "interior_number",
      "label": "Número interior",
      "type": "string",
      "required": false,
      "disclosable": true
    },
    {
      "key": "neighborhood",
      "label": "Colonia",
      "type": "string",
      "required": false,
      "disclosable": true
    },
    {
      "key": "resident_city",
      "label": "Municipio",
      "type": "string",
      "required": false,
      "disclosable": true
    },
    {
      "key": "resident_postal_code",
      "label": "Código postal",
      "type": "string",
      "required": false,
      "disclosable": true
    },
    {
      "key": "issuing_country",
      "label": "País emisor",
      "type": "string",
      "required": false,
      "disclosable": true
    },
    {
      "key": "age_over_18",
      "label": "Mayor de 18",
      "type": "boolean",
      "required": false,
      "disclosable": true
    },
    {
      "key": "curp",
      "label": "CURP",
      "type": "string",
      "required": false,
      "disclosable": true
    },
    {
      "key": "organ_donor",
      "label": "Donador",
      "type": "boolean",
      "required": false,
      "disclosable": true
    },
    {
      "key": "blood_type",
      "label": "Tipo sanguíneo",
      "type": "string",
      "required": false,
      "disclosable": true
    },
    {
      "key": "allergies",
      "label": "Alergias",
      "type": "string",
      "required": false,
      "disclosable": true
    },
    {
      "key": "emergency_phone",
      "label": "Teléfono de emergencia",
      "type": "string",
      "required": false,
      "disclosable": true
    }
  ]
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url https://test-api-sovra.flagonsa.com/api/v1/issuer/schemas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "schema_id": "driving_licence_v2",
  "credential_type": "DrivingLicence",
  "name": "Driving Licence v2",
  "format": "mso_mdoc",
  "namespace": "mx.gob.nl.icv.1",
  "validity_period": "4y",
  "claims": [
    {
      "key": "given_name",
      "label": "Nombre",
      "type": "string",
      "required": true,
      "disclosable": false
    },
    {
      "key": "family_name",
      "label": "Apellido paterno",
      "type": "string",
      "required": true,
      "disclosable": false
    },
    {
      "key": "second_family_name",
      "label": "Apellido materno",
      "type": "string",
      "required": false,
      "disclosable": false
    },
    {
      "key": "birth_date",
      "label": "Fecha de nacimiento",
      "type": "date",
      "required": true,
      "disclosable": true
    },
    {
      "key": "document_number",
      "label": "Folio de licencia",
      "type": "string",
      "required": true,
      "disclosable": false
    },
    {
      "key": "issue_date",
      "label": "Fecha de expedición",
      "type": "date",
      "required": true,
      "disclosable": false
    },
    {
      "key": "expiry_date",
      "label": "Fecha de vencimiento",
      "type": "date",
      "required": true,
      "disclosable": false
    },
    {
      "key": "driving_privileges",
      "label": "Tipo y restricciones",
      "type": "driving_privileges",
      "required": true,
      "disclosable": false
    },
    {
      "key": "portrait",
      "label": "Foto",
      "type": "bytes",
      "required": true,
      "disclosable": false
    },
    {
      "key": "issuing_authority",
      "label": "Autorizado por",
      "type": "string",
      "required": true,
      "disclosable": false
    },
    {
      "key": "signature_usual_mark",
      "label": "Firma",
      "type": "bytes",
      "required": false,
      "disclosable": true
    },
    {
      "key": "street",
      "label": "Calle",
      "type": "string",
      "required": false,
      "disclosable": true
    },
    {
      "key": "exterior_number",
      "label": "Número exterior",
      "type": "string",
      "required": false,
      "disclosable": true
    },
    {
      "key": "interior_number",
      "label": "Número interior",
      "type": "string",
      "required": false,
      "disclosable": true
    },
    {
      "key": "neighborhood",
      "label": "Colonia",
      "type": "string",
      "required": false,
      "disclosable": true
    },
    {
      "key": "resident_city",
      "label": "Municipio",
      "type": "string",
      "required": false,
      "disclosable": true
    },
    {
      "key": "resident_postal_code",
      "label": "Código postal",
      "type": "string",
      "required": false,
      "disclosable": true
    },
    {
      "key": "issuing_country",
      "label": "País emisor",
      "type": "string",
      "required": false,
      "disclosable": true
    },
    {
      "key": "age_over_18",
      "label": "Mayor de 18",
      "type": "boolean",
      "required": false,
      "disclosable": true
    },
    {
      "key": "curp",
      "label": "CURP",
      "type": "string",
      "required": false,
      "disclosable": true
    },
    {
      "key": "organ_donor",
      "label": "Donador",
      "type": "boolean",
      "required": false,
      "disclosable": true
    },
    {
      "key": "blood_type",
      "label": "Tipo sanguíneo",
      "type": "string",
      "required": false,
      "disclosable": true
    },
    {
      "key": "allergies",
      "label": "Alergias",
      "type": "string",
      "required": false,
      "disclosable": true
    },
    {
      "key": "emergency_phone",
      "label": "Teléfono de emergencia",
      "type": "string",
      "required": false,
      "disclosable": true
    }
  ]
}
'
```

### TypeScript

```typescript
const url = 'https://test-api-sovra.flagonsa.com/api/v1/issuer/schemas';
const options = {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer <token>'
  },
  body: JSON.stringify({
    schema_id: 'driving_licence_v2',
    credential_type: 'DrivingLicence',
    name: 'Driving Licence v2',
    format: 'mso_mdoc',
    namespace: 'mx.gob.nl.icv.1',
    validity_period: '4y',
    claims: [
      {
        key: 'given_name',
        label: 'Nombre',
        type: 'string',
        required: true,
        disclosable: false
      },
      {
        key: 'family_name',
        label: 'Apellido paterno',
        type: 'string',
        required: true,
        disclosable: false
      },
      {
        key: 'second_family_name',
        label: 'Apellido materno',
        type: 'string',
        required: false,
        disclosable: false
      },
      {
        key: 'birth_date',
        label: 'Fecha de nacimiento',
        type: 'date',
        required: true,
        disclosable: true
      },
      {
        key: 'document_number',
        label: 'Folio de licencia',
        type: 'string',
        required: true,
        disclosable: false
      },
      {
        key: 'issue_date',
        label: 'Fecha de expedición',
        type: 'date',
        required: true,
        disclosable: false
      },
      {
        key: 'expiry_date',
        label: 'Fecha de vencimiento',
        type: 'date',
        required: true,
        disclosable: false
      },
      {
        key: 'driving_privileges',
        label: 'Tipo y restricciones',
        type: 'driving_privileges',
        required: true,
        disclosable: false
      },
      {
        key: 'portrait',
        label: 'Foto',
        type: 'bytes',
        required: true,
        disclosable: false
      },
      {
        key: 'issuing_authority',
        label: 'Autorizado por',
        type: 'string',
        required: true,
        disclosable: false
      },
      {
        key: 'signature_usual_mark',
        label: 'Firma',
        type: 'bytes',
        required: false,
        disclosable: true
      },
      {
        key: 'street',
        label: 'Calle',
        type: 'string',
        required: false,
        disclosable: true
      },
      {
        key: 'exterior_number',
        label: 'Número exterior',
        type: 'string',
        required: false,
        disclosable: true
      },
      {
        key: 'interior_number',
        label: 'Número interior',
        type: 'string',
        required: false,
        disclosable: true
      },
      {
        key: 'neighborhood',
        label: 'Colonia',
        type: 'string',
        required: false,
        disclosable: true
      },
      {
        key: 'resident_city',
        label: 'Municipio',
        type: 'string',
        required: false,
        disclosable: true
      },
      {
        key: 'resident_postal_code',
        label: 'Código postal',
        type: 'string',
        required: false,
        disclosable: true
      },
      {
        key: 'issuing_country',
        label: 'País emisor',
        type: 'string',
        required: false,
        disclosable: true
      },
      {
        key: 'age_over_18',
        label: 'Mayor de 18',
        type: 'boolean',
        required: false,
        disclosable: true
      },
      {key: 'curp', label: 'CURP', type: 'string', required: false, disclosable: true},
      {
        key: 'organ_donor',
        label: 'Donador',
        type: 'boolean',
        required: false,
        disclosable: true
      },
      {
        key: 'blood_type',
        label: 'Tipo sanguíneo',
        type: 'string',
        required: false,
        disclosable: true
      },
      {
        key: 'allergies',
        label: 'Alergias',
        type: 'string',
        required: false,
        disclosable: true
      },
      {
        key: 'emergency_phone',
        label: 'Teléfono de emergencia',
        type: 'string',
        required: false,
        disclosable: true
      }
    ]
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://test-api-sovra.flagonsa.com/api/v1/issuer/schemas"

payload = {
    "schema_id": "driving_licence_v2",
    "credential_type": "DrivingLicence",
    "name": "Driving Licence v2",
    "format": "mso_mdoc",
    "namespace": "mx.gob.nl.icv.1",
    "validity_period": "4y",
    "claims": [
        {
            "key": "given_name",
            "label": "Nombre",
            "type": "string",
            "required": True,
            "disclosable": False
        },
        {
            "key": "family_name",
            "label": "Apellido paterno",
            "type": "string",
            "required": True,
            "disclosable": False
        },
        {
            "key": "second_family_name",
            "label": "Apellido materno",
            "type": "string",
            "required": False,
            "disclosable": False
        },
        {
            "key": "birth_date",
            "label": "Fecha de nacimiento",
            "type": "date",
            "required": True,
            "disclosable": True
        },
        {
            "key": "document_number",
            "label": "Folio de licencia",
            "type": "string",
            "required": True,
            "disclosable": False
        },
        {
            "key": "issue_date",
            "label": "Fecha de expedición",
            "type": "date",
            "required": True,
            "disclosable": False
        },
        {
            "key": "expiry_date",
            "label": "Fecha de vencimiento",
            "type": "date",
            "required": True,
            "disclosable": False
        },
        {
            "key": "driving_privileges",
            "label": "Tipo y restricciones",
            "type": "driving_privileges",
            "required": True,
            "disclosable": False
        },
        {
            "key": "portrait",
            "label": "Foto",
            "type": "bytes",
            "required": True,
            "disclosable": False
        },
        {
            "key": "issuing_authority",
            "label": "Autorizado por",
            "type": "string",
            "required": True,
            "disclosable": False
        },
        {
            "key": "signature_usual_mark",
            "label": "Firma",
            "type": "bytes",
            "required": False,
            "disclosable": True
        },
        {
            "key": "street",
            "label": "Calle",
            "type": "string",
            "required": False,
            "disclosable": True
        },
        {
            "key": "exterior_number",
            "label": "Número exterior",
            "type": "string",
            "required": False,
            "disclosable": True
        },
        {
            "key": "interior_number",
            "label": "Número interior",
            "type": "string",
            "required": False,
            "disclosable": True
        },
        {
            "key": "neighborhood",
            "label": "Colonia",
            "type": "string",
            "required": False,
            "disclosable": True
        },
        {
            "key": "resident_city",
            "label": "Municipio",
            "type": "string",
            "required": False,
            "disclosable": True
        },
        {
            "key": "resident_postal_code",
            "label": "Código postal",
            "type": "string",
            "required": False,
            "disclosable": True
        },
        {
            "key": "issuing_country",
            "label": "País emisor",
            "type": "string",
            "required": False,
            "disclosable": True
        },
        {
            "key": "age_over_18",
            "label": "Mayor de 18",
            "type": "boolean",
            "required": False,
            "disclosable": True
        },
        {
            "key": "curp",
            "label": "CURP",
            "type": "string",
            "required": False,
            "disclosable": True
        },
        {
            "key": "organ_donor",
            "label": "Donador",
            "type": "boolean",
            "required": False,
            "disclosable": True
        },
        {
            "key": "blood_type",
            "label": "Tipo sanguíneo",
            "type": "string",
            "required": False,
            "disclosable": True
        },
        {
            "key": "allergies",
            "label": "Alergias",
            "type": "string",
            "required": False,
            "disclosable": True
        },
        {
            "key": "emergency_phone",
            "label": "Teléfono de emergencia",
            "type": "string",
            "required": False,
            "disclosable": True
        }
    ]
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

Respuesta exitosa. La colección de Postman de origen no incluye el cuerpo de la respuesta; ver la guía de referencia.


Source: https://sovra-id-docs-1044960690985.us-central1.run.app/api/create-schema/index.md
