Skip to main content
POST
/
v1
/
identities
curl --request POST \
  --url https://api.anchorbrowser.io/v1/identities \
  --header 'Content-Type: application/json' \
  --header 'anchor-api-key: <api-key>' \
  --data '
{
  "name": "My Work Account",
  "source": "https://example.com/login",
  "credentials": [
    {
      "type": "username_password",
      "username": "[email protected]",
      "password": "securepassword123"
    }
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "pending",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
anchor-api-key
string
header
required

API key passed in the header

Query Parameters

​
validateAsync
boolean
default:true

Whether to validate the identity asynchronously. Defaults to true.

Body

application/json
​
source
string<uri>
required

The source URL for the identity (e.g., login page URL)

​
credentials
(username_password · object | authenticator · object | custom · object)[]
required

Array of credentials for authentication

​
name
string

Name of the identity. Defaults to "Unnamed Identity" if not provided.

​
metadata
object

Optional metadata for the identity

​
applicationName
string

Optional application name to associate with the identity

​
applicationDescription
string

Optional application description

Response

Identity created successfully

​
id
string<uuid>

Unique identifier for the identity

​
name
string

Name of the identity

​
status
enum<string>

Status of the identity

Available options:
pending,
validated,
failed
​
metadata
object

Metadata associated with the identity

​
created_at
string<date-time>

Timestamp when the identity was created