> 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/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](/accounts-and-profiles/profile-apis/user-account-information.md) — **`GET`** `/profiles/{username}/`
* [Setting User Credentials](/accounts-and-profiles/profile-apis/setting-user-credentials.md) — **`PUT`** `/profiles/{username}`
* [Setting User Credentials Asynchronously](/accounts-and-profiles/profile-apis/setting-user-credentials-asynchronously.md) — **`PUT`** `/profiles/push/{username}`
* [User Account Balance](/accounts-and-profiles/profile-apis/user-account-balance.md) — **`GET`** `/profiles/{username}/balance`
* [Restoring User Profile](/accounts-and-profiles/profile-apis/restoring-user-profile.md) — **`PUT`** `/profiles/restore/{username}`
* [List Recovery Topics](/accounts-and-profiles/profile-apis/list-recovery-topics.md) — **`PUT`** `/profiles/restore/topics/{username}`
* [Validate DID Document](/accounts-and-profiles/profile-apis/validate-did-document.md) — **`POST`** `/profiles/did-document/validate`
* [Validate DID Keys](/accounts-and-profiles/profile-apis/validate-did-keys.md) — **`POST`** `/profiles/did-keys/validate`
* [Returns List of Keys](/accounts-and-profiles/profile-apis/returns-list-of-keys.md) — **`GET`** `/profiles/keys`
* [Creates a Key](/accounts-and-profiles/profile-apis/creates-a-key.md) — **`POST`** `/profiles/keys`
* [Deletes a Key](/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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://guardian.hedera.com/accounts-and-profiles/profile-apis.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.