{"openapi":"3.0.0","info":{"title":"Konsentus API","version":"0.0.1"},"servers":[{"url":"https://sandbox.konsentus.com/"}],"paths":{"/v1/psp/eidas":{"get":{"summary":"Returns regulatory data based for a PSP based on a passed eIDAS certificate.","security":[{"basicAuth":[]}],"tags":["PSP Checking Service"],"parameters":[{"in":"header","name":"fi_reference_id","required":true,"description":"A string representing the FI authenticating with the system.","schema":{"type":"string"}},{"in":"header","name":"transaction_reference","required":false,"description":"This is an optional custom transaction reference that can be used for tracking when performing an audit.","schema":{"type":"string"}},{"in":"header","name":"version","required":true,"description":"A string representing version of the API you are using.","example":"latest","schema":{"type":"string"}},{"in":"header","name":"eidas","required":true,"description":"The eIDAS certificate used for authorization of the PSP, for example values [see documentation](https://developers.konsentus.com/api-reference/endpoints/eidas-scenarios.html).","example":"MIIEvzCCA6egAwIBAgIUbXNfMDC1ro/nCnzxRDJzDgM2TgcwDQYJKoZIhvcNAQELBQAwdDELMAkGA1UEBhMCR0IxDzANBgNVBAkMBkxvbmRvbjEbMBkGA1UEAwwSS29uc2VudHVzIFFUU1AgLSAxMRswGQYDVQQKDBJLb25zZW50dXMgUVRTUCAtIDExGjAYBgNVBAsMEUtvbnNlbnR1cyBUZXN0aW5nMCAXDTIwMDMwNDEzNTYzN1oYDzIxMjAwMjEwMTM1NjM3WjCBjjELMAkGA1UEBhMCR0IxDzANBgNVBAkMBkxvbmRvbjEaMBgGA1UEAwwRS29uc2VudHVzIFBTUCAtIDExGjAYBgNVBAoMEUtvbnNlbnR1cyBQU1AgLSAxMRowGAYDVQQLDBFLb25zZW50dXMgVGVzdGluZzEaMBgGA1UEYQwRUFNEWFgtVEVTVC0wMDAwMDEwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCt1HJp5QfE+VIAuaZPj5UulknqrXMWxb5oqag0SszlP8t70l8Szmt+7UiLNpCjYjcA6qpeP6Mo06CpWJFqcIZpigZJUDQcsCQHpe+6JwJf6wjmse23/fM4/HFUYglYmdiwrmQQ9TuVCvJABaDeUsWPJY8ONeaLOJ1kMtEL9dml2EI0rb7+YBQT9Yc7j7Jt3WCWSJdzn5d+NzflKbt6iYutVt76zUqko9bRmyxNKyvjU/y+lrOtcTSdbm7nWoYTrrVkcHGIp7jtnwe22Vwz512s2ISa/HPI4eJkJ8HlvrlL+K859drVooRqcSh9Z0CVvkUpIje8ndwwpNWIMJwv4L31AgMBAAGjggEqMIIBJjAYBgNVBGEEEVBTRFhYLVRFU1QtMDAwMDAxMGoGCCsGAQUFBwEBBF4wXDBaBggrBgEFBQcwAoZOaHR0cDovL2stdGVzdC1jZXJ0aWZpY2F0ZXMuczMuZXUtd2VzdC0yLmFtYXpvbmF3cy5jb20vc2NlbmFyaW9fMV9xdHNwX2NlcnQucGVtMF4GA1UdHwRXMFUwU6BRoE+GTWh0dHA6Ly9rLXRlc3QtY2VydGlmaWNhdGVzLnMzLmV1LXdlc3QtMi5hbWF6b25hd3MuY29tL3NjZW5hcmlvXzFfcXRzcF9jcmwuZGVyMB8GA1UdIwQYMBaAFNOKG2rwTAOeehzw1fp1GzxhFCr+MB0GA1UdDgQWBBQ/3LUfN+9vlxzIgEyY6N3n1AhGqDANBgkqhkiG9w0BAQsFAAOCAQEAd+YzVk4PKGNrjBbtYpprJLtkRhpSImua866YUgpdU7vJHhip4yqpLAcu0U2jHnSQyTAvsCK3hbdTHKVclnAn7R9lWIjyeLPWRUifKkjmyTdRnz/kz1RW94Y6DpNlsD9NDrsBc1yAUNcz77KKctObO9ZQ4qbklbQZNuGA4Du/t9/Vkzdi55SZCXDtwoOLkBj/Dqc42YQhdtSJFV8NSqZVyiFl14gWlafIm3KFzDRQhjY8OaA+gOwSbYM5e/a9xrq+qRngE4uQs87agTaz0XCwjTseE4RP3aBpY7UtlFMjy2hX2XFQ9ZSdmXyEXHxUqPI8hQmQLM05URHc09QQvHQaOQ==","schema":{"type":"string"}},{"in":"query","name":"jurisdiction","required":true,"description":"Two letter country code indicating where the transaction is taking place.","example":"XX","schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/valideIDAS"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/Error"}}}}},"components":{"responses":{"BadRequest":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizationError"}}}},"NotFound":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"Error":{"description":"Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}}},"valideIDAS":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/valideIDAS"}}}}},"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"schemas":{"valideIDAS":{"type":"object","properties":{"eIDAS":{"type":"object","properties":{"validity":{"type":"object","properties":{"validQTSP":{"type":"boolean"},"validSignature":{"type":"boolean"},"notRevoked":{"type":"boolean"},"notExpired":{"type":"boolean"}}},"data":{"type":"object","properties":{"QTSPCommonName":{"type":"string","nullable":true,"example":"QTSP Common Name on certificate"},"authNumber":{"type":"string","nullable":true,"example":"PSDGB-FCA-010101"},"pspSubjectName":{"type":"string","nullable":true,"example":"PSP Subject Name on certificate"},"QTSPSource":{"type":"string","example":"QTSP"},"QTSPJurisdiction":{"type":"string","example":"EEA"}}},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","example":"crl_network_error"},"title":{"type":"string","example":"A network error occurred"},"link":{"type":"string","example":"https://developers.konsentus.com/api-reference/error-codes.html"}}}}}},"homeRegister":{"type":"object","properties":{"ncaName":{"type":"string","nullable":true,"example":"GB-FCA"},"ncaCountryCode":{"type":"string","example":"GB"},"registerType":{"type":"string","example":"Home"},"categoryEntries":{"type":"array","items":{"type":"object","description":"Payment services categories of PSP.","properties":{"categoryName":{"type":"string","example":"Payment Institution"},"pspLegalName":{"type":"string","example":"PSP Legal Name"},"pspAuthStatus":{"type":"string","example":"Authorised"},"pspPaymentServices":{"type":"array","items":{"type":"integer"},"example":[1,2,3,4,5,6]},"passportOut":{"type":"object","properties":{"countryCode":{"type":"string","example":"GB"},"paymentServices":{"type":"array","items":{"type":"integer"},"example":[1,2,3,4,5,6]}}}}}}}},"hostRegister":{"type":"object","properties":{"ncaName":{"type":"string","nullable":true,"example":"GB-FCA"},"ncaCountryCode":{"type":"string","example":"GB"},"registerType":{"type":"string","example":"Home"},"categoryEntries":{"type":"array","items":{"type":"object","description":"Payment services categories of PSP.","properties":{"categoryName":{"type":"string","example":"Payment Institution"},"pspLegalName":{"type":"string","example":"PSP Legal Name"},"pspAuthStatus":{"type":"string","example":"Authorised"},"passportIn":{"type":"object","properties":{"paymentServices":{"type":"array","items":{"type":"integer"},"example":[1,2,3,4,5,6]}}}}}},"warning":{"type":"array","items":{"type":"string"},"example":["The PSP Konsentus PSP - 1 could not be found in any XY register"]}}}}},"AuthorizationError":{"type":"object","properties":{"errors":{"type":"array","description":"The array containing error objects.","items":{"type":"object","description":"The object containing the error information to be recorded by the FI.","properties":{"id":{"type":"string","example":null,"description":"A unique identifier for this particular occurrence of the problem."},"code":{"type":"string","example":"authentication_error","description":"An application-specific error code, expressed as a string value."},"title":{"type":"string","example":"Failed to successfully authenticate in the request.","description":"A short, human-readable summary of the problem that should not change from occurrence to occurrence of the problem, except for purposes of localization."},"link":{"type":"string","example":"https://developers.konsentus.com/api-reference/error-codes.html","description":"A link that leads to further details about this particular occurrence of the problem."}}}}}},"Errors":{"type":"object","properties":{"id":{"type":"string","example":"630ead6c11eaee5fc582391ae489c47657cbdb2b","description":"The correlation identifier for this request"},"errorId":{"type":"string","example":"9356b1b36af2a11663d3b1df9bde8bf007507c3e","description":"The identifier for the specific error collection, used when contacting Konsentus support"},"errors":{"type":"array","description":"The array containing error objects.","items":{"type":"object","description":"The object containing the error information to be recorded by the FI.","properties":{"id":{"type":"string","example":null,"description":"A unique identifier for this particular occurrence of the problem."},"code":{"type":"string","example":"parameter_invalid","description":"An application-specific error code, expressed as a string value."},"title":{"type":"string","example":"One or more of the parameter values provided were an incorrect data type. Make sure that only supported values are provided for each attribute. Refer to our API documentation to look up the type of data each attribute supports.","description":"A short, human-readable summary of the problem that should not change from occurrence to occurrence of the problem, except for purposes of localization."},"link":{"type":"string","example":"https://developers.konsentus.com/api-reference/error-codes.html","description":"A link that leads to further details about this particular occurrence of the problem."}}}}}}}},"tags":[{"name":"PSP Checking Service","description":"Retrieve PSP regulatory information."}]}