{ "openapi": "3.0.3", "info": { "title": "SweKit API", "version": "0.1.0", "description": "Swedish payment identifiers, bank accounts/IBAN and business-day calendar. Deterministic, no personal data stored. Checksum/format validation only (does not prove existence).", "license": { "name": "MIT", "url": "https://opensource.org/licenses/MIT" } }, "servers": [ { "url": "https://swekit-api.erikssonanton2001.workers.dev" } ], "paths": { "/v1/personnummer": { "get": { "summary": "Validate & parse a Swedish personnummer / samordningsnummer", "operationId": "v1_personnummer", "parameters": [ { "name": "value", "in": "query", "required": true, "description": "Personnummer in any common format (YYMMDD-NNNC, YYYYMMDDNNNC, with + for 100+). Prefer POST JSON {\"value\": \"...\"} so the number never appears in a URL.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] }, "post": { "summary": "Validate & parse a Swedish personnummer / samordningsnummer (JSON body)", "operationId": "v1_personnummer_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "string", "description": "Personnummer in any common format (YYMMDD-NNNC, YYYYMMDDNNNC, with + for 100+). Prefer POST JSON {\"value\": \"...\"} so the number never appears in a URL." } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] } }, "/v1/orgnr": { "get": { "summary": "Validate organisationsnummer, derive legal form and Swedish VAT number (SE#########01)", "operationId": "v1_orgnr", "parameters": [ { "name": "value", "in": "query", "required": true, "description": "Org no. like 556036-0793, 5560360793, SE556036079301", "schema": { "type": "string" } } ], "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] }, "post": { "summary": "Validate organisationsnummer, derive legal form and Swedish VAT number (SE#########01) (JSON body)", "operationId": "v1_orgnr_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "string", "description": "Org no. like 556036-0793, 5560360793, SE556036079301" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] } }, "/v1/bankgiro": { "get": { "summary": "Validate bankgiro number (Luhn) and format it", "operationId": "v1_bankgiro", "parameters": [ { "name": "value", "in": "query", "required": true, "description": "7-8 digits, with or without dash", "schema": { "type": "string" } } ], "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] }, "post": { "summary": "Validate bankgiro number (Luhn) and format it (JSON body)", "operationId": "v1_bankgiro_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "string", "description": "7-8 digits, with or without dash" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] } }, "/v1/plusgiro": { "get": { "summary": "Validate plusgiro number", "operationId": "v1_plusgiro", "parameters": [ { "name": "value", "in": "query", "required": true, "description": "2-8 digits", "schema": { "type": "string" } } ], "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] }, "post": { "summary": "Validate plusgiro number (JSON body)", "operationId": "v1_plusgiro_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "string", "description": "2-8 digits" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] } }, "/v1/ocr/validate": { "get": { "summary": "Validate an OCR / payment reference (Luhn check digit, optional length digit)", "operationId": "v1_ocr_validate", "parameters": [ { "name": "value", "in": "query", "required": true, "description": "OCR digits", "schema": { "type": "string" } } ], "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] }, "post": { "summary": "Validate an OCR / payment reference (Luhn check digit, optional length digit) (JSON body)", "operationId": "v1_ocr_validate_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "string", "description": "OCR digits" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] } }, "/v1/ocr/generate": { "get": { "summary": "Generate an OCR reference from a base number", "operationId": "v1_ocr_generate", "parameters": [ { "name": "base", "in": "query", "required": true, "description": "Digits, e.g. invoice number", "schema": { "type": "string" } }, { "name": "length_digit", "in": "query", "required": false, "description": "Add length digit (default false)", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] }, "post": { "summary": "Generate an OCR reference from a base number (JSON body)", "operationId": "v1_ocr_generate_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "base": { "type": "string", "description": "Digits, e.g. invoice number" }, "length_digit": { "type": "boolean", "description": "Add length digit (default false)" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] } }, "/v1/account": { "get": { "summary": "Validate a Swedish bank account (clearing + account, per Bankgirot rules) and convert to IBAN", "operationId": "v1_account", "parameters": [ { "name": "number", "in": "query", "required": false, "description": "Full account digits (clearing first), OR", "schema": { "type": "string" } }, { "name": "clearing", "in": "query", "required": false, "description": "Clearing number (4 digits; 5 for Swedbank 8xxx)", "schema": { "type": "string" } }, { "name": "account", "in": "query", "required": false, "description": "Account number without clearing", "schema": { "type": "string" } } ], "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] }, "post": { "summary": "Validate a Swedish bank account (clearing + account, per Bankgirot rules) and convert to IBAN (JSON body)", "operationId": "v1_account_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "number": { "type": "string", "description": "Full account digits (clearing first), OR" }, "clearing": { "type": "string", "description": "Clearing number (4 digits; 5 for Swedbank 8xxx)" }, "account": { "type": "string", "description": "Account number without clearing" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] } }, "/v1/iban": { "get": { "summary": "Validate any IBAN (ISO 13616 mod-97, country length) and identify Swedish banks", "operationId": "v1_iban", "parameters": [ { "name": "value", "in": "query", "required": true, "description": "IBAN, spaces allowed", "schema": { "type": "string" } } ], "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] }, "post": { "summary": "Validate any IBAN (ISO 13616 mod-97, country length) and identify Swedish banks (JSON body)", "operationId": "v1_iban_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "string", "description": "IBAN, spaces allowed" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] } }, "/v1/bic": { "get": { "summary": "Validate BIC/SWIFT format", "operationId": "v1_bic", "parameters": [ { "name": "value", "in": "query", "required": true, "description": "8 or 11 characters", "schema": { "type": "string" } } ], "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] }, "post": { "summary": "Validate BIC/SWIFT format (JSON body)", "operationId": "v1_bic_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "string", "description": "8 or 11 characters" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] } }, "/v1/clearing": { "get": { "summary": "Look up bank, BIC, IBAN id and account type for a clearing number", "operationId": "v1_clearing", "parameters": [ { "name": "value", "in": "query", "required": true, "description": "First 4 digits of the account number", "schema": { "type": "string" } } ], "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] }, "post": { "summary": "Look up bank, BIC, IBAN id and account type for a clearing number (JSON body)", "operationId": "v1_clearing_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "string", "description": "First 4 digits of the account number" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] } }, "/v1/holidays": { "get": { "summary": "Swedish public holidays and eves for a year", "operationId": "v1_holidays", "parameters": [ { "name": "year", "in": "query", "required": false, "description": "1900-2200 (default: current year)", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] }, "post": { "summary": "Swedish public holidays and eves for a year (JSON body)", "operationId": "v1_holidays_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "integer", "description": "1900-2200 (default: current year)" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] } }, "/v1/date": { "get": { "summary": "Info about a date: weekday (sv/en), ISO week, holiday names, business-day status", "operationId": "v1_date", "parameters": [ { "name": "date", "in": "query", "required": true, "description": "YYYY-MM-DD", "schema": { "type": "string" } }, { "name": "mode", "in": "query", "required": false, "description": "\"bank\" (default; midsommarafton, julafton, nyårsafton also excluded) or \"work\"", "schema": { "type": "string" } } ], "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] }, "post": { "summary": "Info about a date: weekday (sv/en), ISO week, holiday names, business-day status (JSON body)", "operationId": "v1_date_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "description": "YYYY-MM-DD" }, "mode": { "type": "string", "description": "\"bank\" (default; midsommarafton, julafton, nyårsafton also excluded) or \"work\"" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] } }, "/v1/business-days/add": { "get": { "summary": "Add (or subtract) N business days to a date", "operationId": "v1_business_days_add", "parameters": [ { "name": "date", "in": "query", "required": true, "description": "YYYY-MM-DD", "schema": { "type": "string" } }, { "name": "days", "in": "query", "required": true, "description": "Positive or negative, |n| <= 3650", "schema": { "type": "integer" } }, { "name": "mode", "in": "query", "required": false, "description": "bank (default) or work", "schema": { "type": "string" } } ], "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] }, "post": { "summary": "Add (or subtract) N business days to a date (JSON body)", "operationId": "v1_business_days_add_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "description": "YYYY-MM-DD" }, "days": { "type": "integer", "description": "Positive or negative, |n| <= 3650" }, "mode": { "type": "string", "description": "bank (default) or work" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] } }, "/v1/business-days/between": { "get": { "summary": "Count business days between two dates", "operationId": "v1_business_days_between", "parameters": [ { "name": "from", "in": "query", "required": true, "description": "YYYY-MM-DD", "schema": { "type": "string" } }, { "name": "to", "in": "query", "required": true, "description": "YYYY-MM-DD", "schema": { "type": "string" } }, { "name": "mode", "in": "query", "required": false, "description": "bank (default) or work", "schema": { "type": "string" } } ], "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] }, "post": { "summary": "Count business days between two dates (JSON body)", "operationId": "v1_business_days_between_post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "from": { "type": "string", "description": "YYYY-MM-DD" }, "to": { "type": "string", "description": "YYYY-MM-DD" }, "mode": { "type": "string", "description": "bank (default) or work" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "JSON result", "content": { "application/json": { "schema": { "type": "object", "properties": { "valid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true } } } }, "400": { "description": "Bad parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or expired API key", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ {}, { "ApiKey": [] } ] } } }, "components": { "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "X-API-Key" } }, "schemas": { "Error": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }