---
title: "POST /identities"
method: POST
path: "/identities"
---

# POST /identities

`POST /identities`

## Request

- Base URL: `https://api.useanima.sh/v1`
- URL: `https://api.useanima.sh/v1/identities`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

## Request body

- object: Provision a complete agent identity in a single call
  - `name` string, required: Human-readable name for the agent (e.g. 'shopping-agent')
  - `slug` string: URL-safe identifier. Auto-derived from name if omitted
  - `capabilities` string[], required: Capabilities to provision. Email is always included.
  - `email` string, email: Custom email address. Defaults to {slug}@agents.useanima.sh
  - `phone` object: Phone provisioning options (only used if 'phone' is in capabilities)
    - `countryCode` string: ISO 3166-1 alpha-2
    - `areaCode` string: Preferred area code
  - `metadata` object: Arbitrary key-value metadata

## Response `200`

OK

- object: Provisioned agent identity with all requested capabilities
  - `id` string, required: Agent ID
  - `name` string, required
  - `slug` string, required
  - `apiKey` string, required: Agent API key — only returned on creation
  - `email` object, nullable, required: Email identity (always provisioned)
    - `id` string, required
    - `email` string, required
    - `domain` string, required
    - `isPrimary` boolean, required
  - `phone` object, nullable, required: Phone identity (if requested)
    - `id` string, required
    - `phoneNumber` string, required
    - `capabilities` object, required
      - `sms` boolean, required
      - `mms` boolean, required
      - `voice` boolean, required
    - `isPrimary` boolean, required
  - `vault` object, nullable, required: Vault identity (if requested)
    - `id` string, required
    - `status` string, required
  - `failures` object[], required: Capabilities that failed to provision. Empty on full success.
    - `capability` 'email' | 'phone' | 'vault', required
    - `error` string, required
  - `createdAt` string, date-time, required

---

[API](https://skmtc.dev/useanima/apis/anima-api.md) · [All operations](https://skmtc.dev/useanima/apis/anima-api/llms.txt) · [OpenAPI document](https://skmtc.dev/useanima/apis/anima-api/revisions/aaa148188980?raw)