# GET /v1/tpp/eidas

Archived documentation

This documentation refers to V1.6. See Release Notes for more information.

# Overview

This endpoint encompasses the TPP Checking Service that enables ASPSPs to check the identity and regulatory status of TPPs. This endpoint requires the eIDAS certificate of the TPP in question as input. It will run a number of checks on the certificate (check here for more information on these checks link) and check the appropriate NCA register for entries representing this TPP. The endpoint will return the result of the eIDAS certificate checks and the regulatory status and roles associated with the TPP.

https://sandbox.konsentus.com/v1/tpp/eidas

# Request Properties

# Headers

Authentication Headers

Authorization REQUIRED
string
Basic Auth Header
fi_reference_id REQUIRED
string
A string representing the FI authenticating with the system

eIDAS Certificate Headers

x-eidas REQUIRED
string
Base64 encoded eIDAS certificate

# Response Properties

data object
eIDAS object
Data about the eIDAS certificate
data object
validity object
Object containing eIDAS check results
validQTSP boolean
Is the eIDAS QTSP valid
validSignature boolean
Is the eIDAS signature valid
notRevoked boolean
Has the given eIDAS certificate been revoked
notExpired boolean
Has the eIDAS expired
values object
A reflection of the TPP auth number and QTSP names found on the certificate.
legalName string
The organisation name of the issuing QTSP that issued the certificate.
authNumber string
The authorisation number of the TPP (country code, NCA code and TPP id) found the eIDAS certificate
QTSP string
The common name of the issuing QTSP found on the eIDAS certificate.
registerEntries object
The list of entries within the Konsentus NCA database
data array<object>
TPP object
Data about a TPP
authorized string
The status of the TPP authorisation within the given NCA. The three available values are 'Authorised', 'Registered' and 'Unauthorised'
legalName string
The legal name of the TPP
commercialNames array<string>
The alternative commercial names of the TPP
roles array<string>
The roles of the TPP. The possible values are 7 (Payment Initiation Service Provider), 8 (Account Information Service Provider) and 5 (Issuing of payment instruments)
NCA object
Data about the NCA for the given TPP
name string
The name of the NCA
error object

        See error documentation for fields and descriptions

# Responses

# 200

Request success and TPP information returned.

{
  "data": {
    "eIDAS": {
      "data": {
        "validity": {
          "validQTSP": boolean,
          "validSignature": boolean,
          "notRevoked": boolean,
          "notExpired": boolean
        },
        "values": {
          "legalName": string,
          "authNumber": string,
          "QTSP": string
        }
      }
    },
    "registerEntries": {
      "data": [{
        "TPP": {
          "authorized": true,
          "legalName": string,
          "commercialNames": [string],
          "roles": [string]
        },
        "NCA": {
          "name": string
        }
      }]
    }
  }
}

# 401

Unable to Authorize.

{
  "errors": [{
    "id": string,
    "code": string,
    "title": string,
    "link": string
  }]
}

# 404

Request received missing parameters or malformed

{
  "errors": [{
    "id": string,
    "code": string,
    "title": string,
    "link": string
  }]
}

# Response Example

# 200 OK

Request success and TPP information returned.

{
  "data": {
    "eIDAS": {
      "data": {
        "validity": {
          "validQTSP": true,
          "validSignature": true,
          "notRevoked": true,
          "notExpired": true
        },
        "values": {
          "legalName": string,
          "authNumber": string,
          "QTSP": string
        }
      }
    },
    "registerEntries": {
      "data": [{
        "TPP": {
          "authorized": true,
          "legalName": string,
          "commercialNames": [string],
          "roles": [string]
        },
        "NCA": {
          "name": string
        }
      }]
    }
  }
}

Last Updated: 8/9/2019, 3:47:34 PM