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

> ## Agent Instructions
> Treat these docs and the Whop MCP server as the source of truth for Whop API behavior. Don't infer endpoint behavior from marketing pages.
> MCP server: connect https://mcp.whop.com/mcp (streamable HTTP, browser sign-in, no API key in the client config) to search these docs and read or change live Whop data. Setup: https://docs.whop.com/developer/guides/ai_and_mcp.md
> Whop CLI: install with `curl -fsSL https://whop.com/install.sh | sh` to scaffold, run, and deploy Whop apps and websites. It acts on production, not the sandbox. Overview: https://docs.whop.com/cli/overview.md Agent mode: https://docs.whop.com/cli/agent-mode.md
> Hosting: Whop serves a site or app from the build `whop apps deploy` uploads, with rollbacks, secrets, and server logs. Guide: https://docs.whop.com/developer/websites/hosting.md
> Plugins: in Claude Code, run `/plugin marketplace add whopio/plugins`, then `/plugin install whop@whop`. Guide: https://docs.whop.com/developer/guides/plugins/claude-code.md Every agent tool: https://docs.whop.com/developer/ai/overview.md
> Environments: build and test in the sandbox (API `https://sandbox-api.whop.com/api/v1`, keys at https://sandbox.whop.com/dashboard/developer, SDK environment `Sandbox`; no real money). Production (API `https://api.whop.com/api/v1`, keys at https://whop.com/dashboard/developer, SDK environment `Production`, the SDK default) moves real money, so use it only at launch. The two share no accounts, keys, products, or webhooks, and their keys look identical: never mix them. Sandbox guide: https://docs.whop.com/developer/guides/sandbox.md Comparison: https://docs.whop.com/developer/quickstart.md
> API: send `Authorization: Bearer <API_KEY>` from your server only, and pin a dated version with the `Api-Version-Date` header. OpenAPI spec: https://api.whop.com/api/v1/openapi.json
> Which API: build on the Current API, whose pages live under https://docs.whop.com/api-reference/ (start at https://docs.whop.com/api-reference/overview.md). Pages under /api-reference/legacy/ are the Legacy API. Use one only when https://docs.whop.com/api-reference/stability.md lists the resource as Legacy-only.

# Profil d'identité

> Un profil d'identité ou d'entreprise consolidé, synchronisé à partir des données du fournisseur de vérification.

```json Example theme={null}
{
	"business_address": {
		"city": "<string>",
		"country": "<string>",
		"line1": "<string>",
		"line2": "<string>",
		"postal_code": "<string>",
		"state": "<string>"
	},
	"business_name": "<string>",
	"business_structure": "<string>",
	"country": "<string>",
	"created_at": "2023-12-01T05:00:00.401Z",
	"date_of_birth": "<string>",
	"email": "<string>",
	"first_name": "<string>",
	"id": "idpf_xxxxxxxxxxxxx",
	"last_name": "<string>",
	"linked_companies": [
		{
			"id": "biz_xxxxxxxxxxxxxx",
			"title": "Pickaxe"
		}
	],
	"payout_status": "connected",
	"payouts_enabled": true,
	"personal_address": {
		"city": "<string>",
		"country": "<string>",
		"line1": "<string>",
		"line2": "<string>",
		"postal_code": "<string>",
		"state": "<string>"
	},
	"phone": "<string>",
	"profile_type": "<string>",
	"status": "not_started",
	"updated_at": "2023-12-01T05:00:00.401Z",
	"verifications": [
		{
			"created_at": "2023-12-01T05:00:00.401Z",
			"id": "verf_xxxxxxxxxxxxx",
			"last_error_code": "abandoned",
			"last_error_reason": "Document image was too blurry to read.",
			"session_url": "https://verify.stripe.com/session/abc123",
			"status": "requires_input"
		}
	]
}
```

**business\_address** `object | null` *required*

Adresse enregistrée de l'entreprise indiquée par le fournisseur d'identité. Présente sur les profils `business`.

**attributs enfants**

**city** `string | null` *required*

La ville de l'adresse.

**country** `string | null` *required*

Le pays de l'adresse.

**line1** `string | null` *required*

La ligne 1 de l'adresse.

**line2** `string | null` *required*

La ligne 2 de l'adresse.

**postal\_code** `string | null` *required*

Le code postal de l'adresse.

**state** `string | null` *required*

L'État ou la région de l'adresse.

**business\_name** `string | null` *required*

Nom de l'entité commerciale. Présent sur les profils `business`.

**business\_structure** `string | null` *required*

Structure juridique déclarée d'un profil d'entreprise (par exemple `corp`, `llc`). Valeurs propres au fournisseur ; présente sur les profils `business`.

**country** `string | null` *required*

Code pays ISO 3166-1 alpha-2 indiqué par le fournisseur d'identité, par exemple `US` ou `GB`. Pour les particuliers, il s'agit du pays de citoyenneté ou de résidence ; pour les entreprises, du pays de constitution.

**created\_at** `string\<date-time\>` *required*

Date de première création du profil d'identité.

Exemple : `2023-12-01T05:00:00.401Z`

**date\_of\_birth** `string | null` *required*

Date ISO (`YYYY-MM-DD`) indiquée par le fournisseur d'identité. Présente sur les profils `individual`.

**email** `string | null` *required*

Adresse e-mail indiquée par le fournisseur d'identité. Généralement présente sur les profils `individual`.

**first\_name** `string | null` *required*

Prénom du particulier.

**id** `string` *required*

Le tag du profil d'identité (idpf\_xxx).

Exemple : `idpf_xxxxxxxxxxxxx`

**last\_name** `string | null` *required*

Nom de famille du particulier.

**linked\_companies** `array\<object\>` *required*

Les entreprises auxquelles ce profil d'identité est actuellement lié. Renseigné uniquement pour les sessions utilisateur Whop directes ; toujours vide en cas d'authentification par clé API, application ou scope OAuth (une même identité peut être liée à des entreprises que la plateforme appelante n'est pas autorisée à voir).

**attributs enfants**

**id** `string` *required*

L'identifiant unique de l'entreprise.

Exemple : `biz_xxxxxxxxxxxxxx`

**title** `string` *required*

Le nom d'affichage de l'entreprise présenté aux clients.

Exemple : `Pickaxe`

**payout\_status** `PayoutAccountCalculatedStatuses` *required*

Progression de la configuration du compte de versement pour ce profil, indépendamment des blocages. `connected` signifie que l'onboarding est terminé ; un statut `connected` associé à `payouts_enabled: false` indique une restriction active sur le compte plutôt qu'une configuration incomplète.

Options disponibles : `connected`, `disabled`, `action_required`, `pending_verification`, `verification_failed`, `manual_review`, `denied`, `not_started`, `blocked_by_parent`

**payouts\_enabled** `boolean` *required*

Indique si ce profil peut recevoir des versements dès maintenant. Vrai uniquement lorsque l'onboarding des versements est terminé et qu'aucun blocage de versement n'est actif sur le compte lié. Considérez ce champ comme la source de vérité unique concernant la capacité à recevoir des versements.

**personal\_address** `object | null` *required*

Adresse de résidence indiquée par le fournisseur d'identité. Présente sur les profils `individual`.

**attributs enfants**

**city** `string | null` *required*

La ville de l'adresse.

**country** `string | null` *required*

Le pays de l'adresse.

**line1** `string | null` *required*

La ligne 1 de l'adresse.

**line2** `string | null` *required*

La ligne 2 de l'adresse.

**postal\_code** `string | null` *required*

Le code postal de l'adresse.

**state** `string | null` *required*

L'État ou la région de l'adresse.

**phone** `string | null` *required*

Numéro de téléphone indiqué par le fournisseur d'identité. Généralement présent sur les profils `individual`.

**profile\_type** `string` *required*

Indique s'il s'agit d'un profil 'individual' ou 'business'.

**status** `IdentityProfileStatuses` *required*

Statut de vérification dérivé de l'ensemble des vérifications liées. Renvoie `action_required` dès que le profil fait l'objet d'une demande d'informations ouverte (qu'il s'agisse d'une RFI de vérification, de versement ou d'audit) — c'est-à-dire que le marchand doit soumettre quelque chose avant d'être en règle.

Options disponibles : `not_started`, `pending`, `manual_review`, `approved`, `rejected`, `action_required`

**updated\_at** `string\<date-time\>` *required*

Date de la dernière synchronisation du profil d'identité à partir d'une vérification.

Exemple : `2023-12-01T05:00:00.401Z`

**verifications** `array\<object\>` *required*

Toutes les tentatives de vérification rattachées à ce profil d'identité, de la plus récente à la plus ancienne.

**attributs enfants**

**created\_at** `string\<date-time\>` *required*

Date de création de l'enregistrement de vérification.

Exemple : `2023-12-01T05:00:00.401Z`

**id** `string` *required*

L'identifiant numérique de l'enregistrement de vérification.

Exemple : `verf_xxxxxxxxxxxxx`

**last\_error\_code** `VerificationErrorCodes | null` *required*

Le code d'erreur le plus récent renvoyé lors de la vérification. Null si aucune erreur ne s'est produite.

Options disponibles : `abandoned`, `consent_declined`, `country_not_supported`, `device_not_supported`, `document_expired`, `document_type_not_supported`, `document_unverified_other`, `email_unverified_other`, `email_verification_declined`, `id_number_insufficient_document_data`, `id_number_mismatch`, `id_number_unverified_other`, `phone_unverified_other`, `phone_verification_declined`, `selfie_document_missing_photo`, `selfie_face_mismatch`, `selfie_manipulated`, `selfie_unverified_other`, `under_supported_age`

**last\_error\_reason** `string | null` *required*

Une explication lisible par un humain de l'erreur de vérification la plus récente. Null si aucune erreur ne s'est produite.

Exemple : `Document image was too blurry to read.`

**session\_url** `string | null` *required*

Une URL que l'utilisateur peut consulter pour terminer le processus de vérification. Null si la session ne nécessite pas d'interaction de l'utilisateur.

Exemple : `https://verify.stripe.com/session/abc123`

**status** `VerificationStatuses` *required*

Le statut actuel de cette session de vérification.

Options disponibles : `requires_input`, `processing`, `verified`, `canceled`, `created`, `started`, `submitted`, `approved`, `declined`, `resubmission_requested`, `expired`, `abandoned`, `review`, `action_required`, `manual_review`
