Skip to main content

Update via Link

Use Update mode to update decentralized permissions or to handle the GRANT_LOGIN_REQUIRED error status.

When to use Update mode​

Update mode is used to update authentication or authorization for a Grant. The most common reason for this is when access to an existing Grant stops working: if the end user changes a password, if multi-factor authentication (MFA) requirements change, or if the login becomes locked.

Resolving GRANT_LOGIN_REQUIRED​

Receiving an GRANT_LOGIN_REQUIRED webhook indicates that the Grant should be re-initialized via update mode.

If you receive the GRANT_LOGIN_REQUIRED error after calling a bankHub endpoint, implement Link in update mode during the user flow, and ask the user to re-authenticate before proceeding to the next step in your flow.

If you receive the GRANT_LOGIN_REQUIRED error via the ITEM: ERROR webhook, re-authenticate with Link in update mode when the user is next in your app. You will need to tell your user (using in-app messaging and/or notifications such as email or text message) to return to your app to fix their Grant.

Using Update Mode​

To use update mode for a Grant, initialize Link with a linkToken configured with the accessToken for the Grant that you wish to update.

Request Body
  • scopes integer required

    List of bankHub product(s) you want to use.

  • redirectUri string required

    A URI indicating the destination where a user should be forwarded after completing the Link flow; used to support OAuth authentication flows when launching Link in the browser or via a webview. The redirectUri should not contain any query parameters. When used in Production or Development, must be an https URI. Note that any redirect URI must also be added to the Allowed redirect URIs list in the developer console.

  • language string

    The language that Link should be displayed in.

Responses

Success

Schema
  • grantToken string

    Grant token

  • expiration string

    The expiration date for the grantToken, in ISO 8601 format

Loading...