---
title: "connect"
slug: "avatar-connect"
updated: 2025-11-07T16:30:47Z
published: 2025-11-07T16:30:47Z
canonical: "docs.doc-know.com/avatar-connect"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.doc-know.com/llms.txt
> Use this file to discover all available pages before exploring further.

# connect

### avatar.connect

Connects to the avatar associated with the specified identity.

### Input Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| **identity** | Object | Yes | Identity associated with target avatar |
| **[simOnly]** | Boolean | No | Whether or not to connect when in simulation mode only; Default = **false** |

### Returns

Type: **Avatar** (JSON object)

If connection is successful, an avatar JSON object is returned. Otherwise, null is returned.

### Examples

```
// connect to a Dr. Know patient using an MRN identity
var identity = {
    "mrn": "12345"
};

// connect to avatar
avatar.connect(identity);
```

```
// alternatively, connect to avatar only when in simulation mode
// note: useful for testing when an avatar is not connected
avatar.connect(identity, true);
```

### Remarks

When working with **avatars**, you must first **connect** to the avatar with an **identity** that has already been attached to the avatar. When successful, you can call subsequent functions on that avatar.

When your app runs in production, the **avatar** object is already connected to the associated patient. This means you already have access to this avatar (via the **avatar** object) and can skip this connection step.

During development in the [App Simulator](https://docs.doc-know.com/v1/docs/sim-getting-started), your app is not attached to an avatar by default. In order to test avatar features, you will need to first connect to an avatar with a patient **MRN** identity (see example above).

In addition to the runtime **avatar** object, you can also connect to additional (including external) avatars using other identities in both development and production environments. Interact with these avatars using your own assigned variables.

          Definition

          

**Avatars** and **identities** are special **Symmetry** concepts. An avatar represents any person, place, or thing. An identity is used to identify and connect to an avatar. Learn more at [The Symmetry Project](http://www.symmetrycloud.net).