{"openapi":"3.1.0","info":{"title":"AXITAM Public API","description":"Reference data (ISO, CLDR), Belgian enterprises, annual accounts and addresses, Peppol participants - built on community-maintained and official sources. See the data-sources API for each source's version and license. Beta.","version":"0.14.0"},"servers":[{"url":"/","description":"This server"}],"tags":[{"name":"Legal Entity Identifiers","description":"LEI records (ISO 17442) read live from the GLEIF API: who is who (legal name, addresses, registration authority and identifier, ISO 20275 legal form, registration status and renewal date) and who owns whom (direct and ultimate accounting consolidation parents and children, or the published reason why no parent is reported). Source: GLEIF, data under CC0 1.0. Nothing is stored; searches are cached a few minutes, records and relationships never."},{"name":"Entity legal forms","description":"The ISO 20275 Entity Legal Forms (ELF) list maintained by GLEIF: one code per legal form and country, with its local names by language and its status. Read from the GLEIF API and kept a day in memory. Source: GLEIF, CC0 1.0."}],"paths":{"/api/v1/leis":{"get":{"tags":["Legal Entity Identifiers"],"summary":"Search LEI records","description":"At least one criterion. name finds the legal names containing the text (case-insensitive); the other criteria match exactly. A Belgian enterprise is found with registeredAt=RA000025 and registeredAs in the dotted form (0202.239.951). GLEIF serves the first 10 000 results only (page and limit accordingly).","operationId":"search","parameters":[{"name":"name","in":"query","description":"Text the legal name contains, case-insensitive","required":false,"schema":{"type":"string","pattern":"^[^\\p{Cntrl}]{2,100}$"},"example":"proximus"},{"name":"country","in":"query","description":"ISO 3166-1 alpha-2 country of the legal address","required":false,"schema":{"type":"string","pattern":"^[A-Z]{2}$"},"example":"BE"},{"name":"registeredAs","in":"query","description":"Identifier at the registration authority, as published","required":false,"schema":{"type":"string","pattern":"^[^\\p{Cntrl}]{1,50}$"},"example":"0202.239.951"},{"name":"registeredAt","in":"query","description":"Registration authority id (RA000025 = the Belgian KBO/BCE)","required":false,"schema":{"type":"string","pattern":"^RA[0-9]{6}$"},"example":"RA000025"},{"name":"status","in":"query","description":"Registration status: ISSUED, LAPSED, RETIRED...","required":false,"schema":{"type":"string","pattern":"^[A-Z_]{3,30}$"},"example":"ISSUED"},{"name":"page","in":"query","description":"0-based page index","required":false,"schema":{"type":"integer","format":"int32","default":0,"minimum":0},"example":0},{"name":"limit","in":"query","description":"Page size","required":false,"schema":{"type":"integer","format":"int32","default":20,"maximum":200,"minimum":1},"example":20}],"responses":{"200":{"description":"One page of matching records, possibly empty","content":{"*/*":{"schema":{"$ref":"#/components/schemas/LeiPageResponse"}}}},"400":{"description":"Malformed parameter (code INVALID_REQUEST); no criterion or a page past the first 10 000 results (code INVALID_ARGUMENT)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"502":{"description":"GLEIF did not answer, or answered an error or an unexpected document (code UPSTREAM_UNAVAILABLE)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"GLEIF answered 429 or too many requests towards it are in flight, retry later (code UPSTREAM_BUSY)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/leis/{lei}":{"get":{"tags":["Legal Entity Identifiers"],"summary":"Read an LEI record","description":"The full Level 1 record: entity, addresses, registration authority and identifier, ISO 20275 legal form with its names, registration status and next renewal date.","operationId":"findRecord","parameters":[{"name":"lei","in":"path","description":"The LEI: 20 letters or digits, the last two checking the others","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9]{20}$"},"example":"549300CWRXC5EP004533"}],"responses":{"200":{"description":"The record","content":{"*/*":{"schema":{"$ref":"#/components/schemas/LeiRecordResponse"}}}},"400":{"description":"Not a well-formed LEI (code INVALID_LEI, or INVALID_REQUEST for another length or characters)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"GLEIF holds no record for this LEI (code LEI_NOT_FOUND)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"502":{"description":"GLEIF did not answer, or answered an error or an unexpected document (code UPSTREAM_UNAVAILABLE)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"GLEIF answered 429 or too many requests towards it are in flight, retry later (code UPSTREAM_BUSY)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/leis/{lei}/ultimate-parent":{"get":{"tags":["Legal Entity Identifiers"],"summary":"Ultimate parent of an entity","description":"The ultimate accounting consolidation parent, or the reason published when none is reported.","operationId":"findUltimateParent","parameters":[{"name":"lei","in":"path","description":"The LEI: 20 letters or digits, the last two checking the others","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9]{20}$"},"example":"5493000LEBANBDSI5T38"}],"responses":{"200":{"description":"The parent or the reason; both absent when GLEIF publishes neither","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ParentResponse"}}}},"400":{"description":"Not a well-formed LEI (code INVALID_LEI, or INVALID_REQUEST for another length or characters)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"GLEIF holds no record for this LEI (code LEI_NOT_FOUND)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"502":{"description":"GLEIF did not answer, or answered an error or an unexpected document (code UPSTREAM_UNAVAILABLE)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"GLEIF answered 429 or too many requests towards it are in flight, retry later (code UPSTREAM_BUSY)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/leis/{lei}/ultimate-children":{"get":{"tags":["Legal Entity Identifiers"],"summary":"Ultimate children of an entity","description":"The entities whose ultimate accounting consolidation parent it is.","operationId":"findUltimateChildren","parameters":[{"name":"lei","in":"path","description":"The LEI: 20 letters or digits, the last two checking the others","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9]{20}$"},"example":"549300CWRXC5EP004533"},{"name":"page","in":"query","description":"0-based page index","required":false,"schema":{"type":"integer","format":"int32","default":0,"maximum":49,"minimum":0},"example":0},{"name":"limit","in":"query","description":"Page size","required":false,"schema":{"type":"integer","format":"int32","default":20,"maximum":200,"minimum":1},"example":20}],"responses":{"200":{"description":"One page of children, possibly empty","content":{"*/*":{"schema":{"$ref":"#/components/schemas/LeiPageResponse"}}}},"400":{"description":"Not a well-formed LEI (code INVALID_LEI, or INVALID_REQUEST for another length or characters)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"GLEIF holds no record for this LEI (code LEI_NOT_FOUND)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"502":{"description":"GLEIF did not answer, or answered an error or an unexpected document (code UPSTREAM_UNAVAILABLE)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"GLEIF answered 429 or too many requests towards it are in flight, retry later (code UPSTREAM_BUSY)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/leis/{lei}/direct-parent":{"get":{"tags":["Legal Entity Identifiers"],"summary":"Direct parent of an entity","description":"The direct accounting consolidation parent, or the reason published when none is reported (NATURAL_PERSONS, NON_CONSOLIDATING...).","operationId":"findDirectParent","parameters":[{"name":"lei","in":"path","description":"The LEI: 20 letters or digits, the last two checking the others","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9]{20}$"},"example":"5493000LEBANBDSI5T38"}],"responses":{"200":{"description":"The parent or the reason; both absent when GLEIF publishes neither","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ParentResponse"}}}},"400":{"description":"Not a well-formed LEI (code INVALID_LEI, or INVALID_REQUEST for another length or characters)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"GLEIF holds no record for this LEI (code LEI_NOT_FOUND)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"502":{"description":"GLEIF did not answer, or answered an error or an unexpected document (code UPSTREAM_UNAVAILABLE)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"GLEIF answered 429 or too many requests towards it are in flight, retry later (code UPSTREAM_BUSY)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/leis/{lei}/direct-children":{"get":{"tags":["Legal Entity Identifiers"],"summary":"Direct children of an entity","description":"The entities whose direct accounting consolidation parent it is.","operationId":"findDirectChildren","parameters":[{"name":"lei","in":"path","description":"The LEI: 20 letters or digits, the last two checking the others","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9]{20}$"},"example":"549300CWRXC5EP004533"},{"name":"page","in":"query","description":"0-based page index","required":false,"schema":{"type":"integer","format":"int32","default":0,"maximum":49,"minimum":0},"example":0},{"name":"limit","in":"query","description":"Page size","required":false,"schema":{"type":"integer","format":"int32","default":20,"maximum":200,"minimum":1},"example":20}],"responses":{"200":{"description":"One page of children, possibly empty","content":{"*/*":{"schema":{"$ref":"#/components/schemas/LeiPageResponse"}}}},"400":{"description":"Not a well-formed LEI (code INVALID_LEI, or INVALID_REQUEST for another length or characters)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"GLEIF holds no record for this LEI (code LEI_NOT_FOUND)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"502":{"description":"GLEIF did not answer, or answered an error or an unexpected document (code UPSTREAM_UNAVAILABLE)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"GLEIF answered 429 or too many requests towards it are in flight, retry later (code UPSTREAM_BUSY)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/entity-legal-forms":{"get":{"tags":["Entity legal forms"],"summary":"List entity legal forms","description":"The ISO 20275 codes, optionally of one country and one status, in GLEIF's order.","operationId":"findAll","parameters":[{"name":"country","in":"query","description":"ISO 3166-1 alpha-2 country","required":false,"schema":{"type":"string","pattern":"^[A-Z]{2}$"},"example":"BE"},{"name":"status","in":"query","description":"ACTV or INAC","required":false,"schema":{"type":"string","pattern":"^(ACTV|INAC)$"},"example":"ACTV"}],"responses":{"200":{"description":"The matching legal forms","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/LegalFormResponse"}}}}},"400":{"description":"Malformed country or status (code INVALID_REQUEST)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"502":{"description":"GLEIF did not answer, or answered an error or an unexpected document (code UPSTREAM_UNAVAILABLE)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"GLEIF answered 429 or too many requests towards it are in flight, retry later (code UPSTREAM_BUSY)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/entity-legal-forms/{code}":{"get":{"tags":["Entity legal forms"],"summary":"Read an entity legal form","description":"One ISO 20275 code with its names by language.","operationId":"find","parameters":[{"name":"code","in":"path","description":"ELF code","required":true,"schema":{"type":"string","pattern":"^[A-Z0-9]{4}$"},"example":"R85P"}],"responses":{"200":{"description":"The legal form","content":{"*/*":{"schema":{"$ref":"#/components/schemas/LegalFormResponse"}}}},"400":{"description":"Not four upper-case letters or digits (code INVALID_REQUEST)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such code (code LEGAL_FORM_NOT_FOUND)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"502":{"description":"GLEIF did not answer, or answered an error or an unexpected document (code UPSTREAM_UNAVAILABLE)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"GLEIF answered 429 or too many requests towards it are in flight, retry later (code UPSTREAM_BUSY)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}}},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"correlationId":{"type":"string"}}},"LegalFormNameResponse":{"type":"object","description":"A local name of an ISO 20275 legal form","properties":{"localName":{"type":"string","description":"The name in its language","example":"Naamloze vennootschap"},"language":{"type":"string","description":"The language","example":"Dutch"},"languageCode":{"type":"string","description":"ISO 639-1 language code","example":"nl"},"transliteratedName":{"type":"string","description":"The name in Latin script","example":"Naamloze vennootschap"}}},"LeiAddressResponse":{"type":"object","description":"An address as GLEIF publishes it","properties":{"language":{"type":["string","null"],"description":"Language of the address","example":"nl"},"addressLines":{"type":"array","description":"Address lines","example":["KONING ALBERTII LAAN 27","SCHAARBEEK"],"items":{"type":"string"}},"addressNumber":{"type":["string","null"],"description":"House number when published apart"},"addressNumberWithinBuilding":{"type":["string","null"],"description":"Box or flat"},"mailRouting":{"type":["string","null"],"description":"Mail routing line"},"city":{"type":"string","description":"City","example":"BRUSSELS"},"region":{"type":["string","null"],"description":"ISO 3166-2 region","example":"BE-BRU"},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country","example":"BE"},"postalCode":{"type":["string","null"],"description":"Postal code","example":"1030"}}},"LeiEntityResponse":{"type":"object","description":"The legal entity behind an LEI, as GLEIF publishes it (Level 1: who is who)","properties":{"legalName":{"$ref":"#/components/schemas/LeiNameResponse","description":"Legal name"},"otherNames":{"type":"array","description":"Other and previous names","items":{"$ref":"#/components/schemas/LeiNameResponse"}},"legalAddress":{"$ref":"#/components/schemas/LeiAddressResponse","description":"Registered address"},"headquartersAddress":{"$ref":"#/components/schemas/LeiAddressResponse","description":"Headquarters address"},"registeredAt":{"type":["string","null"],"description":"Registration authority id (RA000025 = the Belgian KBO/BCE)","example":"RA000025"},"registeredAtOther":{"type":["string","null"],"description":"The registration authority named when it has no id"},"registeredAs":{"type":["string","null"],"description":"The entity's identifier at that authority, as published (dotted KBO number in Belgium)","example":"0202.239.951"},"jurisdiction":{"type":["string","null"],"description":"Legal jurisdiction","example":"BE"},"category":{"type":["string","null"],"description":"GENERAL, FUND, BRANCH, SOLE_PROPRIETOR...","example":"GENERAL"},"subCategory":{"type":["string","null"],"description":"GLEIF subcategory"},"legalForm":{"$ref":"#/components/schemas/LeiLegalFormResponse","description":"ISO 20275 legal form"},"status":{"type":"string","description":"ACTIVE or INACTIVE","example":"ACTIVE"},"creationDate":{"type":["string","null"],"format":"date-time","description":"When the entity was created"},"expirationDate":{"type":["string","null"],"format":"date-time","description":"When the entity ceased to exist"},"expirationReason":{"type":["string","null"],"description":"Why it ceased to exist: DISSOLVED, CORPORATE_ACTION..."},"successorLei":{"type":["string","null"],"description":"LEI of the successor entity"},"successorName":{"type":["string","null"],"description":"Name of the successor when it has no LEI"}}},"LeiLegalFormResponse":{"type":"object","description":"The ISO 20275 legal form GLEIF recorded for the entity, with its names from the ISO 20275 list","properties":{"code":{"type":["string","null"],"description":"ELF code","example":"R85P"},"other":{"type":["string","null"],"description":"The legal form written out when it has no ELF code"},"status":{"type":["string","null"],"description":"Status of the code in the ISO 20275 list: ACTV or INAC","example":"ACTV"},"names":{"type":["array","null"],"description":"Local names of the code, one per language; absent when the entity has no ELF code or the list could not be read","items":{"$ref":"#/components/schemas/LegalFormNameResponse"}}}},"LeiNameResponse":{"type":"object","description":"A name of the entity","properties":{"name":{"type":"string","description":"The name","example":"PROXIMUS"},"language":{"type":["string","null"],"description":"Its language (ISO 639-1)","example":"nl"},"type":{"type":["string","null"],"description":"For other names: PREVIOUS_LEGAL_NAME, TRADING_OR_OPERATING_NAME...; absent for the legal name"}}},"LeiPageResponse":{"type":"object","description":"One page of LEI records","properties":{"totalCount":{"type":"integer","format":"int64","description":"Records matching in the whole of GLEIF","example":5},"page":{"type":"integer","format":"int32","description":"0-based page index","example":0},"limit":{"type":"integer","format":"int32","description":"Page size","example":20},"records":{"type":"array","description":"The records of this page","items":{"$ref":"#/components/schemas/LeiRecordResponse"}}}},"LeiRecordResponse":{"type":"object","description":"An LEI record, as GLEIF publishes it (source: GLEIF, CC0)","properties":{"lei":{"type":"string","description":"The Legal Entity Identifier (ISO 17442)","example":"549300CWRXC5EP004533"},"entity":{"$ref":"#/components/schemas/LeiEntityResponse","description":"The legal entity"},"registration":{"$ref":"#/components/schemas/LeiRegistrationResponse","description":"The LEI registration"},"bic":{"type":"array","description":"BIC codes GLEIF maps to the LEI, possibly none","items":{"type":"string"}},"conformityFlag":{"type":["string","null"],"description":"GLEIF data quality flag: CONFORMING or NON_CONFORMING","example":"CONFORMING"}}},"LeiRegistrationResponse":{"type":"object","description":"The registration of the LEI","properties":{"status":{"type":"string","description":"ISSUED, LAPSED (not renewed), RETIRED, MERGED, ANNULLED, PENDING_TRANSFER...","example":"ISSUED"},"initialRegistrationDate":{"type":"string","format":"date-time","description":"When the LEI was first issued"},"lastUpdateDate":{"type":"string","format":"date-time","description":"When the record last changed"},"nextRenewalDate":{"type":"string","format":"date-time","description":"When the LEI must be renewed to stay ISSUED"},"managingLou":{"type":"string","description":"LEI of the Local Operating Unit managing the record","example":"213800WAVVOPS85N2205"},"corroborationLevel":{"type":"string","description":"FULLY_CORROBORATED, PARTIALLY_CORROBORATED, ENTITY_SUPPLIED_ONLY","example":"FULLY_CORROBORATED"},"validatedAt":{"type":["string","null"],"description":"Registration authority the data was validated at","example":"RA000025"},"validatedAtOther":{"type":["string","null"],"description":"That authority when it has no id"},"validatedAs":{"type":["string","null"],"description":"Identifier at that authority","example":"0202.239.951"}}},"ParentResponse":{"type":"object","description":"The accounting consolidation parent of an entity (Level 2: who owns whom), or why none is reported","properties":{"parent":{"type":"null","$ref":"#/components/schemas/LeiRecordResponse","description":"The parent's LEI record; absent when none is reported"},"reportingException":{"type":"null","$ref":"#/components/schemas/ReportingExceptionResponse","description":"Why no parent is reported; absent when a parent is"}}},"ReportingExceptionResponse":{"type":"object","description":"Why the entity reports no parent, as published","properties":{"category":{"type":"string","description":"DIRECT_ACCOUNTING_CONSOLIDATION_PARENT or ULTIMATE_ACCOUNTING_CONSOLIDATION_PARENT"},"reason":{"type":"string","description":"NATURAL_PERSONS, NON_CONSOLIDATING, NO_KNOWN_PERSON, NON_PUBLIC...","example":"NON_CONSOLIDATING"},"reference":{"type":["string","null"],"description":"A reference given with the reason"}}},"LegalFormResponse":{"type":"object","description":"An entity legal form of the ISO 20275 list, as GLEIF publishes it","properties":{"code":{"type":"string","description":"ELF code","example":"R85P"},"country":{"type":"string","description":"Country name","example":"Belgium"},"countryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country","example":"BE"},"jurisdiction":{"type":["string","null"],"description":"Jurisdiction within the country"},"subdivisionCode":{"type":["string","null"],"description":"ISO 3166-2 subdivision"},"dateCreated":{"type":["string","null"],"format":"date","description":"When the code was created","example":"2017-11-30"},"status":{"type":"string","description":"ACTV (active) or INAC (inactive)","example":"ACTV"},"names":{"type":"array","description":"Local names, one per language","items":{"$ref":"#/components/schemas/LegalFormNameResponse"}}}}},"securitySchemes":{"apiKey":{"type":"apiKey","description":"Optional. A key of a registered developer (portal: /account/) raises the request rate of the client from the anonymous per-IP limit to the plan's. Without it the request is anonymous; an unknown or revoked key is refused (401 INVALID_API_KEY).","name":"X-API-Key","in":"header"}}}}