> For the complete documentation index, see [llms.txt](https://docs.deso.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.deso.org/deso-identity/iframe-api.md).

# Identity: iFrame API

Documentation on the iframe Context API

## Introduction

This guide describes the iframe API, which is an essential component of integrating with the DeSo Identity Service for web application developers.

If you haven't yet read through the [Identity: Overview](/deso-identity/identity.md) and [Core Concepts](/deso-identity/identity/concepts.md) guides, it would be helpful to do so prior to reading this documentation.

This guide also depends on [Identity: Window API](/deso-identity/window-api.md), so we recommend reading about it first.

The iframe API guide consists of two subpages, which should give you a comprehensive view of the API:

* [Overview](/deso-identity/iframe-api/basics.md) guide outlines the fundamentals of integrating with the iframe API
* [Endpoints](/deso-identity/iframe-api/endpoints.md) is an exhaustive list of all API endpoints.

If you're creating a mobile app, check out our [Mobile Integration](/deso-identity/identity/mobile-integration.md) guide next.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.deso.org/deso-identity/iframe-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.