Overall Changes

Custom Authentication has been completely revamped to simplify checkpoint handling and provide a more consistent experience across all providers. You can now handle the full authentication flow using only two endpoints:

• Start Auth Intent
• Solve a Checkpoint

The recommended way to migrate is to follow our complete guide: Authenticate with Custom Auth.

Hosted Authentication is now more customizable and offers the same level of configuration flexibility as Custom Authentication. Because of this, the request body structure for creating links has changed.

Additionally, the success screen at the end of the flow should now be handled by your own application after the redirection.

The recommended way to migrate is to follow our complete guide: Authenticate with Hosted Auth.

Methods changes

List all accounts (GET /v1/accounts)

• Query param cursor is removed
  • Use offset and limit for pagination

Connect an account (native authentication) (POST /v1/accounts)

• Route changed
  • Use POST /v2/auth/intent Start Auth Intent
• Authentication flow has probably changed based on the provider, read the Authentication with Custom Authentication guide.

Connect an account (hosted authentication) (POST /v1/hosted/accounts/link)

• Use POST /v2/auth/link Create Auth Link
• Body is different on those routes, refer to the Authentication with Hosted Auth guide.

Reconnect an account (POST /v1/accounts/:account_id)

• Route is removed
  • Use POST /v2/auth/intent Start Auth Intent and provide the account_id in the body
• Authentication flow has probably changed based on the provider, read the Authentication with Custom Authentication guide.

Solve a code checkpoint (POST /v1/accounts/checkpoint)

• Route changed
  • Use POST /v2/auth/checkpoint Solve a Checkpoint
• Body param account_id is removed
  • Use the intent_id given by the Start Auth Intent route.
• Body param provider is removed

Resend checkpoint notification (POST /v1/accounts/checkpoint/resend)

• Route is removed
  • Use POST /v2/auth/checkpoint Solve a Checkpoint
• Authentication flow has probably changed based on the provider, read the Authentication with Custom Authentication guide.

Restart an account (POST /v1/accounts/:account_id/restart)

• Route is removed
  • Accounts restart automatically now

Resynchronize account messaging data (GET /v1/accounts/:account_id/sync)

• Route is removed
  • Accounts stay in sync now

Update account proxy (POST /v1/accounts/:account_id)

• Use PATCH /v2/accounts/:account_id Update an Account
• The behavior might have change, please refer to the Proxies guide.

Account object changes