Sign in
latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

Connectivity v1.Credentials
ENTERPRISE
REGION.US

Refresh credentials

Refreshes the specified credentials. Please note that there can be only one on-demand refresh ongoing for a credential at a time, any other attempts will be rejected.

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

Path parameters

idstring required

The internal identifier of the Credentials object to refresh.

Query parameters

itemsstring[]

The data types to aggregate from the Provider. Multiple items are allowed. If omitted, all data types are aggregated.

optInboolean

Set to true to trigger an opt-in of accounts before doing the refresh. Today only available for enterprise customers.

authenticateboolean

Set to true to trigger authentication flow before doing the refresh.

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

(DEPRECATED) Use the field in the userAvailability object. This will be ignored if userAvailability is provided.

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"
      }
    }
  ],
  "userAvailability": {
    "originatingUserIp": "198.51.100.10",
    "userAvailableForInteraction": true,
    "userPresent": true
  }
}

Response

The credentials refresh was successfully initiated.