Storecove · Schema

PeppolIdentifierCreate

CompanyE-InvoicingPEPPOLTax ComplianceInvoicingAccountingERP IntegrationFintech

Properties

Name Type Description
identifier string The identifier.
scheme string The scheme of the identifier. See <<_receiver_identifiers_list>> for a list.
superscheme string The superscheme of the identifier. Should always be "iso6523-actorid-upis".
networks array DEPRECATED. Use the new "networks_specification" property. The networks to advertise the identifier on. Note that "dbnalliance" currently requires manual provisioning in the DBNAlliance SML, so you ne
networks_specification array A specification of the networks to advertise the identifier on.
corppass object
View JSON Schema on GitHub

JSON Schema

storecove-peppol-identifier-create-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/storecove/json-schema/storecove-peppol-identifier-create-schema.json",
  "title": "PeppolIdentifierCreate",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/storecove-peppolidentifiers-api-openapi.yml#/components/schemas/PeppolIdentifierCreate",
  "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
    },
    "networks": {
      "title": "Networks",
      "description": "DEPRECATED. Use the new \"networks_specification\" property. The networks to advertise the identifier on. Note that \"dbnalliance\" currently requires manual provisioning in the DBNAlliance SML, so you need to contact us before using this.",
      "type": "array",
      "items": {
        "title": "Network",
        "description": "A network to advertise the identifier on.",
        "type": "string",
        "enum": [
          "peppol",
          "dbnalliance",
          "dgfip"
        ]
      },
      "default": [
        "peppol"
      ],
      "deprecated": true
    },
    "networks_specification": {
      "title": "Networks Specification",
      "description": "A specification of the networks to advertise the identifier on.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/NetworkSpecification"
      }
    },
    "corppass": {
      "allOf": [
        {
          "$ref": "#/$defs/CorpPassCreate"
        },
        {
          "title": "CorpPass Details",
          "description": "CorpPass details, used to create SG:UEN (numerical code: 0195) identifiers. For details, see <<_singapore_corppass_description>>."
        }
      ]
    }
  },
  "required": [
    "identifier",
    "scheme",
    "superscheme"
  ],
  "$defs": {
    "CorpPassCreate": {
      "properties": {
        "enabled": {
          "type": "boolean",
          "title": "CorpPass",
          "description": "DEPRECATED. Whether or not to enable the CorpPass flow. Must be true if provided.",
          "default": true,
          "deprecated": true
        },
        "flow_type": {
          "title": "Flow Type",
          "description": "The CorpPass flow type. Note that using corppass_flow_pdf requires special setup of your account by Storecove.",
          "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. Mandatory for flow_type=\"corppass_flow_email\" and for redirect KYC on Dex.",
          "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. Mandatory for flow_type=\"corppass_flow_email\" and for redirect KYC on Dex.",
          "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. Mandatory for flow_type=\"corppass_flow_redirect\"",
          "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. Mandatory for flow_type=\"corppass_flow_redirect\"",
          "type": "string",
          "minLength": 11,
          "maxLength": 255
        },
        "simulate_corppass": {
          "type": "boolean",
          "title": "Simulate CorpPass",
          "description": "Whether or not to simulate CorpPass. Instead of redirecting to a CorpPass URL, you will receive a redirect to a Storecove URL which will show a page with two buttons: success and fail. This makes development without having test CorpPass credentials possible. Note this only works in sandbox, not in the production environment.",
          "default": false
        },
        "kyc_document": {
          "title": "KYC PDF document",
          "description": "The Base64-encoded PDF document used for KYC. Mandatory for flow_type=\"corppass_flow_pdf\"",
          "type": "string"
        }
      },
      "required": [
        "flow_type"
      ]
    },
    "DgfipAnnuaire": {
      "properties": {
        "routing_code_label": {
          "type": "string",
          "title": "Routing Code Label",
          "description": "Human-readable label for the routing code (annuaire central libelleCodeRoutage). Mandatory when the identifier carries a routing code.",
          "minLength": 1,
          "maxLength": 100
        },
        "address": {
          "allOf": [
            {
              "$ref": "#/$defs/DgfipAnnuaireAddress"
            },
            {
              "title": "Address",
              "description": "Postal address of the routing code (annuaire central adresse). Mandatory when the identifier carries a routing code."
            }
          ]
        },
        "start_date": {
          "title": "Start Date",
          "description": "Planned start date (dateDebutEffet) for the annuaire line. Defaults to today + 1 day (annuaire central rule G1.87).",
          "type": "string",
          "format": "date"
        },
        "formal_agreement": {
          "allOf": [
            {
              "$ref": "#/$defs/FormalAgreement"
            },
            {
              "title": "Formal agreement",
              "description": "The formal agreement (accord formel) by which the taxable person designates Storecove as its plateforme de réception for the electronic addresses registered here. Mandatory on a production create from 2 November 2026 on; before that date a production create without it still succeeds, and one you do send is validated and stored all the same. Sandbox does not register in the annuaire central and never requires it."
            }
          ]
        }
      }
    },
    "DgfipAnnuaireAddress": {
      "properties": {
        "street1": {
          "type": "string",
          "title": "Street 1",
          "description": "The first address line.",
          "maxLength": 192
        },
        "street2": {
          "type": "string",
          "title": "Street 2",
          "description": "The second address line, if applicable.",
          "maxLength": 192
        },
        "zip": {
          "type": "string",
          "title": "Zip",
          "description": "The zipcode.",
          "maxLength": 32
        },
        "city": {
          "type": "string",
          "title": "City",
          "description": "The city.",
          "maxLength": 64
        },
        "country": {
          "type": "string",
          "title": "Country",
          "description": "ISO 3166-1 alpha-2 country code.",
          "minLength": 2,
          "maxLength": 2
        }
      }
    },
    "FormalAgreement": {
      "properties": {
        "document": {
          "title": "Formal agreement",
          "description": "The Base64-encoded PDF of the formal agreement (accord formel). Optional until 2 November 2026, and mandatory from that date on when a production create registers an address in the annuaire central. Maximum size is 10 MB. It must be a readable PDF with at least one page: a file that is not a PDF, or that is password-protected, damaged, or empty, is rejected with HTTP 422. The contents are not inspected. A POST for an identifier that already exists returns already exists and leaves the stored file unchanged. An identifier whose formal_agreement_pending_since is set and that has no PDF yet adds the agreement with PATCH /legal_entities/{legal_entity_id}/peppol_identifiers/{superscheme}/{scheme}/{identifier}, sending annuaire containing only formal_agreement. Without that marker this PATCH is rejected. POST accepts the PDF only when creating a new identifier.",
          "type": "string"
        }
      },
      "required": [
        "document"
      ]
    },
    "NetworkSpecification": {
      "properties": {
        "name": {
          "title": "Network",
          "description": "A network to advertise the identifier on.",
          "type": "string",
          "enum": [
            "peppol",
            "dbnalliance",
            "dgfip"
          ]
        },
        "sub_networks": {
          "title": "Sub Networks",
          "description": "A list of sub_networks to advertise documents for. The Peppol network has two sub_networks: \"france\" (for the upcoming French reform) and \"eb2b\" (enhanced B2B). Use \"main\" to advertise on the main Peppol network.",
          "type": "array",
          "items": {
            "title": "Sub Network",
            "description": "A sub_network to advertise documents for.",
            "type": "string",
            "enum": [
              "main",
              "france",
              "eb2b"
            ]
          }
        },
        "annuaire": {
          "allOf": [
            {
              "$ref": "#/$defs/DgfipAnnuaire"
            },
            {
              "title": "Annuaire (DGFiP)",
              "description": "DGFiP directory (annuaire) details for the French e-invoicing reform. Only applies to the \"dgfip\" network. Required when the identifier addresses below the SIREN level (SIRET, suffix or routing code); a bare SIREN may omit it until 2 November 2026, from which date every production create needs it to carry the formal agreement. When the identifier carries a routing code, \"routing_code_label\" and \"address\" are mandatory."
            }
          ]
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/storecove-peppol-identifier-create"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.