Skip to main content
GET
/
identity_profiles
/
{id}
Retrieve identity profile
curl --request GET \
  --url https://api.whop.com/api/v1/identity_profiles/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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"
}

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.

Authorizations

​
Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Path Parameters

​
id
string
required

The unique identifier of the identity profile (idpf_xxx).

Example:

"idpf_xxxxxxxxxxxxx"

Response

A successful response

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

​
id
string
required

The tag of the identity profile (idpf_xxx).

Example:

"idpf_xxxxxxxxxxxxx"

​
profile_type
string
required

Whether this is an 'individual' or 'business' profile.

​
status
enum<string>
required

Derived verification status across all linked verifications.

Available options:
not_started,
pending,
approved,
rejected
​
first_name
string | null
required

Individual's first name.

​
last_name
string | null
required

Individual's last name.

​
date_of_birth
string | null
required

ISO date (YYYY-MM-DD) reported by the identity provider. Present on individual profiles.

​
email
string | null
required

Email address reported by the identity provider. Typically present on individual profiles.

​
phone
string | null
required

Phone number reported by the identity provider. Typically present on individual profiles.

​
personal_address
object
required

Residential address reported by the identity provider. Present on individual profiles.

​
business_name
string | null
required

Business entity name. Present on business profiles.

​
business_structure
string | null
required

Reported legal structure of a business profile (e.g. corp, llc). Provider-specific values; present on business profiles.

​
business_address
object
required

Registered business address reported by the identity provider. Present on business profiles.

​
country
string | null
required

ISO 3166-1 alpha-3 country code (e.g. USA, GBR). For individuals this is the country of citizenship or residence reported by the identity provider; for businesses this is the country of incorporation.

​
linked_companies
object[]
required

The companies this identity profile is currently linked to. Only populated for direct Whop user sessions; always empty when authenticated via API key, app, or OAuth scope (a single identity can be linked to companies the calling platform is not entitled to see).

​
verifications
object[]
required

All verification attempts attached to this identity profile, ordered most-recent first.

​
created_at
string<date-time>
required

When the identity profile was first created.

Example:

"2023-12-01T05:00:00.401Z"

​
updated_at
string<date-time>
required

When the identity profile was last synced from a verification.

Example:

"2023-12-01T05:00:00.401Z"