{"openapi":"3.1.0","info":{"title":"Directory API. Stage: prod","description":"The Directory API is a search service for receiver-specific e-invoicing endpoints. Based on given search criteria (for example, a French SIREN), it returns possible matches and their endpoints to help customers determine how to send e-invoices to their buyers.","version":"1.0.0"},"paths":{"/directory/fr":{"get":{"tags":["Directory France lookup"],"summary":"Search","operationId":"search_directory_fr_get","parameters":[{"name":"siren","in":"query","required":false,"schema":{"type":"string","minLength":9,"maxLength":9,"pattern":"^[0-9]{9}$","description":"SIREN number, min_length=9, max_length=9 regex=^[0-9]{9}$","title":"Siren"},"description":"SIREN number, min_length=9, max_length=9 regex=^[0-9]{9}$"},{"name":"siret","in":"query","required":false,"schema":{"type":"string","minLength":14,"maxLength":14,"pattern":"^[0-9]{14}$","description":"SIRET number, min_length=14, max_length=14, regex=^[0-9]{14}$","title":"Siret"},"description":"SIRET number, min_length=14, max_length=14, regex=^[0-9]{14}$"},{"name":"addressing_suffix","in":"query","required":false,"schema":{"type":"string","minLength":1,"description":"Addressing Suffix, min_length=1","title":"Addressing Suffix"},"description":"Addressing Suffix, min_length=1"},{"name":"addressing_identifier","in":"query","required":false,"schema":{"type":"string","minLength":9,"description":"Addressing Identifier, min_length=9","title":"Addressing Identifier"},"description":"Addressing Identifier, min_length=9"},{"name":"routing_identifier","in":"query","required":false,"schema":{"type":"string","minLength":5,"description":"Routing Identifier, min_length=5","title":"Routing Identifier"},"description":"Routing Identifier, min_length=5"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DirectoryEntry"},"title":"Response 200 Search Directory Fr Get"}}}},"504":{"description":"Timeout","content":{"application/json":{"example":{"error":"timeout"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Unknown error","content":{"application/json":{"example":{"error":"unknown"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"Service unreachable","content":{"application/json":{"example":{"error":"unreachable"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"example":{"Message":"User is not authorized to access this resource with an explicit deny in an identity-based policy"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Address":{"properties":{"addressLine1":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Addressline1"},"addressLine2":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Addressline2"},"addressLine3":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Addressline3"},"postalCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postalcode"},"countrySubdivision":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Countrysubdivision"},"locality":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locality"},"countryCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Countrycode"},"countryName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Countryname"}},"type":"object","title":"Address"},"DirectoryEntry":{"properties":{"routingIdentifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Routingidentifier"},"addressingIdentifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Addressingidentifier"},"siren":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Siren"},"siret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Siret"},"addressingSuffix":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Addressingsuffix"},"dateTo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dateto"},"effectiveEndDate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effectiveenddate"},"history":{"anyOf":[{"$ref":"#/components/schemas/History"},{"type":"null"}]},"routingCode":{"anyOf":[{"$ref":"#/components/schemas/RoutingCode"},{"type":"null"}]},"legalUnit":{"anyOf":[{"$ref":"#/components/schemas/LegalUnit"},{"type":"null"}]},"facility":{"anyOf":[{"$ref":"#/components/schemas/Facility"},{"type":"null"}]}},"type":"object","title":"DirectoryEntry"},"ErrorResponse":{"properties":{"error":{"type":"string","title":"Error"}},"type":"object","required":["error"],"title":"ErrorResponse","example":{"error":"timeout"}},"Facility":{"properties":{"siret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Siret"},"siren":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Siren"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"facilityType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Facilitytype"},"diffusible":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Diffusible"},"administrativeStatus":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Administrativestatus"},"address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]}},"type":"object","title":"Facility"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"History":{"properties":{"definitionDate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Definitiondate"},"dateFrom":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Datefrom"},"createdBy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Createdby"},"idInstance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idinstance"}},"type":"object","title":"History"},"LegalUnit":{"properties":{"siren":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Siren"},"businessName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Businessname"},"entityType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entitytype"},"administrativeStatus":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Administrativestatus"},"diffusible":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Diffusible"}},"type":"object","title":"LegalUnit"},"RoutingCode":{"properties":{"routingIdentifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Routingidentifier"},"routingIdentifierType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Routingidentifiertype"},"routingCodeName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Routingcodename"},"managesLegalCommitment":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Manageslegalcommitment"},"administrativeStatus":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Administrativestatus"},"address":{"anyOf":[{"$ref":"#/components/schemas/Address"},{"type":"null"}]}},"type":"object","title":"RoutingCode"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"},"HTTPBasic":{"type":"http","scheme":"basic"}}},"security":[{"BearerAuth":[]},{"HTTPBasic":[]}],"servers":[{"url":"/v1"},{"url":"https://api.basware.com/v1"}]}