latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

Connectivity v1.Credentials

Modify credentials

Modify the specified credentials. The request will trigger a refresh towards the provider.

put/api/v1/credentials/{id}

Path parameters

idstring required

The internal identifier of the credentials to change

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.

fieldsobject

This is a key-value map of Field name and value found on the Provider to which the credentials belongs to.

originatingUserIpstring

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

providerNamestring

The provider (financial institution) that the credentials is connected to.

triggerRefreshboolean

Defines if the Credentials update should cause the Credentials refresh. Defaults to true

Example request

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

Response

The credentials was successfully modified.

Connectivity20v1Credentials required— unresolved $ref