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

# KycElement

> Un flux complet de vérification d'identité. Il collecte les informations KYC d'un particulier ou KYB d'une entreprise, démarre ou reprend la session hébergée du prestataire, gère les demandes d'informations complémentaires et de documents, interroge le statut et affiche le résultat final, sans que l'hôte ait à construire d'interface de vérification.

> [!NOTE]
>
> Cette page documente `@whop/elements@1.10.0` et `@whop/elements-react@1.10.0`.

*Depuis `v1.0.0`.*

Se monte à l'intérieur de [`Verifications`](https://docs.whop.com/fr/elements/latest/verifications/overview). Transmettez les props et les callbacks via les options de création ou les props React. Conservez le handle créé, ou la `ref` React, pour appeler `refresh()` et `restart()`.

```tsx React theme={null}
import { WhopElements, Verifications, KycElement } from "@whop/elements-react";
import { loadWhop } from "@whop/elements";

function Example() {
  return (
    <WhopElements elements={loadWhop()}>
      <Verifications /* options */>
        <KycElement onStatusChanged={(e) => console.log(e)} onCompleted={(e) => console.log(e)} onActionRequired={(e) => console.log(e)} onLoadFailed={(e) => console.log(e)} />
      </Verifications>
    </WhopElements>
  );
}
```

```html JavaScript theme={null}
<script src="https://cdn.whop.com/elements/amber/elements.js" data-whop-elements></script>
<script type="module">
  const verifications = window.WhopElements().verifications.create({ /* options */ });
  verifications.create('kyc', {
    onStatusChanged: (e) => console.log(e),
    onCompleted: (e) => console.log(e),
    onActionRequired: (e) => console.log(e),
    onLoadFailed: (e) => console.log(e)
  }).mount('#verifications-kyc');
</script>
```

Données d'exemple. [Ouvrir le Playground](https://docs.whop.com/fr/elements/latest/verifications/overview#playground).

## Props

*Cet élément n'accepte aucune prop de l'intégrateur.*

## Événements

Transmettez les callbacks dans les options de création ou dans les props React.

### `onStatusChanged`

La vérification est passée à un nouveau statut, y compris le statut constaté lors du premier montage.

**payload** `object`

**propriétés**

**verificationId** `string` *required*

**status** `string` *required*

L'une des valeurs `"not_started"`, `"pending"`, `"processing"`, `"manual_review"`, `"approved"`, `"rejected"` ou `"action_required"`.

### `onCompleted`

La vérification a été approuvée. Se déclenche une fois, lorsque l'élément observe `approved` pour la première fois.

**payload** `object`

**propriétés**

**verificationId** `string` *required*

### `onActionRequired`

Whop a besoin d'informations complémentaires. L'élément affiche et soumet lui-même les champs demandés.

**payload** `object`

**propriétés**

**verificationId** `string` *required*

**requestedInformation** `ActionRequiredItem[]` *required*

**propriétés**

**id** `string` *required*

**requirement** `string` *required*

**type** `string` *required*

**label** `string` *required*

**source** `string`

L'une des valeurs `"identity"`, `"payout"`, `"audit"`, `"card_issuing"`, `"bank"`, `"ads"`, `"application"` ou `"airwallex"`.

**optional** `boolean`

**options** `string[]`

**alternative\_document\_label** `string`

**errors** `object[]`

**propriétés**

**code** `string` *required*

**reason** `string` *required*

### `onLoadFailed`

Le chargement initial, la soumission du formulaire initial, la soumission complémentaire ou un redémarrage explicite a échoué.

**payload** `object`

**propriétés**

**reason** `"access_denied" | "unavailable"` *required*

### `onLoaderStart`

S'exécute après le premier affichage du squelette de chargement et avant `onReady`.

### `onReady`

S'exécute après le premier affichage complet de l'élément.

### `onError`

S'exécute lorsque l'élément ne parvient pas à se charger ou plante. L'affichage de repli reste visible. Utilisez `code` pour une gestion programmatique. `sourceKey` identifie une source d'état hôte en échec.

**e** `object`

**propriétés**

**message** `string` *required*

**code** `string`

**sourceKey** `string`

## Méthodes

Appelez-les sur le handle renvoyé par `create`, ou via une `ref` React.

### `refresh`

Récupère immédiatement le dernier statut de vérification. Les états en attente et en examen sont aussi interrogés automatiquement.

**Renvoie** `Promise<object | null>`

**verificationId** `string` *required*

**status** `string` *required*

L'une des valeurs `"not_started"`, `"pending"`, `"processing"`, `"manual_review"`, `"approved"`, `"rejected"` ou `"action_required"`.

### `restart`

Abandonne la tentative en cours et démarre immédiatement une nouvelle session hébergée.

**Renvoie** `Promise<void>`

### `mount`

Monte l'élément dans `target` et démarre le chargement. Les composants React se montent eux-mêmes.

**Paramètres**

**target** `string | HTMLElement` *required*

### `destroy`

Supprime l'élément et libère son frame et ses abonnements. Vous pouvez l'appeler plusieurs fois. React supprime l'élément automatiquement.

### `update`

Fusionne de nouvelles props dans l'élément monté. Avec React, modifiez plutôt les props du composant.

**Paramètres**

**options** `Partial\<KycElementProps\>` *required*

## Style

Stylisez ces parties via `appearance.classes`. Utilisez le camel case ou le kebab case pour les noms de propriétés et incluez les unités. Les feuilles de style de la page ne peuvent pas atteindre le frame de l'élément. Le framework valide chaque déclaration avant de l'injecter.

| Classe | Cible |
| - | - |
| `.whop-KycFrame` | Le panneau de vérification |
| `.whop-KycSurface` | La surface de vérification complète — formulaire initial, transfert vers la vérification hébergée et résultats |

```ts theme={null}
const verifications = whop.verifications.create({
  appearance: {
    classes: {
      'whop-KycFrame': { borderRadius: '8px', fontWeight: '600' },
      'whop-KycSurface': { borderRadius: '8px', fontWeight: '600' }
    }
  }
});

verifications.update({
  appearance: { classes: { 'whop-KycFrame': { fontWeight: '700' } } }
});
```

Avec React, transmettez `appearance` à `<Verifications>`. Définissez-la globalement avec `WhopElements({ appearance })`.
