{"openapi":"3.1.0","info":{"title":"Api","version":"2","description":"API for collecting user consent and ordering electric consumption data from Enedis."},"paths":{"/ask":{"post":{"tags":["asks"],"operationId":"ask","parameters":[{"name":"switchgrid-test-env","in":"header","schema":{"anyOf":[{"type":"string","enum":["true","false"]},{"type":"null"}]},"required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["CREATED"],"title":"CREATED"},{"type":"string","enum":["PENDING_ADDRESS_CHECK"],"title":"PENDING_ADDRESS_CHECK"},{"type":"string","enum":["ADDRESS_CHECK_FAILED"],"title":"ADDRESS_CHECK_FAILED"},{"type":"string","enum":["PREPARING_CONSENT_COLLECTION"],"title":"PREPARING_CONSENT_COLLECTION"},{"type":"string","enum":["PENDING_USER_ACTION"],"title":"PENDING_USER_ACTION"},{"type":"string","enum":["ACCEPTED"],"title":"ACCEPTED"}]},"createdAt":{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},"acceptedAt":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"consentCollectionDetails":{"anyOf":[{"anyOf":[{"type":"object","properties":{"service":{"type":"string","enum":["DOCUSEAL"]},"userUrl":{"$ref":"#/components/schemas/Url"}},"required":["service","userUrl"],"additionalProperties":false},{"type":"object","properties":{"service":{"type":"string","enum":["WEB_HOSTED"]},"userUrl":{"$ref":"#/components/schemas/Url_1"}},"required":["service","userUrl"],"additionalProperties":false},{"type":"object","properties":{"service":{"type":"string","enum":["REGISTERED_CONSENT"]}},"required":["service"],"additionalProperties":false}]},{"type":"null"}]},"__experimentalAddressChecksResults":{"anyOf":[{"type":"object","additionalProperties":{"type":"object","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE"]}},"required":["status"],"additionalProperties":false}},{"type":"null"}]},"addressCheckResults":{"anyOf":[{"type":"object","additionalProperties":{"type":"object","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE"]}},"required":["status"],"additionalProperties":false}},{"type":"null"}]},"consentIds":{"type":"object","additionalProperties":{"type":"string"},"examples":[{"00052775405049":"7252fa9f-b86a-4b95-a090-1012b730004c","00088663455690":"2083c06a-2793-4475-affc-acfec79d4225"}]},"createArgs":{"type":"object","properties":{"electricityContracts":{"type":"array","items":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/ElectricityContract"}]},"title":"Electricity Contracts"},"signer":{"anyOf":[{"type":"object","properties":{"genre":{"anyOf":[{"anyOf":[{"type":"string","enum":["M","F"]},{"type":"null"}]},{"type":"null"}]},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}]},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationName":{"anyOf":[{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},{"type":"null"}]},"phone":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}]},"email":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/Email"},{"type":"null"}]},{"type":"null"}]}},"additionalProperties":false,"description":"The person signing the Consent request.\nFor WEB_CONSENT, all fields are optional (the user will be able to fill their names and project).\nFor DOCUSEAL, fields firstName & lastName are required."},{"type":"null"}]},"consentCollectionMedium":{"anyOf":[{"$ref":"#/components/schemas/ConsentCollectionMedium"},{"type":"null"}]},"options":{"anyOf":[{"type":"object","properties":{"skipAddressCheck":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"scopesAndPurpose":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scopes":{"anyOf":[{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["DETAILS_CONTRACTUELS"]}},"required":["service","id"],"additionalProperties":false},{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["CONSUMPTION_DATA"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["CDC","PMAX","IDX","ENERGIE"]}},"directions":{"type":"array","items":{"type":"string","enum":["SOUTIRAGE","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["service","id","args"],"additionalProperties":false}]},{"anyOf":[{"type":"object","properties":{"id":{"type":"string","enum":["ELECTRICITY_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["LOADCURVE"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["BILLING","DAILY"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_CONTRACT_DETAILS"]}},"required":["id"],"additionalProperties":false}]}]}},{"type":"null"}]},"purposes":{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"string","enum":["SOLAR_INSTALLATION_SIZING"],"title":"Sizing of a solar installation"},{"type":"string","enum":["DEMAND_RESPONSE"],"title":"Demand response"},{"type":"string","enum":["ENERGY_PERFORMANCE_STUDY"],"title":"Energy performance study"},{"type":"string","enum":["ENERGY_BROKERAGE"],"title":"Energy brokerage"},{"type":"string","enum":["VEHICLE_CHARGE_DETECTION"],"title":"Detection of a vehicle charge"}]},{"type":"object","properties":{"id":{"anyOf":[{"type":"string","enum":["SOLAR_INSTALLATION_SIZING"],"title":"Sizing of a solar installation"},{"type":"string","enum":["DEMAND_RESPONSE"],"title":"Demand response"},{"type":"string","enum":["ENERGY_PERFORMANCE_STUDY"],"title":"Energy performance study"},{"type":"string","enum":["ENERGY_BROKERAGE"],"title":"Energy brokerage"},{"type":"string","enum":["VEHICLE_CHARGE_DETECTION"],"title":"Detection of a vehicle charge"}]}},"required":["id"],"additionalProperties":false}]}}},"required":["purposes"],"additionalProperties":false,"description":"**❗️ DEPRECATED ❗️** => use `scopes` and `purposes` instead. This field will be removed in a future version."}},{"type":"null"}]},"scopes":{"anyOf":[{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["DETAILS_CONTRACTUELS"]}},"required":["service","id"],"additionalProperties":false},{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["CONSUMPTION_DATA"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["CDC","PMAX","IDX","ENERGIE"]}},"directions":{"type":"array","items":{"type":"string","enum":["SOUTIRAGE","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["service","id","args"],"additionalProperties":false}]},{"anyOf":[{"type":"object","properties":{"id":{"type":"string","enum":["ELECTRICITY_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["LOADCURVE"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["BILLING","DAILY"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_CONTRACT_DETAILS"]}},"required":["id"],"additionalProperties":false}]}]},"description":"Data the signer is asked to share. Defaults to everything available for the contracts' energies. For electricity, `DETAILS_CONTRACTUELS` is added whenever `CONSUMPTION_DATA` or `ELECTRICITY_TIMESERIES` is requested without it: the signer sees it on the consent page, and its right lasts as long as the consumption data's."},{"type":"null"}]},"purposes":{"anyOf":[{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"string","enum":["SOLAR_INSTALLATION_SIZING"],"title":"Sizing of a solar installation"},{"type":"string","enum":["DEMAND_RESPONSE"],"title":"Demand response"},{"type":"string","enum":["ENERGY_PERFORMANCE_STUDY"],"title":"Energy performance study"},{"type":"string","enum":["ENERGY_BROKERAGE"],"title":"Energy brokerage"},{"type":"string","enum":["VEHICLE_CHARGE_DETECTION"],"title":"Detection of a vehicle charge"}]},{"type":"object","properties":{"id":{"anyOf":[{"type":"string","enum":["SOLAR_INSTALLATION_SIZING"],"title":"Sizing of a solar installation"},{"type":"string","enum":["DEMAND_RESPONSE"],"title":"Demand response"},{"type":"string","enum":["ENERGY_PERFORMANCE_STUDY"],"title":"Energy performance study"},{"type":"string","enum":["ENERGY_BROKERAGE"],"title":"Energy brokerage"},{"type":"string","enum":["VEHICLE_CHARGE_DETECTION"],"title":"Detection of a vehicle charge"}]}},"required":["id"],"additionalProperties":false}]}},{"type":"null"}]},"consentDuration":{"anyOf":[{"type":"string","enum":["1 day","2 days","3 days","4 days","5 days","6 days","1 week","2 weeks","3 weeks","4 weeks","1 month","2 months","3 months","4 months","5 months","6 months","1 year","2 years","3 years","4 years","5 years","6 years","7 years","8 years","9 years","10 years","11 years","12 years","13 years","14 years","15 years","16 years","17 years","18 years","19 years","20 years"]},{"type":"null"}]},"thirdPartyRecipients":{"anyOf":[{"type":"array","items":{"type":"string"},"description":"Optional list of slugs identifying third parties who will get access to the data after consent is given."},{"type":"null"}]},"projectId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["electricityContracts"],"additionalProperties":false},"contracts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"adresseInstallationNormalisee":{"type":"object","properties":{"ligne1":{"anyOf":[{"anyOf":[{"type":"string","title":"Ligne 1 de l’adresse postale.","description":"Ligne 1 de l’adresse postale.\n  Cette ligne identifie le destinataire.\n  Cette donnée ne sera pas renseignée car\n  redondante avec la donnée « Nom ou\n  dénomination sociale du client »\n  "},{"type":"null"}]},{"type":"null"}]},"ligne2":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 2 de l’adresse postale.\n  Cette ligne identifie généralement le\n  complément d’identification du destinataire ou\n  du point de remise (escalier, étage,\n  appartement, boîte aux lettres…).\n        ","examples":["03 D","COLLINE DE VELAUX VI","A"]},{"type":"null"}]},{"type":"null"}]},"ligne3":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 3 de l’adresse postale.\n  Cette ligne identifie généralement le\n  complément d’identification du point\n  géographique (entrée, tour, immeuble,\n  bâtiment, résidence, zone industrielle…).\n        ","examples":["QUARTIER LES CAIRADES","VILLA CHANTE LA MER","VILLA B LOTISSEMENT ACHBARI","QUARTIER LE PEGOUY","CHEMIN DE LA CHABOTT"]},{"type":"null"}]},{"type":"null"}]},"ligne4":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 4 de l’adresse postale.\n  Cette ligne identifie le numéro et le libellé de la\n  voie.\n        ","examples":["70 ALLEE DU BOIS","11 IMPASSE DES SENTEURS","27 CHEMIN DES COUSTELLINES"]},{"type":"null"}]},{"type":"null"}]},"ligne5":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 5 de l’adresse postale.\n  Cette ligne identifie généralement :\n  - le lieu-dit ou le service particulier de\n  distribution dans le cas d’un client\n  résidentiel,\n  - les mentions spéciales de distribution et\n  commune d’implantation de l’entreprise (si\n  différente du bureau distributeur CEDEX)\n  dans le cas d’un client professionnel.\n        ","examples":["HELLEMMES LILLE","BP 4"]},{"type":"null"}]},{"type":"null"}]},"ligne6":{"type":"string","description":"\n  Ligne 6 de l’adresse postale.\n  Cette ligne identifie :\n  - le code postal et la localité de destination\n  dans le cas d’un client résidentiel,\n  - le code postal et bureau distributeur ou\n  code cedex et bureau distributeur cedex\n  dans le cas d’un client professionnel.\n        ","examples":["84190 BEAUMES DE VENISE"]},"ligne7":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 7 de l’adresse postale.\n  Cette ligne identifie le pays.\n  Cette donnée ne sera pas renseignée.\n        "},{"type":"null"}]},{"type":"null"}]}},"required":["ligne6"],"additionalProperties":false,"examples":[{"ligne4":"70 ALLEE DU BOIS","ligne6":"84190 BEAUMES DE VENISE"}]},"categorieClientFinalCode":{"type":"string","enum":["RES","PRO"]},"nomClientFinalOuDenominationSociale":{"type":"string","examples":["DUPONT Marie","SARL DUPONT ET FILS"]},"prm":{"$ref":"#/components/schemas/Prm"}},"required":["id","adresseInstallationNormalisee","categorieClientFinalCode","nomClientFinalOuDenominationSociale","prm"],"additionalProperties":false}},"testEnvironment":{"type":"boolean"},"scopes":{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["DETAILS_CONTRACTUELS"]}},"required":["service","id"],"additionalProperties":false},{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["CONSUMPTION_DATA"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["CDC","PMAX","IDX","ENERGIE"]}},"directions":{"type":"array","items":{"type":"string","enum":["SOUTIRAGE","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["service","id","args"],"additionalProperties":false}]},{"anyOf":[{"type":"object","properties":{"id":{"type":"string","enum":["ELECTRICITY_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["LOADCURVE"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["BILLING","DAILY"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_CONTRACT_DETAILS"]}},"required":["id"],"additionalProperties":false}]}]}},"purposes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["SOLAR_INSTALLATION_SIZING"],"title":"Sizing of a solar installation"},{"type":"string","enum":["DEMAND_RESPONSE"],"title":"Demand response"},{"type":"string","enum":["ENERGY_PERFORMANCE_STUDY"],"title":"Energy performance study"},{"type":"string","enum":["ENERGY_BROKERAGE"],"title":"Energy brokerage"},{"type":"string","enum":["VEHICLE_CHARGE_DETECTION"],"title":"Detection of a vehicle charge"}]}},"thirdPartyRecipients":{"type":"array","items":{"type":"string"}}},"required":["id","status","createdAt","acceptedAt","consentCollectionDetails","consentIds","createArgs","contracts","testEnvironment","scopes","purposes","thirdPartyRecipients"],"additionalProperties":false}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"],"additionalProperties":false}}}}},"summary":"Create an Ask","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"electricityContracts":{"type":"array","items":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/ElectricityContract"}]},"title":"Electricity Contracts"},"signer":{"anyOf":[{"type":"object","properties":{"genre":{"anyOf":[{"anyOf":[{"type":"string","enum":["M","F"]},{"type":"null"}]},{"type":"null"}]},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}]},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationName":{"anyOf":[{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},{"type":"null"}]},"phone":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}]},"email":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/Email"},{"type":"null"}]},{"type":"null"}]}},"additionalProperties":false,"description":"The person signing the Consent request.\nFor WEB_CONSENT, all fields are optional (the user will be able to fill their names and project).\nFor DOCUSEAL, fields firstName & lastName are required."},{"type":"null"}]},"consentCollectionMedium":{"anyOf":[{"$ref":"#/components/schemas/ConsentCollectionMedium"},{"type":"null"}]},"options":{"anyOf":[{"type":"object","properties":{"skipAddressCheck":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"scopesAndPurpose":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scopes":{"anyOf":[{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["DETAILS_CONTRACTUELS"]}},"required":["service","id"],"additionalProperties":false},{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["CONSUMPTION_DATA"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["CDC","PMAX","IDX","ENERGIE"]}},"directions":{"type":"array","items":{"type":"string","enum":["SOUTIRAGE","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["service","id","args"],"additionalProperties":false}]},{"anyOf":[{"type":"object","properties":{"id":{"type":"string","enum":["ELECTRICITY_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["LOADCURVE"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["BILLING","DAILY"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_CONTRACT_DETAILS"]}},"required":["id"],"additionalProperties":false}]}]}},{"type":"null"}]},"purposes":{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"string","enum":["SOLAR_INSTALLATION_SIZING"],"title":"Sizing of a solar installation"},{"type":"string","enum":["DEMAND_RESPONSE"],"title":"Demand response"},{"type":"string","enum":["ENERGY_PERFORMANCE_STUDY"],"title":"Energy performance study"},{"type":"string","enum":["ENERGY_BROKERAGE"],"title":"Energy brokerage"},{"type":"string","enum":["VEHICLE_CHARGE_DETECTION"],"title":"Detection of a vehicle charge"}]},{"type":"object","properties":{"id":{"anyOf":[{"type":"string","enum":["SOLAR_INSTALLATION_SIZING"],"title":"Sizing of a solar installation"},{"type":"string","enum":["DEMAND_RESPONSE"],"title":"Demand response"},{"type":"string","enum":["ENERGY_PERFORMANCE_STUDY"],"title":"Energy performance study"},{"type":"string","enum":["ENERGY_BROKERAGE"],"title":"Energy brokerage"},{"type":"string","enum":["VEHICLE_CHARGE_DETECTION"],"title":"Detection of a vehicle charge"}]}},"required":["id"],"additionalProperties":false}]}}},"required":["purposes"],"additionalProperties":false,"description":"**❗️ DEPRECATED ❗️** => use `scopes` and `purposes` instead. This field will be removed in a future version."}},{"type":"null"}]},"scopes":{"anyOf":[{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["DETAILS_CONTRACTUELS"]}},"required":["service","id"],"additionalProperties":false},{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["CONSUMPTION_DATA"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["CDC","PMAX","IDX","ENERGIE"]}},"directions":{"type":"array","items":{"type":"string","enum":["SOUTIRAGE","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["service","id","args"],"additionalProperties":false}]},{"anyOf":[{"type":"object","properties":{"id":{"type":"string","enum":["ELECTRICITY_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["LOADCURVE"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["BILLING","DAILY"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_CONTRACT_DETAILS"]}},"required":["id"],"additionalProperties":false}]}]},"description":"Data the signer is asked to share. Defaults to everything available for the contracts' energies. For electricity, `DETAILS_CONTRACTUELS` is added whenever `CONSUMPTION_DATA` or `ELECTRICITY_TIMESERIES` is requested without it: the signer sees it on the consent page, and its right lasts as long as the consumption data's."},{"type":"null"}]},"purposes":{"anyOf":[{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"string","enum":["SOLAR_INSTALLATION_SIZING"],"title":"Sizing of a solar installation"},{"type":"string","enum":["DEMAND_RESPONSE"],"title":"Demand response"},{"type":"string","enum":["ENERGY_PERFORMANCE_STUDY"],"title":"Energy performance study"},{"type":"string","enum":["ENERGY_BROKERAGE"],"title":"Energy brokerage"},{"type":"string","enum":["VEHICLE_CHARGE_DETECTION"],"title":"Detection of a vehicle charge"}]},{"type":"object","properties":{"id":{"anyOf":[{"type":"string","enum":["SOLAR_INSTALLATION_SIZING"],"title":"Sizing of a solar installation"},{"type":"string","enum":["DEMAND_RESPONSE"],"title":"Demand response"},{"type":"string","enum":["ENERGY_PERFORMANCE_STUDY"],"title":"Energy performance study"},{"type":"string","enum":["ENERGY_BROKERAGE"],"title":"Energy brokerage"},{"type":"string","enum":["VEHICLE_CHARGE_DETECTION"],"title":"Detection of a vehicle charge"}]}},"required":["id"],"additionalProperties":false}]}},{"type":"null"}]},"consentDuration":{"anyOf":[{"type":"string","enum":["1 day","2 days","3 days","4 days","5 days","6 days","1 week","2 weeks","3 weeks","4 weeks","1 month","2 months","3 months","4 months","5 months","6 months","1 year","2 years","3 years","4 years","5 years","6 years","7 years","8 years","9 years","10 years","11 years","12 years","13 years","14 years","15 years","16 years","17 years","18 years","19 years","20 years"]},{"type":"null"}]},"thirdPartyRecipients":{"anyOf":[{"type":"array","items":{"type":"string"},"description":"Optional list of slugs identifying third parties who will get access to the data after consent is given."},{"type":"null"}]},"projectId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["electricityContracts"],"additionalProperties":false}}},"required":true}},"get":{"tags":["asks"],"operationId":"getAsks","parameters":[{"name":"switchgrid-test-env","in":"header","schema":{"anyOf":[{"type":"string","enum":["true","false"]},{"type":"null"}]},"required":false},{"name":"deliveryPointIds","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false},{"name":"prm","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false},{"name":"status","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false},{"name":"skip","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false},{"name":"limit","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false},{"name":"orderBy","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"skip":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"limit":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"returnedItemsCount":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"totalItemsCount":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["CREATED"],"title":"CREATED"},{"type":"string","enum":["PENDING_ADDRESS_CHECK"],"title":"PENDING_ADDRESS_CHECK"},{"type":"string","enum":["ADDRESS_CHECK_FAILED"],"title":"ADDRESS_CHECK_FAILED"},{"type":"string","enum":["PREPARING_CONSENT_COLLECTION"],"title":"PREPARING_CONSENT_COLLECTION"},{"type":"string","enum":["PENDING_USER_ACTION"],"title":"PENDING_USER_ACTION"},{"type":"string","enum":["ACCEPTED"],"title":"ACCEPTED"}]},"createdAt":{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},"acceptedAt":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"consentCollectionDetails":{"anyOf":[{"anyOf":[{"type":"object","properties":{"service":{"type":"string","enum":["DOCUSEAL"]},"userUrl":{"$ref":"#/components/schemas/Url"}},"required":["service","userUrl"],"additionalProperties":false},{"type":"object","properties":{"service":{"type":"string","enum":["WEB_HOSTED"]},"userUrl":{"$ref":"#/components/schemas/Url_1"}},"required":["service","userUrl"],"additionalProperties":false},{"type":"object","properties":{"service":{"type":"string","enum":["REGISTERED_CONSENT"]}},"required":["service"],"additionalProperties":false}]},{"type":"null"}]},"__experimentalAddressChecksResults":{"anyOf":[{"type":"object","additionalProperties":{"type":"object","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE"]}},"required":["status"],"additionalProperties":false}},{"type":"null"}]},"addressCheckResults":{"anyOf":[{"type":"object","additionalProperties":{"type":"object","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE"]}},"required":["status"],"additionalProperties":false}},{"type":"null"}]},"consentIds":{"type":"object","additionalProperties":{"type":"string"},"examples":[{"00052775405049":"7252fa9f-b86a-4b95-a090-1012b730004c","00088663455690":"2083c06a-2793-4475-affc-acfec79d4225"}]},"createArgs":{"type":"object","properties":{"electricityContracts":{"type":"array","items":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/ElectricityContract"}]},"title":"Electricity Contracts"},"signer":{"anyOf":[{"type":"object","properties":{"genre":{"anyOf":[{"anyOf":[{"type":"string","enum":["M","F"]},{"type":"null"}]},{"type":"null"}]},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}]},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationName":{"anyOf":[{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},{"type":"null"}]},"phone":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}]},"email":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/Email"},{"type":"null"}]},{"type":"null"}]}},"additionalProperties":false,"description":"The person signing the Consent request.\nFor WEB_CONSENT, all fields are optional (the user will be able to fill their names and project).\nFor DOCUSEAL, fields firstName & lastName are required."},{"type":"null"}]},"consentCollectionMedium":{"anyOf":[{"$ref":"#/components/schemas/ConsentCollectionMedium"},{"type":"null"}]},"options":{"anyOf":[{"type":"object","properties":{"skipAddressCheck":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"scopesAndPurpose":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scopes":{"anyOf":[{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["DETAILS_CONTRACTUELS"]}},"required":["service","id"],"additionalProperties":false},{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["CONSUMPTION_DATA"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["CDC","PMAX","IDX","ENERGIE"]}},"directions":{"type":"array","items":{"type":"string","enum":["SOUTIRAGE","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["service","id","args"],"additionalProperties":false}]},{"anyOf":[{"type":"object","properties":{"id":{"type":"string","enum":["ELECTRICITY_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["LOADCURVE"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["BILLING","DAILY"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_CONTRACT_DETAILS"]}},"required":["id"],"additionalProperties":false}]}]}},{"type":"null"}]},"purposes":{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"string","enum":["SOLAR_INSTALLATION_SIZING"],"title":"Sizing of a solar installation"},{"type":"string","enum":["DEMAND_RESPONSE"],"title":"Demand response"},{"type":"string","enum":["ENERGY_PERFORMANCE_STUDY"],"title":"Energy performance study"},{"type":"string","enum":["ENERGY_BROKERAGE"],"title":"Energy brokerage"},{"type":"string","enum":["VEHICLE_CHARGE_DETECTION"],"title":"Detection of a vehicle charge"}]},{"type":"object","properties":{"id":{"anyOf":[{"type":"string","enum":["SOLAR_INSTALLATION_SIZING"],"title":"Sizing of a solar installation"},{"type":"string","enum":["DEMAND_RESPONSE"],"title":"Demand response"},{"type":"string","enum":["ENERGY_PERFORMANCE_STUDY"],"title":"Energy performance study"},{"type":"string","enum":["ENERGY_BROKERAGE"],"title":"Energy brokerage"},{"type":"string","enum":["VEHICLE_CHARGE_DETECTION"],"title":"Detection of a vehicle charge"}]}},"required":["id"],"additionalProperties":false}]}}},"required":["purposes"],"additionalProperties":false,"description":"**❗️ DEPRECATED ❗️** => use `scopes` and `purposes` instead. This field will be removed in a future version."}},{"type":"null"}]},"scopes":{"anyOf":[{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["DETAILS_CONTRACTUELS"]}},"required":["service","id"],"additionalProperties":false},{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["CONSUMPTION_DATA"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["CDC","PMAX","IDX","ENERGIE"]}},"directions":{"type":"array","items":{"type":"string","enum":["SOUTIRAGE","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["service","id","args"],"additionalProperties":false}]},{"anyOf":[{"type":"object","properties":{"id":{"type":"string","enum":["ELECTRICITY_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["LOADCURVE"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["BILLING","DAILY"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_CONTRACT_DETAILS"]}},"required":["id"],"additionalProperties":false}]}]},"description":"Data the signer is asked to share. Defaults to everything available for the contracts' energies. For electricity, `DETAILS_CONTRACTUELS` is added whenever `CONSUMPTION_DATA` or `ELECTRICITY_TIMESERIES` is requested without it: the signer sees it on the consent page, and its right lasts as long as the consumption data's."},{"type":"null"}]},"purposes":{"anyOf":[{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"string","enum":["SOLAR_INSTALLATION_SIZING"],"title":"Sizing of a solar installation"},{"type":"string","enum":["DEMAND_RESPONSE"],"title":"Demand response"},{"type":"string","enum":["ENERGY_PERFORMANCE_STUDY"],"title":"Energy performance study"},{"type":"string","enum":["ENERGY_BROKERAGE"],"title":"Energy brokerage"},{"type":"string","enum":["VEHICLE_CHARGE_DETECTION"],"title":"Detection of a vehicle charge"}]},{"type":"object","properties":{"id":{"anyOf":[{"type":"string","enum":["SOLAR_INSTALLATION_SIZING"],"title":"Sizing of a solar installation"},{"type":"string","enum":["DEMAND_RESPONSE"],"title":"Demand response"},{"type":"string","enum":["ENERGY_PERFORMANCE_STUDY"],"title":"Energy performance study"},{"type":"string","enum":["ENERGY_BROKERAGE"],"title":"Energy brokerage"},{"type":"string","enum":["VEHICLE_CHARGE_DETECTION"],"title":"Detection of a vehicle charge"}]}},"required":["id"],"additionalProperties":false}]}},{"type":"null"}]},"consentDuration":{"anyOf":[{"type":"string","enum":["1 day","2 days","3 days","4 days","5 days","6 days","1 week","2 weeks","3 weeks","4 weeks","1 month","2 months","3 months","4 months","5 months","6 months","1 year","2 years","3 years","4 years","5 years","6 years","7 years","8 years","9 years","10 years","11 years","12 years","13 years","14 years","15 years","16 years","17 years","18 years","19 years","20 years"]},{"type":"null"}]},"thirdPartyRecipients":{"anyOf":[{"type":"array","items":{"type":"string"},"description":"Optional list of slugs identifying third parties who will get access to the data after consent is given."},{"type":"null"}]},"projectId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["electricityContracts"],"additionalProperties":false},"contracts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"adresseInstallationNormalisee":{"type":"object","properties":{"ligne1":{"anyOf":[{"anyOf":[{"type":"string","title":"Ligne 1 de l’adresse postale.","description":"Ligne 1 de l’adresse postale.\n  Cette ligne identifie le destinataire.\n  Cette donnée ne sera pas renseignée car\n  redondante avec la donnée « Nom ou\n  dénomination sociale du client »\n  "},{"type":"null"}]},{"type":"null"}]},"ligne2":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 2 de l’adresse postale.\n  Cette ligne identifie généralement le\n  complément d’identification du destinataire ou\n  du point de remise (escalier, étage,\n  appartement, boîte aux lettres…).\n        ","examples":["03 D","COLLINE DE VELAUX VI","A"]},{"type":"null"}]},{"type":"null"}]},"ligne3":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 3 de l’adresse postale.\n  Cette ligne identifie généralement le\n  complément d’identification du point\n  géographique (entrée, tour, immeuble,\n  bâtiment, résidence, zone industrielle…).\n        ","examples":["QUARTIER LES CAIRADES","VILLA CHANTE LA MER","VILLA B LOTISSEMENT ACHBARI","QUARTIER LE PEGOUY","CHEMIN DE LA CHABOTT"]},{"type":"null"}]},{"type":"null"}]},"ligne4":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 4 de l’adresse postale.\n  Cette ligne identifie le numéro et le libellé de la\n  voie.\n        ","examples":["70 ALLEE DU BOIS","11 IMPASSE DES SENTEURS","27 CHEMIN DES COUSTELLINES"]},{"type":"null"}]},{"type":"null"}]},"ligne5":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 5 de l’adresse postale.\n  Cette ligne identifie généralement :\n  - le lieu-dit ou le service particulier de\n  distribution dans le cas d’un client\n  résidentiel,\n  - les mentions spéciales de distribution et\n  commune d’implantation de l’entreprise (si\n  différente du bureau distributeur CEDEX)\n  dans le cas d’un client professionnel.\n        ","examples":["HELLEMMES LILLE","BP 4"]},{"type":"null"}]},{"type":"null"}]},"ligne6":{"type":"string","description":"\n  Ligne 6 de l’adresse postale.\n  Cette ligne identifie :\n  - le code postal et la localité de destination\n  dans le cas d’un client résidentiel,\n  - le code postal et bureau distributeur ou\n  code cedex et bureau distributeur cedex\n  dans le cas d’un client professionnel.\n        ","examples":["84190 BEAUMES DE VENISE"]},"ligne7":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 7 de l’adresse postale.\n  Cette ligne identifie le pays.\n  Cette donnée ne sera pas renseignée.\n        "},{"type":"null"}]},{"type":"null"}]}},"required":["ligne6"],"additionalProperties":false,"examples":[{"ligne4":"70 ALLEE DU BOIS","ligne6":"84190 BEAUMES DE VENISE"}]},"categorieClientFinalCode":{"type":"string","enum":["RES","PRO"]},"nomClientFinalOuDenominationSociale":{"type":"string","examples":["DUPONT Marie","SARL DUPONT ET FILS"]},"prm":{"$ref":"#/components/schemas/Prm"}},"required":["id","adresseInstallationNormalisee","categorieClientFinalCode","nomClientFinalOuDenominationSociale","prm"],"additionalProperties":false}},"testEnvironment":{"type":"boolean"},"scopes":{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["DETAILS_CONTRACTUELS"]}},"required":["service","id"],"additionalProperties":false},{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["CONSUMPTION_DATA"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["CDC","PMAX","IDX","ENERGIE"]}},"directions":{"type":"array","items":{"type":"string","enum":["SOUTIRAGE","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["service","id","args"],"additionalProperties":false}]},{"anyOf":[{"type":"object","properties":{"id":{"type":"string","enum":["ELECTRICITY_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["LOADCURVE"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["BILLING","DAILY"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_CONTRACT_DETAILS"]}},"required":["id"],"additionalProperties":false}]}]}},"purposes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["SOLAR_INSTALLATION_SIZING"],"title":"Sizing of a solar installation"},{"type":"string","enum":["DEMAND_RESPONSE"],"title":"Demand response"},{"type":"string","enum":["ENERGY_PERFORMANCE_STUDY"],"title":"Energy performance study"},{"type":"string","enum":["ENERGY_BROKERAGE"],"title":"Energy brokerage"},{"type":"string","enum":["VEHICLE_CHARGE_DETECTION"],"title":"Detection of a vehicle charge"}]}},"thirdPartyRecipients":{"type":"array","items":{"type":"string"}}},"required":["id","status","createdAt","acceptedAt","consentCollectionDetails","consentIds","createArgs","contracts","testEnvironment","scopes","purposes","thirdPartyRecipients"],"additionalProperties":false}}},"required":["skip","limit","returnedItemsCount","totalItemsCount","items"],"additionalProperties":false}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"],"additionalProperties":false}}}}},"summary":"List Asks"}},"/ask/{askId}":{"get":{"tags":["asks"],"operationId":"getAsk","parameters":[{"name":"askId","in":"path","schema":{"type":"string"},"required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"status":{"anyOf":[{"type":"string","enum":["CREATED"],"title":"CREATED"},{"type":"string","enum":["PENDING_ADDRESS_CHECK"],"title":"PENDING_ADDRESS_CHECK"},{"type":"string","enum":["ADDRESS_CHECK_FAILED"],"title":"ADDRESS_CHECK_FAILED"},{"type":"string","enum":["PREPARING_CONSENT_COLLECTION"],"title":"PREPARING_CONSENT_COLLECTION"},{"type":"string","enum":["PENDING_USER_ACTION"],"title":"PENDING_USER_ACTION"},{"type":"string","enum":["ACCEPTED"],"title":"ACCEPTED"}]},"createdAt":{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},"acceptedAt":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"consentCollectionDetails":{"anyOf":[{"anyOf":[{"type":"object","properties":{"service":{"type":"string","enum":["DOCUSEAL"]},"userUrl":{"$ref":"#/components/schemas/Url"}},"required":["service","userUrl"],"additionalProperties":false},{"type":"object","properties":{"service":{"type":"string","enum":["WEB_HOSTED"]},"userUrl":{"$ref":"#/components/schemas/Url_1"}},"required":["service","userUrl"],"additionalProperties":false},{"type":"object","properties":{"service":{"type":"string","enum":["REGISTERED_CONSENT"]}},"required":["service"],"additionalProperties":false}]},{"type":"null"}]},"__experimentalAddressChecksResults":{"anyOf":[{"type":"object","additionalProperties":{"type":"object","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE"]}},"required":["status"],"additionalProperties":false}},{"type":"null"}]},"addressCheckResults":{"anyOf":[{"type":"object","additionalProperties":{"type":"object","properties":{"status":{"type":"string","enum":["SUCCESS","FAILURE"]}},"required":["status"],"additionalProperties":false}},{"type":"null"}]},"consentIds":{"type":"object","additionalProperties":{"type":"string"},"examples":[{"00052775405049":"7252fa9f-b86a-4b95-a090-1012b730004c","00088663455690":"2083c06a-2793-4475-affc-acfec79d4225"}]},"createArgs":{"type":"object","properties":{"electricityContracts":{"type":"array","items":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/ElectricityContract"}]},"title":"Electricity Contracts"},"signer":{"anyOf":[{"type":"object","properties":{"genre":{"anyOf":[{"anyOf":[{"type":"string","enum":["M","F"]},{"type":"null"}]},{"type":"null"}]},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}]},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationName":{"anyOf":[{"anyOf":[{"type":"string","minLength":1},{"type":"null"}]},{"type":"null"}]},"phone":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}]},"email":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/Email"},{"type":"null"}]},{"type":"null"}]}},"additionalProperties":false,"description":"The person signing the Consent request.\nFor WEB_CONSENT, all fields are optional (the user will be able to fill their names and project).\nFor DOCUSEAL, fields firstName & lastName are required."},{"type":"null"}]},"consentCollectionMedium":{"anyOf":[{"$ref":"#/components/schemas/ConsentCollectionMedium"},{"type":"null"}]},"options":{"anyOf":[{"type":"object","properties":{"skipAddressCheck":{"anyOf":[{"type":"boolean"},{"type":"null"}]}},"additionalProperties":false},{"type":"null"}]},"scopesAndPurpose":{"anyOf":[{"type":"array","items":{"type":"object","properties":{"scopes":{"anyOf":[{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["DETAILS_CONTRACTUELS"]}},"required":["service","id"],"additionalProperties":false},{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["CONSUMPTION_DATA"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["CDC","PMAX","IDX","ENERGIE"]}},"directions":{"type":"array","items":{"type":"string","enum":["SOUTIRAGE","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["service","id","args"],"additionalProperties":false}]},{"anyOf":[{"type":"object","properties":{"id":{"type":"string","enum":["ELECTRICITY_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["LOADCURVE"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["BILLING","DAILY"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_CONTRACT_DETAILS"]}},"required":["id"],"additionalProperties":false}]}]}},{"type":"null"}]},"purposes":{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"string","enum":["SOLAR_INSTALLATION_SIZING"],"title":"Sizing of a solar installation"},{"type":"string","enum":["DEMAND_RESPONSE"],"title":"Demand response"},{"type":"string","enum":["ENERGY_PERFORMANCE_STUDY"],"title":"Energy performance study"},{"type":"string","enum":["ENERGY_BROKERAGE"],"title":"Energy brokerage"},{"type":"string","enum":["VEHICLE_CHARGE_DETECTION"],"title":"Detection of a vehicle charge"}]},{"type":"object","properties":{"id":{"anyOf":[{"type":"string","enum":["SOLAR_INSTALLATION_SIZING"],"title":"Sizing of a solar installation"},{"type":"string","enum":["DEMAND_RESPONSE"],"title":"Demand response"},{"type":"string","enum":["ENERGY_PERFORMANCE_STUDY"],"title":"Energy performance study"},{"type":"string","enum":["ENERGY_BROKERAGE"],"title":"Energy brokerage"},{"type":"string","enum":["VEHICLE_CHARGE_DETECTION"],"title":"Detection of a vehicle charge"}]}},"required":["id"],"additionalProperties":false}]}}},"required":["purposes"],"additionalProperties":false,"description":"**❗️ DEPRECATED ❗️** => use `scopes` and `purposes` instead. This field will be removed in a future version."}},{"type":"null"}]},"scopes":{"anyOf":[{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["DETAILS_CONTRACTUELS"]}},"required":["service","id"],"additionalProperties":false},{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["CONSUMPTION_DATA"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["CDC","PMAX","IDX","ENERGIE"]}},"directions":{"type":"array","items":{"type":"string","enum":["SOUTIRAGE","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["service","id","args"],"additionalProperties":false}]},{"anyOf":[{"type":"object","properties":{"id":{"type":"string","enum":["ELECTRICITY_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["LOADCURVE"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["BILLING","DAILY"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_CONTRACT_DETAILS"]}},"required":["id"],"additionalProperties":false}]}]},"description":"Data the signer is asked to share. Defaults to everything available for the contracts' energies. For electricity, `DETAILS_CONTRACTUELS` is added whenever `CONSUMPTION_DATA` or `ELECTRICITY_TIMESERIES` is requested without it: the signer sees it on the consent page, and its right lasts as long as the consumption data's."},{"type":"null"}]},"purposes":{"anyOf":[{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"string","enum":["SOLAR_INSTALLATION_SIZING"],"title":"Sizing of a solar installation"},{"type":"string","enum":["DEMAND_RESPONSE"],"title":"Demand response"},{"type":"string","enum":["ENERGY_PERFORMANCE_STUDY"],"title":"Energy performance study"},{"type":"string","enum":["ENERGY_BROKERAGE"],"title":"Energy brokerage"},{"type":"string","enum":["VEHICLE_CHARGE_DETECTION"],"title":"Detection of a vehicle charge"}]},{"type":"object","properties":{"id":{"anyOf":[{"type":"string","enum":["SOLAR_INSTALLATION_SIZING"],"title":"Sizing of a solar installation"},{"type":"string","enum":["DEMAND_RESPONSE"],"title":"Demand response"},{"type":"string","enum":["ENERGY_PERFORMANCE_STUDY"],"title":"Energy performance study"},{"type":"string","enum":["ENERGY_BROKERAGE"],"title":"Energy brokerage"},{"type":"string","enum":["VEHICLE_CHARGE_DETECTION"],"title":"Detection of a vehicle charge"}]}},"required":["id"],"additionalProperties":false}]}},{"type":"null"}]},"consentDuration":{"anyOf":[{"type":"string","enum":["1 day","2 days","3 days","4 days","5 days","6 days","1 week","2 weeks","3 weeks","4 weeks","1 month","2 months","3 months","4 months","5 months","6 months","1 year","2 years","3 years","4 years","5 years","6 years","7 years","8 years","9 years","10 years","11 years","12 years","13 years","14 years","15 years","16 years","17 years","18 years","19 years","20 years"]},{"type":"null"}]},"thirdPartyRecipients":{"anyOf":[{"type":"array","items":{"type":"string"},"description":"Optional list of slugs identifying third parties who will get access to the data after consent is given."},{"type":"null"}]},"projectId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["electricityContracts"],"additionalProperties":false},"contracts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"adresseInstallationNormalisee":{"type":"object","properties":{"ligne1":{"anyOf":[{"anyOf":[{"type":"string","title":"Ligne 1 de l’adresse postale.","description":"Ligne 1 de l’adresse postale.\n  Cette ligne identifie le destinataire.\n  Cette donnée ne sera pas renseignée car\n  redondante avec la donnée « Nom ou\n  dénomination sociale du client »\n  "},{"type":"null"}]},{"type":"null"}]},"ligne2":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 2 de l’adresse postale.\n  Cette ligne identifie généralement le\n  complément d’identification du destinataire ou\n  du point de remise (escalier, étage,\n  appartement, boîte aux lettres…).\n        ","examples":["03 D","COLLINE DE VELAUX VI","A"]},{"type":"null"}]},{"type":"null"}]},"ligne3":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 3 de l’adresse postale.\n  Cette ligne identifie généralement le\n  complément d’identification du point\n  géographique (entrée, tour, immeuble,\n  bâtiment, résidence, zone industrielle…).\n        ","examples":["QUARTIER LES CAIRADES","VILLA CHANTE LA MER","VILLA B LOTISSEMENT ACHBARI","QUARTIER LE PEGOUY","CHEMIN DE LA CHABOTT"]},{"type":"null"}]},{"type":"null"}]},"ligne4":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 4 de l’adresse postale.\n  Cette ligne identifie le numéro et le libellé de la\n  voie.\n        ","examples":["70 ALLEE DU BOIS","11 IMPASSE DES SENTEURS","27 CHEMIN DES COUSTELLINES"]},{"type":"null"}]},{"type":"null"}]},"ligne5":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 5 de l’adresse postale.\n  Cette ligne identifie généralement :\n  - le lieu-dit ou le service particulier de\n  distribution dans le cas d’un client\n  résidentiel,\n  - les mentions spéciales de distribution et\n  commune d’implantation de l’entreprise (si\n  différente du bureau distributeur CEDEX)\n  dans le cas d’un client professionnel.\n        ","examples":["HELLEMMES LILLE","BP 4"]},{"type":"null"}]},{"type":"null"}]},"ligne6":{"type":"string","description":"\n  Ligne 6 de l’adresse postale.\n  Cette ligne identifie :\n  - le code postal et la localité de destination\n  dans le cas d’un client résidentiel,\n  - le code postal et bureau distributeur ou\n  code cedex et bureau distributeur cedex\n  dans le cas d’un client professionnel.\n        ","examples":["84190 BEAUMES DE VENISE"]},"ligne7":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 7 de l’adresse postale.\n  Cette ligne identifie le pays.\n  Cette donnée ne sera pas renseignée.\n        "},{"type":"null"}]},{"type":"null"}]}},"required":["ligne6"],"additionalProperties":false,"examples":[{"ligne4":"70 ALLEE DU BOIS","ligne6":"84190 BEAUMES DE VENISE"}]},"categorieClientFinalCode":{"type":"string","enum":["RES","PRO"]},"nomClientFinalOuDenominationSociale":{"type":"string","examples":["DUPONT Marie","SARL DUPONT ET FILS"]},"prm":{"$ref":"#/components/schemas/Prm"}},"required":["id","adresseInstallationNormalisee","categorieClientFinalCode","nomClientFinalOuDenominationSociale","prm"],"additionalProperties":false}},"testEnvironment":{"type":"boolean"},"scopes":{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["DETAILS_CONTRACTUELS"]}},"required":["service","id"],"additionalProperties":false},{"type":"object","properties":{"service":{"type":"string","enum":["ENEDIS_RAW_API"]},"id":{"type":"string","enum":["CONSUMPTION_DATA"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["CDC","PMAX","IDX","ENERGIE"]}},"directions":{"type":"array","items":{"type":"string","enum":["SOUTIRAGE","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["service","id","args"],"additionalProperties":false}]},{"anyOf":[{"type":"object","properties":{"id":{"type":"string","enum":["ELECTRICITY_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["LOADCURVE"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_TIMESERIES"]},"args":{"type":"object","properties":{"types":{"type":"array","items":{"type":"string","enum":["BILLING","DAILY"]}},"directions":{"type":"array","items":{"type":"string","enum":["CONSUMPTION","INJECTION"]}}},"required":["types","directions"],"additionalProperties":false}},"required":["id","args"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","enum":["GAS_CONTRACT_DETAILS"]}},"required":["id"],"additionalProperties":false}]}]}},"purposes":{"type":"array","items":{"anyOf":[{"type":"string","enum":["SOLAR_INSTALLATION_SIZING"],"title":"Sizing of a solar installation"},{"type":"string","enum":["DEMAND_RESPONSE"],"title":"Demand response"},{"type":"string","enum":["ENERGY_PERFORMANCE_STUDY"],"title":"Energy performance study"},{"type":"string","enum":["ENERGY_BROKERAGE"],"title":"Energy brokerage"},{"type":"string","enum":["VEHICLE_CHARGE_DETECTION"],"title":"Detection of a vehicle charge"}]}},"thirdPartyRecipients":{"type":"array","items":{"type":"string"}}},"required":["id","status","createdAt","acceptedAt","consentCollectionDetails","consentIds","createArgs","contracts","testEnvironment","scopes","purposes","thirdPartyRecipients"],"additionalProperties":false}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"],"additionalProperties":false}}}}},"summary":"Get an Ask"}},"/ask/{askId}/proof":{"get":{"tags":["asks"],"operationId":"getAskProof","parameters":[{"name":"askId","in":"path","schema":{"type":"string"},"required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Success","content":{"application/pdf":{"schema":{"type":"string"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"],"additionalProperties":false}}}}},"summary":"Get an Ask proof as PDF, when it's accepted"}},"/order":{"post":{"tags":["orders"],"operationId":"order","parameters":[{"name":"switchgrid-test-env","in":"header","schema":{"anyOf":[{"type":"string","enum":["true","false"]},{"type":"null"}]},"required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["CREATED","PENDING_REQUESTS","SUCCESS","SOME_REQUESTS_FAILED"]},"requests":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["C68","C68_ASYNC","R63","R63_SYNC","R64","R64_SYNC","R65","R65_SYNC","R66","R66_SYNC","R67","LOADCURVE"]},"status":{"anyOf":[{"type":"string","enum":["NOT_STARTED"],"title":"NOT_STARTED"},{"type":"string","enum":["QUEUED"],"title":"QUEUED"},{"type":"string","enum":["PENDING"],"title":"PENDING"},{"type":"string","enum":["SUCCESS"],"title":"SUCCESS"},{"type":"string","enum":["FAILED"],"title":"FAILED"}]},"orderedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataUrl":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}]},"dataUrls":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"errorMessage":{"anyOf":[{"type":"string"},{"type":"null"}]},"requestedTimeRange":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/LuxonInterval"},{"type":"null"}]},{"type":"null"}]},"summaryPerContract":{"anyOf":[{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"object","properties":{"_tag":{"type":"string","enum":["LoadcurveRequestContractSummary"]},"_status":{"type":"string","enum":["final"]},"prm":{"$ref":"#/components/schemas/Prm"},"timeRangeCoverageRatio":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"holes":{"type":"array","items":{"$ref":"#/components/schemas/LuxonInterval"},"description":"An array of intervals that are **NOT** covered by the returned data. It's an array of intervals. Each interval is 2 dates separated by a slash. The dates are in ISO 8601 format."},"errorMessage":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["_tag","_status","prm","timeRangeCoverageRatio","holes","errorMessage"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","enum":["LoadcurveRequestContractSummary"]},"_status":{"type":"string","enum":["pending"]},"prm":{"$ref":"#/components/schemas/Prm"},"message":{"type":"string"}},"required":["_tag","_status","prm","message"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","enum":["LoadcurveRequestContractSummary"]},"_status":{"type":"string","enum":["erased"]},"prm":{"$ref":"#/components/schemas/Prm"},"erasedAt":{"type":"string"},"reasonFr":{"type":"string"},"reasonEn":{"type":"string"}},"required":["_tag","_status","prm","erasedAt","reasonFr","reasonEn"],"additionalProperties":false}]},{"anyOf":[{"type":"object","properties":{"_tag":{"type":"string","enum":["RawFileContractSummary"]},"_status":{"type":"string","enum":["final"]},"prm":{"$ref":"#/components/schemas/Prm"},"fileUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"errorMessage":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["_tag","_status","prm","fileUrl","errorMessage"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","enum":["RawFileContractSummary"]},"_status":{"type":"string","enum":["erased"]},"prm":{"$ref":"#/components/schemas/Prm"},"erasedAt":{"type":"string"},"reasonFr":{"type":"string"},"reasonEn":{"type":"string"},"fileUrl":{"type":"null"}},"required":["_tag","_status","prm","erasedAt","reasonFr","reasonEn","fileUrl"],"additionalProperties":false}]}]}},{"type":"null"}]},"loadCurve":{"anyOf":[{"anyOf":[{"type":"object","properties":{"period":{"type":"string"},"startsAt":{"type":"string"},"endsAt":{"type":"string"},"values":{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},{"type":"null"}]}}},"required":["period","startsAt","endsAt","values"],"additionalProperties":false},{"type":"null"}]},{"type":"null"}]}},"required":["id","type","status","orderedAt","completedAt","errorMessage"],"additionalProperties":false}}},"required":["id","status","requests"],"additionalProperties":false}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"],"additionalProperties":false}}}}},"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"requests":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["C68"]},"prms":{"type":"array","items":{"$ref":"#/components/schemas/Prm"}}},"required":["type","prms"],"additionalProperties":false,"title":"C68","description":"Données techniques et contractuelles"},{"type":"object","properties":{"type":{"type":"string","enum":["C68_ASYNC"]},"direction":{"anyOf":[{"type":"string","enum":["CONSUMPTION","INJECTION"]},{"type":"null"}]},"prms":{"type":"array","items":{"$ref":"#/components/schemas/Prm"}}},"required":["type","prms"],"additionalProperties":false,"title":"C68_ASYNC","description":"Données techniques et contractuelles (asynchrone par M023)"},{"type":"object","properties":{"type":{"type":"string","enum":["R63"]},"direction":{"anyOf":[{"type":"string","enum":["SOUTIRAGE","INJECTION"]},{"type":"null"}]},"since":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"until":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"enedisRetryAfterLoadcurveActivation":{"anyOf":[{"type":"boolean","description":"Retry after Enedis Loadcurve Activation (Activation de la collecte de courbe de charge)"},{"type":"null"}]},"prms":{"type":"array","items":{"$ref":"#/components/schemas/Prm"}}},"required":["type","prms"],"additionalProperties":false,"title":"R63","description":"Courbes De Charges"},{"type":"object","properties":{"type":{"type":"string","enum":["R64"]},"direction":{"anyOf":[{"type":"string","enum":["SOUTIRAGE","INJECTION"]},{"type":"null"}]},"since":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"until":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"prms":{"type":"array","items":{"$ref":"#/components/schemas/Prm"}}},"required":["type","prms"],"additionalProperties":false,"title":"R64","description":"Index quotidiens (requête asynchrone)"},{"type":"object","properties":{"type":{"type":"string","enum":["R65"]},"direction":{"anyOf":[{"type":"string","enum":["SOUTIRAGE","INJECTION"]},{"type":"null"}]},"since":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"until":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"prms":{"type":"array","items":{"$ref":"#/components/schemas/Prm"}}},"required":["type","prms"],"additionalProperties":false,"title":"R65","description":"Energies quotidiennes"},{"type":"object","properties":{"type":{"type":"string","enum":["R66"]},"direction":{"anyOf":[{"type":"string","enum":["SOUTIRAGE","INJECTION"]},{"type":"null"}]},"since":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"until":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"prms":{"type":"array","items":{"$ref":"#/components/schemas/Prm"}}},"required":["type","prms"],"additionalProperties":false,"title":"R66","description":"Puissance max. quotidiennes"},{"type":"object","properties":{"type":{"type":"string","enum":["R67"]},"direction":{"anyOf":[{"type":"string","enum":["SOUTIRAGE","INJECTION"]},{"type":"null"}]},"since":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"until":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"prms":{"type":"array","items":{"$ref":"#/components/schemas/Prm"}}},"required":["type","prms"],"additionalProperties":false,"title":"R67","description":"Mesures facturantes"},{"type":"object","properties":{"type":{"type":"string","enum":["R63_SYNC"]},"direction":{"anyOf":[{"type":"string","enum":["SOUTIRAGE","INJECTION"]},{"type":"null"}]},"since":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"until":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"enedisCorrection":{"anyOf":[{"type":"boolean","description":"Correction Enedis (only for 'C5' segment)"},{"type":"null"}]},"enedisRetryAfterLoadcurveActivation":{"anyOf":[{"type":"boolean","description":"Retry after Enedis Loadcurve Activation (Activation de la collecte de courbe de charge)"},{"type":"null"}]},"prms":{"type":"array","items":{"$ref":"#/components/schemas/Prm"}}},"required":["type","prms"],"additionalProperties":false,"title":"R63_SYNC","description":"Courbes de charge - 7 jours ou moins (requête synchrone)"},{"type":"object","properties":{"type":{"type":"string","enum":["R64_SYNC"]},"direction":{"anyOf":[{"type":"string","enum":["SOUTIRAGE","INJECTION"]},{"type":"null"}]},"since":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"until":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"enedisCorrection":{"anyOf":[{"type":"boolean","description":"Correction Enedis (only for 'C5' segment)"},{"type":"null"}]},"prms":{"type":"array","items":{"$ref":"#/components/schemas/Prm"}}},"required":["type","prms"],"additionalProperties":false,"title":"R64_SYNC","description":"Index quotidiens (requête synchrone)"},{"type":"object","properties":{"type":{"type":"string","enum":["R65_SYNC"]},"direction":{"anyOf":[{"type":"string","enum":["SOUTIRAGE","INJECTION"]},{"type":"null"}]},"since":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"until":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"enedisCorrection":{"anyOf":[{"type":"boolean","description":"Correction Enedis (only for 'C5' segment)"},{"type":"null"}]},"prms":{"type":"array","items":{"$ref":"#/components/schemas/Prm"}}},"required":["type","prms"],"additionalProperties":false,"title":"R65_SYNC","description":"Energies quotidiennes (requête synchrone)"},{"type":"object","properties":{"type":{"type":"string","enum":["R66_SYNC"]},"direction":{"anyOf":[{"type":"string","enum":["SOUTIRAGE","INJECTION"]},{"type":"null"}]},"since":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"until":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"enedisCorrection":{"anyOf":[{"type":"boolean","description":"Correction Enedis (only for 'C5' segment)"},{"type":"null"}]},"prms":{"type":"array","items":{"$ref":"#/components/schemas/Prm"}}},"required":["type","prms"],"additionalProperties":false,"title":"R66_SYNC","description":"Puissances max. quotidiennes (requête synchrone)"},{"type":"object","properties":{"type":{"type":"string","enum":["LOADCURVE"]},"direction":{"anyOf":[{"type":"string","enum":["CONSUMPTION","INJECTION"]},{"type":"null"}]},"since":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"until":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"enedisCorrection":{"anyOf":[{"type":"boolean","description":"Correction Enedis (only for 'C5' segment)"},{"type":"null"}]},"enedisRetryAfterLoadcurveActivation":{"anyOf":[{"type":"boolean","description":"Retry after Enedis Loadcurve Activation (Activation de la collecte de courbe de charge)"},{"type":"null"}]},"prms":{"type":"array","items":{"$ref":"#/components/schemas/Prm"}}},"required":["type","prms"],"additionalProperties":false,"title":"Loadcurve","description":"Consumption data in regular intervals"}]}}},"required":["requests"],"additionalProperties":false},{"type":"object","properties":{"consentId":{"type":"string"},"requests":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["C68"]}},"required":["type"],"additionalProperties":false,"title":"C68","description":"Données techniques et contractuelles"},{"type":"object","properties":{"type":{"type":"string","enum":["C68_ASYNC"]},"direction":{"anyOf":[{"type":"string","enum":["CONSUMPTION","INJECTION"]},{"type":"null"}]}},"required":["type"],"additionalProperties":false,"title":"C68_ASYNC","description":"Données techniques et contractuelles (asynchrone par M023)"},{"type":"object","properties":{"type":{"type":"string","enum":["R63"]},"direction":{"anyOf":[{"type":"string","enum":["SOUTIRAGE","INJECTION"]},{"type":"null"}]},"since":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"until":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"enedisRetryAfterLoadcurveActivation":{"anyOf":[{"type":"boolean","description":"Retry after Enedis Loadcurve Activation (Activation de la collecte de courbe de charge)"},{"type":"null"}]}},"required":["type"],"additionalProperties":false,"title":"R63","description":"Courbes De Charges"},{"type":"object","properties":{"type":{"type":"string","enum":["R64"]},"direction":{"anyOf":[{"type":"string","enum":["SOUTIRAGE","INJECTION"]},{"type":"null"}]},"since":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"until":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]}},"required":["type"],"additionalProperties":false,"title":"R64","description":"Index quotidiens (requête asynchrone)"},{"type":"object","properties":{"type":{"type":"string","enum":["R65"]},"direction":{"anyOf":[{"type":"string","enum":["SOUTIRAGE","INJECTION"]},{"type":"null"}]},"since":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"until":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]}},"required":["type"],"additionalProperties":false,"title":"R65","description":"Energies quotidiennes"},{"type":"object","properties":{"type":{"type":"string","enum":["R66"]},"direction":{"anyOf":[{"type":"string","enum":["SOUTIRAGE","INJECTION"]},{"type":"null"}]},"since":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"until":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]}},"required":["type"],"additionalProperties":false,"title":"R66","description":"Puissance max. quotidiennes"},{"type":"object","properties":{"type":{"type":"string","enum":["R67"]},"direction":{"anyOf":[{"type":"string","enum":["SOUTIRAGE","INJECTION"]},{"type":"null"}]},"since":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"until":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]}},"required":["type"],"additionalProperties":false,"title":"R67","description":"Mesures facturantes"},{"type":"object","properties":{"type":{"type":"string","enum":["R63_SYNC"]},"direction":{"anyOf":[{"type":"string","enum":["SOUTIRAGE","INJECTION"]},{"type":"null"}]},"since":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"until":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"enedisCorrection":{"anyOf":[{"type":"boolean","description":"Correction Enedis (only for 'C5' segment)"},{"type":"null"}]},"enedisRetryAfterLoadcurveActivation":{"anyOf":[{"type":"boolean","description":"Retry after Enedis Loadcurve Activation (Activation de la collecte de courbe de charge)"},{"type":"null"}]}},"required":["type"],"additionalProperties":false,"title":"R63_SYNC","description":"Courbes de charge - 7 jours ou moins (requête synchrone)"},{"type":"object","properties":{"type":{"type":"string","enum":["R64_SYNC"]},"direction":{"anyOf":[{"type":"string","enum":["SOUTIRAGE","INJECTION"]},{"type":"null"}]},"since":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"until":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"enedisCorrection":{"anyOf":[{"type":"boolean","description":"Correction Enedis (only for 'C5' segment)"},{"type":"null"}]}},"required":["type"],"additionalProperties":false,"title":"R64_SYNC","description":"Index quotidiens (requête synchrone)"},{"type":"object","properties":{"type":{"type":"string","enum":["R65_SYNC"]},"direction":{"anyOf":[{"type":"string","enum":["SOUTIRAGE","INJECTION"]},{"type":"null"}]},"since":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"until":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"enedisCorrection":{"anyOf":[{"type":"boolean","description":"Correction Enedis (only for 'C5' segment)"},{"type":"null"}]}},"required":["type"],"additionalProperties":false,"title":"R65_SYNC","description":"Energies quotidiennes (requête synchrone)"},{"type":"object","properties":{"type":{"type":"string","enum":["R66_SYNC"]},"direction":{"anyOf":[{"type":"string","enum":["SOUTIRAGE","INJECTION"]},{"type":"null"}]},"since":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"until":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"enedisCorrection":{"anyOf":[{"type":"boolean","description":"Correction Enedis (only for 'C5' segment)"},{"type":"null"}]}},"required":["type"],"additionalProperties":false,"title":"R66_SYNC","description":"Puissances max. quotidiennes (requête synchrone)"},{"type":"object","properties":{"type":{"type":"string","enum":["LOADCURVE"]},"direction":{"anyOf":[{"type":"string","enum":["CONSUMPTION","INJECTION"]},{"type":"null"}]},"since":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"until":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"enedisCorrection":{"anyOf":[{"type":"boolean","description":"Correction Enedis (only for 'C5' segment)"},{"type":"null"}]},"enedisRetryAfterLoadcurveActivation":{"anyOf":[{"type":"boolean","description":"Retry after Enedis Loadcurve Activation (Activation de la collecte de courbe de charge)"},{"type":"null"}]}},"required":["type"],"additionalProperties":false,"title":"Loadcurve","description":"Consumption data in regular intervals"}]}}},"required":["consentId","requests"],"additionalProperties":false,"title":"Deprecated (consentId)","description":"@deprecated. Identify delivery points with `prms` on each request instead of a top-level `consentId`. Still accepted for backward compatibility but no longer advertised."}]}}},"required":true}}},"/order/{orderId}":{"get":{"tags":["orders"],"operationId":"getOrder","parameters":[{"name":"orderId","in":"path","schema":{"type":"string"},"required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["CREATED","PENDING_REQUESTS","SUCCESS","SOME_REQUESTS_FAILED"]},"requests":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["C68","C68_ASYNC","R63","R63_SYNC","R64","R64_SYNC","R65","R65_SYNC","R66","R66_SYNC","R67","LOADCURVE"]},"status":{"anyOf":[{"type":"string","enum":["NOT_STARTED"],"title":"NOT_STARTED"},{"type":"string","enum":["QUEUED"],"title":"QUEUED"},{"type":"string","enum":["PENDING"],"title":"PENDING"},{"type":"string","enum":["SUCCESS"],"title":"SUCCESS"},{"type":"string","enum":["FAILED"],"title":"FAILED"}]},"orderedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"completedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"dataUrl":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}]},{"type":"null"}]},"dataUrls":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"errorMessage":{"anyOf":[{"type":"string"},{"type":"null"}]},"requestedTimeRange":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/LuxonInterval"},{"type":"null"}]},{"type":"null"}]},"summaryPerContract":{"anyOf":[{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"object","properties":{"_tag":{"type":"string","enum":["LoadcurveRequestContractSummary"]},"_status":{"type":"string","enum":["final"]},"prm":{"$ref":"#/components/schemas/Prm"},"timeRangeCoverageRatio":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"holes":{"type":"array","items":{"$ref":"#/components/schemas/LuxonInterval"},"description":"An array of intervals that are **NOT** covered by the returned data. It's an array of intervals. Each interval is 2 dates separated by a slash. The dates are in ISO 8601 format."},"errorMessage":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["_tag","_status","prm","timeRangeCoverageRatio","holes","errorMessage"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","enum":["LoadcurveRequestContractSummary"]},"_status":{"type":"string","enum":["pending"]},"prm":{"$ref":"#/components/schemas/Prm"},"message":{"type":"string"}},"required":["_tag","_status","prm","message"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","enum":["LoadcurveRequestContractSummary"]},"_status":{"type":"string","enum":["erased"]},"prm":{"$ref":"#/components/schemas/Prm"},"erasedAt":{"type":"string"},"reasonFr":{"type":"string"},"reasonEn":{"type":"string"}},"required":["_tag","_status","prm","erasedAt","reasonFr","reasonEn"],"additionalProperties":false}]},{"anyOf":[{"type":"object","properties":{"_tag":{"type":"string","enum":["RawFileContractSummary"]},"_status":{"type":"string","enum":["final"]},"prm":{"$ref":"#/components/schemas/Prm"},"fileUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"errorMessage":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["_tag","_status","prm","fileUrl","errorMessage"],"additionalProperties":false},{"type":"object","properties":{"_tag":{"type":"string","enum":["RawFileContractSummary"]},"_status":{"type":"string","enum":["erased"]},"prm":{"$ref":"#/components/schemas/Prm"},"erasedAt":{"type":"string"},"reasonFr":{"type":"string"},"reasonEn":{"type":"string"},"fileUrl":{"type":"null"}},"required":["_tag","_status","prm","erasedAt","reasonFr","reasonEn","fileUrl"],"additionalProperties":false}]}]}},{"type":"null"}]},"loadCurve":{"anyOf":[{"anyOf":[{"type":"object","properties":{"period":{"type":"string"},"startsAt":{"type":"string"},"endsAt":{"type":"string"},"values":{"type":"array","items":{"anyOf":[{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},{"type":"null"}]}}},"required":["period","startsAt","endsAt","values"],"additionalProperties":false},{"type":"null"}]},{"type":"null"}]}},"required":["id","type","status","orderedAt","completedAt","errorMessage"],"additionalProperties":false}}},"required":["id","status","requests"],"additionalProperties":false}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}}},"summary":"Get Order status and data"}},"/search_contract":{"get":{"tags":["contracts"],"operationId":"searchContract","parameters":[{"name":"name","in":"query","schema":{"type":"string"},"required":true},{"name":"address","in":"query","schema":{"anyOf":[{"type":"string","examples":["1 rue de la paix 75001 Paris"]},{"type":"null"}]},"required":false},{"name":"prm","in":"query","schema":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/Prm"},{"$ref":"#/components/schemas/EnedisNumeroDeSerie"}]},{"type":"null"}]},"required":false},{"name":"asProjectId","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"SearchContractResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchContractResponse"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"],"additionalProperties":false}}}},"429":{"description":"The rate limit for this resource has been exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimited"}}}}},"summary":"Search for an electricity contract"}},"/search_contracts_from_invoices":{"post":{"tags":["contracts"],"operationId":"searchContractsFromInvoices","parameters":[],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"SearchContractsFromInvoicesResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchContractsFromInvoicesResponse"}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"],"additionalProperties":false}}}}},"description":"Upload one or more electricity invoice files (PDF or images). We will run OCR on these files and search for matching contracts. For each file, `error` is null when the invoice could be read: empty `contracts` and `others` with `error: null` means it was read and matched nothing.","summary":"BETA: Search for electricity contracts from uploaded electricity invoice files","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"files":{"type":"array","items":{"type":"string","format":"binary"}}},"required":["files"],"additionalProperties":false}}},"required":true}}},"/data-third-party":{"post":{"tags":["data-third-parties"],"operationId":"createDataThirdParty","parameters":[],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"DataThirdParty created successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"createdAt":{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},"deletedAt":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"name":{"type":"string","description":"Name ot the DataThirdParty. This name will appear in Ask consent forms"},"slug":{"type":"string","description":"Unique identifier (in the scope of your project) of the DataThirdParty. This will be used to identify the DataThirdParty when creating the Ask via the API"},"frSiret":{"anyOf":[{"type":"string","description":"Siret number of the DataThirdParty. This will be used to identify the DataThirdParty when creating the Ask via the API"},{"type":"null"}]},"websiteUrl":{"anyOf":[{"type":"string","description":"Website URL of the DataThirdParty. If specified, users will be able to click on it from the Ask consent form"},{"type":"null"}]},"internationalCompanyIdentificationNumber":{"anyOf":[{"type":"string","description":"For non-french third parties, international company identification number of the DataThirdParty. This will be used to identify the DataThirdParty when creating the Ask via the API"},{"type":"null"}]},"collectsEnedisDataDirectly":{"type":"boolean","description":"Set to `true` when the DataThirdParty is itself registered as a third party with Enedis (SGE) and collects the data directly from Enedis. The consent form then names it among the companies that may collect the data from Enedis, alongside your company and Switchgrid, and states that it exploits the data on its own behalf. Defaults to `false`: the DataThirdParty is the company on whose behalf your company exploits the data."},"logoUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A public signed URL of the DataThirdParty"}},"required":["createdAt","deletedAt","name","slug","frSiret","websiteUrl","internationalCompanyIdentificationNumber","collectsEnedisDataDirectly","logoUrl"],"additionalProperties":false,"title":"DataThirdParty","description":"DataThirdParty created successfully."}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"],"additionalProperties":false}}}},"409":{"description":"A DataThirdParty with the same slug already exists","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false,"description":"A DataThirdParty with the same slug already exists"}}}}},"description":"A DataThirdParty can appear in the Ask consent form as the recipient of the data. You may want to use this if the ultimate recipient of the data collected via Switchgrid is another customer of yours (e.g. a solar panel installer), which you are transferring data to.","summary":"Create a DataThirdParty","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"type":"string","description":"Unique identifier (in the scope of your project) of the DataThirdParty. This will be used to identify the DataThirdParty when creating the Ask via the API"},"name":{"type":"string","description":"Name ot the DataThirdParty. This name will appear in Ask consent forms"},"websiteUrl":{"anyOf":[{"type":"string","description":"Website URL of the DataThirdParty. If specified, users will be able to click on it from the Ask consent form"},{"type":"null"}]},"frSiret":{"anyOf":[{"type":"string","description":"Siret number of the DataThirdParty. This will be used to identify the DataThirdParty when creating the Ask via the API"},{"type":"null"}]},"internationalCompanyIdentificationNumber":{"anyOf":[{"type":"string","description":"For non-french third parties, international company identification number of the DataThirdParty. This will be used to identify the DataThirdParty when creating the Ask via the API"},{"type":"null"}]},"collectsEnedisDataDirectly":{"anyOf":[{"type":"boolean","description":"Set to `true` when the DataThirdParty is itself registered as a third party with Enedis (SGE) and collects the data directly from Enedis. The consent form then names it among the companies that may collect the data from Enedis, alongside your company and Switchgrid, and states that it exploits the data on its own behalf. Defaults to `false`: the DataThirdParty is the company on whose behalf your company exploits the data."},{"type":"null"}]},"logoBase64":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Base64-encoded logo of the DataThirdParty. This logo will appear in Ask consent forms. Accepts `png`, `jpg`, and `svg`."},"projectId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The id (UUID) of the project the DataThirdParty belongs to. Only required if it's ambiguous (if this request is not done with a service account or if the user has access to multiple projects)."}},"required":["slug","name"],"additionalProperties":false}}},"required":true}},"get":{"tags":["data-third-parties"],"operationId":"listDataThirdParties","parameters":[{"name":"skip","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false},{"name":"limit","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false},{"name":"orderBy","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false},{"name":"projectId","in":"query","schema":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The id (UUID) of the project to list data third parties of. Only required if it's ambiguous (if this request is not done with a service account or if the user has access to multiple projects)."},{"type":"null"}]},"required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"List of DataThirdParty instances for the current Project","content":{"application/json":{"schema":{"type":"object","properties":{"skip":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"limit":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"returnedItemsCount":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"totalItemsCount":{"anyOf":[{"type":"number"},{"type":"string","enum":["Infinity","-Infinity","NaN"]}]},"items":{"type":"array","items":{"type":"object","properties":{"createdAt":{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},"deletedAt":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"name":{"type":"string","description":"Name ot the DataThirdParty. This name will appear in Ask consent forms"},"slug":{"type":"string","description":"Unique identifier (in the scope of your project) of the DataThirdParty. This will be used to identify the DataThirdParty when creating the Ask via the API"},"frSiret":{"anyOf":[{"type":"string","description":"Siret number of the DataThirdParty. This will be used to identify the DataThirdParty when creating the Ask via the API"},{"type":"null"}]},"websiteUrl":{"anyOf":[{"type":"string","description":"Website URL of the DataThirdParty. If specified, users will be able to click on it from the Ask consent form"},{"type":"null"}]},"internationalCompanyIdentificationNumber":{"anyOf":[{"type":"string","description":"For non-french third parties, international company identification number of the DataThirdParty. This will be used to identify the DataThirdParty when creating the Ask via the API"},{"type":"null"}]},"collectsEnedisDataDirectly":{"type":"boolean","description":"Set to `true` when the DataThirdParty is itself registered as a third party with Enedis (SGE) and collects the data directly from Enedis. The consent form then names it among the companies that may collect the data from Enedis, alongside your company and Switchgrid, and states that it exploits the data on its own behalf. Defaults to `false`: the DataThirdParty is the company on whose behalf your company exploits the data."},"logoUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A public signed URL of the DataThirdParty"}},"required":["createdAt","deletedAt","name","slug","frSiret","websiteUrl","internationalCompanyIdentificationNumber","collectsEnedisDataDirectly","logoUrl"],"additionalProperties":false}}},"required":["skip","limit","returnedItemsCount","totalItemsCount","items"],"additionalProperties":false,"title":"DataThirdParty","description":"List of DataThirdParty instances for the current Project"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"],"additionalProperties":false}}}}},"summary":"List data third parties"}},"/data-third-party/{slug}":{"put":{"tags":["data-third-parties"],"operationId":"updateDataThirdParty","parameters":[{"name":"slug","in":"path","schema":{"type":"string","description":"The current slug of the `DataThirdParty` to update"},"required":true}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"DataThirdParty updated successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"createdAt":{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},"deletedAt":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"name":{"type":"string","description":"Name ot the DataThirdParty. This name will appear in Ask consent forms"},"slug":{"type":"string","description":"Unique identifier (in the scope of your project) of the DataThirdParty. This will be used to identify the DataThirdParty when creating the Ask via the API"},"frSiret":{"anyOf":[{"type":"string","description":"Siret number of the DataThirdParty. This will be used to identify the DataThirdParty when creating the Ask via the API"},{"type":"null"}]},"websiteUrl":{"anyOf":[{"type":"string","description":"Website URL of the DataThirdParty. If specified, users will be able to click on it from the Ask consent form"},{"type":"null"}]},"internationalCompanyIdentificationNumber":{"anyOf":[{"type":"string","description":"For non-french third parties, international company identification number of the DataThirdParty. This will be used to identify the DataThirdParty when creating the Ask via the API"},{"type":"null"}]},"collectsEnedisDataDirectly":{"type":"boolean","description":"Set to `true` when the DataThirdParty is itself registered as a third party with Enedis (SGE) and collects the data directly from Enedis. The consent form then names it among the companies that may collect the data from Enedis, alongside your company and Switchgrid, and states that it exploits the data on its own behalf. Defaults to `false`: the DataThirdParty is the company on whose behalf your company exploits the data."},"logoUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A public signed URL of the DataThirdParty"}},"required":["createdAt","deletedAt","name","slug","frSiret","websiteUrl","internationalCompanyIdentificationNumber","collectsEnedisDataDirectly","logoUrl"],"additionalProperties":false,"title":"DataThirdParty","description":"DataThirdParty updated successfully."}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"`DataThirdParty` for provided `slug` was not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false,"description":"`DataThirdParty` for provided `slug` was not found"}}}},"409":{"description":"A DataThirdParty with the same slug already exists, when updating the slug","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false,"description":"A DataThirdParty with the same slug already exists, when updating the slug"}}}}},"description":"The following things can be updated: slug, name, websiteUrl, frSiret, internationalCompanyIdentificationNumber, logo.\n To remove an optional property, set it to `null`.","summary":"Update a DataThirdParty","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"slug":{"anyOf":[{"type":"string","description":"Unique identifier (in the scope of your project) of the DataThirdParty. This will be used to identify the DataThirdParty when creating the Ask via the API"},{"type":"null"}]},"name":{"anyOf":[{"type":"string","description":"Name ot the DataThirdParty. This name will appear in Ask consent forms"},{"type":"null"}]},"websiteUrl":{"anyOf":[{"anyOf":[{"type":"string","description":"Website URL of the DataThirdParty. If specified, users will be able to click on it from the Ask consent form"},{"type":"null"}]},{"type":"null"}]},"frSiret":{"anyOf":[{"anyOf":[{"type":"string","description":"Siret number of the DataThirdParty. This will be used to identify the DataThirdParty when creating the Ask via the API"},{"type":"null"}]},{"type":"null"}]},"internationalCompanyIdentificationNumber":{"anyOf":[{"anyOf":[{"type":"string","description":"For non-french third parties, international company identification number of the DataThirdParty. This will be used to identify the DataThirdParty when creating the Ask via the API"},{"type":"null"}]},{"type":"null"}]},"collectsEnedisDataDirectly":{"anyOf":[{"anyOf":[{"type":"boolean","description":"Set to `true` when the DataThirdParty is itself registered as a third party with Enedis (SGE) and collects the data directly from Enedis. The consent form then names it among the companies that may collect the data from Enedis, alongside your company and Switchgrid, and states that it exploits the data on its own behalf. Defaults to `false`: the DataThirdParty is the company on whose behalf your company exploits the data."},{"type":"null"}]},{"type":"null"}]},"logoBase64":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Base64-encoded logo of the DataThirdParty. This logo will appear in Ask consent forms. Accepts `png`, `jpg`, and `svg`."},{"type":"null"}]},"projectId":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The id (UUID) of the project the DataThirdParty belongs to. Only required if it's ambiguous (if this request is not done with a service account or if the user has access to multiple projects)."},{"type":"null"}]}},"additionalProperties":false}}},"required":true}},"delete":{"tags":["data-third-parties"],"operationId":"deleteDataThirdParty","parameters":[{"name":"slug","in":"path","schema":{"type":"string","description":"The slug of the `DataThirdParty` to delete"},"required":true},{"name":"projectSlug","in":"query","schema":{"anyOf":[{"type":"string","description":"The slug of the Project the `DataThirdParty` belongs to. Required if the `DataThirdParty` does not belong to a unique Project. If the authenticated user has access to only one Project, this parameter can be omitted."},{"type":"null"}]},"required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"DataThirdParty deleted successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"createdAt":{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},"deletedAt":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"name":{"type":"string","description":"Name ot the DataThirdParty. This name will appear in Ask consent forms"},"slug":{"type":"string","description":"Unique identifier (in the scope of your project) of the DataThirdParty. This will be used to identify the DataThirdParty when creating the Ask via the API"},"frSiret":{"anyOf":[{"type":"string","description":"Siret number of the DataThirdParty. This will be used to identify the DataThirdParty when creating the Ask via the API"},{"type":"null"}]},"websiteUrl":{"anyOf":[{"type":"string","description":"Website URL of the DataThirdParty. If specified, users will be able to click on it from the Ask consent form"},{"type":"null"}]},"internationalCompanyIdentificationNumber":{"anyOf":[{"type":"string","description":"For non-french third parties, international company identification number of the DataThirdParty. This will be used to identify the DataThirdParty when creating the Ask via the API"},{"type":"null"}]},"collectsEnedisDataDirectly":{"type":"boolean","description":"Set to `true` when the DataThirdParty is itself registered as a third party with Enedis (SGE) and collects the data directly from Enedis. The consent form then names it among the companies that may collect the data from Enedis, alongside your company and Switchgrid, and states that it exploits the data on its own behalf. Defaults to `false`: the DataThirdParty is the company on whose behalf your company exploits the data."},"logoUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A public signed URL of the DataThirdParty"}},"required":["createdAt","deletedAt","name","slug","frSiret","websiteUrl","internationalCompanyIdentificationNumber","collectsEnedisDataDirectly","logoUrl"],"additionalProperties":false,"title":"DataThirdParty","description":"DataThirdParty deleted successfully."}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"],"additionalProperties":false}}}}},"description":"Delete a DataThirdParty. It will no longer be possible to use it in a new Ask. Existing Asks can still be signed.","summary":"Delete a DataThirdParty"}},"/request/{requestId}/data":{"get":{"tags":["requests"],"operationId":"getRequestData","parameters":[{"name":"requestId","in":"path","schema":{"type":"string"},"required":true},{"name":"period","in":"query","schema":{"anyOf":[{"type":"string","enum":["5min","10min","15min","30min","1h","1d"],"description":"The period of data to retrieve","default":"1h"},{"type":"null"}]},"required":false},{"name":"format","in":"query","schema":{"anyOf":[{"type":"string","enum":["csv","json","xlsx"],"description":"format of the data","default":"json"},{"type":"null"}]},"required":false},{"name":"since","in":"query","schema":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"required":false},{"name":"until","in":"query","schema":{"anyOf":[{"type":"string","examples":["2024-12-10T00:00:00","2024-12-10T12:00:00Z","2024-12-10T00:00:00+01:00","2024-12-10","2024-12-10T00:00:00[Europe/Paris]","2024-12-10T00:00:00[CET]"]},{"type":"null"}]},"required":false},{"name":"prm","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"required":false},{"name":"ignoreRequestStatus","in":"query","schema":{"anyOf":[{"type":"string","enum":["true","false"]},{"type":"null"}],"description":"Whether to ignore the request status and return data even if the request is not marked as completed. Use with caution. This can return incomplete data. Use when a multi-prm request is stuck in PENDING but most data is available.","default":false},"required":false},{"name":"csvLocalization","in":"query","schema":{"anyOf":[{"type":"string","enum":["fr","international"]},{"type":"null"}]},"required":false},{"name":"csvColumnSeparator","in":"query","schema":{"anyOf":[{"type":"string","enum":["COMMA","SEMICOLON"]},{"type":"null"}]},"required":false},{"name":"csvDecimalSeparator","in":"query","schema":{"anyOf":[{"type":"string","enum":["DOT","COMMA"]},{"type":"null"}]},"required":false},{"name":"timezone","in":"query","schema":{"anyOf":[{"anyOf":[{"type":"string","enum":["LOCAL","UTC"]},{"type":"null"}]},{"type":"null"}]},"required":false}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"string"}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"],"additionalProperties":false}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":false,"description":"Not Found"}}}},"503":{"description":"Loadcurve store temporarily unavailable — retry","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"],"additionalProperties":false,"description":"Loadcurve store temporarily unavailable — retry"}}}}},"summary":"Get data from a specific Request"}}},"components":{"schemas":{"SearchContractsFromInvoicesResponse":{"type":"object","properties":{"resultsByFile":{"type":"array","items":{"type":"object","properties":{"fileName":{"type":"string","examples":["invoice-edf.pdf","invoice-engie.jpg","invoice-totalenergies.png"]},"contracts":{"type":"array","items":{"$ref":"#/components/schemas/EnedisElectricityContract"}},"others":{"type":"array","items":{"$ref":"#/components/schemas/OtherResult"}},"error":{"anyOf":[{"type":"string","examples":["We could not read any text from this file. Check that it is a readable PDF or image of an electricity invoice."]},{"type":"null"}]}},"required":["fileName","contracts","others","error"],"additionalProperties":false}}},"required":["resultsByFile"],"additionalProperties":false},"OtherResult":{"type":"object","properties":{"prm":{"$ref":"#/components/schemas/Prm"},"nomClientFinalOuDenominationSociale":{"type":"string","examples":["DUPONT Marie","SARL DUPONT ET FILS"]},"adresseInstallationNormalisee":{"type":"object","properties":{"ligne1":{"anyOf":[{"anyOf":[{"type":"string","title":"Ligne 1 de l’adresse postale.","description":"Ligne 1 de l’adresse postale.\n  Cette ligne identifie le destinataire.\n  Cette donnée ne sera pas renseignée car\n  redondante avec la donnée « Nom ou\n  dénomination sociale du client »\n  "},{"type":"null"}]},{"type":"null"}]},"ligne2":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 2 de l’adresse postale.\n  Cette ligne identifie généralement le\n  complément d’identification du destinataire ou\n  du point de remise (escalier, étage,\n  appartement, boîte aux lettres…).\n        ","examples":["03 D","COLLINE DE VELAUX VI","A"]},{"type":"null"}]},{"type":"null"}]},"ligne3":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 3 de l’adresse postale.\n  Cette ligne identifie généralement le\n  complément d’identification du point\n  géographique (entrée, tour, immeuble,\n  bâtiment, résidence, zone industrielle…).\n        ","examples":["QUARTIER LES CAIRADES","VILLA CHANTE LA MER","VILLA B LOTISSEMENT ACHBARI","QUARTIER LE PEGOUY","CHEMIN DE LA CHABOTT"]},{"type":"null"}]},{"type":"null"}]},"ligne4":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 4 de l’adresse postale.\n  Cette ligne identifie le numéro et le libellé de la\n  voie.\n        ","examples":["70 ALLEE DU BOIS","11 IMPASSE DES SENTEURS","27 CHEMIN DES COUSTELLINES"]},{"type":"null"}]},{"type":"null"}]},"ligne5":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 5 de l’adresse postale.\n  Cette ligne identifie généralement :\n  - le lieu-dit ou le service particulier de\n  distribution dans le cas d’un client\n  résidentiel,\n  - les mentions spéciales de distribution et\n  commune d’implantation de l’entreprise (si\n  différente du bureau distributeur CEDEX)\n  dans le cas d’un client professionnel.\n        ","examples":["HELLEMMES LILLE","BP 4"]},{"type":"null"}]},{"type":"null"}]},"ligne6":{"type":"string","description":"\n  Ligne 6 de l’adresse postale.\n  Cette ligne identifie :\n  - le code postal et la localité de destination\n  dans le cas d’un client résidentiel,\n  - le code postal et bureau distributeur ou\n  code cedex et bureau distributeur cedex\n  dans le cas d’un client professionnel.\n        ","examples":["84190 BEAUMES DE VENISE"]},"ligne7":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 7 de l’adresse postale.\n  Cette ligne identifie le pays.\n  Cette donnée ne sera pas renseignée.\n        "},{"type":"null"}]},{"type":"null"}]}},"required":["ligne6"],"additionalProperties":false,"examples":[{"ligne4":"70 ALLEE DU BOIS","ligne6":"84190 BEAUMES DE VENISE"}]}},"required":["prm","nomClientFinalOuDenominationSociale","adresseInstallationNormalisee"],"additionalProperties":false},"Prm":{"type":"string"},"EnedisElectricityContract":{"type":"object","properties":{"id":{"type":"string"},"prm":{"$ref":"#/components/schemas/Prm"},"categorieClientFinalCode":{"type":"string","enum":["RES","PRO"]},"nomClientFinalOuDenominationSociale":{"type":"string","examples":["DUPONT Marie","SARL DUPONT ET FILS"]},"adresseInstallationNormalisee":{"type":"object","properties":{"ligne1":{"anyOf":[{"anyOf":[{"type":"string","title":"Ligne 1 de l’adresse postale.","description":"Ligne 1 de l’adresse postale.\n  Cette ligne identifie le destinataire.\n  Cette donnée ne sera pas renseignée car\n  redondante avec la donnée « Nom ou\n  dénomination sociale du client »\n  "},{"type":"null"}]},{"type":"null"}]},"ligne2":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 2 de l’adresse postale.\n  Cette ligne identifie généralement le\n  complément d’identification du destinataire ou\n  du point de remise (escalier, étage,\n  appartement, boîte aux lettres…).\n        ","examples":["03 D","COLLINE DE VELAUX VI","A"]},{"type":"null"}]},{"type":"null"}]},"ligne3":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 3 de l’adresse postale.\n  Cette ligne identifie généralement le\n  complément d’identification du point\n  géographique (entrée, tour, immeuble,\n  bâtiment, résidence, zone industrielle…).\n        ","examples":["QUARTIER LES CAIRADES","VILLA CHANTE LA MER","VILLA B LOTISSEMENT ACHBARI","QUARTIER LE PEGOUY","CHEMIN DE LA CHABOTT"]},{"type":"null"}]},{"type":"null"}]},"ligne4":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 4 de l’adresse postale.\n  Cette ligne identifie le numéro et le libellé de la\n  voie.\n        ","examples":["70 ALLEE DU BOIS","11 IMPASSE DES SENTEURS","27 CHEMIN DES COUSTELLINES"]},{"type":"null"}]},{"type":"null"}]},"ligne5":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 5 de l’adresse postale.\n  Cette ligne identifie généralement :\n  - le lieu-dit ou le service particulier de\n  distribution dans le cas d’un client\n  résidentiel,\n  - les mentions spéciales de distribution et\n  commune d’implantation de l’entreprise (si\n  différente du bureau distributeur CEDEX)\n  dans le cas d’un client professionnel.\n        ","examples":["HELLEMMES LILLE","BP 4"]},{"type":"null"}]},{"type":"null"}]},"ligne6":{"type":"string","description":"\n  Ligne 6 de l’adresse postale.\n  Cette ligne identifie :\n  - le code postal et la localité de destination\n  dans le cas d’un client résidentiel,\n  - le code postal et bureau distributeur ou\n  code cedex et bureau distributeur cedex\n  dans le cas d’un client professionnel.\n        ","examples":["84190 BEAUMES DE VENISE"]},"ligne7":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 7 de l’adresse postale.\n  Cette ligne identifie le pays.\n  Cette donnée ne sera pas renseignée.\n        "},{"type":"null"}]},{"type":"null"}]}},"required":["ligne6"],"additionalProperties":false,"examples":[{"ligne4":"70 ALLEE DU BOIS","ligne6":"84190 BEAUMES DE VENISE"}]}},"required":["id","prm","categorieClientFinalCode","nomClientFinalOuDenominationSociale","adresseInstallationNormalisee"],"additionalProperties":false},"RateLimited":{"type":"object","properties":{"_tag":{"type":"string","enum":["RateLimited"]},"message":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["_tag"],"additionalProperties":false},"SearchContractResponse":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"prm":{"$ref":"#/components/schemas/Prm"},"nomClientFinalOuDenominationSociale":{"type":"string","examples":["DUPONT Marie","SARL DUPONT ET FILS"]},"categorieClientFinalCode":{"type":"string","enum":["RES","PRO"]},"adresseInstallationNormalisee":{"type":"object","properties":{"ligne1":{"anyOf":[{"anyOf":[{"type":"string","title":"Ligne 1 de l’adresse postale.","description":"Ligne 1 de l’adresse postale.\n  Cette ligne identifie le destinataire.\n  Cette donnée ne sera pas renseignée car\n  redondante avec la donnée « Nom ou\n  dénomination sociale du client »\n  "},{"type":"null"}]},{"type":"null"}]},"ligne2":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 2 de l’adresse postale.\n  Cette ligne identifie généralement le\n  complément d’identification du destinataire ou\n  du point de remise (escalier, étage,\n  appartement, boîte aux lettres…).\n        ","examples":["03 D","COLLINE DE VELAUX VI","A"]},{"type":"null"}]},{"type":"null"}]},"ligne3":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 3 de l’adresse postale.\n  Cette ligne identifie généralement le\n  complément d’identification du point\n  géographique (entrée, tour, immeuble,\n  bâtiment, résidence, zone industrielle…).\n        ","examples":["QUARTIER LES CAIRADES","VILLA CHANTE LA MER","VILLA B LOTISSEMENT ACHBARI","QUARTIER LE PEGOUY","CHEMIN DE LA CHABOTT"]},{"type":"null"}]},{"type":"null"}]},"ligne4":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 4 de l’adresse postale.\n  Cette ligne identifie le numéro et le libellé de la\n  voie.\n        ","examples":["70 ALLEE DU BOIS","11 IMPASSE DES SENTEURS","27 CHEMIN DES COUSTELLINES"]},{"type":"null"}]},{"type":"null"}]},"ligne5":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 5 de l’adresse postale.\n  Cette ligne identifie généralement :\n  - le lieu-dit ou le service particulier de\n  distribution dans le cas d’un client\n  résidentiel,\n  - les mentions spéciales de distribution et\n  commune d’implantation de l’entreprise (si\n  différente du bureau distributeur CEDEX)\n  dans le cas d’un client professionnel.\n        ","examples":["HELLEMMES LILLE","BP 4"]},{"type":"null"}]},{"type":"null"}]},"ligne6":{"type":"string","description":"\n  Ligne 6 de l’adresse postale.\n  Cette ligne identifie :\n  - le code postal et la localité de destination\n  dans le cas d’un client résidentiel,\n  - le code postal et bureau distributeur ou\n  code cedex et bureau distributeur cedex\n  dans le cas d’un client professionnel.\n        ","examples":["84190 BEAUMES DE VENISE"]},"ligne7":{"anyOf":[{"anyOf":[{"type":"string","description":"\n  Ligne 7 de l’adresse postale.\n  Cette ligne identifie le pays.\n  Cette donnée ne sera pas renseignée.\n        "},{"type":"null"}]},{"type":"null"}]}},"required":["ligne6"],"additionalProperties":false,"examples":[{"ligne4":"70 ALLEE DU BOIS","ligne6":"84190 BEAUMES DE VENISE"}]}},"required":["id","prm","nomClientFinalOuDenominationSociale","categorieClientFinalCode","adresseInstallationNormalisee"],"additionalProperties":false}}},"required":["results"],"additionalProperties":false},"EnedisNumeroDeSerie":{"type":"string","pattern":"^\\d{14}$","title":"EnedisNumeroDeSerie","description":"a serial number, 14 digits long"},"LuxonInterval":{"type":"string"},"ConsentCollectionMedium":{"anyOf":[{"type":"object","properties":{"service":{"type":"string","enum":["DOCUSEAL"]}},"required":["service"],"additionalProperties":false,"title":"DOCUSEAL","description":"The Docuseal consent collection medium, prefer the web hosted one."},{"type":"object","properties":{"service":{"type":"string","enum":["WEB_HOSTED"]}},"required":["service"],"additionalProperties":false,"title":"WEB_HOSTED","description":"The web hosted consent collection medium, allowing interactions like changing Signer name."},{"type":"object","properties":{"service":{"type":"string","enum":["REGISTERED_CONSENT"]}},"required":["service"],"additionalProperties":false,"title":"REGISTERED_CONSENT","description":"@deprecated. Consent was collected outside Switchgrid and registered via the registerConsent endpoint, removed on 2026-10-07. Only found on Asks created before then; a new Ask cannot use it. No URL to send the user to — the API caller attests to having the proof."}]},"Email":{"type":"string"},"ElectricityContract":{"type":"object","properties":{"prm":{"$ref":"#/components/schemas/Prm"},"heldBy":{"anyOf":[{"$ref":"#/components/schemas/PersonnePhysique"},{"$ref":"#/components/schemas/PersonneMorale"}],"description":"The person or company that holds the contract"},"address":{"type":"object","properties":{"street":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"}},"required":["street","postalCode","city","country"],"additionalProperties":false,"description":"The address where the electricity is consumed"}},"required":["prm","heldBy","address"],"additionalProperties":false,"title":"Electricity Contract Details","description":"Details of an electricity contract."},"PersonneMorale":{"type":"object","properties":{"name":{"type":"string"},"siret":{"type":"string"},"otherNames":{"anyOf":[{"type":"array","items":{"type":"string"},"maxItems":2},{"type":"null"}],"description":"Other names of the company. Max 2 names."}},"required":["name","siret"],"additionalProperties":false,"title":"Legal Entity","description":"A legal entity, as opposed to an individual."},"PersonnePhysique":{"type":"object","properties":{"genre":{"type":"string","enum":["M","F"]},"firstName":{"type":"string"},"lastName":{"type":"string"}},"required":["genre","firstName","lastName"],"additionalProperties":false,"title":"Individual","description":"An Individual, as opposed to a legal entity."},"Url_1":{"type":"string","description":"The URL of the page to embed, or redirect the user to.","examples":["https://c/ask/f965e8f1-9bf3-4dbd-8871-96bf236e9ce3"]},"Url":{"type":"string","description":"The URL to the document that the user needs to sign.","examples":["https://docuseal.co/s/x1uPBSwot114QM"]}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"Bearer"}}},"security":[],"tags":[{"name":"asks","description":"Operations related to asks"},{"name":"orders"},{"name":"contracts"},{"name":"data-third-parties"},{"name":"requests"}],"servers":[{"url":"https://app.switchgrid.tech/enedis/v2"}]}