List of accounts for a specified party and period. Must provide a blank list if there are no hits.
Abbreviations
| Abbreviations | Description | |
|---|---|---|
| M | Mandatory | Must be part of the response, even if there is no data. Not returning this field in the response can break the receiving API. |
| D | Deliver | Providers are obligated to deliver all requested data if they can*. If the data exists in the Producers systems and is possible to deliver through the API, it must be part of the response. If the data does not exist or cannot be delivered through the API, the field can be omitted. |
| MC | Mandatory conditional | - Child fields where Parent field is marked «M»(Mandatory) is crucial to give value to the Parent and must be delivered, even if there is no data. (See separate description for how to return empty or no data in fields.) Not returning this field in the response can break the receiving API. - As long as a parent field marked with “D” is part of the response, the child field marked with “MC” must also be returned. |
| O | Optional | Only used in input parameters |
*If the data provider cannot deliver all requested data through Control API, but have more data offline, responseDetails.status must return value “partial” and a reason must be returned in responseDetails.message.
Input parameters
Values set by data consumer.
It is the data providers responsibility to validate all requests from the data consumers and to make sure that all requests are validated well enough. See some recommendations regarding validation of requests in Control API.
| Parameter | Description | Comment |
|---|---|---|
| AccountInfoRequestID (M) | Consumers case reference id/number | Link to Overall description of the DSOP Control API |
| CorrelationID (M) | Unique identifier for the technical request | Link to Overall description of the DSOP Control API |
| Legal-Mandate* (M) | Legal basis the data provider should validate. Formatted encoded text. | See the specific DSOP Service documentation for the valid legal-mandates |
| PartyID (M) | Identifier for the control object (personal identification number, D-number or organization number). | - |
| AdditionalReferenceID* (O) | Reference ID when Legal-Mandate is not adequate alone, or to identify requester at consumer. Should be validated according to the Legal-Mandate. Formatted encoded text. | Required for some DSOP Services. More information in More information in Overall description of the DSOP Control API |
| AdditionalReferenceIDType* (O) | What type of reference to expect in AdditionalReferenceID | Required for some DSOP Services. More information in More information in Overall description of the DSOP Control API |
| RequesterID (O) | RequesterID identifies the user who makes the request at the public agency. The public agencies are free to pseudonymise RequesterID so that the financial institutions cannot link this ID to the agency’s user or natural person. In turn, the public agency must be able to link RequesterID to a user in the public agency. It is important that RequesterID remains constant per user and is not reused for new users. | Even though this parameter is technically optional, it could become logically mandatory for a given DSOP service. |
| OnlyPrimaryOwner (M) | TRUE: endpoint will return a list of accounts where PartyID is primary owner FALSE: endpoint will return a list of accounts where PartyID has a customer relation, either primary owner, secondary owner or other role to the account(s). |
Specific to each DSOP Service. |
| fromDate (O) | From date, current date if not stated | |
| toDate (O) | To date, current date if not stated |
*It is recommended to validate AdditionalReferenceID and AdditionalReferenceIDType according to the Legal-Mandate.
Responses
Values in response from data providers.
All fields are to be provided as long as the data provider holds the data, regardless of whether the fields are marked as mandatory or not. This is according to the legal basis.
Description of all response elements in the API
responseDetails
Deliver
responseDetails.status
Deliver
Indicates whether this is a complete answer, or whether there is data offline that cannot be retrieved through the API.
- partial: If there is any data in the producers systems that can be retrieved manually and is not part of the API response, or if the provider wishes to be contacted via another channel by the consumer.
- complete: If there is no more available data that can be retrieved manually. All known data has been returned in the response.
responseDetails.status is not to be used as an indicator for paginating.
| [partial, complete] |
responseDetails.message
Deliver
In case of responseDetails.status partial, responseDetails.message indicates the reason why not all data has been delivered through the API in order to inform the data consumers about the situation, and enable them to decide if it is necessary to send a digital letter to the Data provider or not. A description of the different messages to return is available in the document DSOP Control - Functional specification - 2024-03-06 - Messages in relation with partial.pdf.
accounts
Deliver
accounts.status
Deliver
Indicates the current status of an account
- enabled: Any status of the account where a party can use the balance.
- disabled: Any status of an account where no party can use the account, either temporarily or permanently. The account balance and properties are still available for viewing and listing. Accounts blocked due to bankruptcy shall return the value disabled.
- deleted: Any status of an account where the account, balance and properties are no longer available at all.
| [enabled, disabled, deleted] |
accounts.servicer
Deliver
Financial institution.
accounts.servicer.identifier
Mandatory conditional
accounts.servicer.identifier.countryOfResidence
Deliver
CountryCode. The country the financial institution belongs to. From ISO 3166-1/Alpha-2 code.
accounts.servicer.identifier.value
Mandatory conditional
Organization number of the financial institution.
accounts.servicer.identifier.type
Mandatory conditional
- countryIdentificationCode: The national registration code for businesses, enterprise, organizations and companies that is retrieved from the National register for organizations. In Norway this would be from BRREG.
- nationalIdentityNumber: Used for persons. The national identitycode for persons. In Norway this would be P or D numbers from FREG.
| [countryIdentificationCode, nationalIdentityNumber] |
accounts.servicer.name
Deliver
Name of the financial institution.
accounts.accountIdentifier
Mandatory conditional
Account number.
accounts.accountReference
Mandatory conditional
A unique reference to the account, but should not be the account number and not simply decoded to an account number.
accounts.type
Deliver
All accounts/products for a bank must be mapped into one of the account types that are stated in this list below:
- loanAccount: Account for funds borrowed by a financial institution to the party.
- salaryAccount: Account for funds used on an ongoing basis by a person.
- currencyAccount: Account for settlements and transactions in a fixed foreign currency.
- savingsAccount: Account for funds used for savings.
- clientAccount: Account for client funds (keeping clients funds separate from those of the business).
- taxDeductionAccount: Account for funds used to pay advance tax for employees.
- businessAccount: Account for funds that are used on an ongoing basis by a company / business.
- creditCardAccount: Account for funds used by credit cards.
- prepaidCardAccount: Account for funds used by a prepaid card.
- accountWithoutBalance: Account types without balance and usually not registered in KAR. Includes some CashPool and depot accounts as well as some others.
- otherAccount: other type of account that cannot be grouped into the other ten categories or unknown type of account from legacy systems.
Note: All account types that are or have been registered with the bank must be grouped into the eleven valid values listed above.
| [loanAccount, salaryAccount, currencyAccount, savingsAccount, clientAccount, taxDeductionAccount, businessAccount, creditCardAccount, prepaidCardAccount, accountWithoutBalance, otherAccount] |
accounts.currency
Deliver
CurrencyCode ISO Standard 4217.
accounts.primaryOwner
Deliver
Party (person or organization) who owns the account at the end date of the requested period, limited to the period the requested party had a role against the account.
accounts.primaryOwner.permission
Deliver
Specifies the type of role/right the party has for an account.
- rightToUseAlone: Can issue transactions changing the balance of the account on their own.
- rightToUseWithOther: Can only issue transactions changing the balance of the account together with other party.
- rightToSeeOnly: Can only view account details, but not issue transactions.
| [rightToUseAlone, rightToUseWithOther, rightToSeeOnly] |
accounts.primaryOwner.identifier
Deliver
accounts.primaryOwner.identifier.countryOfResidence
Deliver
CountryCode. The country the party belongs to. In ISO 3166-1/Alpha-2 code format.
accounts.primaryOwner.identifier.value
Mandatory conditional
Personal identification number, D-number or organization number.
accounts.primaryOwner.identifier.type
Mandatory conditional
| [ countryIdentificationCode, nationalIdentityNumber ] |
accounts.primaryOwner.name
Deliver
Name of the party that owns the account.
accounts.primaryOwner.startDate
Deliver
Start date for when the party gained their rights as an account owner. This is the last period to be specified if the account is closed and re-opened. ISODate (yyyy-mm-dd).
accounts.primaryOwner.endDate
Deliver
End date for when the party lost their rights as an account owner. This is the last period to be specified if the account is closed and re-opened. No end date if the party is still the owner of the account. ISODate (yyyy-mm-dd).
accounts.name
Deliver
Primary owner’s reference name for the account, if any.
links
Deliver
links.rel
Mandatory conditional
Paginating as in; next, self, prev, last.
links.href
Mandatory conditional
Paginating, Link to page.
Change log
| Date | Version | Change |
|---|---|---|
| 20.03.24 | 2.0 | New version of the DSOP Control API generating extensive changes throughout all documentation. |
| 03.05.23 | 1.2 | Added data model for V.1.2, includes responseDetails |