Skip to main content
GET
Retrieve identity profile
Required permissions:
  • identity:read

Autorizaciones

Authorization
string
header
requerido

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

identity:read

Parámetros de ruta

id
string
requerido

The unique identifier of the identity profile (idpf_xxx).

Ejemplo:

"idpf_xxxxxxxxxxxxx"

Respuesta

A successful response

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

business_address
object | null
requerido

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

business_name
string | null
requerido

Business entity name. Present on business profiles.

business_structure
string | null
requerido

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

country
string | null
requerido

ISO 3166-1 alpha-2 country code reported by the identity provider, such as US or GB. For individuals this is the country of citizenship or residence; for businesses, the country of incorporation.

created_at
string<date-time>
requerido

When the identity profile was first created.

Ejemplo:

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

date_of_birth
string | null
requerido

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

email
string | null
requerido

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

first_name
string | null
requerido

Individual's first name.

id
string
requerido

The tag of the identity profile (idpf_xxx).

Ejemplo:

"idpf_xxxxxxxxxxxxx"

last_name
string | null
requerido

Individual's last name.

linked_companies
object[]
requerido

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).

payout_status
enum<string>
requerido

Progress of payout-account setup for this profile, independent of holds. connected means onboarding is complete; a connected status paired with payouts_enabled: false indicates an active account restriction rather than incomplete setup.

Opciones disponibles:
connected,
disabled,
action_required,
pending_verification,
verification_failed,
manual_review,
denied,
not_started,
blocked_by_parent
payouts_enabled
boolean
requerido

Whether this profile can receive payouts right now. True only when payout onboarding is complete and no payout holds are active on the linked account. Treat this as the single source of truth for payout readiness.

personal_address
object | null
requerido

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

phone
string | null
requerido

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

profile_type
string
requerido

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

status
enum<string>
requerido

Derived verification status across all linked verifications. Returns action_required whenever the profile has an open request for information (whether a verification, payout, or audit RFI) — i.e. the merchant must submit something before it is in good standing.

Opciones disponibles:
not_started,
pending,
manual_review,
approved,
rejected,
action_required
updated_at
string<date-time>
requerido

When the identity profile was last synced from a verification.

Ejemplo:

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

verifications
object[]
requerido

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