{ "components": { "examples": { "standard-error-400": { "description": "The request body or parameters are invalid.", "summary": "Bad Request", "value": { "errors": [], "localizedMessage": "Invalid request", "message": "Invalid request", "status": "BAD_REQUEST", "statusCode": 400 } }, "standard-error-401": { "description": "The credentials are missing or invalid, the calling IP is not on the client's allowlist, or mTLS is enforced and no valid client certificate was sent. An expired session token gets 401 Token expired.", "summary": "Unauthorized", "value": { "errors": [], "localizedMessage": "Authentication failed", "message": "Authentication failed", "status": "UNAUTHORIZED", "statusCode": 401 } }, "standard-error-403": { "description": "The client is not allowed to use this endpoint or resource.", "summary": "Forbidden", "value": { "errors": [], "localizedMessage": "Not allowed", "message": "Not allowed", "status": "FORBIDDEN", "statusCode": 403 } }, "standard-error-404": { "description": "The requested resource does not exist or has expired.", "summary": "Not Found", "value": { "errors": [], "localizedMessage": "Not found", "message": "Not found", "status": "NOT_FOUND", "statusCode": 404 } }, "standard-error-429": { "description": "The client has sent too many requests in a given time window. Retry after a delay using exponential backoff.", "summary": "Rate limit exceeded", "value": { "errors": [], "localizedMessage": "Too many requests. Please retry with backoff.", "message": "Too many requests. Please retry with backoff.", "status": "TOO_MANY_REQUESTS", "statusCode": 429 } } }, "schemas": { "AccountInformation": { "properties": { "cashAccountNumber": { "description": "Number of the cash account.", "example": "123456789", "type": "string" }, "cashValue": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Available cash balance in the account." }, "hasExclusiveOwnership": { "description": "Indicates whether the user has exclusive ownership of the account. False if PoA or shared ownership.", "example": true, "type": "boolean" }, "interestRate": { "description": "Interest rate of the account. Percentage [0...1]", "example": 0.0375, "format": "double", "type": "number" } } }, "AdditionalLoginInput": { "description": "Additional login input", "example": { "key": "region", "options": [ { "label": "Centre Loire", "value": "centreloire" }, { "label": "Centre Est", "value": "centrest" } ], "type": "selectOne" }, "oneOf": [ { "$ref": "#/components/schemas/SelectOne" } ], "properties": { "type": { "type": "string" } } }, "AdditionalLoginInputSelectOption": { "properties": { "label": { "type": "string" }, "value": { "type": "string" } }, "required": [ "label", "value" ] }, "AgePeriod": { "allOf": [ { "$ref": "#/components/schemas/PayoutPeriod" }, { "properties": { "endAge": { "description": "The payout end age. Will not be set if the payout is lifelong.", "example": 70, "format": "int32", "type": "integer" }, "startAge": { "description": "The payout start age.", "example": 65, "format": "int32", "type": "integer" }, "type": { "enum": [ "AGE_RANGE" ], "example": "AGE_RANGE", "type": "string" } }, "type": "object" } ], "description": "A payout period described by an age range.", "discriminator": { "mapping": { "parent": "#/components/schemas/PayoutPeriod" }, "propertyName": "type" }, "title": "AgePeriod" }, "BuyTransaction": { "description": "A purchase on the account", "discriminator": { "mapping": { "parent": "#/components/schemas/Transaction" }, "propertyName": "transaction type" }, "properties": { "amount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The transaction amount." }, "commission": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The optional commission on the transaction" }, "instrumentInformation": { "$ref": "#/components/schemas/TransactionInstrument", "description": "Information about the instrument traded." }, "quantity": { "description": "The quantity of stock or fund bought.", "example": 204.33, "format": "double", "type": "number" }, "settlementDate": { "description": "The date when the transaction was settled.", "example": "2024-01-01", "type": "string" }, "tradeDate": { "description": "The date when the instrument was traded.", "example": "2024-01-01", "type": "string" }, "type": { "enum": [ "BUY", "SELL", "DEPOSIT", "WITHDRAWAL", "FEE", "INTEREST", "DIVIDEND", "REDEMPTION", "OTHER" ], "example": "BUY", "title": "TransactionType", "type": "string" } }, "title": "BuyTransaction" }, "CollectionInput": { "description": "A `CollectionInput` is a set of values that required for the collection process to continue. The required input is specified by the key `REQUIRED_INPUT_TYPES`, under the `extraInformation` key on the `CollectionStatus` object.", "properties": { "items": { "items": { "$ref": "#/components/schemas/Item" }, "type": "array", "uniqueItems": true }, "type": { "enum": [ "COLLECTION_INPUT" ], "example": "COLLECTION_INPUT", "type": "string" } } }, "CollectionRequestFilter": { "properties": { "rules": { "items": { "$ref": "#/components/schemas/CollectionRequestFilterRule" }, "type": "array", "uniqueItems": true } } }, "CollectionRequestFilterRule": { "properties": { "field": { "enum": [ "registrationNo" ], "type": "string" }, "value": { "type": "string" } } }, "CollectionRequestV5": { "discriminator": { "propertyName": "api" }, "properties": { "company": { "description": "The name of the company to trigger the collection from", "example": "se-lansforsakringar", "type": "string" }, "consents": { "description": "A set of consents provided by the end user.", "items": { "$ref": "#/components/schemas/ConsentRequestInput" }, "type": "array", "uniqueItems": true }, "filter": { "$ref": "#/components/schemas/CollectionRequestFilter" }, "input": { "additionalProperties": { "type": "string" }, "description": "Key-value object specifying additional input required for the collection. What values should be included depends on context.Possible keys are `SWEDISH_PERSONAL_NUMBER`, `NORWEGIAN_PERSONAL_NUMBER`, `NORWEGIAN_PHONE_NUMBER`,`USERNAME`, `PASSWORD`, `LASTNAME`, `ACCOUNT_OWNER_NAME`.", "example": { "SWEDISH_PERSONAL_NUMBER": "192101010101" }, "type": "object" }, "loginMethod": { "description": "Login method that will be used to authenticate the user. Available login methods for a company is specified in the `/companies/availability` response.", "enum": [ "DANISH_NEMID", "DANISH_MITID", "DANISH_MITID_SAME_DEVICE", "ESTONIAN_MOBILE_ID", "ESTONIAN_SMART_ID", "ESTONIAN_MOBILE_ID_USERNAME", "ESTONIAN_SMART_ID_USERNAME", "LATVIAN_MOBILE_EPARAKSTS", "LATVIAN_SMART_ID", "LATVIAN_MOBILE_EPARAKSTS_USERNAME", "LATVIAN_SMART_ID_USERNAME", "LITHUANIAN_SMART_ID", "LITHUANIAN_MOBILE_ID", "LITHUANIAN_SMART_ID_USERNAME", "LITHUANIAN_MOBILE_ID_USERNAME", "SMART_ID_SAME_DEVICE", "SMART_ID_OTHER_DEVICE", "SMART_ID_USERNAME_SAME_DEVICE", "SMART_ID_USERNAME_OTHER_DEVICE", "NORWEGIAN_BANKID_ON_MOBILE", "NORWEGIAN_BANKID_ON_MOBILE_FULL_PERSONAL_NUMBER", "SWEDISH_MOBILE_BANKID_OTHER_DEVICE", "SWEDISH_MOBILE_BANKID_OTHER_DEVICE_MOCK", "SWEDISH_MOBILE_BANKID_SAME_DEVICE", "SWEDISH_MOBILE_BANKID_SAME_DEVICE_CLIENT_SIDE_AUTHENTICATION", "SWEDISH_MOBILE_BANKID_SAME_DEVICE_CLIENT_SIDE_AUTHENTICATION_MOCK", "SWEDISH_MOBILE_BANKID_OTHER_DEVICE_TEST", "SWEDISH_MOBILE_BANKID_SAME_DEVICE_TEST", "SWEDISH_SECURITY_TOKEN", "UK_DOB_USERNAME_PASSWORD", "UK_LASTNAME_MEMBERSHIP_NUMBER", "UK_USERNAME_POSTCODE", "USERNAME_AND_PASSWORD", "EMAIL", "PDF_UPLOAD", "GERMAN_EID", "AUTHENTICATION_APP_URL", "MANUAL_SELECT", "API_KEY" ], "example": "SWEDISH_MOBILE_BANKID_OTHER_DEVICE", "type": "string" } } }, "CollectionStatusInformationMap": { "description": "Possible extra information returned for a collection status", "discriminator": { "propertyName": "api" }, "properties": { "ACCESS_TOKEN": { "description": "Access token to call get-data. Returned when data collection is initiated by client-id.", "type": "string" }, "AUTHENTICATION_APP_URL": { "description": "A url to trigger authentication apps.", "example": "https://banklogin.com/challenge?id=bc453568-1e63-432c-9957-ae2fc6acb826", "type": "string" }, "AVAILABLE_TWO_FACTOR_METHODS": { "description": "Available 2FA methods for this collection.", "items": { "$ref": "#/components/schemas/TwoFactorOption" }, "type": "array" }, "INSTRUCTIONS": { "$ref": "#/components/schemas/InstructionsRequestObject", "description": "Instructions used for SWEDISH_MOBILE_BANKID_SAME_DEVICE_CLIENT_SIDE_AUTHENTICATION login method." }, "NORWEGIAN_BANKID_WORDS": { "description": "Two words for validating that the prompted session in app is the same.", "example": "SPINKEL BRIKKE", "type": "string" }, "QR_CODE_DATA": { "description": "A base64 encoded QR-code.", "example": "R0lGODdhtAC0AIAAAAAAAP///ywAAALg==Lg==", "type": "string" }, "REFERENCE_NUMBER": { "description": "Reference number from login page to verify on other device.", "example": "1234", "type": "string" }, "REQUIRED_INPUT_TYPES": { "description": "Input that needs to be provided for the collection process to continue.", "example": "EMAIL", "items": { "description": "Type of input.", "enum": [ "EMAIL", "ESTONIAN_PERSONAL_NUMBER", "ESTONIAN_PHONE_NUMBER", "LASTNAME", "LATVIAN_PERSONAL_NUMBER", "LITHUANIAN_PERSONAL_NUMBER", "LITHUANIAN_PHONE_NUMBER", "LOGIN_METHOD", "MEMBERSHIP_NUMBER", "MOBILE_PHONE_NUMBER", "NORWEGIAN_BANKID_OTP", "NORWEGIAN_BANKID_PASSWORD", "NORWEGIAN_FULL_PERSONAL_NUMBER", "NORWEGIAN_PERSONAL_NUMBER", "NORWEGIAN_PHONE_NUMBER", "PASSWORD", "POSTCODE", "REGION", "SWEDISH_PERSONAL_NUMBER", "TRADE_UNION_MEMBERSHIP", "TWO_FACTOR_TOKEN", "UK_DATE_OF_BIRTH", "USERNAME" ], "example": "EMAIL", "type": "string" }, "type": "array" }, "RESEND_CODE_THRESHOLD_SECONDS": { "description": "Number of seconds to wait before showing the resend 2FA code option. Null if resend is not available.", "format": "int32", "type": "integer", "x-markets": { "fr": true } }, "SWEDISH_BANKID_QRCODE": { "description": "A base64 encoded swedish BankId QR-code.", "example": "R0lGODdhtAC0AIAAAAAAAP///ywAAALg==Lg==", "type": "string" }, "SWEDISH_MOBILE_BANKID_ANIMATED_QR_DATA": { "description": "Used to generate an animated QR-code to authenticate users on other devices. The QR-code needs to be updated every second and is only applicable for companies that have the LoginMethod SWEDISH_MOBILE_BANKID_OTHER_DEVICE.", "example": "bankid.67df3917-fa0d-44e5-b327-edcc928297f8.0.dc69358e712458a66a7525beef148ae8526b1c71610eff2c16cdffb4cdac9bf8", "type": "string" }, "SWEDISH_MOBILE_BANKID_AUTOSTART_TOKEN": { "description": "Used to compile a QR image or an app-link.", "example": "7c40b5c9-fa74-49cf-b98c-bfe651f9a7c6", "type": "string" }, "TWO_FACTOR_AUTHENTICATION_INSTRUCTION": { "$ref": "#/components/schemas/TwoFactorAuthenticationInstruction" } }, "title": "CollectionStatusInformation" }, "CollectionStatusV5": { "discriminator": { "propertyName": "api" }, "properties": { "company": { "description": "Company that this collection is from", "example": "se-lansforsakringar", "type": "string" }, "externalUserUuid": { "description": "The UUID of the external user this collection belongs to, when it is linked to one (null otherwise). Can be used to build a Hub deep-link of the form /collections/user/{externalUserUuid}.", "example": "b3f1c2a4-8d6e-4f2b-9a1c-7e5d3b2a1f0e", "type": "string" }, "extraInformation": { "$ref": "#/components/schemas/CollectionStatusInformationMap", "description": "A key-value map containing potential extra information, depending on the company the collection is getting data from.", "example": { "SWEDISH_BANKID_QRCODE": "iVBORw0KGgoAA==", "SWEDISH_MOBILE_BANKID_AUTOSTART_TOKEN": "38bb848d-5a0d-4dec-977d-a8777f3637da" } }, "id": { "description": "The collection ID of the request", "example": "22e633bc-427d-4f4a-87cf-cfaca04ef351", "type": "string" }, "pollingTimeout": { "description": "The collection status must be polled before this timestamp. Failure to do so may result in the termination of the collection.", "example": "2024-09-26T12:59:10.545Z", "format": "date-time", "type": "string" }, "status": { "description": "Current status of the collection.", "enum": [ "RUNNING", "LOGIN", "CUSTOMER_ENROLLMENT_CHECK", "TWO_FACTOR_PENDING", "TWO_FACTOR_METHOD_SELECTION_TIMEOUT", "CONTACT_FORM_PENDING", "COLLECTION_INPUT_PENDING", "COLLECTION_INPUT_TIMEOUT", "COLLECTING", "COMPLETED", "COMPLETED_PARTIAL", "COMPLETED_EMPTY", "FAILED", "FAILED_PDF_PARSE", "FAILED_PDF_USER_INPUT", "AUTHENTICATION_TIMEOUT", "WAITING_FOR_USER_ACTION", "INCORRECT_CREDENTIALS", "AUTHENTICATION_CANCELLED", "AUTHENTICATION_CONFLICT", "ACCOUNT_TEMPORARILY_LOCKED", "AUTHENTICATION_MISMATCH", "KYC_FORM", "CONTACT_FORM", "CUSTOMER_ENROLLMENT_REQUIRED", "THIRD_PARTY_ERROR" ], "example": "RUNNING", "type": "string" } }, "required": [ "company", "id", "status" ], "title": "CollectionStatus" }, "CompanyAvailability": { "discriminator": { "propertyName": "api" }, "properties": { "additionalLoginInputs": { "description": "Additional input for login step.", "items": { "$ref": "#/components/schemas/AdditionalLoginInput" }, "type": "array", "uniqueItems": true }, "availableCoverageScopes": { "description": "Set of available coverage types and subtypes for this company", "example": [ { "insuranceSubType": "CAR_INSURANCE", "insuranceType": "VEHICLE_INSURANCE" } ], "items": { "$ref": "#/components/schemas/InsuranceTypeAndSubtype" }, "type": "array", "uniqueItems": true }, "company": { "description": "Name of the company.", "example": "uk-aviva", "minLength": 1, "type": "string" }, "companyAndLineOfBusinesses": { "description": "Available company and line of business for insurance pdf upload.", "example": "UK_AXA_HOME", "items": { "enum": [ "EE_SWEDBANK", "FR_ABEILLE_HOME", "FR_ABEILLE_VEHICLE", "FR_ALLIANZ_HOME", "FR_ALLIANZ_VEHICLE", "FR_ANIMAUXSANTE_HOME", "FR_ASSUR_OPOIL_ANIMAL", "FR_AXA_HOME", "FR_AXA_VEHICLE", "FR_AXA_GENERAL", "FR_BANQUE_POPULAIRE_HOME", "FR_BANQUE_POPULAIRE_VEHICLE", "FR_BULLE_BLEUE_HOME", "FR_CAISSE_DEPARGNE_HOME", "FR_CAISSE_DEPARGNE_VEHICLE", "FR_CARDIF_HOME", "FR_CREDIT_AGRICOLE_HOME", "FR_CREDIT_AGRICOLE_VEHICLE", "FR_CREDIT_MUTUEL_HOME", "FR_CREDIT_MUTUEL_VEHICLE", "FR_DEMO_HOME", "FR_DEMO_VEHICLE", "FR_DIRECT_ASSURANCE_HOME", "FR_DIRECT_ASSURANCE_VEHICLE", "FR_ECA_HOME", "FR_ECA_VEHICLE", "FR_ECA_ANIMAL", "FR_GENERALI_HOME", "FR_GENERALI_VEHICLE", "FR_GMF_HOME", "FR_GMF_VEHICLE", "FR_GROUPAMA_HOME", "FR_GROUPAMA_VEHICLE", "FR_LUKO_HOME", "FR_LOLIVIER_HOME", "FR_LOLIVIER_VEHICLE", "FR_LA_BANQUE_POSTALE_HOME", "FR_LA_BANQUE_POSTALE_VEHICLE", "FR_MAAF_HOME", "FR_MAAF_VEHICLE", "FR_MACIF_HOME", "FR_MACIF_VEHICLE", "FR_MAIF_HOME", "FR_MAIF_VEHICLE", "FR_MATMUT_HOME", "FR_MATMUT_VEHICLE", "FR_SOCIETE_GENERAL_INSURANCE_HOME", "FR_SOCIETE_GENERAL_INSURANCE_VEHICLE", "FR_MMA_HOME", "FR_MMA_VEHICLE", "FR_SANTEVET_HOME", "LT_BALCIA_HOME", "LT_COMPENSA_HOME", "LT_ERGO_HOME", "LT_GJENSIDIGE_HOME", "LT_IF_HOME", "LT_LIETUVOS_DRAUDIMAS_HOME", "LT_SWEDBANK_HOME", "LV_BALCIA_HOME", "LV_BALTA_HOME", "LV_COMPENSA_HOME", "LV_ERGO_HOME", "LV_GJENSIDIGE_HOME", "LV_IF_HOME", "LV_SWEDBANK_HOME", "SE_IF_VEHICLE", "SE_FOLKSAM_VEHICLE", "SE_LANSFORSAKRINGAR_HOME", "SE_PAYDRIVE_VEHICLE", "SE_SVEDEA_VEHICLE", "SE_VOLVIA_VEHICLE", "SE_BLIWA_ACCIDENT", "UK_AXA_HOME", "UK_AXA_VEHICLE", "UK_HASTINGS_DIRECT_HOME", "UK_HASTINGS_DIRECT_VEHICLE", "UK_POLICYEXPERT_HOME", "UK_POLICYEXPERT_VEHICLE", "UK_POST_OFFICE_HOME", "UK_THE_AA_HOME", "UK_THE_AA_VEHICLE", "UK_URBAN_JUNGLE_HOME", "FR_AXA_PERSON", "FR_ACHEEL_HOME", "FR_ACHEEL_VEHICLE", "FR_MALAKOFF_HUMANIS_HEALTH", "FR_HARMONIE_MUTUELLE_HEALTH", "FR_ALAN_HEALTH", "FR_AESIO_MUTUELLE_HEALTH", "FR_AG2R_LA_MONDIALE_HEALTH" ], "type": "string" }, "type": "array", "uniqueItems": true }, "companyDisplayName": { "description": "Company display name, for displaying to users.", "example": "Aviva", "minLength": 1, "type": "string" }, "companyGroup": { "description": "The name of the group that a company or integration belongs to", "example": "SEB", "type": "string" }, "companyLinks": { "additionalProperties": { "type": "string" }, "description": "Company-specific links such as contact forms or other external resources", "example": "{'contactFormLink': 'https://example.com/contact'", "type": "object" }, "consentRequirements": { "description": "The set of consents required for initiating collections from this company.", "items": { "$ref": "#/components/schemas/ConsentRequirement" }, "type": "array", "uniqueItems": true }, "functional": { "description": "Whether or not it is possible to collect data from the company currently.", "example": false, "type": "boolean" }, "loginConfig": { "$ref": "#/components/schemas/CompanyLoginConfig", "description": "Configuration options for different login methods." }, "loginMethods": { "description": "Available login methods for the company.", "example": "USERNAME_AND_PASSWORD", "items": { "enum": [ "DANISH_NEMID", "DANISH_MITID", "DANISH_MITID_SAME_DEVICE", "ESTONIAN_MOBILE_ID", "ESTONIAN_SMART_ID", "ESTONIAN_MOBILE_ID_USERNAME", "ESTONIAN_SMART_ID_USERNAME", "LATVIAN_MOBILE_EPARAKSTS", "LATVIAN_SMART_ID", "LATVIAN_MOBILE_EPARAKSTS_USERNAME", "LATVIAN_SMART_ID_USERNAME", "LITHUANIAN_SMART_ID", "LITHUANIAN_MOBILE_ID", "LITHUANIAN_SMART_ID_USERNAME", "LITHUANIAN_MOBILE_ID_USERNAME", "SMART_ID_SAME_DEVICE", "SMART_ID_OTHER_DEVICE", "SMART_ID_USERNAME_SAME_DEVICE", "SMART_ID_USERNAME_OTHER_DEVICE", "NORWEGIAN_BANKID_ON_MOBILE", "NORWEGIAN_BANKID_ON_MOBILE_FULL_PERSONAL_NUMBER", "SWEDISH_MOBILE_BANKID_OTHER_DEVICE", "SWEDISH_MOBILE_BANKID_OTHER_DEVICE_MOCK", "SWEDISH_MOBILE_BANKID_SAME_DEVICE", "SWEDISH_MOBILE_BANKID_SAME_DEVICE_CLIENT_SIDE_AUTHENTICATION", "SWEDISH_MOBILE_BANKID_SAME_DEVICE_CLIENT_SIDE_AUTHENTICATION_MOCK", "SWEDISH_MOBILE_BANKID_OTHER_DEVICE_TEST", "SWEDISH_MOBILE_BANKID_SAME_DEVICE_TEST", "SWEDISH_SECURITY_TOKEN", "UK_DOB_USERNAME_PASSWORD", "UK_LASTNAME_MEMBERSHIP_NUMBER", "UK_USERNAME_POSTCODE", "USERNAME_AND_PASSWORD", "EMAIL", "PDF_UPLOAD", "GERMAN_EID", "AUTHENTICATION_APP_URL", "MANUAL_SELECT", "API_KEY" ], "type": "string" }, "type": "array", "uniqueItems": true }, "nonFunctionalLoginMethods": { "description": "Disabled login methods for the company.", "example": "USERNAME_AND_PASSWORD", "items": { "enum": [ "DANISH_NEMID", "DANISH_MITID", "DANISH_MITID_SAME_DEVICE", "ESTONIAN_MOBILE_ID", "ESTONIAN_SMART_ID", "ESTONIAN_MOBILE_ID_USERNAME", "ESTONIAN_SMART_ID_USERNAME", "LATVIAN_MOBILE_EPARAKSTS", "LATVIAN_SMART_ID", "LATVIAN_MOBILE_EPARAKSTS_USERNAME", "LATVIAN_SMART_ID_USERNAME", "LITHUANIAN_SMART_ID", "LITHUANIAN_MOBILE_ID", "LITHUANIAN_SMART_ID_USERNAME", "LITHUANIAN_MOBILE_ID_USERNAME", "SMART_ID_SAME_DEVICE", "SMART_ID_OTHER_DEVICE", "SMART_ID_USERNAME_SAME_DEVICE", "SMART_ID_USERNAME_OTHER_DEVICE", "NORWEGIAN_BANKID_ON_MOBILE", "NORWEGIAN_BANKID_ON_MOBILE_FULL_PERSONAL_NUMBER", "SWEDISH_MOBILE_BANKID_OTHER_DEVICE", "SWEDISH_MOBILE_BANKID_OTHER_DEVICE_MOCK", "SWEDISH_MOBILE_BANKID_SAME_DEVICE", "SWEDISH_MOBILE_BANKID_SAME_DEVICE_CLIENT_SIDE_AUTHENTICATION", "SWEDISH_MOBILE_BANKID_SAME_DEVICE_CLIENT_SIDE_AUTHENTICATION_MOCK", "SWEDISH_MOBILE_BANKID_OTHER_DEVICE_TEST", "SWEDISH_MOBILE_BANKID_SAME_DEVICE_TEST", "SWEDISH_SECURITY_TOKEN", "UK_DOB_USERNAME_PASSWORD", "UK_LASTNAME_MEMBERSHIP_NUMBER", "UK_USERNAME_POSTCODE", "USERNAME_AND_PASSWORD", "EMAIL", "PDF_UPLOAD", "GERMAN_EID", "AUTHENTICATION_APP_URL", "MANUAL_SELECT", "API_KEY" ], "type": "string" }, "type": "array", "uniqueItems": true }, "notifications": { "additionalProperties": { "type": "string" }, "description": "Company-specific notifications configuration", "example": "{'LOADING_SCREEN': 'SIGNIN_WARNING'}", "type": "object" }, "reason": { "description": "Reason for data collection being non-functional at present.", "enum": [ "THIRD_PARTY_ERROR", "THIRD_PARTY_UPDATE", "INSURELY_ERROR", "INSURELY_UPDATE", "RECONSTRUCTION" ], "example": "THIRD_PARTY_ERROR", "type": "string" }, "resetCredentials": { "additionalProperties": { "type": "string" }, "description": "Reset links to reset credentials for the company.", "example": "{'resetUsernameUrl': 'https://insurely.com/forgot-username', 'resetPasswordUrl': 'https://insurely.com/forgot-password'}", "type": "object" }, "status": { "description": "Status indicating the quality of the data collection for this company. A company has status BETA until we can\nguarantee the data quality and stability of it, after which its status is set to OK. Once taken out of BETA\nit cannot be set to BETA again.\n", "enum": [ "OK", "BETA", "NOT_IMPLEMENTED" ], "example": "OK", "type": "string" }, "supportsPreheating": { "description": "Whether the company supports starting a collection without user input.\nRequires input to be passed in at a later stage through the supplemental-info endpoint.\n", "type": "boolean" } }, "required": [ "additionalLoginInputs", "availableCoverageScopes", "company", "companyAndLineOfBusinesses", "companyDisplayName", "consentRequirements", "functional", "loginMethods", "nonFunctionalLoginMethods", "status", "supportsPreheating" ] }, "CompanyLoginConfig": { "properties": { "passwordFieldPlaceholder": { "enum": [ "PASSWORD", "CONFIDENTIAL_CODE", "PERSONAL_CODE", "SECRET_CODE", "MEMBERSHIP_NUMBER", "PIN_OR_PASSWORD" ], "type": "string" }, "passwordLabel": { "enum": [ "PASSWORD", "CONFIDENTIAL_CODE", "PERSONAL_CODE", "SECRET_CODE", "MEMBERSHIP_NUMBER", "PIN_OR_PASSWORD" ], "type": "string" }, "usernameFieldPlaceholder": { "enum": [ "EMAIL", "IDENTIFICATION_NUMBER_11", "IDENTIFICATION_CHARACTERS_8", "EMAIL_MOBILE_MUTUAL_MEMBER", "EMAIL_MOBILE_CLIENT", "EMAIL_MUTUAL_OR_REGULAR_MEMBER", "EMAIL_MOBILE_CONTRACT", "EMAIL_OR_MEMBER", "CLIENT_NUMBER", "LAST_NAME" ], "type": "string" }, "usernameLabel": { "enum": [ "EMAIL", "USERNAME", "CLIENT_NUMBER", "LAST_NAME" ], "type": "string" } } }, "ConsentRequestInput": { "description": "Represents a specific consent provided by the end user.", "properties": { "type": { "description": "The type of consent.", "enum": [ "TRADE_UNION_MEMBERSHIP" ], "example": "TRADE_UNION_MEMBERSHIP", "type": "string" } }, "required": [ "type" ] }, "ConsentRequirement": { "description": "The requirement for collect a specific consent.", "properties": { "method": { "description": "What method to use to collect the consent.", "enum": [ "NONE", "NOTICE", "ACTIVE" ], "example": "ACTIVE", "type": "string" }, "type": { "description": "The consent type.", "enum": [ "TRADE_UNION_MEMBERSHIP" ], "example": "TRADE_UNION_MEMBERSHIP", "type": "string" } }, "required": [ "method", "type" ] }, "ContactFormInput": { "description": "Input values for requested contact form input types.", "discriminator": { "propertyName": "api" }, "properties": { "input": { "description": "The value returned for the corresponding input type.", "example": "test@gmail.com", "type": "string" }, "inputType": { "description": "Types used in contact form input.", "enum": [ "EMAIL", "MOBILE_PHONE_NUMBER" ], "example": "EMAIL", "type": "string" } }, "required": [ "input", "inputType" ] }, "Cookie": { "description": "A description of an HTTP cookie.", "properties": { "domain": { "description": "Domain of the cookie.", "example": ".insurely.com", "type": "string" }, "httpOnly": { "description": "Whether the cookie is set to httpOnly or not.", "example": false, "type": "boolean" }, "name": { "description": "Name of the cookie.", "example": "COOKIE_CONSENT", "type": "string" }, "path": { "description": "Path of the cookie.", "example": "/", "type": "string" }, "secure": { "description": "Whether the cookie is secure or not.", "example": true, "type": "boolean" }, "value": { "description": "Value of the cookie.", "example": "1", "type": "string" } } }, "CustodyAccount": { "description": "Custody account. Example: Aktie-FondKonto", "discriminator": { "mapping": { "parent": "#/components/schemas/FinancialProduct" }, "propertyName": "financial product type" }, "example": { "accountInformation": { "cashAccountNumber": "1234567", "cashValue": { "amount": 4514.27, "currency": "SEK" }, "hasExclusiveOwnership": true, "interestRate": 0.0025 }, "company": "se-company", "companyDisplayName": "Company", "financialInformation": { "currentValue": { "amount": 26982.66, "currency": "SEK" }, "performanceSinceStart": 0.1605 }, "holder": { "name": "Firstname Lastname" }, "holdings": [ { "acquisitionValue": { "amount": 18883.51, "currency": "SEK" }, "feeVariable": 0, "isin": "SE0001718388", "name": "Avanza Zero", "quantity": 54.076858, "type": "FUND", "value": { "amount": 22468.39, "currency": "SEK" } } ], "id": "df2e7a28-d871-45c1-a01e-515b7aeaf7da", "monthlySavingsAmount": { "amount": 4000, "currency": "SEK" }, "personalInformation": { "PERSONAL_NUMBER": "19010106-1234" }, "productName": "Min Depå", "productNumber": "987654321", "transactions": [ { "amount": { "amount": 10.32, "currency": "EUR" }, "description": "Insättning", "settlementDate": "2024-01-01", "type": "DEPOSIT" } ], "type": "CUSTODY_ACCOUNT" }, "properties": { "accountInformation": { "$ref": "#/components/schemas/AccountInformation", "description": "Account details such as available balance and interest rate." }, "company": { "description": " Company where the financial product has been collected from. Examples:\n `se-folksam`, `se-lansforsakringar`, `se-avanza`, `se-movestic`, `se-spp`, `se-nordea`,\n `se-amf`, `se-seb`, `se-alecta`, `se-nordnet`, `se-handelsbanken`, `se-futur`,\n `se-swedbank`, `se-skandia`, `se-ica-bank`, `se-danske-bank`.\n", "example": "se-company", "type": "string" }, "companyDisplayName": { "description": "Display name of the company for user-friendly presentation.", "example": "Company", "type": "string" }, "financialInformation": { "$ref": "#/components/schemas/ProductFinancialInformation", "description": "Financial details of the product, like value, performance etc." }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the owner of the financial product." }, "holdings": { "description": "List of holdings within the financial product.", "items": { "$ref": "#/components/schemas/Wealth.Holding" }, "type": "array" }, "id": { "description": "Insurely-generated unique identifier for this collection of the financial product. Randomly generated and not stable across collections — a new id is issued each time the product is collected, even for the same underlying account. Use this only as a handle within a single collection (e.g., to correlate holdings and transactions). Do not use it to recognize the same product over time; use the stable institution-assigned identifier on this product (e.g., `productNumber`, `accountNumber`, or `loanId`) for that.", "example": "6a7c135e-3a56-44ae-bc53-1d0d5321f552", "type": "string" }, "monthlySavingsAmount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Monthly savings amount associated with the financial product." }, "personalInformation": { "additionalProperties": { "type": "string" }, "description": "Details of the person collecting the data, e.g., personal number.", "type": "object" }, "productName": { "description": "Name of the financial product.", "example": "Avtalspension FTP", "type": "string" }, "productNumber": { "description": "The product number assigned by the source financial institution (e.g., ISK account number, policy number, mortgage number). This is the most stable identifier for the product over time and across collections, and is suitable for matching the same product between repeated collections. Note that stability is best-effort and depends on what the institution exposes; it may occasionally change if the institution restructures or reissues the product.", "example": "SU91231230-2", "type": "string" }, "transactions": { "description": "Transaction history for the last 12 months.", "items": { "$ref": "#/components/schemas/Transaction" }, "type": "array" }, "type": { "description": "Type of the financial product.", "enum": [ "KF", "ISK", "CUSTODY_ACCOUNT", "UNKNOWN_INVESTMENT_TYPE", "IPS_PENSION", "PRIVATE_PENSION", "OCCUPATIONAL_PENSION", "COLLECTIVE_OCCUPATIONAL_PENSION", "UNKNOWN_PENSION_TYPE", "MORTGAGE_LOAN", "UNSECURED_LOAN" ], "example": "ISK", "type": "string" } }, "required": [ "company", "companyDisplayName", "id", "type" ], "title": "Custody Account", "x-tag": "Financial Product Type" }, "DatePeriod": { "allOf": [ { "$ref": "#/components/schemas/PayoutPeriod" }, { "properties": { "endDate": { "description": "The payout end date. Will not be set if the payout is lifelong.", "example": "2060-01-31", "type": "string" }, "startDate": { "description": "The payout start date.", "example": "2050-01-01", "type": "string" }, "type": { "enum": [ "DATE_RANGE" ], "example": "DATE_RANGE", "type": "string" } }, "type": "object" } ], "description": "A payout period described by an date range.", "discriminator": { "mapping": { "parent": "#/components/schemas/PayoutPeriod" }, "propertyName": "type" }, "title": "DatePeriod" }, "DepositTransaction": { "description": "A deposit to the account", "discriminator": { "mapping": { "parent": "#/components/schemas/Transaction" }, "propertyName": "transaction type" }, "properties": { "amount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The transaction amount." }, "description": { "description": "The description of the transaction.", "example": "Insättning", "type": "string" }, "settlementDate": { "description": "The date when the transaction was settled.", "example": "2024-01-01", "type": "string" }, "type": { "enum": [ "BUY", "SELL", "DEPOSIT", "WITHDRAWAL", "FEE", "INTEREST", "DIVIDEND", "REDEMPTION", "OTHER" ], "example": "DEPOSIT", "title": "TransactionType", "type": "string" } }, "title": "DepositTransaction" }, "DividendTransaction": { "description": "A dividend from a holding in the account", "discriminator": { "mapping": { "parent": "#/components/schemas/Transaction" }, "propertyName": "transaction type" }, "properties": { "amount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The transaction amount." }, "description": { "description": "The description of the transaction.", "example": "Utdelning", "type": "string" }, "instrumentInformation": { "$ref": "#/components/schemas/TransactionInstrument", "description": "Instrument that related to the dividend transaction." }, "settlementDate": { "description": "The date when the transaction was settled.", "example": "2024-01-01", "type": "string" }, "type": { "enum": [ "BUY", "SELL", "DEPOSIT", "WITHDRAWAL", "FEE", "INTEREST", "DIVIDEND", "REDEMPTION", "OTHER" ], "example": "DIVIDEND", "title": "TransactionType", "type": "string" } }, "title": "DividendTransaction" }, "ErrorResponse": { "description": "Standard error response returned by the API when a request fails.", "properties": { "errors": { "description": "Field-level validation errors, empty when not applicable.", "items": { "$ref": "#/components/schemas/InsurelyInputError" }, "type": "array" }, "localizedMessage": { "description": "Localized version of the error message, if available.", "example": "Invalid request", "type": "string" }, "message": { "description": "Human-readable error message.", "example": "Invalid request", "type": "string" }, "status": { "description": "HTTP status name.", "example": "BAD_REQUEST", "type": "string" }, "statusCode": { "description": "HTTP status code.", "example": 400, "format": "int32", "type": "integer" } } }, "FeeTransaction": { "description": "Fee withdrawn from the account", "discriminator": { "mapping": { "parent": "#/components/schemas/Transaction" }, "propertyName": "transaction type" }, "properties": { "amount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The transaction amount." }, "description": { "description": "The description of the transaction.", "example": "Avgift", "type": "string" }, "settlementDate": { "description": "The date when the transaction was settled.", "example": "2024-01-01", "type": "string" }, "type": { "enum": [ "BUY", "SELL", "DEPOSIT", "WITHDRAWAL", "FEE", "INTEREST", "DIVIDEND", "REDEMPTION", "OTHER" ], "example": "FEE", "title": "TransactionType", "type": "string" } }, "title": "FeeTransaction" }, "Fees": { "properties": { "feeFixed": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Annual fixed fee for managing the financial product." }, "feeVariable": { "description": "Annual variable fee based on the product's value. Percentage [0-1]", "example": 0.0015, "format": "double", "type": "number" }, "feesCollected": { "description": "Indicates if the fees were collected on an individual basis or mapped generally.", "example": true, "type": "boolean" }, "feesPreviousYear": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Total fees paid for the financial product over the past year." } } }, "FinancialPeriod": { "properties": { "endDate": { "description": "End date of the period. Format: YYYY-MM-DD.", "example": "2020-12-31", "type": "string" }, "startDate": { "description": "Start date of the period. Format: YYYY-MM-DD.", "example": "2020-01-01", "type": "string" } } }, "FinancialProduct": { "description": "Details of financial products such as pensions and investments accounts.", "discriminator": { "mapping": { "child-1": "#/components/schemas/CustodyAccount", "child-10": "#/components/schemas/LoanMortgage", "child-11": "#/components/schemas/UnsecuredLoan", "child-2": "#/components/schemas/ISK", "child-3": "#/components/schemas/InvestmentUnknown", "child-4": "#/components/schemas/KF", "child-5": "#/components/schemas/PensionCollectiveOccupational", "child-6": "#/components/schemas/PensionIPS", "child-7": "#/components/schemas/PensionOccupational", "child-8": "#/components/schemas/PensionPrivate", "child-9": "#/components/schemas/PensionUnknown" }, "propertyName": "financial product type" }, "oneOf": [ { "$ref": "#/components/schemas/CustodyAccount" }, { "$ref": "#/components/schemas/ISK" }, { "$ref": "#/components/schemas/KF" }, { "$ref": "#/components/schemas/InvestmentUnknown" }, { "$ref": "#/components/schemas/PensionPrivate" }, { "$ref": "#/components/schemas/PensionIPS" }, { "$ref": "#/components/schemas/PensionOccupational" }, { "$ref": "#/components/schemas/PensionCollectiveOccupational" }, { "$ref": "#/components/schemas/PensionUnknown" }, { "$ref": "#/components/schemas/LoanMortgage" }, { "$ref": "#/components/schemas/UnsecuredLoan" } ], "properties": { "company": { "description": " Company where the financial product has been collected from. Examples:\n `se-folksam`, `se-lansforsakringar`, `se-avanza`, `se-movestic`, `se-spp`, `se-nordea`,\n `se-amf`, `se-seb`, `se-alecta`, `se-nordnet`, `se-handelsbanken`, `se-futur`,\n `se-swedbank`, `se-skandia`, `se-ica-bank`, `se-danske-bank`.\n", "example": "se-company", "type": "string" }, "companyDisplayName": { "description": "Display name of the company for user-friendly presentation.", "example": "Company", "type": "string" }, "type": { "description": "Type of the financial product.", "enum": [ "KF", "ISK", "CUSTODY_ACCOUNT", "UNKNOWN_INVESTMENT_TYPE", "IPS_PENSION", "PRIVATE_PENSION", "OCCUPATIONAL_PENSION", "COLLECTIVE_OCCUPATIONAL_PENSION", "UNKNOWN_PENSION_TYPE", "MORTGAGE_LOAN", "UNSECURED_LOAN" ], "example": "ISK", "type": "string" } }, "required": [ "type" ], "title": "Financial Product" }, "Holder": { "properties": { "name": { "description": "Name of the person or organization owning the financial product.", "example": "Bolagsnamn AB", "type": "string" }, "organization": { "$ref": "#/components/schemas/Organization", "description": "Information about the organization owning the pension/investment. This field is absent if the holder is a person. This field can also be absent if no organization has been found, or if there is more than one matching organization based on the holder name. See organization suggestions." }, "organizationSuggestions": { "description": "List of holder organization suggestions. If the organization could not be identified uniquely, base on name or number, Then a list of suggestions will be returned. If there is only one organization identified, this will be present under organization and this field will be absent.", "items": { "$ref": "#/components/schemas/Organization" }, "type": "array" } } }, "ISK": { "description": "ISK. Investeringsparkonto", "discriminator": { "mapping": { "parent": "#/components/schemas/FinancialProduct" }, "propertyName": "financial product type" }, "example": { "accountInformation": { "cashAccountNumber": "1234567", "cashValue": { "amount": 4514.27, "currency": "SEK" }, "hasExclusiveOwnership": true, "interestRate": 0.0025 }, "company": "se-company", "companyDisplayName": "Company", "financialInformation": { "currentValue": { "amount": 26982.66, "currency": "SEK" }, "performanceSinceStart": 0.1605 }, "holder": { "name": "Firstname Lastname" }, "holdings": [ { "acquisitionValue": { "amount": 18883.51, "currency": "SEK" }, "feeVariable": 0, "isin": "SE0001718388", "name": "Avanza Zero", "quantity": 54.076858, "type": "FUND", "value": { "amount": 22468.39, "currency": "SEK" } } ], "id": "df2e7a28-d871-45c1-a01e-515b7aeaf7da", "monthlySavingsAmount": { "amount": 4000, "currency": "SEK" }, "personalInformation": { "PERSONAL_NUMBER": "19010106-1234" }, "productName": "Min ISK", "productNumber": "987654321", "transactions": [ { "amount": { "amount": 10.32, "currency": "EUR" }, "description": "Insättning", "settlementDate": "2024-01-01", "type": "DEPOSIT" } ], "type": "ISK" }, "properties": { "accountInformation": { "$ref": "#/components/schemas/AccountInformation", "description": "Account details such as available balance and interest rate." }, "company": { "description": " Company where the financial product has been collected from. Examples:\n `se-folksam`, `se-lansforsakringar`, `se-avanza`, `se-movestic`, `se-spp`, `se-nordea`,\n `se-amf`, `se-seb`, `se-alecta`, `se-nordnet`, `se-handelsbanken`, `se-futur`,\n `se-swedbank`, `se-skandia`, `se-ica-bank`, `se-danske-bank`.\n", "example": "se-company", "type": "string" }, "companyDisplayName": { "description": "Display name of the company for user-friendly presentation.", "example": "Company", "type": "string" }, "financialInformation": { "$ref": "#/components/schemas/ProductFinancialInformation", "description": "Financial details of the product, like value, performance etc." }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the owner of the financial product." }, "holdings": { "description": "List of holdings within the financial product.", "items": { "$ref": "#/components/schemas/Wealth.Holding" }, "type": "array" }, "id": { "description": "Insurely-generated unique identifier for this collection of the financial product. Randomly generated and not stable across collections — a new id is issued each time the product is collected, even for the same underlying account. Use this only as a handle within a single collection (e.g., to correlate holdings and transactions). Do not use it to recognize the same product over time; use the stable institution-assigned identifier on this product (e.g., `productNumber`, `accountNumber`, or `loanId`) for that.", "example": "6a7c135e-3a56-44ae-bc53-1d0d5321f552", "type": "string" }, "monthlySavingsAmount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Monthly savings amount associated with the financial product." }, "personalInformation": { "additionalProperties": { "type": "string" }, "description": "Details of the person collecting the data, e.g., personal number.", "type": "object" }, "productName": { "description": "Name of the financial product.", "example": "Avtalspension FTP", "type": "string" }, "productNumber": { "description": "The product number assigned by the source financial institution (e.g., ISK account number, policy number, mortgage number). This is the most stable identifier for the product over time and across collections, and is suitable for matching the same product between repeated collections. Note that stability is best-effort and depends on what the institution exposes; it may occasionally change if the institution restructures or reissues the product.", "example": "SU91231230-2", "type": "string" }, "transactions": { "description": "Transaction history for the last 12 months.", "items": { "$ref": "#/components/schemas/Transaction" }, "type": "array" }, "type": { "description": "Type of the financial product.", "enum": [ "KF", "ISK", "CUSTODY_ACCOUNT", "UNKNOWN_INVESTMENT_TYPE", "IPS_PENSION", "PRIVATE_PENSION", "OCCUPATIONAL_PENSION", "COLLECTIVE_OCCUPATIONAL_PENSION", "UNKNOWN_PENSION_TYPE", "MORTGAGE_LOAN", "UNSECURED_LOAN" ], "example": "ISK", "type": "string" } }, "required": [ "company", "companyDisplayName", "id", "type" ], "title": "ISK", "x-tag": "Financial Product Type" }, "InstructionsRequestObject": { "description": "The instructions request object included in the `CollectionStatusInformationMap` for the `SWEDISH_MOBILE_BANKID_SAME_DEVICE_CLIENT_SIDE_AUTHENTICATION` login method.", "properties": { "request": { "$ref": "#/components/schemas/Request" } }, "required": [ "request" ] }, "Insurance": { "properties": { "insuredPersonName": { "description": "Name of the insured person.", "example": "Namn Namnsson", "type": "string" }, "survivorsProtection": { "description": "Indicates if the pension has survivors protection.", "example": true, "type": "boolean" } } }, "InsuranceTypeAndSubtype": { "properties": { "insuranceSubType": { "description": "The specific insurance subtype", "enum": [ "carInsurance", "boatInsurance", "trailerInsurance", "motorcycleInsurance", "mopedInsurance", "caravanInsurance", "motorhomeInsurance", "otherVehicleInsurance", "childInsurance", "pregnancyInsurance", "lifeInsurance", "healthInsurance", "accidentInsurance", "travelInsurance", "condoInsurance", "contentsInsurance", "villaInsurance", "cottageInsurance", "farmInsurance", "catInsurance", "dogInsurance", "horseInsurance", "otherAnimalInsurance", "genericInsurance", "groupInsurance", "incomeInsurance", "sicknessInsurance", "loanInsurance", "landlordInsurance" ], "example": "CAR_INSURANCE", "type": "string" }, "insuranceType": { "description": "The main insurance type category", "enum": [ "vehicleInsurance", "houseContentInsurance", "personInsurance", "animalInsurance", "groupInsurance", "generalInsurance", "incomeInsurance" ], "example": "VEHICLE_INSURANCE", "type": "string" } } }, "InsurelyInputError": { "description": "Field-level validation errors, empty when not applicable." }, "Interest": { "description": "Interest data points", "example": { "baseRate": 0.0512, "discount": 0.012, "discountEndDate": "2025-03-31", "effectiveRate": 0.0398, "periodStartDate": "2024-07-01", "rate": 0.0392, "rateAdjustmentDate": "2024-10-01" }, "properties": { "baseRate": { "format": "double", "type": "number" }, "discount": { "format": "double", "type": "number" }, "discountEndDate": { "type": "string" }, "effectiveRate": { "format": "double", "type": "number" }, "periodStartDate": { "type": "string" }, "rate": { "format": "double", "type": "number" }, "rateAdjustmentDate": { "type": "string" } } }, "InterestTransaction": { "description": "A deposit of interest to the account", "discriminator": { "mapping": { "parent": "#/components/schemas/Transaction" }, "propertyName": "transaction type" }, "properties": { "amount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The transaction amount." }, "description": { "description": "The description of the transaction.", "example": "Ränta", "type": "string" }, "settlementDate": { "description": "The date when the transaction was settled.", "example": "2024-01-01", "type": "string" }, "type": { "enum": [ "BUY", "SELL", "DEPOSIT", "WITHDRAWAL", "FEE", "INTEREST", "DIVIDEND", "REDEMPTION", "OTHER" ], "example": "INTEREST", "title": "TransactionType", "type": "string" } }, "title": "InterestTransaction" }, "InvestmentUnknown": { "description": "Unknown Investment Account type. Could not be determined from the origin company.", "discriminator": { "mapping": { "parent": "#/components/schemas/FinancialProduct" }, "propertyName": "financial product type" }, "example": { "accountInformation": { "cashAccountNumber": "1234567", "cashValue": { "amount": 4514.27, "currency": "SEK" }, "interestRate": 0.0025 }, "company": "se-company", "companyDisplayName": "Company", "financialInformation": { "currentValue": { "amount": 26982.66, "currency": "SEK" }, "performanceSinceStart": 0.1605 }, "holder": { "name": "Firstname Lastname" }, "holdings": [ { "acquisitionValue": { "amount": 18883.51, "currency": "SEK" }, "feeVariable": 0, "isin": "SE0001718388", "name": "Avanza Zero", "quantity": 54.076858, "type": "FUND", "value": { "amount": 22468.39, "currency": "SEK" } } ], "id": "df2e7a28-d871-45c1-a01e-515b7aeaf7da", "monthlySavingsAmount": { "amount": 4000, "currency": "SEK" }, "personalInformation": { "PERSONAL_NUMBER": "19010106-1234" }, "productName": "My account name", "productNumber": "987654321", "transactions": [ { "amount": { "amount": 10.32, "currency": "EUR" }, "description": "Insättning", "settlementDate": "2024-01-01", "type": "DEPOSIT" } ], "type": "UNKNOWN_INVESTMENT_TYPE" }, "properties": { "accountInformation": { "$ref": "#/components/schemas/AccountInformation", "description": "Account details such as available balance and interest rate." }, "company": { "description": " Company where the financial product has been collected from. Examples:\n `se-folksam`, `se-lansforsakringar`, `se-avanza`, `se-movestic`, `se-spp`, `se-nordea`,\n `se-amf`, `se-seb`, `se-alecta`, `se-nordnet`, `se-handelsbanken`, `se-futur`,\n `se-swedbank`, `se-skandia`, `se-ica-bank`, `se-danske-bank`.\n", "example": "se-company", "type": "string" }, "companyDisplayName": { "description": "Display name of the company for user-friendly presentation.", "example": "Company", "type": "string" }, "financialInformation": { "$ref": "#/components/schemas/ProductFinancialInformation", "description": "Financial details of the product, like value, performance etc." }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the owner of the financial product." }, "holdings": { "description": "List of holdings within the financial product.", "items": { "$ref": "#/components/schemas/Wealth.Holding" }, "type": "array" }, "id": { "description": "Insurely-generated unique identifier for this collection of the financial product. Randomly generated and not stable across collections — a new id is issued each time the product is collected, even for the same underlying account. Use this only as a handle within a single collection (e.g., to correlate holdings and transactions). Do not use it to recognize the same product over time; use the stable institution-assigned identifier on this product (e.g., `productNumber`, `accountNumber`, or `loanId`) for that.", "example": "6a7c135e-3a56-44ae-bc53-1d0d5321f552", "type": "string" }, "monthlySavingsAmount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Monthly savings amount associated with the financial product." }, "personalInformation": { "additionalProperties": { "type": "string" }, "description": "Details of the person collecting the data, e.g., personal number.", "type": "object" }, "productName": { "description": "Name of the financial product.", "example": "Avtalspension FTP", "type": "string" }, "productNumber": { "description": "The product number assigned by the source financial institution (e.g., ISK account number, policy number, mortgage number). This is the most stable identifier for the product over time and across collections, and is suitable for matching the same product between repeated collections. Note that stability is best-effort and depends on what the institution exposes; it may occasionally change if the institution restructures or reissues the product.", "example": "SU91231230-2", "type": "string" }, "transactions": { "description": "Transaction history for the last 12 months.", "items": { "$ref": "#/components/schemas/Transaction" }, "type": "array" }, "type": { "description": "Type of the financial product.", "enum": [ "KF", "ISK", "CUSTODY_ACCOUNT", "UNKNOWN_INVESTMENT_TYPE", "IPS_PENSION", "PRIVATE_PENSION", "OCCUPATIONAL_PENSION", "COLLECTIVE_OCCUPATIONAL_PENSION", "UNKNOWN_PENSION_TYPE", "MORTGAGE_LOAN", "UNSECURED_LOAN" ], "example": "ISK", "type": "string" } }, "required": [ "company", "companyDisplayName", "id", "type" ], "title": "Unknown Investment", "x-tag": "Financial Product Type" }, "Item": { "description": "The item object included in the `CollectionInput` for providing supplemental information", "properties": { "type": { "description": "The type of information provided", "enum": [ "EMAIL", "ESTONIAN_PERSONAL_NUMBER", "ESTONIAN_PHONE_NUMBER", "LASTNAME", "LATVIAN_PERSONAL_NUMBER", "LITHUANIAN_PERSONAL_NUMBER", "LITHUANIAN_PHONE_NUMBER", "LOGIN_METHOD", "MEMBERSHIP_NUMBER", "MOBILE_PHONE_NUMBER", "NORWEGIAN_BANKID_OTP", "NORWEGIAN_BANKID_PASSWORD", "NORWEGIAN_FULL_PERSONAL_NUMBER", "NORWEGIAN_PERSONAL_NUMBER", "NORWEGIAN_PHONE_NUMBER", "PASSWORD", "POSTCODE", "REGION", "SWEDISH_PERSONAL_NUMBER", "TRADE_UNION_MEMBERSHIP", "TWO_FACTOR_TOKEN", "UK_DATE_OF_BIRTH", "USERNAME" ], "example": "EMAIL", "type": "string" }, "value": { "description": "The value for the corresponding type that is passed in for the item", "example": "abc@insurely.com", "minLength": 1, "type": "string" } }, "required": [ "value" ] }, "KF": { "discriminator": { "mapping": { "parent": "#/components/schemas/FinancialProduct" }, "propertyName": "financial product type" }, "example": { "company": "se-company", "companyDisplayName": "Company", "fees": { "feesCollected": false, "feesPreviousYear": { "amount": 519.15, "currency": "SEK" } }, "financialInformation": { "currentValue": { "amount": 13046.26, "currency": "SEK" } }, "holder": {}, "holdings": [ { "isin": "SE0000429789", "name": "Carnegie Sverigefond", "type": "FUND", "value": { "amount": 2257.87, "currency": "SEK" } } ], "id": "a028429c-dbf5-4501-a0dd-e9bdf051f7e1", "insurance": { "survivorsProtection": true }, "personalInformation": { "PERSONAL_NUMBER": "010105-1234" }, "productName": "Fondspar kapitalförsäkring", "productNumber": "IN12345678", "traditionallyManaged": false, "type": "KF" }, "properties": { "accountInformation": { "$ref": "#/components/schemas/AccountInformation", "description": "Account details such as available balance and interest rate." }, "company": { "description": " Company where the financial product has been collected from. Examples:\n `se-folksam`, `se-lansforsakringar`, `se-avanza`, `se-movestic`, `se-spp`, `se-nordea`,\n `se-amf`, `se-seb`, `se-alecta`, `se-nordnet`, `se-handelsbanken`, `se-futur`,\n `se-swedbank`, `se-skandia`, `se-ica-bank`, `se-danske-bank`.\n", "example": "se-company", "type": "string" }, "companyDisplayName": { "description": "Display name of the company for user-friendly presentation.", "example": "Company", "type": "string" }, "fees": { "$ref": "#/components/schemas/Fees", "description": "Fees associated with the financial product." }, "financialInformation": { "$ref": "#/components/schemas/ProductFinancialInformation", "description": "Financial details of the product, like value, performance etc." }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the owner of the financial product." }, "holdings": { "description": "List of holdings within the financial product.", "items": { "$ref": "#/components/schemas/Wealth.Holding" }, "type": "array" }, "id": { "description": "Insurely-generated unique identifier for this collection of the financial product. Randomly generated and not stable across collections — a new id is issued each time the product is collected, even for the same underlying account. Use this only as a handle within a single collection (e.g., to correlate holdings and transactions). Do not use it to recognize the same product over time; use the stable institution-assigned identifier on this product (e.g., `productNumber`, `accountNumber`, or `loanId`) for that.", "example": "6a7c135e-3a56-44ae-bc53-1d0d5321f552", "type": "string" }, "insurance": { "$ref": "#/components/schemas/Insurance", "description": "Information about the insured person and beneficiaries." }, "monthlySavingsAmount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Monthly savings amount associated with the financial product." }, "movability": { "$ref": "#/components/schemas/Movability", "description": "The result of evaluating default or custom movability rules", "example": { "result": "MOVABLE" } }, "payoutDetails": { "description": "Provides details about the payout from the pension. Can contain multiple payout details depending on the payout schedule, for example, 2000 SEK monthly between age 65 and 70 and a lifelong monthly payout of 1000 SEK starting at age 70.", "items": { "$ref": "#/components/schemas/PayoutDetails" }, "type": "array" }, "personalInformation": { "additionalProperties": { "type": "string" }, "description": "Details of the person collecting the data, e.g., personal number.", "type": "object" }, "productName": { "description": "Name of the financial product.", "example": "Skandia Liv", "type": "string" }, "productNumber": { "description": "The product number assigned by the source financial institution (e.g., ISK account number, policy number, mortgage number). This is the most stable identifier for the product over time and across collections, and is suitable for matching the same product between repeated collections. Note that stability is best-effort and depends on what the institution exposes; it may occasionally change if the institution restructures or reissues the product.", "example": "SU91231230-2", "type": "string" }, "startDate": { "description": "Start date of the KF.", "example": "2020-01-01", "type": "string" }, "traditionallyManaged": { "description": "Indicates if the portfolio is traditionally managed. If true, no holdings will be shown.", "example": false, "type": "boolean" }, "type": { "description": "Type of the financial product.", "enum": [ "KF", "ISK", "CUSTODY_ACCOUNT", "UNKNOWN_INVESTMENT_TYPE", "IPS_PENSION", "PRIVATE_PENSION", "OCCUPATIONAL_PENSION", "COLLECTIVE_OCCUPATIONAL_PENSION", "UNKNOWN_PENSION_TYPE", "MORTGAGE_LOAN", "UNSECURED_LOAN" ], "example": "ISK", "type": "string" } }, "required": [ "company", "companyDisplayName", "id", "type" ], "title": "Kapitalförsäkring", "x-tag": "Financial Product Type" }, "LoanDetails": { "description": "Details about the loan", "example": { "balance": { "amount": 2000000, "currency": "SEK" }, "granted": { "amount": 3000000, "currency": "SEK" }, "paid": { "amount": 1000000, "currency": "SEK" } }, "properties": { "balance": { "$ref": "#/components/schemas/MonetaryAmount" }, "granted": { "$ref": "#/components/schemas/MonetaryAmount" }, "paid": { "$ref": "#/components/schemas/MonetaryAmount" } } }, "LoanMortgage": { "description": "Mortgage (\"Bolån\")", "discriminator": { "mapping": { "parent": "#/components/schemas/FinancialProduct" }, "propertyName": "financial product type" }, "example": { "company": "se-company", "companyDisplayName": "Company", "financedObject": "BRF EKORRHOLKEN 32", "firstDrawDownDate": "2020-02-29", "id": "6a7c135e-3a56-44ae-bc53-1d0d5321f552", "interest": { "baseRate": 0.0512, "discount": 0.012, "discountEndDate": "2025-03-31", "effectiveRate": 0.0398, "periodStartDate": "2024-07-01", "rate": 0.0392, "rateAdjustmentDate": "2024-10-01" }, "interestBindingPeriod": "TWO_YEARS", "loanDetails": { "balance": { "amount": 2000000, "currency": "SEK" }, "granted": { "amount": 3000000, "currency": "SEK" }, "paid": { "amount": 1000000, "currency": "SEK" } }, "loanId": "000047433123", "nextPayment": { "date": "2024-09-28", "instalment": { "amount": 5000, "currency": "SEK" }, "interest": { "amount": 7784, "currency": "SEK" }, "total": { "amount": 12784, "currency": "SEK" } }, "owners": [ { "name": "Karl Ekorrströmberg", "sharePercentage": 1 } ], "repaymentSchedule": { "finalDebt": 0, "finalPaymentDate": "2070-09-28", "numberOfInstalments": 50, "repaymentDayOfMonth": 30 }, "status": "IN_PROGRESS", "type": "MORTGAGE_LOAN" }, "properties": { "company": { "description": " Company where the financial product has been collected from. Examples:\n `se-folksam`, `se-lansforsakringar`, `se-avanza`, `se-movestic`, `se-spp`, `se-nordea`,\n `se-amf`, `se-seb`, `se-alecta`, `se-nordnet`, `se-handelsbanken`, `se-futur`,\n `se-swedbank`, `se-skandia`, `se-ica-bank`, `se-danske-bank`.\n", "example": "se-company", "type": "string" }, "companyDisplayName": { "description": "Display name of the company for user-friendly presentation.", "example": "Company", "type": "string" }, "financedObject": { "description": "The security of the loan", "example": "BRF EKORREN 32", "type": "string" }, "firstDrawDownDate": { "description": "The date the loan was paid out", "example": "2020-02-29", "type": "string" }, "id": { "description": "Insurely-generated unique identifier for this collection of the financial product. Randomly generated and not stable across collections — a new id is issued each time the product is collected, even for the same underlying account. Use this only as a handle within a single collection (e.g., to correlate holdings and transactions). Do not use it to recognize the same product over time; use the stable institution-assigned identifier on this product (e.g., `productNumber`, `accountNumber`, or `loanId`) for that.", "example": "6a7c135e-3a56-44ae-bc53-1d0d5321f552", "type": "string" }, "interest": { "$ref": "#/components/schemas/Interest" }, "interestBindingPeriod": { "description": "The period during which the interest is fixed", "enum": [ "THREE_MONTHS", "ONE_YEAR", "TWO_YEARS", "THREE_YEARS", "FOUR_YEARS", "FIVE_YEARS", "SEVEN_YEARS", "EIGHT_YEARS", "TEN_YEARS", "UNKNOWN" ], "type": "string" }, "loanDetails": { "$ref": "#/components/schemas/LoanDetails" }, "loanId": { "description": "The id of the loan from the source", "example": "000047433123", "type": "string" }, "nextPayment": { "$ref": "#/components/schemas/NextPayment" }, "owners": { "items": { "$ref": "#/components/schemas/LoanOwner" }, "type": "array" }, "repaymentSchedule": { "$ref": "#/components/schemas/RepaymentSchedule" }, "status": { "enum": [ "IN_PROGRESS", "PAID_UP", "CANCELLED", "UNKNOWN" ], "type": "string" }, "type": { "description": "Type of the financial product.", "enum": [ "KF", "ISK", "CUSTODY_ACCOUNT", "UNKNOWN_INVESTMENT_TYPE", "IPS_PENSION", "PRIVATE_PENSION", "OCCUPATIONAL_PENSION", "COLLECTIVE_OCCUPATIONAL_PENSION", "UNKNOWN_PENSION_TYPE", "MORTGAGE_LOAN", "UNSECURED_LOAN" ], "example": "ISK", "type": "string" } }, "required": [ "company", "id", "type" ], "title": "Mortgage", "x-tag": "Financial Product Type" }, "LoanOwner": { "description": "An owner of the loan, and their share", "example": { "name": "Karl Ekorrströmberg", "sharePercentage": 1 }, "properties": { "name": { "type": "string" }, "sharePercentage": { "format": "double", "type": "number" } } }, "MonetaryAmount": { "description": "Defines a monetary amount, specified by its currency code and numerical value.", "properties": { "amount": { "description": "The numeric representation of the monetary value.", "example": 10.32, "type": "number" }, "currency": { "description": "The ISO 4217 standard currency code. Possible enums: DKK, EUR, GBP, NOK, SEK, USD, etc.", "example": "EUR", "type": "string" } }, "title": "Monetary Amount" }, "Movability": { "properties": { "result": { "description": "The result of either the default or custom configured pension movability rules\n\nThe meaning of the result depends on the implementation of the rules, but these are the intended meanings:\n\n\n`MOVABLE` - Movable digitally\n\n`MOVABLE_VALCENTRAL` - Movable by the end user through a \"valcentral\" (relevant info in `managementInstitutions`)\n\n`MOVABLE_MEETING` - Movable but requires a meeting with an advisor\n\n`NOT_MOVABLE` - The criteria for being movable are not met\n\n`UNKNOWN` - Usually means that some data points required to determine movability were missing\n", "enum": [ "MOVABLE", "MOVABLE_VALCENTRAL", "MOVABLE_MEETING", "NOT_MOVABLE", "UNKNOWN" ], "example": { "result": "MOVABLE" }, "type": "string" } } }, "NextPayment": { "description": "Information about the next payment on the loan", "example": { "date": "2024-09-28", "instalment": { "amount": 5000, "currency": "SEK" }, "interest": { "amount": 7784, "currency": "SEK" }, "total": { "amount": 12784, "currency": "SEK" } }, "properties": { "date": { "type": "string" }, "instalment": { "$ref": "#/components/schemas/MonetaryAmount" }, "interest": { "$ref": "#/components/schemas/MonetaryAmount" }, "total": { "$ref": "#/components/schemas/MonetaryAmount" } } }, "Organization": { "description": "Information about the organization owning the financial product. This field is absent if the holder is a person. This field can also be absent if no organization has been found, or if there is more than one matching organization based on the holder name. See organization suggestions.", "properties": { "city": { "description": "City where the company is based.", "example": "Stockholm", "type": "string" }, "financialInformation": { "$ref": "#/components/schemas/Wealth.OrganizationFinancialInformation", "description": "Financial information about the organization. This field is a premium feature and will not be returned by default. To turn this feature on, please contact your Account Manager." }, "name": { "description": "Name of the organization.", "example": "Company Inc", "type": "string" }, "number": { "description": "Organization number.", "example": "5111111111", "type": "string" } } }, "OtherTransaction": { "description": "A transaction to or from the account with an unknown type", "discriminator": { "mapping": { "parent": "#/components/schemas/Transaction" }, "propertyName": "transaction type" }, "properties": { "amount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The transaction amount." }, "description": { "description": "The description of the transaction.", "example": "Skatt", "type": "string" }, "settlementDate": { "description": "The date when the transaction was settled.", "example": "2024-01-01", "type": "string" }, "type": { "enum": [ "BUY", "SELL", "DEPOSIT", "WITHDRAWAL", "FEE", "INTEREST", "DIVIDEND", "REDEMPTION", "OTHER" ], "example": "OTHER", "title": "TransactionType", "type": "string" } }, "title": "OtherTransaction" }, "PayoutDetails": { "properties": { "active": { "description": "Indicates if the payout is active.", "example": false, "type": "boolean" }, "amount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Amount to be paid out." }, "lifelongPayout": { "description": "Indicates if the payout has a defined end.", "example": false, "type": "boolean" }, "period": { "$ref": "#/components/schemas/PayoutPeriod", "description": "Period for the payout, can be a range of ages or dates." } } }, "PayoutPeriod": { "discriminator": { "mapping": { "AGE_RANGE": "#/components/schemas/AgePeriod", "DATE_RANGE": "#/components/schemas/DatePeriod" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AgePeriod" }, { "$ref": "#/components/schemas/DatePeriod" } ], "properties": { "type": { "description": "Type of the period.", "enum": [ "AGE_RANGE", "DATE_RANGE" ], "example": "AGE_RANGE", "type": "string" } }, "title": "PayoutPeriod" }, "PensionCollectiveOccupational": { "description": "Collective occupational pension (\"Kollektivavtalad tjänstepension\")", "discriminator": { "mapping": { "parent": "#/components/schemas/FinancialProduct" }, "propertyName": "financial product type" }, "example": { "activePayment": false, "activePayout": false, "classification": "ITP", "company": "se-company", "companyDisplayName": "Company", "fees": { "feeFixed": { "amount": 50, "currency": "SEK" }, "feeVariable": 0.0017, "feesCollected": false, "feesPreviousYear": { "amount": 62, "currency": "SEK" } }, "financialInformation": { "currentValue": { "amount": 136600, "currency": "SEK" }, "totalDeposits": { "amount": 56747, "currency": "SEK" } }, "holder": { "name": "COMPANY AB", "organizationSuggestions": [ { "city": "Stockholm", "financialInformation": { "employeeCount": 333, "financialPeriod": { "endDate": "2022-12-31", "startDate": "2022-01-01" }, "netIncome": { "amount": 604300000, "currency": "SEK" }, "shareCapital": { "amount": 100000000, "currency": "SEK" }, "turnover": { "amount": 2211907000, "currency": "SEK" } }, "name": "COMPANY AB", "number": "5563141234" }, { "city": "Malmö", "financialInformation": { "employeeCount": 666, "financialPeriod": { "endDate": "2023-12-31", "startDate": "2023-01-01" }, "netIncome": { "amount": 1604300000, "currency": "SEK" }, "shareCapital": { "amount": 1100000000, "currency": "SEK" }, "turnover": { "amount": 12211907000, "currency": "SEK" } }, "name": "COMPANY COMPANY AB", "number": "5563141235" } ] }, "holdings": [ { "acquisitionValue": { "amount": 18883.51, "currency": "SEK" }, "feeVariable": 0, "isin": "SE0001718388", "name": "Avanza Zero", "quantity": 54.076858, "type": "FUND", "value": { "amount": 22468.39, "currency": "SEK" } } ], "id": "901a6ce9-6643-4f60-b732-87c992381a78", "insurance": { "insuredPersonName": "Anka, Karl", "survivorsProtection": false }, "managementInstitutions": [ { "name": "Collectum", "url": "https://ik.collectum.se/privat/index.jsp" } ], "movability": { "result": "NOT_MOVABLE" }, "personalInformation": { "PERSONAL_NUMBER": "19010106-1234" }, "productName": "ITP 1, Traditionell försäkring", "productNumber": "0124345", "startDate": "2000-02-01", "traditionallyManaged": true, "type": "COLLECTIVE_OCCUPATIONAL_PENSION" }, "properties": { "activePayment": { "description": "Indicates if the pension is currently being paid into.", "example": true, "type": "boolean" }, "activePayout": { "description": "Indicates if the pension is currently being paid out.", "example": false, "type": "boolean" }, "classification": { "description": "Classification of the pension.", "enum": [ "ITP", "FTP", "KAP-KL", "SAF-LO", "PA16", "PA-KFS", "GTP", "BTP", "PPA07", "PPA13", "UNKNOWN_PENSION_CLASSIFICATION" ], "example": "ITP", "type": "string" }, "company": { "description": " Company where the financial product has been collected from. Examples:\n `se-folksam`, `se-lansforsakringar`, `se-avanza`, `se-movestic`, `se-spp`, `se-nordea`,\n `se-amf`, `se-seb`, `se-alecta`, `se-nordnet`, `se-handelsbanken`, `se-futur`,\n `se-swedbank`, `se-skandia`, `se-ica-bank`, `se-danske-bank`.\n", "example": "se-company", "type": "string" }, "companyDisplayName": { "description": "Display name of the company for user-friendly presentation.", "example": "Company", "type": "string" }, "fees": { "$ref": "#/components/schemas/Fees", "description": "Fees associated with the financial product." }, "financialInformation": { "$ref": "#/components/schemas/ProductFinancialInformation", "description": "Financial details of the product, like value, performance etc." }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the owner of the pension." }, "holdings": { "description": "List of holdings within the pension.", "items": { "$ref": "#/components/schemas/Wealth.Holding" }, "type": "array" }, "id": { "description": "Insurely-generated unique identifier for this collection of the financial product. Randomly generated and not stable across collections — a new id is issued each time the product is collected, even for the same underlying account. Use this only as a handle within a single collection (e.g., to correlate holdings and transactions). Do not use it to recognize the same product over time; use the stable institution-assigned identifier on this product (e.g., `productNumber`, `accountNumber`, or `loanId`) for that.", "example": "6a7c135e-3a56-44ae-bc53-1d0d5321f552", "type": "string" }, "insurance": { "$ref": "#/components/schemas/Insurance", "description": "Information about the insured person and beneficiaries." }, "managementInstitutions": { "description": "Institutions managing this class of collective occupational pensions.\nPresent only if the pension has a known classification.\nWill be present even if the pension is not movable", "items": { "$ref": "#/components/schemas/Wealth.PensionManagementInstitution" }, "type": "array" }, "movability": { "$ref": "#/components/schemas/Movability", "description": "The result of evaluating default or custom movability rules", "example": { "result": "MOVABLE" } }, "otherInsuredPerson": { "description": "If the person insured by the pension is someone else than the person who initiated the collection.", "example": false, "type": "boolean" }, "payoutDetails": { "description": "Provides details about the payout from the pension. Can contain multiple payout details depending on the payout schedule, for example, 2000 SEK monthly between age 65 and 70 and a lifelong monthly payout of 1000 SEK starting at age 70.", "items": { "$ref": "#/components/schemas/PayoutDetails" }, "type": "array" }, "personalInformation": { "additionalProperties": { "type": "string" }, "description": "Details of the person collecting the data, e.g. personal number.", "type": "object" }, "productName": { "description": "Name of the financial product.", "example": "Avtalspension FTP", "type": "string" }, "productNumber": { "description": "The product number assigned by the source financial institution (e.g., ISK account number, policy number, mortgage number). This is the most stable identifier for the product over time and across collections, and is suitable for matching the same product between repeated collections. Note that stability is best-effort and depends on what the institution exposes; it may occasionally change if the institution restructures or reissues the product.", "example": "SU91231230-2", "type": "string" }, "startDate": { "description": "Start date of the pension.", "example": "2020-01-01", "type": "string" }, "traditionallyManaged": { "description": "Indicates if the portfolio is traditionally managed.", "example": false, "type": "boolean" }, "type": { "description": "Type of the financial product.", "enum": [ "KF", "ISK", "CUSTODY_ACCOUNT", "UNKNOWN_INVESTMENT_TYPE", "IPS_PENSION", "PRIVATE_PENSION", "OCCUPATIONAL_PENSION", "COLLECTIVE_OCCUPATIONAL_PENSION", "UNKNOWN_PENSION_TYPE", "MORTGAGE_LOAN", "UNSECURED_LOAN" ], "example": "ISK", "type": "string" } }, "required": [ "company", "companyDisplayName", "id", "type" ], "title": "Collective Occupational Pension", "x-tag": "Financial Product Type" }, "PensionIPS": { "description": "IPS Pension, private pension saving (\"Individuellt Pensionssparande\").", "discriminator": { "mapping": { "parent": "#/components/schemas/FinancialProduct" }, "propertyName": "financial product type" }, "example": { "activePayment": false, "activePayout": false, "company": "se-company", "companyDisplayName": "Company", "fees": { "feeFixed": { "amount": 0, "currency": "SEK" }, "feeVariable": 0, "feesCollected": false, "feesPreviousYear": { "amount": 0, "currency": "SEK" } }, "financialInformation": { "currentValue": { "amount": 103488, "currency": "SEK" }, "totalDeposits": { "amount": 43011, "currency": "SEK" } }, "holder": {}, "holdings": [ { "feeVariable": 0.0025, "isin": "SE0000810772", "name": "Skandia Europa Exponering", "quantity": 89.651, "type": "FUND", "value": { "amount": 66124, "currency": "SEK" } } ], "id": "dd4257d5-6bc2-4103-baf2-4ba7c838929f", "insurance": { "insuredPersonName": "Johan Johanson", "survivorsProtection": false }, "movability": { "result": "MOVABLE" }, "personalInformation": { "PERSONAL_NUMBER": "19010101-1234234" }, "productName": "IPS Pension", "productNumber": "S123456789", "startDate": "2016-04-01", "traditionallyManaged": false, "type": "IPS_PENSION" }, "properties": { "activePayment": { "description": "Indicates if the pension is currently being paid into.", "example": true, "type": "boolean" }, "activePayout": { "description": "Indicates if the pension is currently being paid out.", "example": false, "type": "boolean" }, "company": { "description": " Company where the financial product has been collected from. Examples:\n `se-folksam`, `se-lansforsakringar`, `se-avanza`, `se-movestic`, `se-spp`, `se-nordea`,\n `se-amf`, `se-seb`, `se-alecta`, `se-nordnet`, `se-handelsbanken`, `se-futur`,\n `se-swedbank`, `se-skandia`, `se-ica-bank`, `se-danske-bank`.\n", "example": "se-company", "type": "string" }, "companyDisplayName": { "description": "Display name of the company for user-friendly presentation.", "example": "Company", "type": "string" }, "fees": { "$ref": "#/components/schemas/Fees", "description": "Fees associated with the financial product." }, "financialInformation": { "$ref": "#/components/schemas/ProductFinancialInformation", "description": "Financial details of the product, like value, performance etc." }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the owner of the pension." }, "holdings": { "description": "List of holdings within the pension.", "items": { "$ref": "#/components/schemas/Wealth.Holding" }, "type": "array" }, "id": { "description": "Insurely-generated unique identifier for this collection of the financial product. Randomly generated and not stable across collections — a new id is issued each time the product is collected, even for the same underlying account. Use this only as a handle within a single collection (e.g., to correlate holdings and transactions). Do not use it to recognize the same product over time; use the stable institution-assigned identifier on this product (e.g., `productNumber`, `accountNumber`, or `loanId`) for that.", "example": "6a7c135e-3a56-44ae-bc53-1d0d5321f552", "type": "string" }, "insurance": { "$ref": "#/components/schemas/Insurance", "description": "Information about the insured person and beneficiaries." }, "movability": { "$ref": "#/components/schemas/Movability", "description": "The result of evaluating default or custom movability rules", "example": { "result": "MOVABLE" } }, "otherInsuredPerson": { "description": "If the person insured by the pension is someone else than the person who initiated the collection.", "example": false, "type": "boolean" }, "payoutDetails": { "description": "Provides details about the payout from the pension. Can contain multiple payout details depending on the payout schedule, for example, 2000 SEK monthly between age 65 and 70 and a lifelong monthly payout of 1000 SEK starting at age 70.", "items": { "$ref": "#/components/schemas/PayoutDetails" }, "type": "array" }, "personalInformation": { "additionalProperties": { "type": "string" }, "description": "Details of the person collecting the data, e.g. personal number.", "type": "object" }, "productName": { "description": "Name of the financial product.", "example": "Avtalspension FTP", "type": "string" }, "productNumber": { "description": "The product number assigned by the source financial institution (e.g., ISK account number, policy number, mortgage number). This is the most stable identifier for the product over time and across collections, and is suitable for matching the same product between repeated collections. Note that stability is best-effort and depends on what the institution exposes; it may occasionally change if the institution restructures or reissues the product.", "example": "SU91231230-2", "type": "string" }, "startDate": { "description": "Start date of the pension.", "example": "2020-01-01", "type": "string" }, "traditionallyManaged": { "description": "Indicates if the portfolio is traditionally managed.", "example": false, "type": "boolean" }, "type": { "description": "Type of the financial product.", "enum": [ "KF", "ISK", "CUSTODY_ACCOUNT", "UNKNOWN_INVESTMENT_TYPE", "IPS_PENSION", "PRIVATE_PENSION", "OCCUPATIONAL_PENSION", "COLLECTIVE_OCCUPATIONAL_PENSION", "UNKNOWN_PENSION_TYPE", "MORTGAGE_LOAN", "UNSECURED_LOAN" ], "example": "ISK", "type": "string" } }, "required": [ "company", "companyDisplayName", "id", "type" ], "title": "IPS", "x-tag": "Financial Product Type" }, "PensionOccupational": { "description": "Occupational pension (\"Tjänstepension\")", "discriminator": { "mapping": { "parent": "#/components/schemas/FinancialProduct" }, "propertyName": "financial product type" }, "example": { "activePayment": false, "activePayout": false, "company": "se-company", "companyDisplayName": "Company", "fees": { "feeFixed": { "amount": 100, "currency": "SEK" }, "feeVariable": 0.0065, "feesCollected": false, "feesPreviousYear": { "amount": 513, "currency": "SEK" } }, "financialInformation": { "currentValue": { "amount": 103488, "currency": "SEK" }, "totalDeposits": { "amount": 43011, "currency": "SEK" } }, "holder": { "name": "COMPANY AB", "organization": { "city": "Stockholm", "financialInformation": { "employeeCount": 333, "financialPeriod": { "endDate": "2022-12-31", "startDate": "2022-01-01" }, "netIncome": { "amount": 604300000, "currency": "SEK" }, "shareCapital": { "amount": 100000000, "currency": "SEK" }, "turnover": { "amount": 2211907000, "currency": "SEK" } }, "name": "COMPANY AB", "number": "5563141234" } }, "holdings": [ { "feeVariable": 0.0025, "isin": "SE0000810772", "name": "Skandia Europa Exponering", "quantity": 89.651, "type": "FUND", "value": { "amount": 66124, "currency": "SEK" } }, { "feeVariable": 0.0025, "isin": "SE0005065505", "name": "Skandia Nordamerika Exponering", "quantity": 70.8153, "type": "FUND", "value": { "amount": 8601, "currency": "SEK" } } ], "id": "dd4257d5-6bc2-4103-baf2-4ba7c838929f", "insurance": { "insuredPersonName": "Johan Johanson", "survivorsProtection": true }, "movability": { "result": "MOVABLE" }, "payoutDetails": [ { "active": false, "amount": { "amount": 0, "currency": "SEK" }, "lifelongPayout": true, "period": { "startDate": "2045-03-01", "type": "DATE_RANGE" } } ], "personalInformation": { "PERSONAL_NUMBER": "19010101-1234234" }, "productName": "Tjänstepension", "productNumber": "S123456789", "startDate": "2016-04-01", "traditionallyManaged": false, "type": "OCCUPATIONAL_PENSION" }, "properties": { "activePayment": { "description": "Indicates if the pension is currently being paid into.", "example": true, "type": "boolean" }, "activePayout": { "description": "Indicates if the pension is currently being paid out.", "example": false, "type": "boolean" }, "company": { "description": " Company where the financial product has been collected from. Examples:\n `se-folksam`, `se-lansforsakringar`, `se-avanza`, `se-movestic`, `se-spp`, `se-nordea`,\n `se-amf`, `se-seb`, `se-alecta`, `se-nordnet`, `se-handelsbanken`, `se-futur`,\n `se-swedbank`, `se-skandia`, `se-ica-bank`, `se-danske-bank`.\n", "example": "se-company", "type": "string" }, "companyDisplayName": { "description": "Display name of the company for user-friendly presentation.", "example": "Company", "type": "string" }, "fees": { "$ref": "#/components/schemas/Fees", "description": "Fees associated with the financial product." }, "financialInformation": { "$ref": "#/components/schemas/ProductFinancialInformation", "description": "Financial details of the product, like value, performance etc." }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the owner of the pension." }, "holdings": { "description": "List of holdings within the pension.", "items": { "$ref": "#/components/schemas/Wealth.Holding" }, "type": "array" }, "id": { "description": "Insurely-generated unique identifier for this collection of the financial product. Randomly generated and not stable across collections — a new id is issued each time the product is collected, even for the same underlying account. Use this only as a handle within a single collection (e.g., to correlate holdings and transactions). Do not use it to recognize the same product over time; use the stable institution-assigned identifier on this product (e.g., `productNumber`, `accountNumber`, or `loanId`) for that.", "example": "6a7c135e-3a56-44ae-bc53-1d0d5321f552", "type": "string" }, "insurance": { "$ref": "#/components/schemas/Insurance", "description": "Information about the insured person and beneficiaries." }, "movability": { "$ref": "#/components/schemas/Movability", "description": "The result of evaluating default or custom movability rules", "example": { "result": "MOVABLE" } }, "otherInsuredPerson": { "description": "If the person insured by the pension is someone else than the person who initiated the collection.", "example": false, "type": "boolean" }, "payoutDetails": { "description": "Provides details about the payout from the pension. Can contain multiple payout details depending on the payout schedule, for example, 2000 SEK monthly between age 65 and 70 and a lifelong monthly payout of 1000 SEK starting at age 70.", "items": { "$ref": "#/components/schemas/PayoutDetails" }, "type": "array" }, "personalInformation": { "additionalProperties": { "type": "string" }, "description": "Details of the person collecting the data, e.g. personal number.", "type": "object" }, "productName": { "description": "Name of the financial product.", "example": "Avtalspension FTP", "type": "string" }, "productNumber": { "description": "The product number assigned by the source financial institution (e.g., ISK account number, policy number, mortgage number). This is the most stable identifier for the product over time and across collections, and is suitable for matching the same product between repeated collections. Note that stability is best-effort and depends on what the institution exposes; it may occasionally change if the institution restructures or reissues the product.", "example": "SU91231230-2", "type": "string" }, "startDate": { "description": "Start date of the pension.", "example": "2020-01-01", "type": "string" }, "traditionallyManaged": { "description": "Indicates if the portfolio is traditionally managed.", "example": false, "type": "boolean" }, "type": { "description": "Type of the financial product.", "enum": [ "KF", "ISK", "CUSTODY_ACCOUNT", "UNKNOWN_INVESTMENT_TYPE", "IPS_PENSION", "PRIVATE_PENSION", "OCCUPATIONAL_PENSION", "COLLECTIVE_OCCUPATIONAL_PENSION", "UNKNOWN_PENSION_TYPE", "MORTGAGE_LOAN", "UNSECURED_LOAN" ], "example": "ISK", "type": "string" } }, "required": [ "company", "companyDisplayName", "id", "type" ], "title": "Occupational Pension", "x-tag": "Financial Product Type" }, "PensionPrivate": { "description": "Private pension savings.", "discriminator": { "mapping": { "parent": "#/components/schemas/FinancialProduct" }, "propertyName": "financial product type" }, "example": { "activePayment": false, "activePayout": false, "company": "se-company", "companyDisplayName": "Company", "fees": { "feeFixed": { "amount": 0, "currency": "SEK" }, "feeVariable": 0, "feesCollected": false, "feesPreviousYear": { "amount": 0, "currency": "SEK" } }, "financialInformation": { "currentValue": { "amount": 103488, "currency": "SEK" }, "totalDeposits": { "amount": 43011, "currency": "SEK" } }, "holder": {}, "holdings": [ { "feeVariable": 0.0025, "isin": "SE0000810772", "name": "Skandia Europa Exponering", "quantity": 89.651, "type": "FUND", "value": { "amount": 66124, "currency": "SEK" } } ], "id": "dd4257d5-6bc2-4103-baf2-4ba7c838929f", "insurance": { "insuredPersonName": "Johan Johanson", "survivorsProtection": false }, "movability": { "result": "MOVABLE" }, "personalInformation": { "PERSONAL_NUMBER": "19010101-1234234" }, "productName": "Private Pension", "productNumber": "S123456789", "startDate": "2016-04-01", "traditionallyManaged": false, "type": "PRIVATE_PENSION" }, "properties": { "activePayment": { "description": "Indicates if the pension is currently being paid into.", "example": true, "type": "boolean" }, "activePayout": { "description": "Indicates if the pension is currently being paid out.", "example": false, "type": "boolean" }, "company": { "description": " Company where the financial product has been collected from. Examples:\n `se-folksam`, `se-lansforsakringar`, `se-avanza`, `se-movestic`, `se-spp`, `se-nordea`,\n `se-amf`, `se-seb`, `se-alecta`, `se-nordnet`, `se-handelsbanken`, `se-futur`,\n `se-swedbank`, `se-skandia`, `se-ica-bank`, `se-danske-bank`.\n", "example": "se-company", "type": "string" }, "companyDisplayName": { "description": "Display name of the company for user-friendly presentation.", "example": "Company", "type": "string" }, "fees": { "$ref": "#/components/schemas/Fees", "description": "Fees associated with the financial product." }, "financialInformation": { "$ref": "#/components/schemas/ProductFinancialInformation", "description": "Financial details of the product, like value, performance etc." }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the owner of the pension." }, "holdings": { "description": "List of holdings within the pension.", "items": { "$ref": "#/components/schemas/Wealth.Holding" }, "type": "array" }, "id": { "description": "Insurely-generated unique identifier for this collection of the financial product. Randomly generated and not stable across collections — a new id is issued each time the product is collected, even for the same underlying account. Use this only as a handle within a single collection (e.g., to correlate holdings and transactions). Do not use it to recognize the same product over time; use the stable institution-assigned identifier on this product (e.g., `productNumber`, `accountNumber`, or `loanId`) for that.", "example": "6a7c135e-3a56-44ae-bc53-1d0d5321f552", "type": "string" }, "insurance": { "$ref": "#/components/schemas/Insurance", "description": "Information about the insured person and beneficiaries." }, "movability": { "$ref": "#/components/schemas/Movability", "description": "The result of evaluating default or custom movability rules", "example": { "result": "MOVABLE" } }, "otherInsuredPerson": { "description": "If the person insured by the pension is someone else than the person who initiated the collection.", "example": false, "type": "boolean" }, "payoutDetails": { "description": "Provides details about the payout from the pension. Can contain multiple payout details depending on the payout schedule, for example, 2000 SEK monthly between age 65 and 70 and a lifelong monthly payout of 1000 SEK starting at age 70.", "items": { "$ref": "#/components/schemas/PayoutDetails" }, "type": "array" }, "personalInformation": { "additionalProperties": { "type": "string" }, "description": "Details of the person collecting the data, e.g. personal number.", "type": "object" }, "productName": { "description": "Name of the financial product.", "example": "Avtalspension FTP", "type": "string" }, "productNumber": { "description": "The product number assigned by the source financial institution (e.g., ISK account number, policy number, mortgage number). This is the most stable identifier for the product over time and across collections, and is suitable for matching the same product between repeated collections. Note that stability is best-effort and depends on what the institution exposes; it may occasionally change if the institution restructures or reissues the product.", "example": "SU91231230-2", "type": "string" }, "startDate": { "description": "Start date of the pension.", "example": "2020-01-01", "type": "string" }, "traditionallyManaged": { "description": "Indicates if the portfolio is traditionally managed.", "example": false, "type": "boolean" }, "type": { "description": "Type of the financial product.", "enum": [ "KF", "ISK", "CUSTODY_ACCOUNT", "UNKNOWN_INVESTMENT_TYPE", "IPS_PENSION", "PRIVATE_PENSION", "OCCUPATIONAL_PENSION", "COLLECTIVE_OCCUPATIONAL_PENSION", "UNKNOWN_PENSION_TYPE", "MORTGAGE_LOAN", "UNSECURED_LOAN" ], "example": "ISK", "type": "string" } }, "required": [ "company", "companyDisplayName", "id", "type" ], "title": "Private Pension", "x-tag": "Financial Product Type" }, "PensionUnknown": { "description": "Unknown pension type. Could not be determined from the pensions savings company.", "discriminator": { "mapping": { "parent": "#/components/schemas/FinancialProduct" }, "propertyName": "financial product type" }, "example": { "activePayment": false, "activePayout": false, "company": "se-company", "companyDisplayName": "Company", "fees": { "feeFixed": { "amount": 0, "currency": "SEK" }, "feeVariable": 0, "feesCollected": false, "feesPreviousYear": { "amount": 0, "currency": "SEK" } }, "financialInformation": { "currentValue": { "amount": 103488, "currency": "SEK" }, "totalDeposits": { "amount": 43011, "currency": "SEK" } }, "holder": {}, "holdings": [ { "feeVariable": 0.0025, "isin": "SE0000810772", "name": "Skandia Europa Exponering", "quantity": 89.651, "type": "FUND", "value": { "amount": 66124, "currency": "SEK" } } ], "id": "dd4257d5-6bc2-4103-baf2-4ba7c838929f", "insurance": { "insuredPersonName": "Johan Johanson", "survivorsProtection": false }, "movability": { "result": "MOVABLE" }, "personalInformation": { "PERSONAL_NUMBER": "19010101-1234234" }, "productName": "Pension", "productNumber": "S123456789", "startDate": "2016-04-01", "traditionallyManaged": false, "type": "UNKNOWN_PENSION_TYPE" }, "properties": { "activePayment": { "description": "Indicates if the pension is currently being paid into.", "example": true, "type": "boolean" }, "activePayout": { "description": "Indicates if the pension is currently being paid out.", "example": false, "type": "boolean" }, "company": { "description": " Company where the financial product has been collected from. Examples:\n `se-folksam`, `se-lansforsakringar`, `se-avanza`, `se-movestic`, `se-spp`, `se-nordea`,\n `se-amf`, `se-seb`, `se-alecta`, `se-nordnet`, `se-handelsbanken`, `se-futur`,\n `se-swedbank`, `se-skandia`, `se-ica-bank`, `se-danske-bank`.\n", "example": "se-company", "type": "string" }, "companyDisplayName": { "description": "Display name of the company for user-friendly presentation.", "example": "Company", "type": "string" }, "fees": { "$ref": "#/components/schemas/Fees", "description": "Fees associated with the financial product." }, "financialInformation": { "$ref": "#/components/schemas/ProductFinancialInformation", "description": "Financial details of the product, like value, performance etc." }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the owner of the pension." }, "holdings": { "description": "List of holdings within the pension.", "items": { "$ref": "#/components/schemas/Wealth.Holding" }, "type": "array" }, "id": { "description": "Insurely-generated unique identifier for this collection of the financial product. Randomly generated and not stable across collections — a new id is issued each time the product is collected, even for the same underlying account. Use this only as a handle within a single collection (e.g., to correlate holdings and transactions). Do not use it to recognize the same product over time; use the stable institution-assigned identifier on this product (e.g., `productNumber`, `accountNumber`, or `loanId`) for that.", "example": "6a7c135e-3a56-44ae-bc53-1d0d5321f552", "type": "string" }, "insurance": { "$ref": "#/components/schemas/Insurance", "description": "Information about the insured person and beneficiaries." }, "movability": { "$ref": "#/components/schemas/Movability", "description": "The result of evaluating default or custom movability rules", "example": { "result": "MOVABLE" } }, "otherInsuredPerson": { "description": "If the person insured by the pension is someone else than the person who initiated the collection.", "example": false, "type": "boolean" }, "payoutDetails": { "description": "Provides details about the payout from the pension. Can contain multiple payout details depending on the payout schedule, for example, 2000 SEK monthly between age 65 and 70 and a lifelong monthly payout of 1000 SEK starting at age 70.", "items": { "$ref": "#/components/schemas/PayoutDetails" }, "type": "array" }, "personalInformation": { "additionalProperties": { "type": "string" }, "description": "Details of the person collecting the data, e.g. personal number.", "type": "object" }, "productName": { "description": "Name of the financial product.", "example": "Avtalspension FTP", "type": "string" }, "productNumber": { "description": "The product number assigned by the source financial institution (e.g., ISK account number, policy number, mortgage number). This is the most stable identifier for the product over time and across collections, and is suitable for matching the same product between repeated collections. Note that stability is best-effort and depends on what the institution exposes; it may occasionally change if the institution restructures or reissues the product.", "example": "SU91231230-2", "type": "string" }, "startDate": { "description": "Start date of the pension.", "example": "2020-01-01", "type": "string" }, "traditionallyManaged": { "description": "Indicates if the portfolio is traditionally managed.", "example": false, "type": "boolean" }, "type": { "description": "Type of the financial product.", "enum": [ "KF", "ISK", "CUSTODY_ACCOUNT", "UNKNOWN_INVESTMENT_TYPE", "IPS_PENSION", "PRIVATE_PENSION", "OCCUPATIONAL_PENSION", "COLLECTIVE_OCCUPATIONAL_PENSION", "UNKNOWN_PENSION_TYPE", "MORTGAGE_LOAN", "UNSECURED_LOAN" ], "example": "ISK", "type": "string" } }, "required": [ "company", "companyDisplayName", "id", "type" ], "title": "Unknown Pension", "x-tag": "Financial Product Type" }, "ProductFinancialInformation": { "properties": { "currentValue": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Current value of all the assets in the financial product, including cash. Current value is total paid + change in value. Change in value is affected by performance of underlying assets and withdrawals." }, "performanceSinceStart": { "description": "Performance of the portfolio as a percentage. For example, 0.2533 represents a 25.33% increase in value. Performance is taken as presented in the source, exact measuring method is unavailable", "example": 0.2533, "format": "double", "type": "number" }, "totalDeposits": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Cumulated value of all deposits (premiums/transfers)." } } }, "RedemptionTransaction": { "description": "Redemption of shares on the account", "discriminator": { "mapping": { "parent": "#/components/schemas/Transaction" }, "propertyName": "transaction type" }, "properties": { "amount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The transaction amount." }, "description": { "description": "The description of the transaction.", "example": "Utdelning", "type": "string" }, "instrumentInformation": { "$ref": "#/components/schemas/TransactionInstrument", "description": "Instrument that related to the dividend transaction." }, "settlementDate": { "description": "The date when the transaction was settled.", "example": "2024-01-01", "type": "string" }, "type": { "enum": [ "BUY", "SELL", "DEPOSIT", "WITHDRAWAL", "FEE", "INTEREST", "DIVIDEND", "REDEMPTION", "OTHER" ], "example": "REDEMPTION", "title": "TransactionType", "type": "string" } }, "title": "RedemptionTransaction" }, "RepaymentSchedule": { "description": "The planned payments", "example": { "finalDebt": 0, "finalPaymentDate": "2070-09-28", "numberOfInstalments": 50, "repaymentDayOfMonth": 30 }, "properties": { "finalDebt": { "format": "int64", "type": "integer" }, "finalPaymentDate": { "type": "string" }, "numberOfInstalments": { "format": "int32", "type": "integer" }, "repaymentDayOfMonth": { "format": "int32", "type": "integer" } } }, "Request": { "properties": { "body": { "description": "If the method is POST, body to be included in the POST request as string.", "example": "'{\"username\":\"19900101-1234\"}'", "type": "string" }, "cookies": { "description": "List of cookies to include in the request. They should be added to a cookie jar and included in each subsequent request.", "items": { "$ref": "#/components/schemas/Cookie" }, "type": "array" }, "etag": { "description": "Entity tag of the request, each unique request will have its own unique etag. This allows for distinguishing between new requests to be made,\nsince the same request may be \"returned with multiple `CollectionStatus` responses.", "example": "d5c19d129d9f4a54b7de2fa198bf73fa-initiate", "type": "string" }, "headers": { "additionalProperties": { "type": "string" }, "description": "Map of headers to include with the request.", "example": { "Content-Type": "application/json" }, "type": "object" }, "method": { "description": "HTTP method of the request.", "example": "POST", "type": "string" }, "url": { "description": "URL to make a request towards. This will be based on the company that the collection is started towards.", "example": "https://insurely.com/initiate-bankid", "type": "string" } }, "required": [ "url" ] }, "ResponseObject": { "description": "An HTTP response to be provided after receiving HTTP `INSTRUCTIONS` in the `CollectionStatus` `extraInformation` object. This is expected when using the `SWEDISH_MOBILE_BANKID_SAME_DEVICE_CLIENT_SIDE_AUTHENTICATION` `loginMethod`. An in-depth description of this flow can be found in the introduction.", "properties": { "headers": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "description": "The keys and values of the response headers. Values are lists because some headers (notably Set-Cookie) will be repeated", "example": { "Cache-Control": [ "no-cache, no-store, max-age=0" ], "Content-Encoding": [ "gzip" ], "Content-Language": [ "sv_SE" ], "Content-Type": [ "application/json; charset=UTF-8" ], "Date": [ "Sun, 20 Jul 1969 20:17:10 GMT" ], "Expires": [ "Thu, 01 Jan 1970 00:00:00 GMT" ], "Pragma": [ "no-cache" ], "Server": [ "-" ], "Set-Cookie": [ "session=0cdd1666-7319-4f73-8fc3-d095f83b4ff9;Path=/;Domain=somecompany.se;Secure;HttpOnly", "qwerty=219ffwef9w0f; Domain=somecompany.se" ], "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], "Transfer-Encoding": [ "Identity" ], "Vary": [ "Accept-Encoding" ] }, "type": "object" }, "response": { "description": "The response body, in the format it was responded, e.g. html or json.", "example": { "andromedaUserToken": "some_random_token", "extendedUsage": false, "formattedServerTime": "1969-07-20 22:27", "links": { "next": { "method": "GET", "uri": "/v5/profile/" } }, "maskedUserId": "19300805****", "serverTime": "19690720 22:17", "status": "COMPLETE" } }, "type": { "enum": [ "RESPONSE_OBJECT" ], "example": "RESPONSE_OBJECT", "type": "string" } }, "title": "ResponseObject" }, "SelectOne": { "properties": { "key": { "type": "string" }, "options": { "items": { "$ref": "#/components/schemas/AdditionalLoginInputSelectOption" }, "type": "array", "uniqueItems": true }, "type": { "type": "string" } }, "required": [ "key", "options" ] }, "SellTransaction": { "description": "The sale of a holding in the account", "discriminator": { "mapping": { "parent": "#/components/schemas/Transaction" }, "propertyName": "transaction type" }, "properties": { "amount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The transaction amount." }, "commission": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The optional commission on the transaction" }, "instrumentInformation": { "$ref": "#/components/schemas/TransactionInstrument", "description": "Information about the instrument traded." }, "quantity": { "description": "The quantity of stock or fund bought.", "example": 204.33, "format": "double", "type": "number" }, "settlementDate": { "description": "The date when the transaction was settled.", "example": "2024-01-01", "type": "string" }, "tradeDate": { "description": "The date when the instrument was traded.", "example": "2024-01-01", "type": "string" }, "type": { "enum": [ "BUY", "SELL", "DEPOSIT", "WITHDRAWAL", "FEE", "INTEREST", "DIVIDEND", "REDEMPTION", "OTHER" ], "example": "SELL", "title": "TransactionType", "type": "string" } }, "title": "SellTransaction" }, "SupplementInformation": { "discriminator": { "mapping": { "COLLECTION_INPUT": "#/components/schemas/CollectionInput", "RESPONSE_OBJECT": "#/components/schemas/ResponseObject", "TWO_FACTOR_CHOICE": "#/components/schemas/TwoFactorChoice", "TWO_FACTOR_CODE": "#/components/schemas/TwoFactorCode" }, "propertyName": "api" }, "oneOf": [ { "$ref": "#/components/schemas/TwoFactorCode" }, { "$ref": "#/components/schemas/TwoFactorChoice" }, { "$ref": "#/components/schemas/ResponseObject" }, { "$ref": "#/components/schemas/CollectionInput" } ], "properties": { "type": { "description": "Type of the supplemental information.", "enum": [ "TWO_FACTOR_CODE", "TWO_FACTOR_CHOICE", "RESPONSE_OBJECT", "COLLECTION_INPUT" ], "type": "string" } }, "title": "SupplementInformation" }, "Transaction": { "description": "List of transactions on the account within the last 12 months. Will only be included if configured accordingly", "discriminator": { "mapping": { "child-1": "#/components/schemas/BuyTransaction", "child-2": "#/components/schemas/DepositTransaction", "child-3": "#/components/schemas/DividendTransaction", "child-4": "#/components/schemas/FeeTransaction", "child-5": "#/components/schemas/InterestTransaction", "child-6": "#/components/schemas/OtherTransaction", "child-7": "#/components/schemas/SellTransaction", "child-8": "#/components/schemas/RedemptionTransaction", "child-9": "#/components/schemas/WithdrawalTransaction" }, "propertyName": "transaction type" }, "oneOf": [ { "$ref": "#/components/schemas/BuyTransaction" }, { "$ref": "#/components/schemas/DepositTransaction" }, { "$ref": "#/components/schemas/DividendTransaction" }, { "$ref": "#/components/schemas/FeeTransaction" }, { "$ref": "#/components/schemas/InterestTransaction" }, { "$ref": "#/components/schemas/OtherTransaction" }, { "$ref": "#/components/schemas/SellTransaction" }, { "$ref": "#/components/schemas/RedemptionTransaction" }, { "$ref": "#/components/schemas/WithdrawalTransaction" } ], "properties": { "type": { "enum": [ "BUY", "SELL", "DEPOSIT", "WITHDRAWAL", "FEE", "INTEREST", "DIVIDEND", "REDEMPTION", "OTHER" ], "example": "BUY", "title": "TransactionType", "type": "string" } } }, "TransactionInstrument": { "properties": { "isin": { "description": "The isin of the instrument.", "example": "SE0005188836", "type": "string" }, "name": { "description": "The name of the instrument.", "example": "LF Global Indexnära", "type": "string" }, "priceInAccountCurrency": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The price of the instrument in the account currency." }, "type": { "description": "The type of the instrument (equity, fund, etc).", "enum": [ "EQUITY", "FUND", "UNKNOWN" ], "example": "FUND", "type": "string" } }, "title": "TransactionInstrument" }, "TwoFactorAuthenticationInstruction": { "description": "Instructions for two factor authentication. Add supplemental information to a collection if the `responseType` is not `NO_RESPONSE`.", "properties": { "authenticationInstruction": { "description": "Instructions text", "example": "Please authenticate with the following device: 's IPHONE 13", "type": "string" }, "responseType": { "description": "Expected response type", "enum": [ "NUMBER_CODE", "NO_RESPONSE", "PHONE_NUMBER", "QR_CODE" ], "example": "NUMBER_CODE", "type": "string" } }, "required": [ "authenticationInstruction", "responseType" ] }, "TwoFactorChoice": { "description": "A two factor code to be supplied to a collection. The collection will have status `TWO FACTOR PENDING` when a two factor code is expected from the user.", "properties": { "type": { "enum": [ "TWO_FACTOR_CHOICE" ], "example": "TWO_FACTOR_CHOICE", "type": "string" }, "value": { "description": "UUID of Selected Two factor method", "example": "2331690c-06ea-499b-a5b5-c719e253ce93", "type": "string" } }, "title": "TwoFactorChoice" }, "TwoFactorCode": { "description": "A two factor code to be supplied to a collection. The collection will have status `TWO FACTOR PENDING` when a two factor code is expected from the user.", "properties": { "type": { "enum": [ "TWO_FACTOR_CODE" ], "example": "TWO_FACTOR_CODE", "type": "string" }, "value": { "description": "Two factor code", "example": "A12345", "type": "string" } }, "title": "TwoFactorCode" }, "TwoFactorOption": { "description": "Available 2FA methods for this collection.", "properties": { "displayText": { "description": "text to display", "example": "Please supply the code sent to your iPhone 070******6", "type": "string" }, "type": { "description": "2FA type", "enum": [ "SMS", "APP", "APP_CODE", "EMAIL" ], "example": "APP", "type": "string" }, "uuid": { "description": "uuid for this option", "example": "7fbc80f0-870b-4d94-8a31-baf683780b79", "type": "string" } } }, "UnsecuredLoan": { "description": "Unsecured loan", "discriminator": { "mapping": { "parent": "#/components/schemas/FinancialProduct" }, "propertyName": "financial product type" }, "example": { "company": "se-company", "companyDisplayName": "Company", "firstDrawDownDate": "2020-02-29", "id": "6a7c135e-3a56-44ae-bc53-1d0d5321f552", "interest": { "rate": 0.0392 }, "loanDetails": { "balance": { "amount": 2000000, "currency": "SEK" }, "granted": { "amount": 3000000, "currency": "SEK" }, "paid": { "amount": 1000000, "currency": "SEK" } }, "loanId": "000047433123", "nextPayment": { "date": "2024-09-28", "instalment": { "amount": 5000, "currency": "SEK" }, "interest": { "amount": 7784, "currency": "SEK" }, "total": { "amount": 12784, "currency": "SEK" } }, "owners": [ { "name": "Karl Ekorrströmberg", "sharePercentage": 1 } ], "repaymentSchedule": { "finalDebt": 0, "finalPaymentDate": "2070-09-28", "numberOfInstalments": 50, "repaymentDayOfMonth": 30 }, "status": "IN_PROGRESS", "type": "UNSECURED_LOAN" }, "properties": { "company": { "description": " Company where the financial product has been collected from. Examples:\n `se-folksam`, `se-lansforsakringar`, `se-avanza`, `se-movestic`, `se-spp`, `se-nordea`,\n `se-amf`, `se-seb`, `se-alecta`, `se-nordnet`, `se-handelsbanken`, `se-futur`,\n `se-swedbank`, `se-skandia`, `se-ica-bank`, `se-danske-bank`.\n", "example": "se-company", "type": "string" }, "companyDisplayName": { "description": "Display name of the company for user-friendly presentation.", "example": "Company", "type": "string" }, "firstDrawDownDate": { "description": "The date the loan was paid out", "example": "2020-02-29", "type": "string" }, "id": { "description": "Insurely-generated unique identifier for this collection of the financial product. Randomly generated and not stable across collections — a new id is issued each time the product is collected, even for the same underlying account. Use this only as a handle within a single collection (e.g., to correlate holdings and transactions). Do not use it to recognize the same product over time; use the stable institution-assigned identifier on this product (e.g., `productNumber`, `accountNumber`, or `loanId`) for that.", "example": "6a7c135e-3a56-44ae-bc53-1d0d5321f552", "type": "string" }, "interest": { "$ref": "#/components/schemas/UnsecuredLoan_Interest" }, "loanDetails": { "$ref": "#/components/schemas/LoanDetails" }, "loanId": { "description": "The id of the loan from the source", "example": "000047433123", "type": "string" }, "nextPayment": { "$ref": "#/components/schemas/NextPayment" }, "owners": { "items": { "$ref": "#/components/schemas/LoanOwner" }, "type": "array" }, "repaymentSchedule": { "$ref": "#/components/schemas/RepaymentSchedule" }, "status": { "enum": [ "IN_PROGRESS", "PAID_UP", "CANCELLED", "UNKNOWN" ], "type": "string" }, "type": { "description": "Type of the financial product.", "enum": [ "KF", "ISK", "CUSTODY_ACCOUNT", "UNKNOWN_INVESTMENT_TYPE", "IPS_PENSION", "PRIVATE_PENSION", "OCCUPATIONAL_PENSION", "COLLECTIVE_OCCUPATIONAL_PENSION", "UNKNOWN_PENSION_TYPE", "MORTGAGE_LOAN", "UNSECURED_LOAN" ], "example": "ISK", "type": "string" } }, "required": [ "company", "id", "type" ], "title": "Unsecured loan", "x-tag": "Financial Product Type" }, "UnsecuredLoan_Interest": { "description": "Interest data points", "example": { "rate": 0.0392 }, "properties": { "rate": { "format": "double", "type": "number" } } }, "Wealth.Holding": { "properties": { "acquisitionValue": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The total cost incurred to acquire an asset." }, "feeVariable": { "description": "Yearly variable fee based on the value of the holding.", "example": 0.0015, "format": "double", "type": "number" }, "isin": { "description": "ISIN code of the holding.", "example": "SE0005188836", "type": "string" }, "marketIdentifierCode": { "description": "Unique identification code used to identify securities trading exchanges defined in ISO 10383", "example": "XSTO", "type": "string" }, "name": { "description": "Name of the holding.", "example": "LF Global Indexnära", "type": "string" }, "quantity": { "description": "Quantity of the asset held.", "example": 123.43, "format": "double", "type": "number" }, "type": { "description": "Type of the holding.", "enum": [ "EQUITY", "FUND", "UNKNOWN" ], "example": "EQUITY", "type": "string" }, "value": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Current valuation of the holding, calculated as the product of unit price and quantity." } }, "title": "Holding" }, "Wealth.OrganizationFinancialInformation": { "properties": { "employeeCount": { "description": "Number of employees in the organization.", "format": "int32", "type": "integer" }, "financialPeriod": { "$ref": "#/components/schemas/FinancialPeriod", "description": "Time period for which the information was fetched." }, "netIncome": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Net income for the specified period." }, "shareCapital": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Total share capital at the end of the period." }, "turnover": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Turnover during the specified period." } }, "title": "OrganizationFinancialInformation" }, "Wealth.PensionManagementInstitution": { "properties": { "name": { "description": "Name of the institution.", "example": "Collectum", "type": "string" }, "url": { "description": "Login URL for moving the pension.", "enum": [ "https://www.avtalat.se/logga-in/", "https://internetkontoret.fora.se/irj/portal/Privat", "https://valcentralen.se/Sec/BankID/Auth.aspx", "https://www.pensionsvalet.se/inloggning/", "https://spv.se/privatperson/statlig-tjanstepension/mina-sidor/" ], "example": "https://ik.collectum.se/privat/index.jsp", "type": "string" } }, "title": "PensionManagementInstitution" }, "WithdrawalTransaction": { "description": "A withdrawal from the account", "discriminator": { "mapping": { "parent": "#/components/schemas/Transaction" }, "propertyName": "transaction type" }, "properties": { "amount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The transaction amount." }, "description": { "description": "The description of the transaction.", "example": "Uttag", "type": "string" }, "settlementDate": { "description": "The date when the transaction was settled.", "example": "2024-01-01", "type": "string" }, "type": { "enum": [ "BUY", "SELL", "DEPOSIT", "WITHDRAWAL", "FEE", "INTEREST", "DIVIDEND", "REDEMPTION", "OTHER" ], "example": "WITHDRAWAL", "title": "TransactionType", "type": "string" } }, "title": "WithdrawalTransaction" } }, "securitySchemes": { "authorization-token": { "description": "Your API key. Requests are only accepted from IP addresses on the client's allowlist, and with a registered client certificate when mTLS is enforced for the client.", "in": "header", "name": "authorization-token", "type": "apiKey" }, "client-id": { "description": "Your client ID, as used by the Prebuilt UI. Server-to-server integrations authenticate with authorization-token instead.", "in": "header", "name": "client-id", "type": "apiKey" }, "jwt-token": { "bearerFormat": "JWT", "description": "A user session token, sent as `Authorization: Bearer `.", "scheme": "bearer", "type": "http" } } }, "info": { "contact": { "email": "tech@insurely.com", "name": "Insurely", "url": "https://insurely.com" }, "description": "", "termsOfService": "https://www.insurely.com/sv/privacy-policy", "title": "Insurely API", "version": "2024-06-01" }, "openapi": "3.1.0", "paths": { "/companies/availability": { "get": { "description": "Obtain a full list of companies available for your client, together with their current status, availability (functional or not) and available login methods.", "operationId": "getCompaniesStatus", "parameters": [ { "description": "The API version to use, as YYYY-MM-DD. Must match the version of the endpoint you are targeting. A request without it, or with a version older than the client's minimum API version, is served by the client's minimum API version.", "example": "2024-06-01", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2024-06-01" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/CompanyAvailability" }, "type": "array" } } }, "description": "Successful request." }, "429": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-429" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too many requests. Please retry with backoff." } }, "security": [ { "authorization-token": [] }, { "client-id": [] } ], "summary": "Get status and availability", "tags": [ "Company" ] } }, "/wealth/collection": { "post": { "description": "Initiate a pension/investment data collection for a specific individual. Calling this will trigger the selected login method.", "operationId": "initiateCollection", "parameters": [ { "in": "header", "name": "insurely-session-id", "required": false, "schema": { "type": "string" } }, { "description": "The API version to use, as YYYY-MM-DD. Must match the version of the endpoint you are targeting. A request without it, or with a version older than the client's minimum API version, is served by the client's minimum API version.", "example": "2024-06-01", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2024-06-01" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionRequestV5" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionStatusV5" } } }, "description": "Data collection successfully initiated." }, "400": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-400" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Invalid request (Possibly invalid personal number)." }, "401": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-401" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Invalid authorization token or the token specified is not allowed to collect information from the specified company." }, "403": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-403" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The client is not allowed to use this endpoint or resource." }, "429": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-429" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too many requests. Please retry with backoff." } }, "security": [ { "authorization-token": [] }, { "client-id": [] }, { "jwt-token": [] } ], "summary": "Initiate collection", "tags": [ "Wealth Data Collection" ] } }, "/wealth/collection/{collectionId}/add-contact-form-input": { "post": { "description": "Add required contact form input fields to a collection. The required input fields are sent as extraInformation in the status response message. The collection will have the status `CONTACT_FORM_PENDING` in this case.", "operationId": "addContactFormInput", "parameters": [ { "in": "path", "name": "collectionId", "required": true, "schema": { "type": "string" } }, { "description": "The API version to use, as YYYY-MM-DD. Must match the version of the endpoint you are targeting. A request without it, or with a version older than the client's minimum API version, is served by the client's minimum API version.", "example": "2024-06-01", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2024-06-01" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ContactFormInput" }, "type": "array" } } }, "required": true }, "responses": { "201": { "description": "Contact form input successfully added" }, "400": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-400" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "If status is not `CONTACT_FORM_PENDING` or the provided `ContactFormInput` array doesn't contain all expected fields." }, "401": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-401" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Invalid authorization token or the token specified is not allowed to add contact form input to the specified `collectionId`." }, "403": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-403" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The client is not allowed to use this endpoint or resource." }, "404": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-404" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "No collection with that ID exists for this client." }, "429": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-429" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too many requests. Please retry with backoff." } }, "security": [ { "authorization-token": [] }, { "client-id": [] } ], "summary": "Add collection contact form input", "tags": [ "Wealth Data Collection" ] } }, "/wealth/collection/{collectionId}/data": { "get": { "operationId": "getCollectionData", "parameters": [ { "in": "path", "name": "collectionId", "required": true, "schema": { "type": "string" } }, { "description": "The API version to use, as YYYY-MM-DD. Must match the version of the endpoint you are targeting. A request without it, or with a version older than the client's minimum API version, is served by the client's minimum API version.", "example": "2024-06-01", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2024-06-01" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/FinancialProduct" }, "type": "array" } } }, "description": "Pension data successfully fetched." }, "401": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-401" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication failed: the credentials are missing or invalid, the calling IP is not on the client's allowlist, or mTLS is enforced and no valid client certificate was sent. An expired session token gets 401 Token expired." }, "403": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-403" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The client is not allowed to use this endpoint or resource." }, "404": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-404" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "No collection with that ID exists for this client, the collection has expired or there was no data to fetch." }, "429": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-429" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too many requests. Please retry with backoff." } }, "security": [ { "authorization-token": [] }, { "jwt-token": [] } ], "summary": "Get collection data", "tags": [ "Wealth Data Collection" ] } }, "/wealth/collection/{collectionId}/skip": { "post": { "description": "Mark a collection as skipped by the user.", "operationId": "skipCollection", "parameters": [ { "in": "path", "name": "collectionId", "required": true, "schema": { "type": "string" } }, { "description": "The API version to use, as YYYY-MM-DD. Must match the version of the endpoint you are targeting. A request without it, or with a version older than the client's minimum API version, is served by the client's minimum API version.", "example": "2024-06-01", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2024-06-01" ], "type": "string" } } ], "responses": { "201": { "description": "Successfully marked as skipped." }, "401": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-401" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Invalid authorization token or disabled client." }, "403": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-403" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The authenticated external user does not have access to the collection." }, "404": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-404" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Collection not found for this client." }, "429": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-429" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too many requests. Please retry with backoff." } }, "security": [ { "authorization-token": [] }, { "client-id": [] }, { "jwt-token": [] } ], "summary": "Skip collection", "tags": [ "Wealth Data Collection" ] } }, "/wealth/collection/{collectionId}/status": { "get": { "description": "Returns the current status of an initiated collection of wealth data.", "operationId": "getCollectionStatus", "parameters": [ { "in": "path", "name": "collectionId", "required": true, "schema": { "type": "string" } }, { "description": "The API version to use, as YYYY-MM-DD. Must match the version of the endpoint you are targeting. A request without it, or with a version older than the client's minimum API version, is served by the client's minimum API version.", "example": "2024-06-01", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2024-06-01" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionStatusV5" } } }, "description": "Status successfully fetched." }, "401": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-401" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication failed: the credentials are missing or invalid, the calling IP is not on the client's allowlist, or mTLS is enforced and no valid client certificate was sent. An expired session token gets 401 Token expired." }, "403": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-403" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The client is not allowed to use this endpoint or resource." }, "404": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-404" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "No collection with that ID exists for this client, or the collection has expired." }, "429": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-429" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too many requests. Please retry with backoff." } }, "security": [ { "authorization-token": [] }, { "client-id": [] }, { "jwt-token": [] } ], "summary": "Get collection status", "tags": [ "Wealth Data Collection" ] } }, "/wealth/collection/{collectionId}/supplement-info": { "post": { "description": "Add supplemental information to a collection. See the extended section of SupplementInformation for what types of supplemental information that are supported.\n", "operationId": "addSupplementInformation", "parameters": [ { "in": "path", "name": "collectionId", "required": true, "schema": { "type": "string" } }, { "description": "The API version to use, as YYYY-MM-DD. Must match the version of the endpoint you are targeting. A request without it, or with a version older than the client's minimum API version, is served by the client's minimum API version.", "example": "2024-06-01", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2024-06-01" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplementInformation" } } }, "required": true }, "responses": { "201": { "description": "Successfully added supplemental information." }, "401": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-401" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Invalid authorization token or disabled client." }, "403": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-403" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The client is not allowed to use this endpoint or resource." }, "404": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-404" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Collection not found for this client." }, "429": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-429" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too many requests. Please retry with backoff." } }, "security": [ { "authorization-token": [] }, { "client-id": [] } ], "summary": "Add collection supplemental information", "tags": [ "Wealth Data Collection" ] } } }, "servers": [ { "description": "Production", "url": "https://api.insurely.com" }, { "description": "Test", "url": "https://api.test.insurely.com" } ], "tags": [ { "description": "Provides statuses of companies available for data collection", "name": "Company" }, { "description": "Initiate a collection of pension & investments data, see the status and get the data collected from the holder of pension data.", "name": "Wealth Data Collection" } ] }