---
title: "Identify"
method: POST
path: "/v1/identify"
tags: ["Real-time"]
---

# Identify

`POST /v1/identify`

## Headers

- `Content-Type` string
- `Accept` string
- `Authorization` string, required

## Request body

- object
  - `user_id` string, required — The unique identifier for the user. This is the ID that Userpilot uses to identify the user.
  - `metadata` object — Optional user metadata. You can add, remove, or modify any properties as needed for your use case. Note: Only string values are supported (numbers and dates should be sent as strings).
    - `custom_user_property` string — example: Name, Job title, etc.
  - `company` object — Company information. If provided, `company_id` is required. Additional company properties are optional metadata.
    - `company_id` string, required — The unique identifier for the company. This is the ID that Userpilot uses to identify the company.
    - `custom_company_property` string — example: Company name, Industry, etc.

## Other responses

- `401` — Unauthorized - Invalid API key

---

[API](https://skmtc.dev/userpilot/apis/userpilot-api.md) · [All operations](https://skmtc.dev/userpilot/apis/userpilot-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/userpilot/userpilot-api/revisions/2b3a88b6a474/schema)