List of account owners associated with the specified account and period.
The principles are defined in Principles for delivery of information via DSOP Control information common standard.
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 |
|---|---|---|
| accountID (M) | Account number to be investigated. | - |
| 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 providers should validate. Formatted encoded text. | See the specific DSOP Service documentation for the valid legal mandates |
| KID (O) | Identificator related to a person for collection accounts. | Required when the account number is a collection account. |
| 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. |
| fromDate (M) | Date (included) from which the time period for the data delivery starts. | - |
| toDate (M) | Date (included) from which the time period for the data delivery ends. | - |
*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.
| Value | Level 1 | Level 2 |
|---|---|---|
| responseDetails (D) | ||
| responseDetails.status (D) | ||
| responseDetails.message (D) | ||
| accountOwners (D) | ||
| accountOwners.accountownerID (MC) | ||
| accountOwners.IDtype (MC) | ||
| accountOwners.name (D) |
Description of all response elements in the API
responseDetails
Deliver
Status that informs the data consumer of the degree of completeness of the response from the data provider.
responseDetails.status
Deliver
Indicates whether the data delivery is a complete answer, or whether there is data offline the data provider is aware of that cannot be retrieved through the API.
- partial: If there is any data the data provider is aware of 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 the data provider is aware of 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 must be used and will indicate 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 - Messages in relation with partial.pdf.
accountOwners
Deliver
Overview of all the account owners (person or organization) to the specified account number during the requested time period.
accountOwners.accountownerID
Deliver
Personal identification number, D-number or organization number.
accountOwners.IDtype
Deliver
- 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.
accountOwners.name
Deliver
Name of the person or organization that is / was account owner in the time period.
Change log
| Date | Change |
|---|---|
| xx.xx.26 | Introduction of the new endpont, Owners in the DSOP Control API v.2.1. |