Skip to content
Navigation

Crear esquema mDoc con namespace propio

POST
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.

Authorization

  • apiKey
    HTTP Bearer
    required

    Authorization: Bearer <token>

Request body JSON required

  • schema_id
    optional
    string
  • credential_type
    optional
    string
  • name
    optional
    string
  • format
    optional
    string
  • namespace
    optional
    string
  • validity_period
    optional
    string
  • claims
    optional
    array of
    object
    • key
      optional
      string
    • label
      optional
      string
    • type
      optional
      string
    • required
      optional
      boolean
    • disclosable
      optional
      boolean

Example request

{
  "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
    }
  ]
}

Returns

200

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

Type to search…

↑↓ navigate↵ selectEsc close