{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/storecove/json-schema/storecove-peppol-identifier-schema.json",
  "title": "PeppolIdentifier",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/storecove-peppolidentifiers-api-openapi.yml#/components/schemas/PeppolIdentifier",
  "properties": {
    "identifier": {
      "type": "string",
      "title": "Identifier",
      "description": "The identifier.",
      "minLength": 2,
      "maxLength": 64
    },
    "scheme": {
      "type": "string",
      "title": "Type",
      "description": "The scheme of the identifier. See <<_receiver_identifiers_list>> for a list.",
      "minLength": 2,
      "maxLength": 64
    },
    "superscheme": {
      "type": "string",
      "title": "Type",
      "description": "The superscheme of the identifier. Should always be \"iso6523-actorid-upis\".",
      "minLength": 2,
      "maxLength": 64
    },
    "corppass": {
      "allOf": [
        {
          "$ref": "#/$defs/CorpPass"
        },
        {
          "title": "CorpPass Details",
          "description": "CorpPass details, if applicable."
        }
      ]
    },
    "annuaire_line_id_instance": {
      "title": "Annuaire Line Id Instance (DGFiP)",
      "description": "Read-only PPF idInstance for the directory line provisioned for this identifier. Omitted until the first successful sync. Present only for identifiers advertised on the \"dgfip\" network.",
      "type": "string",
      "maxLength": 32,
      "readOnly": true
    },
    "annuaire_routing_code_id_instance": {
      "title": "Annuaire Routing Code Id Instance (DGFiP)",
      "description": "Read-only PPF idInstance for the routing code provisioned for this identifier. Omitted until the first successful sync, or when the identifier has no routing code. Present only for identifiers advertised on the \"dgfip\" network.",
      "type": "string",
      "maxLength": 32,
      "readOnly": true
    }
  },
  "$defs": {
    "CorpPass": {
      "properties": {
        "enabled": {
          "type": "boolean",
          "title": "CorpPass",
          "description": "Whether or not the CorpPass flow is enabled.",
          "default": false
        },
        "flow_type": {
          "title": "Flow Type",
          "description": "The CorpPass flow type.",
          "type": "string",
          "enum": [
            "corppass_flow_redirect",
            "corppass_flow_email",
            "corppass_flow_pdf"
          ]
        },
        "signer_name": {
          "title": "Signer Name",
          "description": "The name of the person who is going to perform the CorpPass process.",
          "type": "string",
          "minLength": 2,
          "maxLength": 64
        },
        "signer_email": {
          "title": "Signer Email",
          "description": "The email of the person who is going to perform the CorpPass process.",
          "type": "string",
          "minLength": 2,
          "maxLength": 128
        },
        "client_redirect_success_url": {
          "title": "Client Redirect Success URL",
          "description": "The URL the CorpPass system will redirect to in case of successful identity verfication.",
          "type": "string",
          "minLength": 11,
          "maxLength": 255
        },
        "client_redirect_fail_url": {
          "title": "Client Redirect Success URL",
          "description": "The URL the CorpPass system will redirect to in case of a failure to perform identity verfication.",
          "type": "string",
          "minLength": 11,
          "maxLength": 255
        },
        "corppass_url": {
          "title": "CorpPass redirect URL",
          "description": "The CorpPass redirect URL.",
          "type": "string",
          "minLength": 11,
          "maxLength": 512
        },
        "status": {
          "title": "CorpPass Status",
          "description": "The status of the CorpPass process.",
          "type": "string",
          "enum": [
            "corppass_no_status",
            "corppass_initiated",
            "corppass_cancelled",
            "corppass_failed",
            "corppass_succeeded"
          ]
        },
        "simulate_corppass": {
          "type": "boolean",
          "title": "Simulate CorpPass",
          "description": "Whether or not CorpPass is being simulated.",
          "default": false
        }
      }
    }
  }
}