> For the complete documentation index, see [llms.txt](https://guardian.hedera.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guardian.hedera.com/docs/3.6.0/accounts-and-profiles/profile-apis.md).

# Profile APIs

The Profile APIs allow users to manage their Hedera account credentials, DID documents, and policy keys.

**Base URL:** `/api/v1/profiles`

**Authentication:** All endpoints require a valid JWT Bearer token (`Authorization: Bearer <token>`). Obtain a token via `POST /accounts/login`.

***

## Endpoints

| Method       | Endpoint                              | Description                                                           | Auth Required |
| ------------ | ------------------------------------- | --------------------------------------------------------------------- | ------------- |
| **`GET`**    | `/profiles/{username}/`               | Returns user account info                                             | Yes           |
| **`PUT`**    | `/profiles/{username}`                | Sets Hedera credentials for a user (synchronous)                      | Yes           |
| **`PUT`**    | `/profiles/push/{username}`           | Sets Hedera credentials for a user (asynchronous)                     | Yes           |
| **`GET`**    | `/profiles/{username}/balance`        | Returns the Hedera account balance for the specified user             | Yes           |
| **`PUT`**    | `/profiles/restore/{username}`        | Restores user data (policy, DID/VC documents) from Hedera topics      | Yes           |
| **`PUT`**    | `/profiles/restore/topics/{username}` | Returns list of available recovery topics for a user's Hedera account | Yes           |
| **`POST`**   | `/profiles/did-document/validate`     | Validates the format and structure of a DID document                  | Yes           |
| **`POST`**   | `/profiles/did-keys/validate`         | Validates the keys within a DID document                              | Yes           |
| **`GET`**    | `/profiles/keys`                      | Returns a paginated list of existing policy signing keys              | Yes           |
| **`POST`**   | `/profiles/keys`                      | Creates a new policy signing key                                      | Yes           |
| **`DELETE`** | `/profiles/keys/{id}`                 | Deletes a signing key by ID                                           | Yes           |

***

## Endpoint Details

* [User Account Information](/docs/3.6.0/accounts-and-profiles/profile-apis/user-account-information.md) — **`GET`** `/profiles/{username}/`
* [Setting User Credentials](/docs/3.6.0/accounts-and-profiles/profile-apis/setting-user-credentials.md) — **`PUT`** `/profiles/{username}`
* [Setting User Credentials Asynchronously](/docs/3.6.0/accounts-and-profiles/profile-apis/setting-user-credentials-asynchronously.md) — **`PUT`** `/profiles/push/{username}`
* [User Account Balance](/docs/3.6.0/accounts-and-profiles/profile-apis/user-account-balance.md) — **`GET`** `/profiles/{username}/balance`
* [Restoring User Profile](/docs/3.6.0/accounts-and-profiles/profile-apis/restoring-user-profile.md) — **`PUT`** `/profiles/restore/{username}`
* [List Recovery Topics](/docs/3.6.0/accounts-and-profiles/profile-apis/list-recovery-topics.md) — **`PUT`** `/profiles/restore/topics/{username}`
* [Validate DID Document](/docs/3.6.0/accounts-and-profiles/profile-apis/validate-did-document.md) — **`POST`** `/profiles/did-document/validate`
* [Validate DID Keys](/docs/3.6.0/accounts-and-profiles/profile-apis/validate-did-keys.md) — **`POST`** `/profiles/did-keys/validate`
* [Returns List of Keys](/docs/3.6.0/accounts-and-profiles/profile-apis/returns-list-of-keys.md) — **`GET`** `/profiles/keys`
* [Creates a Key](/docs/3.6.0/accounts-and-profiles/profile-apis/creates-a-key.md) — **`POST`** `/profiles/keys`
* [Deletes a Key](/docs/3.6.0/accounts-and-profiles/profile-apis/deletes-a-key.md) — **`DELETE`** `/profiles/keys/{id}`


---

# 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://guardian.hedera.com/docs/3.6.0/accounts-and-profiles/profile-apis.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.