{"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.23.0"},"servers":[{"url":"/","description":"This server"}],"tags":[{"name":"Phone numbers (libphonenumber)","description":"Checks a phone number as a user typed it: whether it is possible and valid for its country, its type (fixed line, mobile, toll free...), its region, and its written forms - E.164 to store it, international, national, tel: URI - plus the region or city of a geographic number, the carrier the range was allocated to (not the current one after number portability) and its time zones. Computed with Google's libphonenumber (Apache-2.0) embedded in this API: the number is sent nowhere and stored nowhere."}],"paths":{"/api/v1/phone-numbers/regions":{"get":{"tags":["Phone numbers (libphonenumber)"],"summary":"The regions libphonenumber knows","description":"Every region with its country calling code and the types of number it has, by code.","operationId":"findRegions","responses":{"200":{"description":"The regions","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PhoneRegionResponse"}}}}},"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/phone-numbers/regions/{region}/example":{"get":{"tags":["Phone numbers (libphonenumber)"],"summary":"An example number of a region","description":"The library's example number of a type, checked: a fictitious number of a range in use, for a form placeholder or a test.","operationId":"findExample","parameters":[{"name":"region","in":"path","description":"ISO 3166-1 alpha-2 region","required":true,"schema":{"type":"string","pattern":"^[A-Za-z]{2}$"},"example":"BE"},{"name":"type","in":"query","description":"FIXED_LINE, MOBILE, TOLL_FREE, PREMIUM_RATE, SHARED_COST, VOIP, PERSONAL_NUMBER, PAGER, UAN or VOICEMAIL","required":false,"schema":{"type":"string","default":"FIXED_LINE","pattern":"^[A-Z_]{3,25}$"},"example":"MOBILE"},{"name":"lang","in":"query","description":"Language of the location and carrier names (en, fr, nl, de...), English by default","required":false,"schema":{"type":"string","pattern":"^[A-Za-z]{2,3}([-_][A-Za-z0-9]{2,8})?$"},"example":"fr"}],"responses":{"200":{"description":"The example number","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PhoneNumberCheckResponse"}}}},"400":{"description":"Unknown region (code INVALID_REGION), unknown type (code INVALID_ARGUMENT) or malformed parameter (code INVALID_REQUEST)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The region has no number of that type (code EXAMPLE_NUMBER_NOT_FOUND)","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/phone-numbers/check":{"get":{"tags":["Phone numbers (libphonenumber)"],"summary":"Check a phone number","description":"The number as typed: international (+32..., 0032...) or national with its region (02/211.11.11 with region=BE); spaces, dots, slashes, dashes and brackets are allowed, and an extension (ext. 123). A number that can be read but matches no range in use answers 200 with isValid false.","operationId":"check","parameters":[{"name":"number","in":"query","description":"The phone number as typed","required":true,"schema":{"type":"string","pattern":"^[^\\p{Cntrl}]{1,50}$"},"example":"012 34 56 78"},{"name":"region","in":"query","description":"ISO 3166-1 alpha-2 region of a national form","required":false,"schema":{"type":"string","pattern":"^[A-Za-z]{2}$"},"example":"BE"},{"name":"lang","in":"query","description":"Language of the location and carrier names (en, fr, nl, de...), English by default","required":false,"schema":{"type":"string","pattern":"^[A-Za-z]{2,3}([-_][A-Za-z0-9]{2,8})?$"},"example":"fr"}],"responses":{"200":{"description":"What libphonenumber says of the number","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PhoneNumberCheckResponse"}}}},"400":{"description":"Not a phone number (code INVALID_PHONE_NUMBER), unknown region (code INVALID_REGION) or malformed parameter (code INVALID_REQUEST)","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":{"PhoneRegionResponse":{"type":"object","description":"A region libphonenumber knows","properties":{"regionCode":{"type":"string","description":"ISO 3166-1 alpha-2 code","example":"BE"},"countryCallingCode":{"type":"integer","format":"int32","description":"Country calling code","example":32},"numberTypes":{"type":"array","description":"Types of number the region has","example":["FIXED_LINE","MOBILE"],"items":{"type":"string"}}}},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"correlationId":{"type":"string"}}},"PhoneNumberCheckResponse":{"type":"object","description":"What libphonenumber says of a phone number","properties":{"number":{"type":"string","description":"The number as it was typed","example":"012 34 56 78"},"defaultRegion":{"type":["string","null"],"description":"Region used for a national form, null when none was given","example":"BE"},"isPossible":{"type":"boolean","description":"Its length is possible for its country"},"possibility":{"type":"string","description":"IS_POSSIBLE, IS_POSSIBLE_LOCAL_ONLY, INVALID_COUNTRY_CODE, TOO_SHORT, INVALID_LENGTH or TOO_LONG","example":"IS_POSSIBLE"},"isValid":{"type":"boolean","description":"It matches a numbering range in use in its country"},"type":{"type":"string","description":"FIXED_LINE, MOBILE, FIXED_LINE_OR_MOBILE, TOLL_FREE, PREMIUM_RATE, SHARED_COST, VOIP, PERSONAL_NUMBER, PAGER, UAN, VOICEMAIL or UNKNOWN","example":"FIXED_LINE"},"regionCode":{"type":["string","null"],"description":"ISO 3166-1 alpha-2 region of the number (001 for a non-geographic entity), null when it matches none","example":"BE"},"countryCallingCode":{"type":"integer","format":"int32","description":"Country calling code","example":32},"nationalNumber":{"type":"string","description":"National significant number, digits only","example":"12345678"},"extension":{"type":["string","null"],"description":"Extension typed after the number"},"formats":{"$ref":"#/components/schemas/PhoneNumberFormatsResponse","description":"Its written forms"},"location":{"type":["string","null"],"description":"Region or city of a geographic number, in the asked language","example":"Tongres"},"carrier":{"type":["string","null"],"description":"Carrier the range was allocated to - not the current one after number portability"},"timeZones":{"type":"array","description":"Time zones of the number","example":["Europe/Brussels"],"items":{"type":"string"}}}},"PhoneNumberFormatsResponse":{"type":"object","description":"The standard written forms of a phone number","properties":{"e164":{"type":"string","description":"E.164, the canonical form to store","example":"+3212345678"},"international":{"type":"string","description":"ITU-T E.123 international form","example":"+32 12 34 56 78"},"national":{"type":"string","description":"National form of its country","example":"012 34 56 78"},"rfc3966":{"type":"string","description":"RFC 3966 tel: URI","example":"tel:+32-12-34-56-78"}}}},"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"}}}}