Identities API

Identities represent user profiles used for outreach. Each identity can be connected to external channels such as LinkedIn.

Create an Identity

POST /v1/identities

Request Body

Field	Type	Required	Description
firstName	string	yes	First name.
lastName	string	yes	Last name.
role	string	yes	Role or title.

Response — 201 Created

{
  "status": "success",
  "identity": { /* identity object */ }
}

---

List Identities

GET /v1/identities

Returns all identities for the authenticated user’s tenant.

---

Get an Identity

GET /v1/identities/:identity_id

---

Update an Identity

PUT /v1/identities/:identity_id

Request Body

Field	Type	Required	Description
firstName	string	no	First name.
lastName	string	no	Last name.
jobTitle	string	no	Job title.

---

Delete an Identity

DELETE /v1/identities/:identity_id

---

LinkedIn Integration

Login to LinkedIn

POST /v1/identities/:identity_id/linkedin/login

Field	Type	Required	Description
username	string	no	LinkedIn username / email.
password	string	no	LinkedIn password.
country	string	no	Country code for the login request.
max_verification_wait_time	number	no	Max seconds to wait for verification (default: 600).

If the identity already has a stored LinkedIn profile_id, you can omit username and password to re-authenticate using the existing session.

Response — 200 OK

{
  "status": "success",
  "message": "LinkedIn login initiated",
  "identity_id": "abc123",
  "login_result": {
    "profile_id": "li_abc",
    "session_id": "sess_xyz",
    "status": "queued"
  }
}

Check LinkedIn Login Status

GET /v1/identities/:identity_id/linkedin/check

Returns the current LinkedIn connection status for the identity.

Get LinkedIn Operation Status

GET /v1/identities/:identity_id/linkedin/status/:session_id

Poll this endpoint to check the progress of an in-flight LinkedIn operation.

Submit 2FA Verification Code

POST /v1/identities/:identity_id/linkedin/code/:session_id

Field	Type	Required	Description
code	string	yes	Two-factor auth code.