latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

Connectivity v1.Credentials

Manual authenticate of credentials

Triggers a full authentication flow to renew refresh tokens with ASPSPs. This endpoint only triggers authentication, thus a full credentials refresh will not be executed.

post/api/v1/credentials/{id}/authenticate

Path parameters

idstring required

The internal identifier of the Credentials object to authenticate.

Request body

appUristring

The end user will be redirected to this URI after the authorization code has been delivered. This field is used for flows where we have third party redirects to financial institutions. There is a default value which is tink://open. It can be any type of URI (mobile deeplink, http address etc.)

callbackUristring

This URI will be used by the ASPSP to pass the authorization code. It corresponds to the redirect/callback URI in OAuth2/OpenId. This parameter is only applicable if you are a TPP.

originatingUserIpstring

The originating user's remote IP address of the corresponding HTTP request.

Example request

{
  "appUri": "https://my-customer-app.com/authentication",
  "callbackUri": "http://my-customer-app.com/callback",
  "originatingUserIp": "198.51.100.10",
  "selectedAuthenticationOptions": [
    {
      "authenticationOptionDefinition": "SE_MOBILE_BANKID_OTHER_DEVICE",
      "authenticationOptionsGroup": "SE_MOBILE_BANKID_DEVICE_CHOICE",
      "fields": {
        "username": "198401011111"
      }
    }
  ]
}

Response

The credentials authentication was successfully initiated.