# GET /v1/psp/eidas

# Overview

This endpoint encompasses the PSP Checking Service that enables ASPSPs to verify the identity and regulatory status of PSPs. This endpoint requires the eIDAS certificate of the PSP you want to get regulatory status of and the jurisdiction of the transaction. It will run a number of checks on the certificate (check here for more information on these checks) and check the appropriate NCA register for entries representing this PSP. The endpoint will return the result of the eIDAS certificate checks and the regulatory status and roles associated with the PSP.

When calling this endpoint you will be asked to provide a Transaction Jurisdiction. This field represents the country where the financial transaction took place and will determine which regulator (or regulators) Konsentus will check. If the Transaction Jurisdiction is the same as the PSPs home country then Konsentus will check only the home regulator. If the Transaction Jurisdiction is different from the PSPs home country then Konsentus will check the PSP with its home regulator and the regulator of the country that transaction took place in. When populating the Transaction Jurisdiction field, the two letter country code should be in the list of valid Transaction Jurisdictions to identify where the transaction took place.

For details on our passporting logic follow this link

https://sandbox.konsentus.com/v1/psp/eidas?jurisdiction=

# Request Properties

# Headers

Authorization REQUIRED
string
Basic Auth Header
fi_reference_id REQUIRED
string
A string representing the FI authenticating with the system
version REQUIRED
string
A string representing version of the API you are using
eidas REQUIRED
string
Base64 encoded eIDAS certificate

Further information is available on Authentication Headers, eIDAS Certificates and Version Header.

# Query Parameters

jurisdiction REQUIRED
string
Two letter country code indicating where the FI is holding the customer’s account, for example a customer account held in Britain would use the jurisdiction code GB

# Response Properties

eIDAS object
Data about the eIDAS certificate
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
data string
eIDAS certificate information
QTSPCommonName string
Common name of the QTSP found on the eIDAS certificate
authNumber string
Auth number of the PSP found on the eIDAS certificate
pspSubjectName string
Subject name of the PSP found in the eIDAS certificate
warning array<string>(optional)
Information indicating why categoryEntries could be false
homeRegister object
Details of the PSP from its home register
ncaName string
Name of the NCA
ncaCountryCode string
Capitalised country code of the NCA
registerType string
Indicates if the record is from the home or a host register
categoryEntries array<object>
Payment services categories of PSP
categoryName string
Payment services category name. See the register categories page for more information on categories.
pspLegalName string
Legal name of the PSP found in the register entry
pspAuthStatus string
Status of the PSP authorisation within the given NCA. The three available values are 'Authorised', 'Registered' and 'Unauthorised'
pspPaymentServices array<number>
Payment services that PSP can perform in home register
passportOut object(optional)
Information about payment services that the PSP can perform in the specified country
countryCode string
Capitalised country code that the PSP can perform services in
paymentServices array<number>
List of payment services that the PSP can perform in the specified country
warning array<string>(optional)
Information indicating why categoryEntries could be empty
hostRegister object(optional)
Details of the PSP from a host register
ncaName string
Name of the NCA
ncaCountryCode string
Capitalised country code of the NCA
registerType string
Name of the NCA
categoryEntries array<object>
Payment services categories of PSP
categoryName string
Payment services category name. See the register categories page for more information on categories.
pspLegalName string
Legal name of the PSP found in the register entry
pspAuthStatus string
Authorisation status in their register
passportIn object(optional)
Specifies the PSPs home register.
countryCode string
Capitalised two letter country code of the PSPs home register.
warning array<string>(optional)
Information indicating why categoryEntries could be empty
errors array<object>

        See error documentation for fields and descriptions

# Responses

# 200

Request success and PSP information returned.

{
  "eIDAS": {
    "validity": {
      "validQTSP": boolean,
      "validSignature": boolean,
      "notRevoked": boolean,
      "notExpired": boolean
    },
    "data": {
      "QTSPCommonName": string,
      "authNumber": string,
      "pspSubjectName": string
    }
  }
  "homeRegister": {
    "ncaName": string,
    "ncaCountryCode": string,
    "registerType": string,
    "categoryEntries": [
      {
        "categoryName": string,
        "pspLegalName": string,
        "pspAuthStatus": string,
        "pspPaymentServices": [number]
      }
    ],
  }
}

# 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
  }]
}

# Passporting Response Examples

# 200 OK - Scenario 1: Home Register Check

A check is requested on a PSP who is attempting a transaction in their home country. In this scenario the response is the PSP's entry from their home register.

Sample Request:

Auth Number (from eIDAS certificate)

PSDGB-FCA-010101

Transaction Jurisdiction

GB

Sample Response:

{
  "eIDAS": {
    "validity": {
      "validQTSP": true,
      "validSignature": true,
      "notRevoked": true,
      "notExpired": true
    },
    "data": {
      "QTSPCommonName": "QTSP Common Name on certificate",
      "authNumber": "PSDGB-FCA-010101",
      "pspSubjectName": "PSP Subject Name on certificate"
    }
  },
  "homeRegister": {
    "ncaName": "FCA",
    "ncaCountryCode": "GB",
    "registerType": "Home",
    "categoryEntries": [
      {
        "categoryName": "Payment Institution",
        "pspLegalName": "PSP Legal Name",
        "pspAuthStatus": "Authorised",
        "pspPaymentServices": [1, 2, 3, 4, 5, 6]
      }
    ],
  }
}

# 200 OK - Scenario 2: Host Register Check

A check is requested on a PSP who is attempting a transaction in a country which is different to their home country. In this scenario the response is the PSP's entry in their home register (including payment services they provide in the specified host country) alongside the entry for the specified host country.

For details on our passporting logic follow this link

Sample Request:

Auth Number (from eIDAS certificate)

PSDGB-FCA-010101

Transaction Jursidiction

FR

Sample Response:

{
  "eIDAS": {
    "validity": {
      "validQTSP": true,
      "validSignature": true,
      "notRevoked": true,
      "notExpired": true
    },
    "data": {
      "QTSPCommonName": "QTSP Common Name on certificate",
      "authNumber": "PSDGB-FCA-010101",
      "pspSubjectName": "PSP Subject Name on certificate"
    }
  },
  "homeRegister": {
    "ncaName": "FCA",
    "ncaCountryCode": "GB",
    "registerType": "Home",
    "categoryEntries": [
      {
        "categoryName": "Payment Institution",
        "pspLegalName": "PSP Legal Name",
        "pspAuthStatus": "Authorised",
        "pspPaymentServices": [1, 2, 3, 4, 5, 6],
        "passportOut": {
          "countryCode": "FR",
          "paymentServices": [1, 2, 3, 4, 5]
        }
      }
    ]
  },
  "hostRegister": {
    "ncaName": "ACPR",
    "ncaCountryCode": "FR",
    "registerType": "Host",
    "categoryEntries": [
      {
        "categoryName": "Payment Institution",
        "pspLegalName": "PSP Legal Name",
        "pspAuthStatus": "Authorised",
        "passportIn": {
          "countryCode": "GB"
        }
      }
    ]
  }
}

# 200 OK - Scenario 3: PSP in multiple categories on a register

A check is requested on a PSP who is attempting a transaction in their home country and is registered under multiple categories (payment institution, e-money institutions etc) on an NCA register. In this scenario the response is the PSP's entry from their home register with all of the categories they are registered under.

Sample Request:

Auth Number (from eIDAS certificate)

PSDGB-FCA-010101

Transaction Jursidiction

GB

Sample Response:

{
  "eIDAS": {
    "validity": {
      "validQTSP": true,
      "validSignature": true,
      "notRevoked": true,
      "notExpired": true
    },
    "data": {
      "QTSPCommonName": "QTSP Common Name on certificate",
      "authNumber": "PSDGB-FCA-010101",
      "pspSubjectName": "PSP Subject Name on certificate"
    }
  },
  "homeRegister": {
    "ncaName": "FCA",
    "ncaCountryCode": "GB",
    "registerType": "Home",
    "categoryEntries": [
      {
        "categoryName": "E-Money Institution",
        "pspLegalName": "PSP Legal Name",
        "pspAuthStatus": "Authorised",
        "pspPaymentServices": [1, 2, 3, 4, 5, 6]
      },
      {
        "categoryName": "Credit Institution",
        "pspLegalName": "PSP Legal Name",
        "pspAuthStatus": "Authorised",
        "pspPaymentServices": [1, 2, 3, 4, 5, 6, 7, 8]
      }
    ]
  }
}

# 200 OK - Scenario 4: No record of PSP in host register

A check is requested on a PSP who is attempting a transaction in a country that is not their home country. While there is a record of the PSP in their home register the host register does not have a record of it. In this scenario the response is the PSP's entry from their home register as expected, alongside a warning that the PSP could not be found in the host register.

Sample Request:

Auth Number (from eIDAS certificate)

PSDGB-FCA-010101

Transaction Jursidiction

DE

Sample Response:

{
  "eIDAS": {
    "validity": {
      "validQTSP": true,
      "validSignature": true,
      "notRevoked": true,
      "notExpired": true
    },
    "data": {
      "QTSPCommonName": "QTSP Common Name on certificate",
      "authNumber": "PSDGB-FCA-010101",
      "pspSubjectName": "PSP Subject Name on certificate"
    }
  },
  "homeRegister": {
    "ncaName": "FCA",
    "ncaCountryCode": "GB",
    "registerType": "Home",
    "categoryEntries": [
      {
        "categoryName": "Payment Institution",
        "pspLegalName": "PSP Legal Name",
        "pspAuthStatus": "Authorised",
        "pspPaymentServices": [1, 2, 3, 4, 5, 6],
        "passportOut": {
          "countryCode": "DE",
          "paymentServices": [1, 2, 3, 4]
        }
      }
    ]
  },
  "hostRegister": {
    "ncaName": "BaFin",
    "ncaCountryCode": "DE",
    "registerType": "Host",
    "categoryEntries": [],
    "warning": ["The PSP <PSP Legal Name> could not be found in the <NCA Name> register"]
  }
}

# 200 OK - Scenario 5: No record of PSP in any register

A check is requested on a PSP who is attempting a transaction in their home country. In this scenario the response is a warning that no PSP was found in the home register.

Sample Request:

Auth Number (from eIDAS certificate)

PSDGB-FCA-010101

Transaction Jursidiction

GB

Sample Response:

{
  "eIDAS": {
    "validity": {
      "validQTSP": true,
      "validSignature": true,
      "notRevoked": true,
      "notExpired": true
    },
    "data": {
      "QTSPCommonName": "QTSP Common Name on certificate",
      "authNumber": "PSDGB-FCA-010101",
      "pspSubjectName": "PSP Subject Name on certificate"
    }
  },
  "homeRegister": {
    "ncaName": "FCA",
    "ncaCountryCode": "GB",
    "registerType": "Home",
    "categoryEntries": [],
    "warning": ["Could not find a register entry for PSP <eIDAS Auth Number>"]
  }
}
Last Updated: 11/21/2019, 2:47:43 PM