---
title: "Refresh credentials"
method: POST
path: "/api/v1/credentials/{id}/refresh"
tags: ["Connectivity v1.Credentials", "ENTERPRISE", "REGION.US"]
---

# Refresh credentials

`POST /api/v1/credentials/{id}/refresh`

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.

## Path parameters

- `id` string, required

## Query parameters

- `items` string[]
- `optIn` boolean
- `authenticate` boolean

## Request body

- RefreshCredentialsRequest
  - `appUri` string — 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.)
  - `callbackUri` string — 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.
  - `originatingUserIp` string — (DEPRECATED) Use the field in the userAvailability object. This will be ignored if userAvailability is provided.
  - `selectedAuthenticationOptions` SelectedAuthenticationOption[] — [BETA] Specifies the selected authentication options for each available group when a provider has more than one authentication option available in any of the available groups. Note that if you send in selected authentication options for a refresh request authenticate flag needs to be set to true.
    - `authenticationOptionDefinition` string — Specifies the selected authentication option. This is only required if selectedAuthenticationOptions is used.
    - `authenticationOptionsGroup` string — Specifies the authentication option group for which we have selected an authentication option. This is only required if selectedAuthenticationOptions is used.
    - `fields` object — Specifies the values for the fields that are required to be sent when this authentication option is selected, if any.
  - `userAvailability` UserAvailability
    - `originatingUserIp` string — The originating user's remote IP address of the corresponding HTTP request.
    - `userAvailableForInteraction` boolean, required — Indicates whether or not we can interact with the user (e.g. SCA through any supplemental information flow)
    - `userPresent` boolean, required — The userPresent flag indicates whether or not the user is present at the time of the operation. A present user doesn't necessarily mean we can interact with the user. Imagine an app that, automatically, refreshes all credentials upon the user entering the app. This doesn't mean that the user is ready ("available") for interaction. For knowing if the user is available for interaction, use the flag userAvailableForInteraction.

## Response `204`

The credentials refresh was successfully initiated.

## Other responses

- `404` — The credentials could not be found.

---

[API](https://skmtc.net/tink/apis/tink-api.md) · [All operations](https://skmtc.net/tink/apis/tink-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tink/tink-api/revisions/23d8982b533d/schema)