> ## Documentation Index
> Fetch the complete documentation index at: https://docs.edges.run/llms.txt
> Use this file to discover all available pages before exploring further.
# Create an Identity
> Create an identity
To automate Actions with Edges, you'll need to create Identities. You have two options:
1. **Synchronize Your Own Users**: Connect your existing users as identities
2. **Use Managed Accounts**: Use our pre-configured accounts
Learn more about these options in our guide on [When LinkedIn Identities Options: Sync, Rent, or Use Managed](/v1/identities/sync-vs-managed).
## Identity Types
When creating an identity, you can specify its type:
* **`standard`** (default): Standard identity included in your plan. All actions consume credits at the normal rate.
* **`engagement`**: Engagement identity that allows running a broad set of LinkedIn outreach actions (connect, message, follow, like, comment, etc.) **without consuming credits**. Ideal for building SaaS products or AI agents that enable users to engage on LinkedIn or create outreach sequences.
Engagement Identities must be **enabled first** from the [Developer Settings](https://app.edges.run/settings/developers) page and require billing details to be filled. They are **billed monthly** based on the peak number of active Engagement Identities during your billing cycle (starting at \$7.99/identity/month).
Use Engagement Identities for high-volume, repetitive outreach actions (connect, message, follow) and keep standard identities for more occasional or data extraction workflows. See [Engagement Identities](/v1/identities/engagement) for more details.
**Important**: The identity `type` cannot be changed after creation. If you need to change an identity's type, you must delete the existing identity and create a new one with the desired type.
Once you've created an Identity, connect them to platforms like LinkedIn using the [Connect an Identity's' Integration](/v1/api/integrations/connect) endpoint.
Read everything you need to know about [Adding & Managing Identities](/v1/identities/add-manage-identities).
`identity_login_links` are secure, 48-hour valid URLs that let users connect their integration accounts (like LinkedIn) without a browser extension.
Users authenticate through our white-labeled interface, and you can share these links via email or embed them in your product.
Once connected, the integration is ready to use with our API.
## OpenAPI
````yaml v1/api/business.json post /identities
openapi: 3.1.0
info:
title: ED's Public API
description: ED's Public API
version: 26.622.88
servers:
- url: https://api.edges.run/v1/
security:
- APIKeyHeader: []
paths:
/identities:
post:
tags:
- Core
summary: Create a new identity with basic profile information.
description: Create an identity
operationId: create_identity
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InsertIdentityRequestPublic'
example:
name: John Doe
timezone: Europe/Paris
type: standard
responses:
'200':
description: Identity successfully created.
content:
application/json:
schema:
$ref: >-
#/components/schemas/GenericResponse_IdentityCreatePublicModel_
example:
uid: 123e4567-e89b-12d3-a456-426614174000
created_at: '2023-10-01T12:00:00Z'
workspace_uid: 5678e456-e89b-12d3-a456-426614174001
name: John Doe
type: standard
timezone: Europe/Paris
integrations: []
identity_login_links:
linkedin: https://app.edges.run/identities/linkedin/login?token=XXXXXX
'400':
description: Invalid request.
content:
application/json:
examples:
invalid_country_code:
summary: Invalid timezone
value:
message: The provided timezone is not valid.
error_label: CREATE_ONE_IDENTITY_400_BAD_REQUEST
'403':
description: Forbidden
content:
application/json:
examples:
identity_management_disabled:
summary: Identity Management Disabled
value:
message: >-
Identity management via the API is not permitted for the
current workspace.
error_label: CREATE_ONE_IDENTITY_403_FORBIDDEN
params:
details: >-
To manage identities via the API, enable this feature in
the workspace settings under the 'Developers' section of
the platform.
max_number_identity_created:
summary: Maximum number identities created via API reach
value:
message: >-
The maximum number of identities created via the API has
been reached.
error_label: CREATE_ONE_IDENTITY_403_FORBIDDEN
params:
max_identities_via_api: '100'
insufficient_role:
summary: Insufficient Role
value:
message: You are not allowed to create a new identity.
error_label: CREATE_ONE_IDENTITY_403_FORBIDDEN
params:
details: You do not have the right role to create an identity.
create_one_identity_403_forbidden:
summary: Your plan does not allow for additional identities.
value:
message: Your plan does not allow for additional identities.
error_label: CREATE_ONE_IDENTITY_403_FORBIDDEN
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
InsertIdentityRequestPublic:
properties:
name:
type: string
minLength: 3
title: Name
description: Name of the identity. Must be at least 3 characters long.
timezone:
type: string
title: Timezone
description: >-
IANA-compliant timezone identifier used to localize timestamps.
Follows the IANA time zone database (e.g. America/New_York,
Europe/London)
default: Europe/Paris
type:
allOf:
- $ref: '#/components/schemas/IdentityType'
description: Specifies the type of identity. Determines if the identity is billed
default: standard
additionalProperties: false
type: object
required:
- name
title: InsertIdentityRequestPublic
GenericResponse_IdentityCreatePublicModel_:
allOf:
- $ref: '#/components/schemas/IdentityCreatePublicModel'
title: GenericResponse[IdentityCreatePublicModel]
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
IdentityType:
type: string
enum:
- standard
- engagement
title: IdentityType
IdentityCreatePublicModel:
properties:
uid:
type: string
format: uuid
title: Uid
workspace_uid:
type: string
format: uuid
title: Workspace Uid
created_at:
type: string
format: date-time
title: Created At
name:
anyOf:
- type: string
- type: 'null'
title: Name
timezone:
type: string
title: Timezone
type:
$ref: '#/components/schemas/IdentityType'
is_active:
type: boolean
title: Is Active
default: false
integrations:
items:
type: string
type: array
title: Integrations
identity_login_links:
anyOf:
- $ref: '#/components/schemas/IdentityLoginLinksModel'
- type: 'null'
type: object
required:
- workspace_uid
- timezone
- type
title: IdentityCreatePublicModel
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
IdentityLoginLinksModel:
properties:
linkedin:
type: string
title: Linkedin
type: object
title: IdentityLoginLinksModel
securitySchemes:
APIKeyHeader:
type: apiKey
in: header
name: X-API-Key
description: >-
API key required for authentication. Add your API key in the X-API-Key
header.
````