Skip to main content

Fonctionnement

1

Lancez une vérification

Appelez POST /api/v1/verifications avec le compte que vous voulez vérifier. Vous obtenez en retour une session_url.
2

Envoyez l'utilisateur effectuer le KYC

Redirigez votre utilisateur vers la session_url. Il y téléverse sa pièce d’identité, prend un selfie et vérifie son identité sur une page hébergée. Vous n’avez aucune interface à construire pour cela.
3

Écoutez le résultat

Abonnez-vous au webhook identity_profile.updated — il se déclenche à chaque modification du profil (approuvé, refusé, action requise, ou ouverture ou clôture d’un examen). Le webhook vous indique quel profil a changé, et non son nouvel état : appelez donc GET /api/v1/verifications?account_id={biz_ tag} pour lire le statut actuel et les données d’identité vérifiées.

Exemple rapide

cURL
Response
Vous avez besoin d’une clé API de compte avec le scope identity:write. Consultez Authentification et clés API pour connaître les types d’identifiants et la façon de limiter leur portée. Rendez-vous dans votre tableau de bord → Settings → API Keys pour en créer une.

Préremplir le formulaire de vérification d’identité

Transmettez des champs d’identité pour épargner des étapes à votre utilisateur. Ils alimentent le formulaire de vérification afin qu’il n’ait pas à ressaisir son nom et son adresse :
cURL
tax_identification_number est le numéro d’identification fiscale de la personne — son SSN pour les particuliers aux États-Unis — et il est obligatoire lorsque country vaut US : le compte de versement ne peut pas être créé sans lui. Envoyez-le tel quel. Il est tokenisé pendant le transit, et la valeur brute n’est jamais stockée dans les systèmes de Whop.
Whop ne peut pas prendre en charge les utilisateurs situés dans un pays ou une région sous sanctions. La requête échoue avec un 400 et le code d’erreur address_country_sanctioned.

Réutiliser une vérification existante

Si vous avez déjà vérifié cette personne avec Sumsub, envoyez son jeton de partage au lieu de lui faire passer le KYC une seconde fois. Whop importe l’identité attestée par votre compte Sumsub et la contrôle au regard de ses propres exigences :
cURL
Response
1

Concluez un accord de KYC réutilisable avec Whop

Sumsub ne partage les données des demandeurs qu’entre clients ayant conclu un accord de KYC réutilisable (Reusable KYC). Whop vous fournit l’ID client avec lequel partager une fois cet accord en place.
2

Générez un jeton de partage pour le demandeur

Appelez POST https://api.sumsub.com/resources/accessTokens/shareToken sur votre propre compte Sumsub avec l’ID du demandeur et l’ID client de Whop dans forClientId.
3

Envoyez-le à Whop

Transmettez le jeton dans share_token. Chaque jeton ne fonctionne qu’une seule fois.
La réponse vous indique le résultat. approved signifie que votre vérification couvrait tout ce dont Whop a besoin et qu’il n’y a plus rien à faire. pending avec une session_url signifie qu’elle en couvrait une partie — envoyez l’utilisateur vers cette URL pour terminer uniquement ce qui manque encore. Whop refuse avec un 400 un jeton dont les données ne couvrent aucune des exigences.
share_token ne peut pas être combiné avec documents ou document_type — chacun constitue une alternative complète au flux hébergé.

Deux types de vérification

Un compte peut avoir une vérification de chaque type — un KYC individuel et un KYB d’entreprise.

Et ensuite

Vérifier le statut

Vérifiez le statut d’une vérification et lisez les données d’identité vérifiées.

Traiter les RFI

Répondez lorsque Whop a besoin d’informations supplémentaires, comme un relevé bancaire.

Mise à jour et suppression

Mettez à jour les champs d’identité ou supprimez une vérification.

Référence de l'API

Référence complète des champs de l’objet vérification.