Skip to main content
WEBHOOK
identity_profile.needs_action
{
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "api_version": "v1",
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "identity_profile.needs_action",
  "data": {
    "id": "idpf_xxxxxxxxxxxxx",
    "profile_type": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "date_of_birth": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "personal_address": {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "business_name": "<string>",
    "business_structure": "<string>",
    "business_address": {
      "line1": "<string>",
      "line2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "postal_code": "<string>",
      "country": "<string>"
    },
    "country": "<string>",
    "linked_companies": [
      {
        "id": "biz_xxxxxxxxxxxxxx",
        "title": "Pickaxe"
      }
    ],
    "verifications": [
      {
        "id": "verf_xxxxxxxxxxxxx",
        "session_url": "https://verify.stripe.com/session/abc123",
        "last_error_reason": "Document image was too blurry to read.",
        "created_at": "2023-12-01T05:00:00.401Z"
      }
    ],
    "created_at": "2023-12-01T05:00:00.401Z",
    "updated_at": "2023-12-01T05:00:00.401Z"
  },
  "company_id": "biz_xxxxxxxxxxxxxx"
}

Documentation Index

Fetch the complete documentation index at: https://docs.whop.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
webhook-id
string
required

A unique identifier for this webhook request

Example:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

​
webhook-signature
string
required

The signature of the webhook request with the webhook version prepended

Example:

"v1,BASE64ENCODEDSIGNATURE"

​
webhook-timestamp
string
required

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

Example:

"1727606400"

Body

application/json
​
id
string
required

A unique ID for every single webhook request

Example:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

​
api_version
string
required

The API version for this webhook

Allowed value: "v1"
Example:

"v1"

​
timestamp
string<date-time>
required

The timestamp in ISO 8601 format that the webhook was sent at on the server

Example:

"2025-01-01T00:00:00.000Z"

​
type
string
required

The webhook event type

Allowed value: "identity_profile.needs_action"
Example:

"identity_profile.needs_action"

​
data
object
required

A consolidated identity or business profile synced from verification provider data.

​
company_id
string | null

The company ID that this webhook event is associated with

Example:

"biz_xxxxxxxxxxxxxx"

Response

200

Return a 200 status to indicate that the data was received successfully