--- title: "Create a new PeppolIdentifier" method: POST path: "/legal_entities/{legal_entity_id}/peppol_identifiers" tags: ["PeppolIdentifiers"] --- # Create a new PeppolIdentifier `POST /legal_entities/{legal_entity_id}/peppol_identifiers` ## Request - Base URL: `https://api.storecove.com/api/v2` - URL: `https://api.storecove.com/api/v2/legal_entities/{legal_entity_id}/peppol_identifiers` - Auth: API key in header `Authorization` Create a brand new PeppolIdentifier. For <<_singapore_corppass_description>>, special rules apply. When the request includes a `dgfip` network, Annuaire provisioning runs synchronously and before the Peppol advertisement: a PPF rejection (line already held by another PDP, INSEE errors) is returned as HTTP 422 and the whole create is rolled back (no PeppolIdentifier is created). Fix the payload and retry the create. ## Path parameters - `legal_entity_id` integer, required ## Request body - PeppolIdentifierCreate - `identifier` string, required: The identifier. - `scheme` string, required: The scheme of the identifier. See <<_receiver_identifiers_list>> for a list. - `superscheme` string, required: The superscheme of the identifier. Should always be "iso6523-actorid-upis". - `networks` string[]: 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. - `networks_specification` NetworkSpecification[]: A specification of the networks to advertise the identifier on. - `name` 'peppol' | 'dbnalliance' | 'dgfip': A network to advertise the identifier on. - `sub_networks` string[]: 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. - `annuaire` DgfipAnnuaire - `routing_code_label` string: Human-readable label for the routing code (annuaire central libelleCodeRoutage). Mandatory when the identifier carries a routing code. - `address` DgfipAnnuaireAddress - `street1` string: The first address line. - `street2` string: The second address line, if applicable. - `zip` string: The zipcode. - `city` string: The city. - `country` string: ISO 3166-1 alpha-2 country code. - `start_date` string, date: Planned start date (dateDebutEffet) for the annuaire line. Defaults to today + 1 day (annuaire central rule G1.87). - `corppass` CorpPassCreate - `enabled` boolean: DEPRECATED. Whether or not to enable the CorpPass flow. Must be true if provided. - `flow_type` 'corppass_flow_redirect' | 'corppass_flow_email' | 'corppass_flow_pdf', required: The CorpPass flow type. Note that using corppass_flow_pdf requires special setup of your account by Storecove. - `signer_name` string: 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. - `signer_email` string: 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. - `client_redirect_success_url` string: The URL the CorpPass system will redirect to in case of successful identity verfication. Mandatory for flow_type="corppass_flow_redirect" - `client_redirect_fail_url` string: The URL the CorpPass system will redirect to in case of a failure to perform identity verfication. Mandatory for flow_type="corppass_flow_redirect" - `simulate_corppass` boolean: 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. - `kyc_document` string: The Base64-encoded PDF document used for KYC. Mandatory for flow_type="corppass_flow_pdf" ## Response `200` Success - PeppolIdentifier - `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". - `corppass` CorpPass - `enabled` boolean: Whether or not the CorpPass flow is enabled. - `flow_type` 'corppass_flow_redirect' | 'corppass_flow_email' | 'corppass_flow_pdf': The CorpPass flow type. - `signer_name` string: The name of the person who is going to perform the CorpPass process. - `signer_email` string: The email of the person who is going to perform the CorpPass process. - `client_redirect_success_url` string: The URL the CorpPass system will redirect to in case of successful identity verfication. - `client_redirect_fail_url` string: The URL the CorpPass system will redirect to in case of a failure to perform identity verfication. - `corppass_url` string: The CorpPass redirect URL. - `status` 'corppass_no_status' | 'corppass_initiated' | 'corppass_cancelled' | 'corppass_failed' | 'corppass_succeeded': The status of the CorpPass process. - `simulate_corppass` boolean: Whether or not CorpPass is being simulated. - `annuaire_line_id_instance` string: 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. - `annuaire_routing_code_id_instance` string: 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. ## Other responses - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found - `422`: Unprocessable Entity --- [API](https://skmtc.dev/storecove/apis/storecove-api.md) - [All operations](https://skmtc.dev/storecove/apis/storecove-api/llms.txt) - [OpenAPI document](https://skmtc.dev/storecove/apis/storecove-api/revisions/18226354b6a5?raw)