EPC164-22 v2.0 API Security Framework
EPC164-22 v2.0 API Security Framework
Framework
EPC164-22
Version 2.0
Date issued: 31 October 2024
Public
Approved
www.epc-cep.eu 1 / 20
API Security Framework
31 October 2024
Table of Contents
1. Document information .......................................................................................................3
1.1. References ......................................................................................................................... 3
1.2. Defined terms or abbreviations ......................................................................................... 3
1.3. Background ........................................................................................................................ 5
2. Scope .................................................................................................................................7
3. Actors and Roles .................................................................................................................8
3.1. Operational Scheme Manager ........................................................................................... 8
3.2. SPAA scheme – Actors and Roles ...................................................................................... 8
3.3. SRTP Scheme – Actors and Roles ....................................................................................... 8
3.4. VOP Scheme – Actors and Roles ........................................................................................ 8
4. Identification ......................................................................................................................9
4.1. API server/API client .......................................................................................................... 9
4.2. API client Customer (dedicated to SPAA scheme) ............................................................. 9
4.3. Scheme Participants Identification requirements ............................................................. 9
5. Scheme Participants Information requirement .................................................................. 11
6. Scheme Participants Authentication requirements ............................................................ 11
7. Secured communication between Scheme Participants requirements ............................... 11
8. Authorisation requirements .............................................................................................. 11
8.1. Client authorisation principles......................................................................................... 11
8.2. Schemes closed access with client authentication .......................................................... 12
8.2.1. Mandatory Basic approach ......................................................................................... 12
8.2.2. Additional Optional optimised approach..................................................................... 13
8.3. API server identification and authorisation ..................................................................... 13
9. Scheme Participants sealing/signing requirements ............................................................ 14
10. Availability requirements .................................................................................................. 14
11. Security conformance and testing ..................................................................................... 14
12. Audit trail requirements ................................................................................................... 14
13. Operational Scheme Manager (OSM) related requirements .............................................. 15
Annex 1: SPAA scheme specificities .......................................................................................... 16
Annex 2: SRTP scheme specificities ........................................................................................... 17
Annex 3: VOP scheme specificities ............................................................................................ 18
www.epc-cep.eu 2 / 20
API Security Framework
31 October 2024
1. Document information
1.1. References
This section lists documents referred to in this document. The convention used throughout is to
provide the reference number only, in square brackets. Use of square brackets throughout is
exclusively for this purpose.
Document
Title Issued by:
Number
To be
[5] EDS User Guide EPC
defined
www.epc-cep.eu 3 / 20
API Security Framework
31 October 2024
www.epc-cep.eu 4 / 20
API Security Framework
31 October 2024
1.3. Background
The use of APIs for the exchanges between scheme Participants will be either mandatory or a
feasible option, depending on the EPC schemes.
Since API related security matters are essential and support the actual API exchange, the purpose
of this document is to define an API security framework based on widely available European or
international security standards, listing the minimum-security related requirements applicable,
regardless of the scheme, to scheme Participants using APIs.
The schemes in the current scope are SRTP, SPAA and VOP.
These schemes may rely on a directory service, called EPC Directory Service (EDS), managed by the
Operational Scheme Manager (OSM). The registration in and the use of the EDS is under the
responsibility of each scheme. Refer to the EDS User Guide [5] for further details.
The security requirements are independent of the API functionality and technical implementation
and are applicable to all the schemes using API’s and to all the API specifications (market or EPC)
used by a scheme Participant, whether the scheme Participant chooses to send and receive
messages directly, or whether it chooses to use mutualised services of a Proxy (technical solution
provider) acting as a message gateway.
The SPAA, SRTP and VOP schemes are all managed by the EPC and were designed to use APIs for
the communication between scheme Participants. Although there are some differences related to
how the schemes operate, as well as a difference in maturity between them, and differences in
naming the Participants and stakeholders, they are sufficiently similar as messaging schemes to
justify a joint effort in defining a common API security framework.
Wherever there is a difference in a scheme that justifies a different approach in the security
framework, that difference will be highlighted.
www.epc-cep.eu 5 / 20
API Security Framework
31 October 2024
Note:
The capitalized keywords "MUST", “MAY", "SHOULD" and their variants, should be interpreted as
defined in RFC 2119 [4].
www.epc-cep.eu 6 / 20
API Security Framework
31 October 2024
2. Scope
For the details related to the schemes in scope of this document (i.e., the SPAA, the SRTP and the
VOP schemes), please refer to their respective rulebook ([1], [2], [3]).
The purpose of this document is to describe the requirements of an API Security Framework,
including:
• The security-related requirements based on widely available European or international
security standards. The recommended security measures shall be proportionate and
affordable.
• The list of operational requirements that an Operational Scheme Manager (OSM) should
provide to ensure a smooth functioning of the framework.
The requirements laid out in this framework only relate to the interaction between the scheme
Participants. The interaction between the scheme Participants and their customers as well as
between the scheme Participants and the EDS is outside the scope of the framework.
The specifications of these requirements will be the responsibility of each API specification that
uses them. In the case of SPAA that would be any API initiative defining a technical specification of
the SPAA Scheme Rulebook. In the case of the SRTP and VOP schemes, it would be the
responsibility of each scheme respectively to define the content for its own API specifications. In
addition, the SRTP scheme shall define the scope of the homologation process related to the
below requirements. It is also possible that different API initiatives define the content of other API
specifications for SRTP or VOP. In any case, none of those specifications will be a part of this
document.
The integration of each specification of the requirements laid out in this framework will be a
responsibility of the scheme for which those specifications are intended. Furthermore, the
obligation to implement any given specification by a scheme Participant, will also be the
responsibility of each scheme.
Although most of the requirements are common and applicable to all schemes, there are some
specificities for each of the schemes that will be indicated accordingly.
The requirements in this document are about securing the API itself as an “envelope”, not about
securing each piece of information inside each individual message exchanged through the API.
Messages may contain information that could lead to fraud if insufficiently secured, such as a
Payee’s IBAN. If such information, inside messages, is to be protected, it is the role of Schemes to
describe how. The current framework will only ensure that the messages flow correctly between
identified, authenticated and authorised Participants, ensuring confidentiality, and that the
content of the message was not tampered with in transport. The framework does not look at the
content of the messages.
As indicated above, this version of the document includes details for the SPAA, SRTP and VOP
schemes. In case other schemes would introduce new APIs, the document will be revised and
updated accordingly.
www.epc-cep.eu 7 / 20
API Security Framework
31 October 2024
www.epc-cep.eu 8 / 20
API Security Framework
31 October 2024
4. Identification
4.1. API server/API client
The SRTP/SPAA related API specifications cover the SRTP/SPAA related messages exchanged
between the Payee’s SRTP Service Provider/ Asset Broker and the Payer’s SRTP Service
Provider/Asset Holder, in both directions. The two technical roles being API client or API server
depending on the situation. Since some interactions may not be completed synchronously, a call
back possibility has been set to send back asynchronous responses.
In the VOP scheme, the Responding PSP provides the API server and the Requesting PSP has the
API client role. As clarified above, an RVM can operate one or either of these roles on behalf of the
PSP.
The following table provides an overview of the role of the Participants for each of the Schemes:
www.epc-cep.eu 9 / 20
API Security Framework
31 October 2024
API server
The API server does not need a QWAC, it can use a standard website certificate. To ensure a
sufficient high level of authentication, an EV TLS certificate is required.
Remarks
• It is possible that a Participant in an API server role uses the same certificate as API client for
call-backs. In this case the field extendedKeyUsage in the certificate SHALL contain both
attributes clientAuth and serverAuth.
• The scheme Participants should be able to receive, and act upon, the broadcasted emergency
messages issued by the OSM.
1
A QWAC PSD2 certificate already owned by a Participant may be reused
www.epc-cep.eu 10 / 20
API Security Framework
31 October 2024
8. Authorisation requirements
8.1. Client authorisation principles
Authorisation is the process by which an API server will decide to allow or deny an API client
request. In case of denial, the API server will answer with an HTTP 403 (Forbidden) response.
www.epc-cep.eu 11 / 20
API Security Framework
31 October 2024
The URI requested by an API client may be subject to different access modalities for scheme
Participants:
1. All schemes apply a closed access model to the API with authentication
- A prerequisite registration of the API client with the scheme is mandatory and subject to
some conditions.
- The registration conditions of an API client may include:
o A participation to a scheme (e.g.: SRTP, VOP, SPAA).
o Registration in a directory (e.g.: EDS for VOP).
o For SPAA, following additional conditions for the registration of the API client apply:
▪ A contractual relationship between both legal entities, on API client and API
server sides (currently only applicable to the SPAA scheme) must exist.
▪ A legal role, e.g.: PISP, AISP roles as specified by PSD2 (currently only applicable
to the SPAA scheme) must be defined.
- The API client must authenticate when accessing the server’s URI.
For SPAA, closed access with authentication and explicit authorisation applies: the API
client must also get the consent from the data owner. The consent could for example
result in the provision of an authorisation token to the API client, for instance using
OAuth2 (RFC 6749).
In these cases, the registration will be subject to the participation of the API client to the relevant
EPC scheme. In the case of the SPAA Scheme, this registration must be completed by the PISP role
of the API client.
The last step is critical to avoid an unauthorised access, for instance to a resource that was
submitted by another API client:
- A SEPA Request-To-Pay or a Cancellation Request in case of SRTP
- A Payment Initiation Request in case of SPAA
www.epc-cep.eu 12 / 20
API Security Framework
31 October 2024
As the whole authorisation process may be repeatedly executed by the API server for each API
client request, it is also possible to optimise this process through a pre-enrolment of the API client.
The pre-enrolment process will usually provide the API client with a client id that is linked to the
usage context specified by the provided information. If needed, an API client may execute, with
the same API server, several pre-enrolments for different specialised usage contexts.
An example for an enrolment protocol is proposed by the IETF in the OAuth2 context (RFC 7591 &
7592).
Client id usage
The client id may be used to get an authorisation token, for instance using OAuth2 (RFC 6749).
The API server can execute some of the authorisation steps at once before providing the
authorisation token to the API client.
www.epc-cep.eu 13 / 20
API Security Framework
31 October 2024
www.epc-cep.eu 14 / 20
API Security Framework
31 October 2024
www.epc-cep.eu 15 / 20
API Security Framework
31 October 2024
www.epc-cep.eu 16 / 20
API Security Framework
31 October 2024
www.epc-cep.eu 17 / 20
API Security Framework
31 October 2024
www.epc-cep.eu 18 / 20
API Security Framework
31 October 2024
As Requesting PSP
• Case 1: directly connected PSP
- Each PSP operates its own responding API gateway, exposing its QWAC PSD2 certificate
Key in EDS (BIC11) Identifier in client certificate
ABCDLLCC123 ID-ABCD-12345
EFGHLLCC123 ID-EFGH-67890
2
We only mention the URI scheme (‘https’) and URI host; to obtain the full URI, the API resource path will be added
but as this is a fixed text (‘vop/v1/payee-verifications’), it is not mentioned in the table. Example of a full API URI:
'https://api.EFGH.com/vop/v1/payee-verifications'.
www.epc-cep.eu 19 / 20
API Security Framework
31 October 2024
www.epc-cep.eu 20 / 20