Skip to navigation
API ReferenceIdentity Profiles

Unlink an identity profile

Unlinks an IdentityProfile from a LedgerAccount (flips the matching link to is_current=false).

Authentication

AuthorizationBearer

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

idstringRequired
The ID of the IdentityProfile to unlink.

Query parameters

ledger_account_idstringRequired

Response

A successful response
business_addressobject or null

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

business_namestring or null

Business entity name. Present on business profiles.

business_structurestring or null

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

countrystring or null

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.

created_atdatetime
When the identity profile was first created.
date_of_birthstring or null

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

emailstring or null

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

first_namestring or null
Individual's first name.
idstring

The tag of the identity profile (idpf_xxx).

last_namestring or null
Individual's last name.
linked_companieslist of objects

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

personal_addressobject or null

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

phonestring or null

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

profile_typestring
Whether this is an 'individual' or 'business' profile.
statusenum
Derived verification status across all linked verifications.
Allowed values:
updated_atdatetime
When the identity profile was last synced from a verification.
verificationslist of objects

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

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error