Identities

Reauthenticate Identity

Changed on

Re-authenticates an identity on demand: validates the saved browser profile and runs login if it is no longer signed in, then persists the refreshed profile and tears the temporary session down. Equivalent to a session with identity_skip_validation: false that ends after auth.

post/v1/identities/{identityId}/reauthenticate

Request

  • Base URL
    https://api.anchorbrowser.io
  • Auth
    API key in header anchor-api-key

Path parameters

identityIdstring uuid required

The ID of the identity to reauthenticate

Request body

syncboolean

When true (default), wait for authentication to finish and persist the refreshed profile before returning. When false, start authentication asynchronously.

Response

Identity reauthentication started or completed

identityIdstring required

The identity that was reauthenticated

asyncboolean required

Whether authentication is still running in the background

sessionIdstring required

Browser session that ran the reauthentication; its recording shows what happened

auth_status'authenticated' | 'pending' required

authenticated: the identity is signed in again; pending: an async run is still in progress

method'profile' | 'task' | 'mixed'

How the identity got authenticated: profile = stored profile was still signed in, task = agentic authentication task, mixed = both. Absent while pending.

Changes