SaltEdge PSD2 Compliance Logo

TPP

OBSEAL Register

The API allows the TPP to request the Salt Edge PSD2 Compliance Solution to register a new client. The TPP submits a JWS payload that describes the characteristics of the client to be created. If client creation is successful, the ASPSP responds with a JSON payload that describes the client that was created.

CURL

curl -i  \ 
 -d 'eyJhbGciOiJQUzI1NiIsImtpZCI6InRlc3QifQ.eyJyZXF1ZXN0X29iamVjdF9zaWduaW5nX2FsZyI6IlBTMjU2IiwiaXNzIjoiYmVLdXhDMVJuaVZzVGVMWXdmcGdOUCIsImlhdCI6MTYwNjI5Nzg1MywiZXhwIjoxNjA2Mjk4MTY5LCJhdWQiOiIwZHcyM2RzYTEzMTIzIiwidG9rZW5fZW5kcG9pbnRfYXV0aF9tZXRob2QiOiJjbGllbnRfc2VjcmV0X2Jhc2ljIiwidG9rZW5fZW5kcG9pbnRfYXV0aF9zaWduaW5nX2FsZyI6IlBTMjU2IiwiZ3JhbnRfdHlwZXMiOlsiY2xpZW50X2NyZWRlbnRpYWxzIiwiYXV0aG9yaXphdGlvbl9jb2RlIiwicmVmcmVzaF90b2tlbiJdLCJyZXNwb25zZV90eXBlcyI6WyJjb2RlIGlkX3Rva2VuIl0sInNvZnR3YXJlX3N0YXRlbWVudCI6ImV5SmhiR2NpT2lKSVV6STFOaUlzSW10cFpDSTZJa0ZDUTBReE1qTTBJbjAuZXlKcGMzTWlPaUpQY0dWdVFtRnVhMmx1WnlCTWRHUWlMQ0pwWVhRaU9qRTBPVEkzTlRZek16RXNJbXAwYVNJNkltbGtNVEl6TkRVMk9EVTBNemswT0RjMk56Z2lMQ0p6YjJaMGQyRnlaVjlsYm5acGNtOXViV1Z1ZENJNkluQnliMlIxWTNScGIyNGlMQ0p6YjJaMGQyRnlaVjl0YjJSbElqb2liR2wyWlNJc0luTnZablIzWVhKbFgybGtJam9pTmpWa01XWXlOMk10TkdGbFlTMDBOVFE1TFRsak1qRXROakJsTkRrMVlUZGhPRFptSWl3aWMyOW1kSGRoY21WZlkyeHBaVzUwWDJsa0lqb2lUM0JsYmtKaGJtdHBibWNnVkZCUUlFTnNhV1Z1ZENCVmJtbHhkV1VnU1VRaUxDSnpiMlowZDJGeVpWOWpiR2xsYm5SZmJtRnRaU0k2SWtGdFlYcHZiaUJRY21sdFpTQk5iM1pwWlhNaUxDSnpiMlowZDJGeVpWOWpiR2xsYm5SZlpHVnpZM0pwY0hScGIyNGlPaUpCYldGNmIyNGdVSEpwYldVZ1RXOTJhV1Z6SUdseklHRWdiVzkyYVc1bklITjBjbVZoYldsdVp5QnpaWEoyYVdObElpd2ljMjltZEhkaGNtVmZkbVZ5YzJsdmJpSTZJakl1TWlJc0luTnZablIzWVhKbFgyTnNhV1Z1ZEY5MWNta2lPaUpvZEhSd2N6b3ZMM0J5YVcxbExtRnRZWHB2Ymk1amIyMGlMQ0p6YjJaMGQyRnlaVjl5WldScGNtVmpkRjkxY21seklqcGJJbWgwZEhCek9pOHZjSEpwYldVdVlXMWhlbTl1TG1OdmJTOWpZaUlzSW1oMGRIQnpPaTh2Y0hKcGJXVXVZVzFoZW05dUxtTnZMblZyTDJOaUlsMHNJbk52Wm5SM1lYSmxYM0p2YkdWeklqcGJJbEJKVTFBaUxDSkJTVk5RSWwwc0ltOXlaMkZ1YVhOaGRHbHZibDlqYjIxd1pYUmxiblJmWVhWMGFHOXlhWFI1WDJOc1lXbHRjeUk2VzNzaVlYVjBhRzl5YVhSNVgybGtJam9pUmsxQklpd2ljbVZuYVhOMGNtRjBhVzl1WDJsa0lqb2lNVEV4TVRFeElpd2ljM1JoZEhWeklqb2lRV04wYVhabElpd2lZWFYwYUc5eWFYTmhkR2x2Ym5NaU9sdDdJbTFsYldKbGNsOXpkR0YwWlNJNklrZENVaUlzSW5KdmJHVnpJanBiSWxCSlUxQWlMQ0pCU1ZOUUlsMTlMSHNpYldWdFltVnlYM04wWVhSbElqb2lVazlKSWl3aWNtOXNaWE1pT2xzaVVFbFRVQ0pkZlYxOVhTd2ljMjltZEhkaGNtVmZiRzluYjE5MWNta2lPaUpvZEhSd2N6b3ZMM0J5YVcxbExtRnRZWHB2Ymk1amIyMHZiRzluYnk1d2JtY2lMQ0p2Y21kZmMzUmhkSFZ6SWpvaVFXTjBhWFpsSWl3aWIzSm5YMmxrSWpvaVFXMWhlbTl1SUZSUVVFbEVJaXdpYjNKblgyNWhiV1VpT2lKUGNHVnVRbUZ1YTJsdVp5QlVVRkFnVW1WbmFYTjBaWEpsWkNCT1lXMWxJaXdpYjNKblgyTnZiblJoWTNSeklqcGJleUp1WVcxbElqb2lZMjl1ZEdGamRDQnVZVzFsSWl3aVpXMWhhV3dpT2lKamIyNTBZV04wUUdOdmJuUmhZM1F1WTI5dElpd2ljR2h2Ym1VaU9pSXJORFEzT0Rrd01UTXdOVFU0SWl3aWRIbHdaU0k2SW1KMWMybHVaWE56SW4wc2V5SnVZVzFsSWpvaVkyOXVkR0ZqZENCdVlXMWxJaXdpWlcxaGFXd2lPaUpqYjI1MFlXTjBRR052Ym5SaFkzUXVZMjl0SWl3aWNHaHZibVVpT2lJck5EUTNPRGt3TVRNd05UVTRJaXdpZEhsd1pTSTZJblJsWTJodWFXTmhiQ0o5WFN3aWIzSm5YMnAzYTNOZlpXNWtjRzlwYm5RaU9pSm9kSFJ3Y3pvdkwycDNhM011YjNCbGJtSmhibXRwYm1jdWIzSm5MblZyTDI5eVoxOXBaQzl2Y21kZmFXUXVhbXQzY3lJc0ltOXlaMTlxZDJ0elgzSmxkbTlyWldSZlpXNWtjRzlwYm5RaU9pSm9kSFJ3Y3pvdkwycDNhM011YjNCbGJtSmhibXRwYm1jdWIzSm5MblZyTDI5eVoxOXBaQzl5WlhadmEyVmtMMjl5WjE5cFpDNXFhM2R6SWl3aWMyOW1kSGRoY21WZmFuZHJjMTlsYm1Sd2IybHVkQ0k2SW1oMGRIQnpPaTh2YW5kcmN5NXZjR1Z1WW1GdWEybHVaeTV2Y21jdWRXc3ZiM0puWDJsa0wzTnZablIzWVhKbFgybGtMbXByZDNNaUxDSnpiMlowZDJGeVpWOXFkMnR6WDNKbGRtOXJaV1JmWlc1a2NHOXBiblFpT2lKb2RIUndjem92TDJwM2EzTXViM0JsYm1KaGJtdHBibWN1YjNKbkxuVnJMMjl5WjE5cFpDOXlaWFp2YTJWa0wzTnZablIzWVhKbFgybGtMbXByZDNNaUxDSnpiMlowZDJGeVpWOXdiMnhwWTNsZmRYSnBJam9pYUhSMGNITTZMeTkwY0hBdVkyOXRMM0J2YkdsamVTNW9kRzFzSWl3aWMyOW1kSGRoY21WZmRHOXpYM1Z5YVNJNkltaDBkSEJ6T2k4dmRIQndMbU52YlM5MGIzTXVhSFJ0YkNJc0luTnZablIzWVhKbFgyOXVYMkpsYUdGc1psOXZabDl2Y21jaU9pSm9kSFJ3Y3pvdkwyRndhUzV2Y0dWdVltRnVhMmx1Wnk1dmNtY3VkV3N2YzJOcGJUSXZUMEpVY25WemRHVmtVR0Y1YldWdWRGQmhjblI1THpFeU16UTFOamMzT0RraUxDSnZZbDl5WldkcGMzUnllVjkwYjNNaU9pSm9kSFJ3Y3pvdkwzSmxaMmx6ZEhKNUxtOXdaVzVpWVc1cmFXNW5MbTl5Wnk1MWF5OTBiM011YUhSdGJDSjkub0hscTdOeEVvajB2ZFhlVFI1Y1V6N29JcTdWdDlkQjM0cGJ3eHREaFdUcyIsInNvZnR3YXJlX2lkIjoiYmVLdXhDMVJuaVZzVGVMWXdmcGdOUCIsInJlZGlyZWN0X3VyaXMiOlsiaHR0cHM6Ly9yZWRpcmVjdC5oZXJlIiwiaHR0cDovL2FuZC5oZXJlIl0sInNjb3BlIjoibWFrZXBheW1lbnQiLCJhcHBsaWNhdGlvbl90eXBlIjoid2ViIiwiaWRfdG9rZW5fc2lnbmVkX3Jlc3BvbnNlX2FsZyI6IlBTMjU2In0.RUveouJohlu9dcqQcLJMtzIYaDy2K-413W8yjs-1DWFgBqCjy7yu5Wzzb22kWmWCIM4Z__XJoSX41F2zQSxAocEgufgCttP09_tjXVIK2UKaKrR4Dlu3WdopV23FFmjjy_AbmwdslBuWTjNVrDDkFMdol3JyMzcmhaYTvtmtqQ0f3tCk5WXyEFcZCxO06MwybPqTiEU5Y3i_n5QAU2w3-041Y9n5ArJtWLwLp2CRfbmzj_HswCxWv7yt658JAmvkPR3IuMDvqDMQ3OWfLLfCo9oe_z8m1bQA7C2pypSwZP5mKtAuBATfZ3bVG0RyZZQ_Gt8KTtqbx-kSAwOdpvk84w' \ 
-X POST "/api/open-banking/v3.1/tpp/register"

Example of unpacked Authorization header

{"request_object_signing_alg":"PS256","iss":"beKuxC1RniVsTeLYwfpgNP","iat":1606297853,"exp":1606298169,"aud":"0dw23dsa13123","token_endpoint_auth_method":"client_secret_basic","token_endpoint_auth_signing_alg":"PS256","grant_types":["client_credentials","authorization_code","refresh_token"],"response_types":["code id_token"],"software_statement":"eyJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0In0.eyJpc3MiOiJPcGVuQmFua2luZyBMdGQiLCJpYXQiOjE0OTI3NTYzMzEsImp0aSI6ImlkMTIzNDU2ODU0Mzk0ODc2NzgiLCJzb2Z0d2FyZV9lbnZpcm9ubWVudCI6InByb2R1Y3Rpb24iLCJzb2Z0d2FyZV9tb2RlIjoibGl2ZSIsInNvZnR3YXJlX2lkIjoiNjVkMWYyN2MtNGFlYS00NTQ5LTljMjEtNjBlNDk1YTdhODZmIiwic29mdHdhcmVfY2xpZW50X2lkIjoiT3BlbkJhbmtpbmcgVFBQIENsaWVudCBVbmlxdWUgSUQiLCJzb2Z0d2FyZV9jbGllbnRfbmFtZSI6IkFtYXpvbiBQcmltZSBNb3ZpZXMiLCJzb2Z0d2FyZV9jbGllbnRfZGVzY3JpcHRpb24iOiJBbWF6b24gUHJpbWUgTW92aWVzIGlzIGEgbW92aW5nIHN0cmVhbWluZyBzZXJ2aWNlIiwic29mdHdhcmVfdmVyc2lvbiI6IjIuMiIsInNvZnR3YXJlX2NsaWVudF91cmkiOiJodHRwczovL3ByaW1lLmFtYXpvbi5jb20iLCJzb2Z0d2FyZV9yZWRpcmVjdF91cmlzIjpbImh0dHBzOi8vcHJpbWUuYW1hem9uLmNvbS9jYiIsImh0dHBzOi8vcHJpbWUuYW1hem9uLmNvLnVrL2NiIl0sInNvZnR3YXJlX3JvbGVzIjpbIlBJU1AiLCJBSVNQIl0sIm9yZ2FuaXNhdGlvbl9jb21wZXRlbnRfYXV0aG9yaXR5X2NsYWltcyI6W3siYXV0aG9yaXR5X2lkIjoiRk1BIiwicmVnaXN0cmF0aW9uX2lkIjoiMTExMTExIiwic3RhdHVzIjoiQWN0aXZlIiwiYXV0aG9yaXNhdGlvbnMiOlt7Im1lbWJlcl9zdGF0ZSI6IkdCUiIsInJvbGVzIjpbIlBJU1AiLCJBSVNQIl19LHsibWVtYmVyX3N0YXRlIjoiUk9JIiwicm9sZXMiOlsiUElTUCJdfV19XSwic29mdHdhcmVfbG9nb191cmkiOiJodHRwczovL3ByaW1lLmFtYXpvbi5jb20vbG9nby5wbmciLCJvcmdfc3RhdHVzIjoiQWN0aXZlIiwib3JnX2lkIjoiQW1hem9uIFRQUElEIiwib3JnX25hbWUiOiJPcGVuQmFua2luZyBUUFAgUmVnaXN0ZXJlZCBOYW1lIiwib3JnX2NvbnRhY3RzIjpbeyJuYW1lIjoiY29udGFjdCBuYW1lIiwiZW1haWwiOiJjb250YWN0QGNvbnRhY3QuY29tIiwicGhvbmUiOiIrNDQ3ODkwMTMwNTU4IiwidHlwZSI6ImJ1c2luZXNzIn0seyJuYW1lIjoiY29udGFjdCBuYW1lIiwiZW1haWwiOiJjb250YWN0QGNvbnRhY3QuY29tIiwicGhvbmUiOiIrNDQ3ODkwMTMwNTU4IiwidHlwZSI6InRlY2huaWNhbCJ9XSwib3JnX2p3a3NfZW5kcG9pbnQiOiJodHRwczovL2p3a3Mub3BlbmJhbmtpbmcub3JnLnVrL29yZ19pZC9vcmdfaWQuamt3cyIsIm9yZ19qd2tzX3Jldm9rZWRfZW5kcG9pbnQiOiJodHRwczovL2p3a3Mub3BlbmJhbmtpbmcub3JnLnVrL29yZ19pZC9yZXZva2VkL29yZ19pZC5qa3dzIiwic29mdHdhcmVfandrc19lbmRwb2ludCI6Imh0dHBzOi8vandrcy5vcGVuYmFua2luZy5vcmcudWsvb3JnX2lkL3NvZnR3YXJlX2lkLmprd3MiLCJzb2Z0d2FyZV9qd2tzX3Jldm9rZWRfZW5kcG9pbnQiOiJodHRwczovL2p3a3Mub3BlbmJhbmtpbmcub3JnLnVrL29yZ19pZC9yZXZva2VkL3NvZnR3YXJlX2lkLmprd3MiLCJzb2Z0d2FyZV9wb2xpY3lfdXJpIjoiaHR0cHM6Ly90cHAuY29tL3BvbGljeS5odG1sIiwic29mdHdhcmVfdG9zX3VyaSI6Imh0dHBzOi8vdHBwLmNvbS90b3MuaHRtbCIsInNvZnR3YXJlX29uX2JlaGFsZl9vZl9vcmciOiJodHRwczovL2FwaS5vcGVuYmFua2luZy5vcmcudWsvc2NpbTIvT0JUcnVzdGVkUGF5bWVudFBhcnR5LzEyMzQ1Njc3ODkiLCJvYl9yZWdpc3RyeV90b3MiOiJodHRwczovL3JlZ2lzdHJ5Lm9wZW5iYW5raW5nLm9yZy51ay90b3MuaHRtbCJ9.oHlq7NxEoj0vdXeTR5cUz7oIq7Vt9dB34pbwxtDhWTs","software_id":"beKuxC1RniVsTeLYwfpgNP","redirect_uris":["https://redirect.here","http://and.here"],"scope":"makepayment","application_type":"web","id_token_signed_response_alg":"PS256"}

Example of response

{"tls_client_auth_subject_dn":"N/A","client_id":"ABCD1234","client_secret":"N/A","client_id_issued_at":1606297853,"client_secret_expires_at":0,"redirect_uris":["https://redirect.here","http://and.here"],"token_endpoint_auth_method":"client_secret_basic","token_endpoint_auth_signing_alg":"PS256","grant_types":["client_credentials","authorization_code","refresh_token"],"response_types":["code id_token"],"software_id":"beKuxC1RniVsTeLYwfpgNP","scope":"makepayment","application_type":"web","id_token_signed_response_alg":"PS256","request_object_signing_alg":"PS256"}
Request

POST /api/open-banking/v3.1/tpp/register

Unpacked Authorization
iss
string, required
TPP identifier: software_id from SSA. Can raise: ActionNotAllowed
iat
integer, required
The time at which the request was issued by the TPP expressed as "seconds since the epoch"
exp
integer, required
The time at which the request expires expressed as seconds since the epoch. Values greater than: 1614537228
aud
string, required
The audience for the request. This should be the unique identifier for the ASPSP issued by the issuer of the software statement.
token_endpoint_auth_method
string, optional
Specifies which Token endpoint authentication method the TPP wants to use. It should be noted that only tls_client_auth and client_secret_basic are FAPI compliant. Default value: client_secret_basic Allowed values: client_secret_basic
token_endpoint_auth_signing_alg
string, optional
Algorithm which the TPP uses to authenticate with the token endpoint. Default value: PS256 Allowed values: RS256, PS256
grant_types
array, required
A JSON array specifying what the TPP can request to be supplied to the token endpoint as exchange for an access token. Allowed values: client_credentials, authorization_code, refresh_token
response_types
array, optional
A JSON array specifying what the TPP can request to be returned from the ASPSP authorisation endpoint. Default value: ["code id_token"] Allowed values: code, id_token, code id_token
software_statement
string, required
Software statement assertion issued by the issuer. The data model for the software statements issued by the Open Banking directory are documented as part of the Directory Specification. Can raise: NotFound, Invalid
software_id
string, optional
If specified, the software_id in the request MUST match the software_id specified in the SSA.
redirect_uris
array, required
Registered URIs the TPP will use to interact with the ASPSP AS. If the software statement defines a master set of redirect URIs, this must match or be a subset of the redirect URIs in the SSA.
scope
string, optional
Scopes the client is asking for (if not specified, default scopes are assigned by the AS). This consists of a list scopes separated by spaces. Allowed values: openid, accounts
application_type
string, optional
Please specify whether TPP software is a mobile or a web app. Allowed values: web, mobile
id_token_signed_response_alg
string, optional
Algorithm which the TPP expects to sign the id_token, if an id_token is returned. Allowed values: RS256, PS256
request_object_signing_alg
string, optional
Algorithm which the TPP expects to sign the request object if a request object will be part of the authorization request sent to the ASPSP. Allowed values: RS256, PS256
Response

Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other posibilities.


client_id
string, required
Client application identifier.
client_secret
string, optional
A shared secret that goes in pair with client_id. Currently not supported.
client_id_issued_at
integer, required
Time at which the client identifier was issued expressed as "seconds since the epoch".
client_secret_expires_at
integer, optional
Time at which the client secret will expire expressed as "seconds since the epoch". The value must be populated if a client_secret is returned. Default value: 0
redirect_uris
array, required
Registered URIs the TPP will use to interact with the ASPSP AS. If the software statement defines a master set of redirect URIs, this must match or be a subset of the redirect URIs in the SSA.
token_endpoint_auth_method
string, required
Specifies which Token endpoint authentication method the TPP wants to use. It should be noted that only tls_client_auth and client_secret_basic are FAPI compliant. Default value: client_secret_basic Allowed values: client_secret_basic
token_endpoint_auth_signing_alg
string, optional
Algorithm which the TPP uses to authenticate with the token endpoint. Default value: PS256 Allowed values: RS256, PS256
grant_types
array, required
A JSON array specifying what the TPP can request to be supplied to the token endpoint as exchange for an access token. Allowed values: client_credentials, authorization_code, refresh_token
response_types
array, optional
A JSON array specifying what the TPP can request to be returned from the ASPSP authorisation endpoint. Default value: ["code id_token"] Allowed values: code, id_token, code id_token
software_id
string, optional
If specified, the software_id in the request MUST match the software_id specified in the SSA.
scope
string, required
Scopes the client is asking for (if not specified, default scopes are assigned by the AS). This consists of a list scopes separated by spaces. Allowed values: openid, accounts
application_type
string, required
Please specify whether TPP software is a mobile or a web app. Allowed values: web, mobile
id_token_signed_response_alg
string, optional
Algorithm which the TPP expects to sign the id_token, if an id_token is returned. Allowed values: RS256, PS256
request_object_signing_alg
string, optional
Algorithm which the TPP expects to sign the request object if a request object will be part of the authorization request sent to the ASPSP. Allowed values: RS256, PS256
tls_client_auth_subject_dn
string, optional
The tls_client_auth_subject_dn claim MUST contain the DN of the certificate that the TPP will present to the ASPSP token endpoint. Currently not supported.
Related Errors
Class Code Description
NotFound 404 A resource could not be found. More in error_message.
ActionNotAllowed 406 You're not allowed to perform this action. This might be a configuration problem or parameters incompatibility.
Invalid 406 Given data is invalid. More in error_message.

QWAC or QSEAL Register

Used for registration in Salt Edge PSD2 Compliance Dashboard. After registration, you will receive a letter of confirmation on your representative email.

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImNlcnRpZmljYXRlIjp7InR5cGUiOiJxc2VhbCIsIm5hbWUiOiJFeGFtcGxlIE5hbWUiLCJwZW0iOiItLS0tLUJFR0lOIENFUlRJRklDQVRFLS0tLS1cbk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmxcbmMzUXdNREF4SURBZUJnTlZCQU1NRjJObGNuUlRTVWRPVTBGTVZGUkZVMVFnVjJWaUlFTkJNUkV3RHdZRFZRUUtcbkRBaFRZV3gwVkdWemRERUxNQWtHQTFVRUJoTUNVazh3SGhjTk1Ua3hNVEU0TVRZd05EVXdXaGNOTWpFeE1URTNcbk1UWXdORFV3V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnNcbmRGUmxjM1F4Q3pBSkJnTlZCQVlUQWxKUE1SSXdFQVlEVlFRSURBbENkV04xY21WemRHa3hFakFRQmdOVkJBY01cbkNVSjFZM1Z5WlhOMGFURVdNQlFHQTFVRUNRd05RV3hpWVNCSmRXeHBZU0EzTlRFVE1CRUdBMVVFWVF3S2FXUmxcbmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0xcblFVcExJNHNaQkpuUWhnUWFKWERscFQyODVsZThlRHE3VGpaZ2F6S3FNOUZCcnc0QUVEcVJsWEd2Z3dpbkpGNjJcbjB3dUlxKzdwak9YUFB3K1k5WFFCcFNranVyYnloSk9mOGI2VWpMUExCdUF3T2tGTnY3Smtsd0t5cWZrNEdHNE5cbmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2pcbldkRnpSVldxY3RwNDY1b1hGV2U2d0JpcmxKZStSRGdoZ0FkVEFpUEdSd1h1eHZkYkluUjh2dm9ESTUyR0V1c2hcbkZZQ1l3bzN1YVVJVHlneE5kQnJaNU5pWktoK3JuNVU1bjMzSkROb05XaEJVRTAxTC9oVjNQeWV4cEpUeW1pRFBcbjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUJcbkJqQWRCZ05WSFE0RUZnUVVLcFBmeTE5UkFCUEtydmJzTVJ0VzN5R0lNZm93SHdZRFZSMGpCQmd3Rm9BVUtwUGZcbnkxOVJBQlBLcnZic01SdFczeUdJTWZvd1B3WUlLd1lCQlFVSEFRTUVNd3d4ZEdWemRGQlRVRjlCU1M0dUxqQTFcblpXRTBaRGt3TFROak1qQXRORGRoT1MwNFpqY3dMV00wTmpCallXUTVZVEZrTkRBTkJna3Foa2lHOXcwQkFRc0ZcbkFBT0NBUUVBRnM1OGhMK1k0eU44MzdkcC94U3dGamVvd0JaSzRSY0xlZktoRnVEY0lsQi80RlRPSFMxeUNQZWpcbjFwSTlCVndpM2JyUStkUGNMc3VLSE8rMFFlelh2MTlXWkpwL0pnVStORjhjMGRwUFVCN2FwRVdPYjN4endOMmFcbjhneFVCOEQ0b2VmclhFRENhMzBHQlVHWitxdEFJb0NSSW82L0hCVVUyelVFWFVEZVRJWnFLaTVydHNCV0ZiVFpcbi92SHovVXNoMmh4Y0VnQ0FocWlMMzNpc3pIeVJDeDFaaExLWFBTTFdXdGpZaUtGVnYzc2dQTnJ3czdqYWQwamlcbkFESTdJVTdvMEdSV0ZaZFNQaWhSWWkvTmFrZnhjNWY1YzB0M1QySXJpTXNUQ04yUnlyKy8xWGx5aUFxbTBxekpcbm5CQTlrZTV1TDM0WVpuM2dIKzBCRXovL3BldFo3dz09XG4tLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tXG4ifSwicmVwcmVzZW50YXRpdmUiOnsiZW1haWwiOiJleGFtcGxlQGV4YW1wbGUuY29tIiwibmFtZSI6IkV4YW1wbGUgTmFtZSJ9LCJjb21wYW55Ijp7ImNpdHkiOiJHdWlsZGZvcmQiLCJ6aXBfY29kZSI6IlhGLTEyMzQiLCJwaG9uZV9udW1iZXIiOiI3MTUwNzkxMTIiLCJuYW1lIjoiRXhhbXBsZSBOYW1lIiwiZW1haWwiOiJleGFtcGxlQGV4YW1wbGUuY29tIiwiYWRkcmVzcyI6IjQwOSBCcm9hZHdheSBHVUlMREZPUkQifX0sImV4cCI6MTYxNDMwMDAyMX0.KDnnIrQR5eivz-D2d9lXbwOBQXRiAQ7LmId9zH7PAdDWVeAC8Qd-aoqCx3GMwdjXRnUyM_Nn49WCQy4K-Ed9n6yYcQTn7DdEVpTZ-07EFN4r4QXEg24fGNWYltNAzAu-8nOcvhF77Jyli76gebjcqcBgdfdO6gDepn1vLoJePICWwkvUBI1qaox3l4r2ETfUwBxDuI4jejR6pkM52W8hLOHiFjwTRLzV3epQxItlGQkohlyLZuObSgzreiY65HxU7zHn_4t8kxZ2JrakY54zHIDVujg1TVkJAYbIVDtz5jyHUzKnwqstKVaPrV20G0FksbkOZB_HGcjJGNx9KhKSkA" \ 
 -H "Client-Request-Id: 13" \ 
 -X POST "/api/v2/tpp/register"

Example of unpacked Authorization header

{"data":{"certificate":{"type":"qseal","name":"Example Name","pem":"-----BEGIN CERTIFICATE-----\nMIIEAjCCAuoCAQAwDQYJKoZIhvcNAQELBQAwWzEXMBUGA1UEYQwOVHBwU2FsdFRl\nc3QwMDAxIDAeBgNVBAMMF2NlcnRTSUdOU0FMVFRFU1QgV2ViIENBMREwDwYDVQQK\nDAhTYWx0VGVzdDELMAkGA1UEBhMCUk8wHhcNMTkxMTE4MTYwNDUwWhcNMjExMTE3\nMTYwNDUwWjCBjTEWMBQGA1UEAwwNc2FsdC10ZXN0LmNvbTERMA8GA1UECgwIU2Fs\ndFRlc3QxCzAJBgNVBAYTAlJPMRIwEAYDVQQIDAlCdWN1cmVzdGkxEjAQBgNVBAcM\nCUJ1Y3VyZXN0aTEWMBQGA1UECQwNQWxiYSBJdWxpYSA3NTETMBEGA1UEYQwKaWRl\nbnRpZmllcjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKgW4J9+HFcL\nQUpLI4sZBJnQhgQaJXDlpT285le8eDq7TjZgazKqM9FBrw4AEDqRlXGvgwinJF62\n0wuIq+7pjOXPPw+Y9XQBpSkjurbyhJOf8b6UjLPLBuAwOkFNv7JklwKyqfk4GG4N\ngk8dUa1cKNLcX377pvz4CHYjPkhiKcLjARxLTIbGmz9YAT/Ak3l7BFDdWj0BrkGj\nWdFzRVWqctp465oXFWe6wBirlJe+RDghgAdTAiPGRwXuxvdbInR8vvoDI52GEush\nFYCYwo3uaUITygxNdBrZ5NiZKh+rn5U5n33JDNoNWhBUE01L/hV3PyexpJTymiDP\n6SPRJ3FLGtkCAwEAAaOBojCBnzAMBgNVHRMEBTADAQH/MA4GA1UdDwEB/wQEAwIB\nBjAdBgNVHQ4EFgQUKpPfy19RABPKrvbsMRtW3yGIMfowHwYDVR0jBBgwFoAUKpPf\ny19RABPKrvbsMRtW3yGIMfowPwYIKwYBBQUHAQMEMwwxdGVzdFBTUF9BSS4uLjA1\nZWE0ZDkwLTNjMjAtNDdhOS04ZjcwLWM0NjBjYWQ5YTFkNDANBgkqhkiG9w0BAQsF\nAAOCAQEAFs58hL+Y4yN837dp/xSwFjeowBZK4RcLefKhFuDcIlB/4FTOHS1yCPej\n1pI9BVwi3brQ+dPcLsuKHO+0QezXv19WZJp/JgU+NF8c0dpPUB7apEWOb3xzwN2a\n8gxUB8D4oefrXEDCa30GBUGZ+qtAIoCRIo6/HBUU2zUEXUDeTIZqKi5rtsBWFbTZ\n/vHz/Ush2hxcEgCAhqiL33iszHyRCx1ZhLKXPSLWWtjYiKFVv3sgPNrws7jad0ji\nADI7IU7o0GRWFZdSPihRYi/Nakfxc5f5c0t3T2IriMsTCN2Ryr+/1XlyiAqm0qzJ\nnBA9ke5uL34YZn3gH+0BEz//petZ7w==\n-----END CERTIFICATE-----\n"},"representative":{"email":"example@example.com","name":"Example Name"},"company":{"city":"Guildford","zip_code":"XF-1234","phone_number":"715079112","name":"Example Name","email":"example@example.com","address":"409 Broadway GUILDFORD"}},"exp":1574093210}

Example of response

{"data":{"message":"example_data.message"}}
Request

POST /api/v2/tpp/register

Headers
Header Type Description
Authorization string, required JSON Web Token containing payload, signed using RSA256 and application.private_key. Can raise: JWTClaimMissing, JWTIncorrectAlgorithm, PublicKeyInvalid, AuthorizationMissing, RequestFormatInvalid, WrongRequiredFields
Client-Request-Id string, optional Request identifier. If present, it will be returned within meta field in response.
Unpacked Authorization
exp
integer, required
The lifetime of the request in timestamp UTC format. Values greater than: Current time.
Response

Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other posibilities.


Related Errors
Class Code Description
JWTClaimMissing 400 Authorization Token expiration is not provided. Please specify exp alongside data field.
JWTIncorrectAlgorithm 400 Authorization Token was encrypted with incorrect algorithm. Please use RSA256 algorithm for ecnrypting.
PublicKeyInvalid 400 Given public key is not a public key.
AuthorizationMissing 400 Authorization header is missing.
RequestFormatInvalid 400 Request format is wrong. Details are stored in error_message
WrongRequiredFields 401 Specified required fields were not provided. More info in error_message
AccessDenied 401 Action you want to perform is not allowed. More in error_message

Add QWAC or QSEAL Certificate

Used for adding QSEAL or QWAC certificates after successful registration. The added certificate must be selected in Salt Edge PSD2 Compliance Dashboard as active one.

CURL

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImNlcnRpZmljYXRlIjp7InR5cGUiOiJxc2VhbCIsIm5hbWUiOiJFeGFtcGxlIE5hbWUiLCJwZW0iOiItLS0tLUJFR0lOIENFUlRJRklDQVRFLS0tLS1cbk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmxcbmMzUXdNREF4SURBZUJnTlZCQU1NRjJObGNuUlRTVWRPVTBGTVZGUkZVMVFnVjJWaUlFTkJNUkV3RHdZRFZRUUtcbkRBaFRZV3gwVkdWemRERUxNQWtHQTFVRUJoTUNVazh3SGhjTk1Ua3hNVEU0TVRZd05EVXdXaGNOTWpFeE1URTNcbk1UWXdORFV3V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnNcbmRGUmxjM1F4Q3pBSkJnTlZCQVlUQWxKUE1SSXdFQVlEVlFRSURBbENkV04xY21WemRHa3hFakFRQmdOVkJBY01cbkNVSjFZM1Z5WlhOMGFURVdNQlFHQTFVRUNRd05RV3hpWVNCSmRXeHBZU0EzTlRFVE1CRUdBMVVFWVF3S2FXUmxcbmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0xcblFVcExJNHNaQkpuUWhnUWFKWERscFQyODVsZThlRHE3VGpaZ2F6S3FNOUZCcnc0QUVEcVJsWEd2Z3dpbkpGNjJcbjB3dUlxKzdwak9YUFB3K1k5WFFCcFNranVyYnloSk9mOGI2VWpMUExCdUF3T2tGTnY3Smtsd0t5cWZrNEdHNE5cbmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2pcbldkRnpSVldxY3RwNDY1b1hGV2U2d0JpcmxKZStSRGdoZ0FkVEFpUEdSd1h1eHZkYkluUjh2dm9ESTUyR0V1c2hcbkZZQ1l3bzN1YVVJVHlneE5kQnJaNU5pWktoK3JuNVU1bjMzSkROb05XaEJVRTAxTC9oVjNQeWV4cEpUeW1pRFBcbjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUJcbkJqQWRCZ05WSFE0RUZnUVVLcFBmeTE5UkFCUEtydmJzTVJ0VzN5R0lNZm93SHdZRFZSMGpCQmd3Rm9BVUtwUGZcbnkxOVJBQlBLcnZic01SdFczeUdJTWZvd1B3WUlLd1lCQlFVSEFRTUVNd3d4ZEdWemRGQlRVRjlCU1M0dUxtSXhcbk56UTVPV0U0TFdRNE5tWXRORGMyWVMwNVlXRXpMVEk0WkRBMFpEazJZekk1WVRBTkJna3Foa2lHOXcwQkFRc0ZcbkFBT0NBUUVBSlBqSTBrV1JwZ3BaNVZTazNhM0F3SXpYejV1R2tlRnhDTU1FUUFtQW4vT2cranozVDZSektVb2xcbkU1RldWL21LbkJka2MrVGU1dmpEQ1BORWp6Qi9WeXZKZFNUYURTeVhvUTVtcFpJRm1kbmJYOVg0T0JZcEVja3ZcbkRTM0JzMVZLZjBTRkVQVy8rWkp6aFEzcWxPR2VvT283blYzdjhvZnJQdnlaWFdDRWUxZnRCZ0VTZThzQld1M1RcbkNPVGd1UkZrbHUyVEI2R2d5bUhYNkFhOTVLcDEzWStsczlqZjZQdUFxNWt5bjZqcEZBSnVYVkZ4NmU0dGIrMkxcblpmK2g5RFE1MTBkdUtRYmtmV3crdWNPMk1wUVd6MWhPeWpjSGIzanBYL2tnYjh4Wm5uVFBEbEVZWmFKWEt2Ty9cbnpibUZVc0ZCY092aG1acEVKeUJoSmc4OHMvMjdKQT09XG4tLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tXG4ifX0sImV4cCI6MTYxNDMwMDAyMX0.K3ozdESWCCFgT08JyafpIFG5ef9IVwO-gt7s02B60Q0gfA-suEfYynowp0RqVgVbbM4qp6P3oNBBuVroFng8PKw1SwfDrIK44oZK8lOztpfY1IQM8kk6__q-xIkkUND7rhCVJlXDkhRwo7uoWzUM8vzn5l3ZcWHqfKKjLbB_K3WKpT2DTWjeelz1s49p1FWAQ0uq9TXTAY-ezqItmojVz22-Layjz8qcY3i4yOi9FiKV4dnkRFya3_-rXkjqp1lonR393vwDqFMQbwl3r5RmGNCbkFDRtkoR96MDrO_rEF7jFoOeCHCPEAw43UrcUEjzKuYr_iyppwYOivqDZTuInQ" \ 
 -H "App-Id: GBGZrINCK7K0SUbllZYm2w" \ 
 -H "App-Secret: PQyeEZzg-i9-E3b-X9nclg" \ 
 -H "Client-Request-Id: 17" \ 
 -X POST "/api/v2/tpp/certificates"

Example of unpacked Authorization header

{"data":{"certificate":{"type":"qseal","name":"Example Name","pem":"-----BEGIN CERTIFICATE-----\nMIIEAjCCAuoCAQAwDQYJKoZIhvcNAQELBQAwWzEXMBUGA1UEYQwOVHBwU2FsdFRl\nc3QwMDAxIDAeBgNVBAMMF2NlcnRTSUdOU0FMVFRFU1QgV2ViIENBMREwDwYDVQQK\nDAhTYWx0VGVzdDELMAkGA1UEBhMCUk8wHhcNMTkxMTE4MTYwNDUwWhcNMjExMTE3\nMTYwNDUwWjCBjTEWMBQGA1UEAwwNc2FsdC10ZXN0LmNvbTERMA8GA1UECgwIU2Fs\ndFRlc3QxCzAJBgNVBAYTAlJPMRIwEAYDVQQIDAlCdWN1cmVzdGkxEjAQBgNVBAcM\nCUJ1Y3VyZXN0aTEWMBQGA1UECQwNQWxiYSBJdWxpYSA3NTETMBEGA1UEYQwKaWRl\nbnRpZmllcjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKgW4J9+HFcL\nQUpLI4sZBJnQhgQaJXDlpT285le8eDq7TjZgazKqM9FBrw4AEDqRlXGvgwinJF62\n0wuIq+7pjOXPPw+Y9XQBpSkjurbyhJOf8b6UjLPLBuAwOkFNv7JklwKyqfk4GG4N\ngk8dUa1cKNLcX377pvz4CHYjPkhiKcLjARxLTIbGmz9YAT/Ak3l7BFDdWj0BrkGj\nWdFzRVWqctp465oXFWe6wBirlJe+RDghgAdTAiPGRwXuxvdbInR8vvoDI52GEush\nFYCYwo3uaUITygxNdBrZ5NiZKh+rn5U5n33JDNoNWhBUE01L/hV3PyexpJTymiDP\n6SPRJ3FLGtkCAwEAAaOBojCBnzAMBgNVHRMEBTADAQH/MA4GA1UdDwEB/wQEAwIB\nBjAdBgNVHQ4EFgQUKpPfy19RABPKrvbsMRtW3yGIMfowHwYDVR0jBBgwFoAUKpPf\ny19RABPKrvbsMRtW3yGIMfowPwYIKwYBBQUHAQMEMwwxdGVzdFBTUF9BSS4uLmIx\nNzQ5OWE4LWQ4NmYtNDc2YS05YWEzLTI4ZDA0ZDk2YzI5YTANBgkqhkiG9w0BAQsF\nAAOCAQEAJPjI0kWRpgpZ5VSk3a3AwIzXz5uGkeFxCMMEQAmAn/Og+jz3T6RzKUol\nE5FWV/mKnBdkc+Te5vjDCPNEjzB/VyvJdSTaDSyXoQ5mpZIFmdnbX9X4OBYpEckv\nDS3Bs1VKf0SFEPW/+ZJzhQ3qlOGeoOo7nV3v8ofrPvyZXWCEe1ftBgESe8sBWu3T\nCOTguRFklu2TB6GgymHX6Aa95Kp13Y+ls9jf6PuAq5kyn6jpFAJuXVFx6e4tb+2L\nZf+h9DQ510duKQbkfWw+ucO2MpQWz1hOyjcHb3jpX/kgb8xZnnTPDlEYZaJXKvO/\nzbmFUsFBcOvhmZpEJyBhJg88s/27JA==\n-----END CERTIFICATE-----\n"}},"exp":1574093210}

Example of response

{"data":{"message":"example_data.message"}}
Request

POST /api/v2/tpp/certificates

Headers
Header Type Description
Authorization string, required JSON Web Token containing payload, signed using RSA256 and application.private_key. Can raise: JWTClaimMissing, JWTIncorrectAlgorithm, PublicKeyInvalid, AuthorizationMissing, RequestFormatInvalid, WrongRequiredFields
App-Id string, required Application’s app_id from connection details tab. Can raise: OauthAppNotFound, CertificateNotFound
App-Secret string, required Application’s app_secret from connection details tab.
Client-Request-Id string, optional Request identifier. If present, it will be returned within meta field in response.
Unpacked Authorization
exp
integer, required
The lifetime of the request in timestamp UTC format. Values greater than: Current time.
Response

Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other posibilities.


Related Errors
Class Code Description
JWTClaimMissing 400 Authorization Token expiration is not provided. Please specify exp alongside data field.
JWTIncorrectAlgorithm 400 Authorization Token was encrypted with incorrect algorithm. Please use RSA256 algorithm for ecnrypting.
PublicKeyInvalid 400 Given public key is not a public key.
AuthorizationMissing 400 Authorization header is missing.
RequestFormatInvalid 400 Request format is wrong. Details are stored in error_message
WrongRequiredFields 401 Specified required fields were not provided. More info in error_message
OauthAppNotFound 404 OAuth Application specified in request does not exist or cannot be retrieved.
CertificateNotFound 404 Certificate has no permissions.

Add OBSEAL Certificate

Used for adding an OBSEAL certificate. On successful response (200 status code), the UK TPPs’ existing eIDAS certificate will be switched with the OBSEAL certificate obtained from the OpenBanking Directory. The body of the request has to contain the JWT built from the parameters below and signed with the OBSEAL Certificate.

CURL

curl -i  \ 
 -H "Content-Type: application/jwt" \ 
 -H "X-Request-ID: 9b45fa6c-ff61-4e73-aec8-5e805388ce7f" \ 
 -H "Digest: SHA-256=47DEQpj8HBSa+/TImW+5JCeuQeRkm5NMpJWZG3hSuFU=" \ 
 -H "Date: Wed, 18 Dec 2019 11:25:59 GMT" \ 
 -H "TPP-Signature-Certificate: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVBakNDQXVvQ0FRQXdEUVlKS29aSWh2Y05BUUVMQlFBd1d6RVhNQlVHQTFVRVlRd09WSEJ3VTJGc2RGUmwKYzNRd01EQXhJREFlQmdOVkJBTU1GMk5sY25SVFNVZE9VMEZNVkZSRlUxUWdWMlZpSUVOQk1SRXdEd1lEVlFRSwpEQWhUWVd4MFZHVnpkREVMTUFrR0ExVUVCaE1DVWs4d0hoY05NVGt4TWpFNE1URXlOVFU1V2hjTk1qRXhNakUzCk1URXlOVFU1V2pDQmpURVdNQlFHQTFVRUF3d05jMkZzZEMxMFpYTjBMbU52YlRFUk1BOEdBMVVFQ2d3SVUyRnMKZEZSbGMzUXhDekFKQmdOVkJBWVRBbEpQTVJJd0VBWURWUVFJREFsQ2RXTjFjbVZ6ZEdreEVqQVFCZ05WQkFjTQpDVUoxWTNWeVpYTjBhVEVXTUJRR0ExVUVDUXdOUVd4aVlTQkpkV3hwWVNBM05URVRNQkVHQTFVRVlRd0thV1JsCmJuUnBabWxsY2pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBS2dXNEo5K0hGY0wKUVVwTEk0c1pCSm5RaGdRYUpYRGxwVDI4NWxlOGVEcTdUalpnYXpLcU05RkJydzRBRURxUmxYR3Znd2luSkY2Mgowd3VJcSs3cGpPWFBQdytZOVhRQnBTa2p1cmJ5aEpPZjhiNlVqTFBMQnVBd09rRk52N0prbHdLeXFmazRHRzROCmdrOGRVYTFjS05MY1gzNzdwdno0Q0hZalBraGlLY0xqQVJ4TFRJYkdtejlZQVQvQWszbDdCRkRkV2owQnJrR2oKV2RGelJWV3FjdHA0NjVvWEZXZTZ3QmlybEplK1JEZ2hnQWRUQWlQR1J3WHV4dmRiSW5SOHZ2b0RJNTJHRXVzaApGWUNZd28zdWFVSVR5Z3hOZEJyWjVOaVpLaCtybjVVNW4zM0pETm9OV2hCVUUwMUwvaFYzUHlleHBKVHltaURQCjZTUFJKM0ZMR3RrQ0F3RUFBYU9Cb2pDQm56QU1CZ05WSFJNRUJUQURBUUgvTUE0R0ExVWREd0VCL3dRRUF3SUIKQmpBZEJnTlZIUTRFRmdRVUtwUGZ5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dId1lEVlIwakJCZ3dGb0FVS3BQZgp5MTlSQUJQS3J2YnNNUnRXM3lHSU1mb3dQd1lJS3dZQkJRVUhBUU1FTXd3eGRHVnpkRkJUVUY5QlNTNHVMbUZsCk9EVTBNalE1TFdaaVpEQXROREV4WmkxaU0ySXdMV0poWkRFNE5Ea3hNelptWmpBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFacHEvdmF5T3ZSS3dKd1dPQnpTMzhoUHA4TjVnRTlqd2J6dkxCTUhvZERXZk11ZTA5SzFweUI3KwpQdU1rZjNOT0tVSERMWDhob0xiZ0dWVlY0S1lqRndGa203cWY0OTZNTWE0VnZBRWNPeUJkM0pGVWcyeGIxVlN4Cjk0OWVCaVdGcGtaSVNZZUNxNXJ4UWFNeHJJVm9OZjhaSjVOT2V3aU1DM0ZYM3duVGw2VG9yUW1lQUU5MnhuMEQKdnZ6ZUJ4YlFqdTdjQlh3SDFPaGdUamx0YTM1WE1ESjhXbGo4TWZRR0YvZThIZFIrS014WWU5SWNROHN1UjdBVQpGRGkyaUJsMlVQc3dCa0FqMHJRVlY2U2psNWdVSm95K0FJaGZBYXE2cUxSQnJ1NGJTbE44TnVpY2RTRkZ3eHZ1ClEwOVl1U3U3djQ2a1R3ZUxpNnZJZGQxaUxUc05Ndz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K" \ 
 -H "Signature: Signature keyId="SN=0,DN=/organizationIdentifier=TppSaltTest000/CN=certSIGNSALTTEST Web CA/O=SaltTest/C=RO",algorithm="rsa-sha256",headers="digest date x-request-id",signature="Fys106OY/uMk1Tnh4MEvHsUKdJIOX9fw+am3NrqrxFOLIl1BGlcu1+UJhDBHlc3/rkRn0++5AAbkXzqUL8kqm1RVILoRzSg+tr75PUTM5RlIgCli8QtHZrpZtfzb7tEoHqa8zo1SmiopI/bQchQrjdhWu9xIC0TUuMfiD8f6TdH2QpbkXi25uXTQl8wB4qt2dAb4k76lkDM4x29JVmoZkWq28R/kVkPWGJrU7mS2viUUhgofdNzL2vaSd2g7FPrr/E03U/KYU0k047ucCbv1Z4ozdaSJljuyzj0Iq4O04Ztj6oaV8yhnr3LY8aKj1JO9tRy1gpSidxCAqDz90iE9LQ=="" \ 
 -d '{
  "requestObjectSigningAlg": "PS256",
  "iss": "beKuxC1RniVsTeLYwfpgNP",
  "iat": 1606297853,
  "exp": 1606298169,
  "aud": "0dw23dsa13123",
  "tokenEndpointAuthMethod": "client_secret_basic",
  "tokenEndpointAuthSigningAlg": "PS256",
  "grantTypes": [
    "client_credentials",
    "authorization_code",
    "refresh_token"
  ],
  "responseTypes": [
    "code id_token"
  ],
  "softwareStatement": "eyJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0In0.eyJpc3MiOiJPcGVuQmFua2luZyBMdGQiLCJpYXQiOjE0OTI3NTYzMzEsImp0aSI6ImlkMTIzNDU2ODU0Mzk0ODc2NzgiLCJzb2Z0d2FyZV9lbnZpcm9ubWVudCI6InByb2R1Y3Rpb24iLCJzb2Z0d2FyZV9tb2RlIjoibGl2ZSIsInNvZnR3YXJlX2lkIjoiNjVkMWYyN2MtNGFlYS00NTQ5LTljMjEtNjBlNDk1YTdhODZmIiwic29mdHdhcmVfY2xpZW50X2lkIjoiT3BlbkJhbmtpbmcgVFBQIENsaWVudCBVbmlxdWUgSUQiLCJzb2Z0d2FyZV9jbGllbnRfbmFtZSI6IkFtYXpvbiBQcmltZSBNb3ZpZXMiLCJzb2Z0d2FyZV9jbGllbnRfZGVzY3JpcHRpb24iOiJBbWF6b24gUHJpbWUgTW92aWVzIGlzIGEgbW92aW5nIHN0cmVhbWluZyBzZXJ2aWNlIiwic29mdHdhcmVfdmVyc2lvbiI6IjIuMiIsInNvZnR3YXJlX2NsaWVudF91cmkiOiJodHRwczovL3ByaW1lLmFtYXpvbi5jb20iLCJzb2Z0d2FyZV9yZWRpcmVjdF91cmlzIjpbImh0dHBzOi8vcHJpbWUuYW1hem9uLmNvbS9jYiIsImh0dHBzOi8vcHJpbWUuYW1hem9uLmNvLnVrL2NiIl0sInNvZnR3YXJlX3JvbGVzIjpbIlBJU1AiLCJBSVNQIl0sIm9yZ2FuaXNhdGlvbl9jb21wZXRlbnRfYXV0aG9yaXR5X2NsYWltcyI6W3siYXV0aG9yaXR5X2lkIjoiRk1BIiwicmVnaXN0cmF0aW9uX2lkIjoiMTExMTExIiwic3RhdHVzIjoiQWN0aXZlIiwiYXV0aG9yaXNhdGlvbnMiOlt7Im1lbWJlcl9zdGF0ZSI6IkdCUiIsInJvbGVzIjpbIlBJU1AiLCJBSVNQIl19LHsibWVtYmVyX3N0YXRlIjoiUk9JIiwicm9sZXMiOlsiUElTUCJdfV19XSwic29mdHdhcmVfbG9nb191cmkiOiJodHRwczovL3ByaW1lLmFtYXpvbi5jb20vbG9nby5wbmciLCJvcmdfc3RhdHVzIjoiQWN0aXZlIiwib3JnX2lkIjoiQW1hem9uIFRQUElEIiwib3JnX25hbWUiOiJPcGVuQmFua2luZyBUUFAgUmVnaXN0ZXJlZCBOYW1lIiwib3JnX2NvbnRhY3RzIjpbeyJuYW1lIjoiY29udGFjdCBuYW1lIiwiZW1haWwiOiJjb250YWN0QGNvbnRhY3QuY29tIiwicGhvbmUiOiIrNDQ3ODkwMTMwNTU4IiwidHlwZSI6ImJ1c2luZXNzIn0seyJuYW1lIjoiY29udGFjdCBuYW1lIiwiZW1haWwiOiJjb250YWN0QGNvbnRhY3QuY29tIiwicGhvbmUiOiIrNDQ3ODkwMTMwNTU4IiwidHlwZSI6InRlY2huaWNhbCJ9XSwib3JnX2p3a3NfZW5kcG9pbnQiOiJodHRwczovL2p3a3Mub3BlbmJhbmtpbmcub3JnLnVrL29yZ19pZC9vcmdfaWQuamt3cyIsIm9yZ19qd2tzX3Jldm9rZWRfZW5kcG9pbnQiOiJodHRwczovL2p3a3Mub3BlbmJhbmtpbmcub3JnLnVrL29yZ19pZC9yZXZva2VkL29yZ19pZC5qa3dzIiwic29mdHdhcmVfandrc19lbmRwb2ludCI6Imh0dHBzOi8vandrcy5vcGVuYmFua2luZy5vcmcudWsvb3JnX2lkL3NvZnR3YXJlX2lkLmprd3MiLCJzb2Z0d2FyZV9qd2tzX3Jldm9rZWRfZW5kcG9pbnQiOiJodHRwczovL2p3a3Mub3BlbmJhbmtpbmcub3JnLnVrL29yZ19pZC9yZXZva2VkL3NvZnR3YXJlX2lkLmprd3MiLCJzb2Z0d2FyZV9wb2xpY3lfdXJpIjoiaHR0cHM6Ly90cHAuY29tL3BvbGljeS5odG1sIiwic29mdHdhcmVfdG9zX3VyaSI6Imh0dHBzOi8vdHBwLmNvbS90b3MuaHRtbCIsInNvZnR3YXJlX29uX2JlaGFsZl9vZl9vcmciOiJodHRwczovL2FwaS5vcGVuYmFua2luZy5vcmcudWsvc2NpbTIvT0JUcnVzdGVkUGF5bWVudFBhcnR5LzEyMzQ1Njc3ODkiLCJvYl9yZWdpc3RyeV90b3MiOiJodHRwczovL3JlZ2lzdHJ5Lm9wZW5iYW5raW5nLm9yZy51ay90b3MuaHRtbCJ9.oHlq7NxEoj0vdXeTR5cUz7oIq7Vt9dB34pbwxtDhWTs",
  "softwareId": "beKuxC1RniVsTeLYwfpgNP",
  "redirectUris": [
    "https://redirect.here",
    "http://and.here"
  ],
  "scope": "makepayment",
  "applicationType": "web",
  "idTokenSignedResponseAlg": "PS256"
}' \ 
-X POST "/api/berlingroup/v1/tpp/certificates"

Example of unpacked Authorization header

{"requestObjectSigningAlg":"PS256","iss":"beKuxC1RniVsTeLYwfpgNP","iat":1606297853,"exp":1606298169,"aud":"0dw23dsa13123","tokenEndpointAuthMethod":"client_secret_basic","tokenEndpointAuthSigningAlg":"PS256","grantTypes":["client_credentials","authorization_code","refresh_token"],"responseTypes":["code id_token"],"softwareStatement":"eyJhbGciOiJIUzI1NiIsImtpZCI6IkFCQ0QxMjM0In0.eyJpc3MiOiJPcGVuQmFua2luZyBMdGQiLCJpYXQiOjE0OTI3NTYzMzEsImp0aSI6ImlkMTIzNDU2ODU0Mzk0ODc2NzgiLCJzb2Z0d2FyZV9lbnZpcm9ubWVudCI6InByb2R1Y3Rpb24iLCJzb2Z0d2FyZV9tb2RlIjoibGl2ZSIsInNvZnR3YXJlX2lkIjoiNjVkMWYyN2MtNGFlYS00NTQ5LTljMjEtNjBlNDk1YTdhODZmIiwic29mdHdhcmVfY2xpZW50X2lkIjoiT3BlbkJhbmtpbmcgVFBQIENsaWVudCBVbmlxdWUgSUQiLCJzb2Z0d2FyZV9jbGllbnRfbmFtZSI6IkFtYXpvbiBQcmltZSBNb3ZpZXMiLCJzb2Z0d2FyZV9jbGllbnRfZGVzY3JpcHRpb24iOiJBbWF6b24gUHJpbWUgTW92aWVzIGlzIGEgbW92aW5nIHN0cmVhbWluZyBzZXJ2aWNlIiwic29mdHdhcmVfdmVyc2lvbiI6IjIuMiIsInNvZnR3YXJlX2NsaWVudF91cmkiOiJodHRwczovL3ByaW1lLmFtYXpvbi5jb20iLCJzb2Z0d2FyZV9yZWRpcmVjdF91cmlzIjpbImh0dHBzOi8vcHJpbWUuYW1hem9uLmNvbS9jYiIsImh0dHBzOi8vcHJpbWUuYW1hem9uLmNvLnVrL2NiIl0sInNvZnR3YXJlX3JvbGVzIjpbIlBJU1AiLCJBSVNQIl0sIm9yZ2FuaXNhdGlvbl9jb21wZXRlbnRfYXV0aG9yaXR5X2NsYWltcyI6W3siYXV0aG9yaXR5X2lkIjoiRk1BIiwicmVnaXN0cmF0aW9uX2lkIjoiMTExMTExIiwic3RhdHVzIjoiQWN0aXZlIiwiYXV0aG9yaXNhdGlvbnMiOlt7Im1lbWJlcl9zdGF0ZSI6IkdCUiIsInJvbGVzIjpbIlBJU1AiLCJBSVNQIl19LHsibWVtYmVyX3N0YXRlIjoiUk9JIiwicm9sZXMiOlsiUElTUCJdfV19XSwic29mdHdhcmVfbG9nb191cmkiOiJodHRwczovL3ByaW1lLmFtYXpvbi5jb20vbG9nby5wbmciLCJvcmdfc3RhdHVzIjoiQWN0aXZlIiwib3JnX2lkIjoiQW1hem9uIFRQUElEIiwib3JnX25hbWUiOiJPcGVuQmFua2luZyBUUFAgUmVnaXN0ZXJlZCBOYW1lIiwib3JnX2NvbnRhY3RzIjpbeyJuYW1lIjoiY29udGFjdCBuYW1lIiwiZW1haWwiOiJjb250YWN0QGNvbnRhY3QuY29tIiwicGhvbmUiOiIrNDQ3ODkwMTMwNTU4IiwidHlwZSI6ImJ1c2luZXNzIn0seyJuYW1lIjoiY29udGFjdCBuYW1lIiwiZW1haWwiOiJjb250YWN0QGNvbnRhY3QuY29tIiwicGhvbmUiOiIrNDQ3ODkwMTMwNTU4IiwidHlwZSI6InRlY2huaWNhbCJ9XSwib3JnX2p3a3NfZW5kcG9pbnQiOiJodHRwczovL2p3a3Mub3BlbmJhbmtpbmcub3JnLnVrL29yZ19pZC9vcmdfaWQuamt3cyIsIm9yZ19qd2tzX3Jldm9rZWRfZW5kcG9pbnQiOiJodHRwczovL2p3a3Mub3BlbmJhbmtpbmcub3JnLnVrL29yZ19pZC9yZXZva2VkL29yZ19pZC5qa3dzIiwic29mdHdhcmVfandrc19lbmRwb2ludCI6Imh0dHBzOi8vandrcy5vcGVuYmFua2luZy5vcmcudWsvb3JnX2lkL3NvZnR3YXJlX2lkLmprd3MiLCJzb2Z0d2FyZV9qd2tzX3Jldm9rZWRfZW5kcG9pbnQiOiJodHRwczovL2p3a3Mub3BlbmJhbmtpbmcub3JnLnVrL29yZ19pZC9yZXZva2VkL3NvZnR3YXJlX2lkLmprd3MiLCJzb2Z0d2FyZV9wb2xpY3lfdXJpIjoiaHR0cHM6Ly90cHAuY29tL3BvbGljeS5odG1sIiwic29mdHdhcmVfdG9zX3VyaSI6Imh0dHBzOi8vdHBwLmNvbS90b3MuaHRtbCIsInNvZnR3YXJlX29uX2JlaGFsZl9vZl9vcmciOiJodHRwczovL2FwaS5vcGVuYmFua2luZy5vcmcudWsvc2NpbTIvT0JUcnVzdGVkUGF5bWVudFBhcnR5LzEyMzQ1Njc3ODkiLCJvYl9yZWdpc3RyeV90b3MiOiJodHRwczovL3JlZ2lzdHJ5Lm9wZW5iYW5raW5nLm9yZy51ay90b3MuaHRtbCJ9.oHlq7NxEoj0vdXeTR5cUz7oIq7Vt9dB34pbwxtDhWTs","softwareId":"beKuxC1RniVsTeLYwfpgNP","redirectUris":["https://redirect.here","http://and.here"],"scope":"makepayment","applicationType":"web","idTokenSignedResponseAlg":"PS256"}

Example of response

{"tlsClientAuthSubjectDn":"N/A","clientId":"ABCD1234","clientSecret":"N/A","clientIdIssuedAt":1606297853,"clientSecretExpiresAt":0,"redirectUris":["https://redirect.here","http://and.here"],"tokenEndpointAuthMethod":"client_secret_basic","tokenEndpointAuthSigningAlg":"PS256","grantTypes":["client_credentials","authorization_code","refresh_token"],"responseTypes":["code id_token"],"softwareId":"beKuxC1RniVsTeLYwfpgNP","scope":"makepayment","applicationType":"web","idTokenSignedResponseAlg":"PS256","requestObjectSigningAlg":"PS256"}
Request

POST /api/berlingroup/v1/tpp/certificates

Headers
Header Type Description
X-Request-ID string, required ID of the request, unique to the call, as determined by the initiating party.
Digest string, required Contains a Hash of the message body, if the message does not contain a body, the "Digest" header must contain the hash of an empty string - "". Can raise: CertificateMissing, CertificateInvalid, SignatureInvalid, SignatureMissing, SignatureMalformed
Date datetime, required Endpoint request execution date.
TPP-Signature-Certificate string, required The certificate used for signing the request, in base64 encoding that should comply with RFC 4648 (No line feeds). Can raise: CertificateMissing, CertificateInvalid
Signature string, required A signature of the request by the TPP on application level. This might be mandated by ASPSP. Can raise: CertificateMissing, CertificateInvalid, SignatureMissing, SignatureInvalid, SignatureMalformed
Content-Type string, required The media type of the body of the request. Allowed values: application/jwt, text/plain
Parameters
iss
string, required
TPP identifier: software_id from SSA. Can raise: ActionNotAllowed
iat
integer, required
The time at which the request was issued by the TPP expressed as "seconds since the epoch"
exp
integer, required
The time at which the request expires expressed as seconds since the epoch. Values greater than: 1614537228
aud
string, required
The audience for the request. This should be the unique identifier for the ASPSP issued by the issuer of the software statement.
tokenEndpointAuthMethod
string, optional
Specifies which Token endpoint authentication method the TPP wants to use. It should be noted that only tls_client_auth and client_secret_basic are FAPI compliant. Default value: client_secret_basic Allowed values: client_secret_basic
tokenEndpointAuthSigningAlg
string, optional
Algorithm which the TPP uses to authenticate with the token endpoint. Default value: PS256 Allowed values: PS256
grantTypes
array, required
A JSON array specifying what the TPP can request to be supplied to the token endpoint as exchange for an access token. Allowed values: client_credentials, authorization_code, refresh_token
responseTypes
array, optional
A JSON array specifying what the TPP can request to be returned from the ASPSP authorisation endpoint. Default value: ["code id_token"] Allowed values: code, code id_token
softwareStatement
string, required
Software statement assertion issued by the issuer. The data model for the software statements issued by the Open Banking directory are documented as part of the Directory Specification. Can raise: Forbidden
softwareId
string, optional
If specified, the software_id in the request MUST match the software_id specified in the SSA.
redirectUris
array, required
Registered URIs the TPP will use to interact with the ASPSP AS. If the software statement defines a master set of redirect URIs, this must match or be a subset of the redirect URIs in the SSA.
scope
string, optional
Scopes the client is asking for (if not specified, default scopes are assigned by the AS). This consists of a list scopes separated by spaces. Allowed values: openid, makepayment, accounts, payments
applicationType
string, optional
Please specify whether TPP software is a mobile or a web app. Allowed values: web, mobile
idTokenSignedResponseAlg
string, optional
Algorithm which the TPP expects to sign the id_token, if an id_token is returned. Allowed values: PS256
requestObjectSigningAlg
string, optional
Algorithm which the TPP expects to sign the request object if a request object will be part of the authorization request sent to the ASPSP. Allowed values: PS256
Response

Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other posibilities.


clientId
string, required
Returned after successful registration client identifier. Will be used afterwards for TPP identification.
clientSecret
string, optional
A shared secret that goes in pair with client_id. Currently not supported.
clientIdIssuedAt
integer, required
Time at which the client identifier was issued expressed as "seconds since the epoch".
clientSecretExpiresAt
integer, optional
Time at which the client secret will expire expressed as "seconds since the epoch". The value must be populated if a client_secret is returned. Default value: 0
redirectUris
array, required
Registered URIs the TPP will use to interact with the ASPSP AS. If the software statement defines a master set of redirect URIs, this must match or be a subset of the redirect URIs in the SSA.
tokenEndpointAuthMethod
string, required
Specifies which Token endpoint authentication method the TPP wants to use. It should be noted that only tls_client_auth and client_secret_basic are FAPI compliant. Default value: client_secret_basic Allowed values: client_secret_basic
tokenEndpointAuthSigningAlg
string, optional
Algorithm which the TPP uses to authenticate with the token endpoint. Default value: PS256 Allowed values: PS256
grantTypes
array, required
A JSON array specifying what the TPP can request to be supplied to the token endpoint as exchange for an access token. Allowed values: client_credentials, authorization_code, refresh_token
responseTypes
array, optional
A JSON array specifying what the TPP can request to be returned from the ASPSP authorisation endpoint. Default value: ["code id_token"] Allowed values: code, code id_token
softwareId
string, optional
If specified, the software_id in the request MUST match the software_id specified in the SSA.
scope
string, required
Scopes the client is asking for (if not specified, default scopes are assigned by the AS). This consists of a list scopes separated by spaces. Allowed values: openid, makepayment, accounts, payments
applicationType
string, required
Please specify whether TPP software is a mobile or a web app. Allowed values: web, mobile
idTokenSignedResponseAlg
string, optional
Algorithm which the TPP expects to sign the id_token, if an id_token is returned. Allowed values: PS256
requestObjectSigningAlg
string, optional
Algorithm which the TPP expects to sign the request object if a request object will be part of the authorization request sent to the ASPSP. Allowed values: PS256
tlsClientAuthSubjectDn
string, optional
The tls_client_auth_subject_dn claim MUST contain the DN of the certificate that the TPP will present to the ASPSP token endpoint. Currently not supported.
Related Errors
Class Code Description
CertificateMissing 401 This request cannot be performed without Certificate header.
CertificateInvalid 401 Given certificate is invalid.
SignatureInvalid 401 Given signature is invalid.
SignatureMissing 401 This request cannot be performed without Signature header.
SignatureMalformed 401 Given signature is malformed.
Forbidden 403 Action is forbidden. More details in error_message.
ActionNotAllowed 406 You're not allowed to perform this action. This might be a rate limit, configuration problem or parameters incompatibility.