Skip to main content
Les comptes et les utilisateurs effectuent une vérification lorsque Whop doit confirmer leur identité avant d’activer les versements ou des flux de travail sensibles en matière de conformité. Utilisez l’API Vérifications pour démarrer ou reprendre une session de vérification hébergée, consulter le statut de l’examen, et soumettre les informations ou documents demandés. Si requested_information contient des éléments, soumettez les réponses avec Mettre à jour une vérification.
Remplace la ressource Legacy Vérifications. Les intégrations Legacy existantes continuent de fonctionner ; consultez Versions de l’API pour le contrat de stabilité.

Endpoints

Attributs

string
ID du profil de vérification, préfixé par idpf_.
string[]
requis
Comptes pour lesquels cette vérification a été lue, chacun préfixé par biz_ : le compte par lequel vous avez listé, le compte ou sous-compte auquel elle appartient avec include_subaccounts, ou tous les comptes que vous pouvez lire auxquels elle appartient lorsqu’elle est récupérée par ID. Généralement un seul. Vide pour une vérification personnelle.
object | null
Adresse figurant sur le profil de vérification. null lorsqu’aucune adresse n’est définie.

Propriétés

string | null
string | null
Code pays ISO 3166-1 à deux lettres, par exemple US, DE ou GB.
string
Première ligne de l’adresse postale.
string | null
Deuxième ligne de l’adresse postale.
string | null
Code postal.
string | null
Code de l’État, de la province ou de la région, par exemple CA.
string | null
Raison sociale de l’entreprise.
string | null
Structure juridique de l’entreprise, telle que private_corporation ou sole_proprietorship. Les valeurs prises en charge varient selon le pays de constitution — voir Structures d’entreprise.
string | null
Code pays ISO 3166-1 à deux lettres, par exemple US, DE ou GB.
string
Date de création du profil de vérification, sous forme d’horodatage ISO 8601.
string | null
Au format YYYY-MM-DD.
string | null
Adresse e-mail figurant sur le profil de vérification.
string | null
string | null
Date de constitution de l’entreprise, au format YYYY-MM-DD, telle qu’enregistrée pour la vérification d’entreprise. Vérifications d’entreprise uniquement ; null jusqu’à son envoi.
string
Options disponibles : individual, business
string | null
object[]
requis
Propriétaires de l’entreprise et avancement de la vérification propre à chacun. Vide pour les vérifications individuelles.

Propriétés

string
requis
ID du propriétaire, préfixé par own_. Envoyez-le dans le champ owners de Update Verification pour modifier ou supprimer le propriétaire, y compris un propriétaire ajouté dans la session hébergée.
string | null
requis
La date de naissance enregistrée du propriétaire, au format YYYY-MM-DD.
string | null
requis
string | null
requis
number | null
requis
Part de l’entreprise détenue par la personne, de 0 à 100.
string[]
requis
Ce que le fournisseur a rejeté lorsque la vérification du propriétaire a été renvoyée : details (son nom, sa date de naissance ou d’autres informations ne correspondent pas à sa pièce d’identité), identity_document ou selfie. Corrigez uniquement ces éléments avec Update Verification. Vide sinon.Options disponibles : details, identity_document, selfie
object[]
requis
Les documents du propriétaire et leur avancement. Vide pour un propriétaire ajouté avec verification_id.

Propriétés

string
Clé d’emplacement du document, telle que id_card_front, id_card_back ou selfie.
string | null
Raison du rejet de la soumission précédente, lorsque le fournisseur a demandé de nouveaux documents ou refusé la vérification.
string
pending_upload jusqu’à ce que le document ait été transmis pour examen ; submitted ensuite.Options disponibles : pending_upload, submitted
string[]
requis
Le rôle de la personne au sein de l’entreprise.Options disponibles : ubo, director, representative, shareholder
string
requis
L’état de la vérification propre au propriétaire, avec les mêmes états que status. action_required lorsque ses documents doivent être renvoyés.Options disponibles : not_started, pending, processing, manual_review, approved, rejected, action_required
string | null
Numéro de téléphone figurant sur le profil de vérification.
string | null
État ou région de constitution de l’entreprise, tel qu’enregistré pour la vérification d’entreprise. Vérifications d’entreprise uniquement ; null jusqu’à son envoi.
string | null
Numéro sous lequel l’entreprise a été immatriculée dans son lieu de constitution, tel qu’un numéro d’enregistrement d’État aux États-Unis ou un Company Number au Royaume-Uni. Vérifications d’entreprise uniquement ; tel qu’enregistré pour la vérification d’entreprise, ou null jusqu’à son envoi.
object[]
Ce dont Whop a encore besoin avant que l’examen puisse se poursuivre, avec une exigence par entrée. Répondez avec Update Verification. Rien de la réponse n’est renvoyé. Les clés non applicables sont omises. Pour une vérification d’entreprise créée avec documents ou owners, cela inclut les informations et documents de l’entreprise encore manquants avant qu’elle puisse être envoyée pour examen. Les documents de chaque propriétaire sont listés sous ce propriétaire.

Propriétés

string
requis
ID de l’élément d’information demandé, préfixé par inrqi_.
string
URL d’une action associée, comme terminer la vérification du caractère vivant ou consulter un paiement. Absente lorsqu’aucune action n’est disponible.
string
Un document qui répond à cet élément à la place de value, comme une lettre EIN de l’IRS lorsque l’EIN n’a pas pu être rapproché. Envoyez ses pages dans files, avec ou sans value corrigée. Absent lorsque seule value est acceptée.
string
Question complémentaire affichée avec cette exigence.
boolean
Indique si la réponse complémentaire est obligatoire lorsqu’elle est visible.
string[]
Valeurs d’options sélectionnées qui rendent la question complémentaire visible.
object[]
Présent après une soumission rejetée.

Propriétés

string
Code d’erreur stable.
string
Raison du rejet.
string
requis
Instruction à afficher à l’utilisateur. Reprend mot pour mot la note de l’examinateur lorsqu’il y en a une.
boolean
true lorsque l’élément peut être ignoré.
string[]
Les valeurs que value peut prendre pour un élément select. Pour un élément id_document, il s’agit des types de pièces d’identité acceptés, et celui choisi détermine les emplacements documents à envoyer. Absent lorsque l’élément n’implique aucun choix.
string
requis
Ce qui est requis : un nom de document tel que bank_statement, ou une clé de champ telle que ssn ou identity_document. Traitez les valeurs non reconnues selon type.
string
Format de saisie natif facultatif pour une réponse textuelle.Options disponibles : yes_no, yes_no_na, date, url, number, tel
string
Indique si une question avec options accepte une seule valeur ou plusieurs valeurs.Options disponibles : single, multiple
object[]
Documents fournis avec l’exigence à titre de contexte.

Propriétés

string
requis
L’ID du fichier, préfixé par file_.
string | null
requis
Espace réservé BlurHash pour une image ou une vidéo. Null lorsqu’il n’est pas disponible ou qu’il a été supprimé par la modération.
string | null
requis
Le type MIME du fichier d’origine, par exemple application/pdf. Il est conservé lorsque la modération supprime le fichier.
string
requis
Date de création du fichier, sous forme d’horodatage ISO 8601.
number | null
requis
Durée de l’audio ou de la vidéo en secondes. Null lorsqu’elle n’est pas disponible ou qu’elle a été supprimée par la modération.
string | null
requis
Le nom de fichier d’origine, extension comprise.
integer | null
requis
Hauteur de l’image ou de la vidéo en pixels. Null lorsqu’elle n’est pas disponible ou qu’elle a été supprimée par la modération.
integer | null
La taille en octets que doit avoir chaque partie (sauf la dernière). Présent uniquement à la création, et uniquement pour les téléversements multiparties.
string | null
L’ID du téléversement multipartie, à renvoyer à complete. Présent uniquement à la création, et uniquement pour les téléversements multiparties.
object[] | null
L’URL présignée de chaque partie. Présent uniquement à la création, et uniquement pour les téléversements multiparties.

Propriétés

integer
requis
L’index (commençant à 1) de cette partie dans le téléversement multipartie.
string
requis
L’URL présignée vers laquelle envoyer (PUT) les octets de cette partie.
string
requis
Le type de cet objet, toujours file.
boolean
requis
Indique si la modération a supprimé le fichier. Lorsque true, url sert une image de remplacement. filename, size et content_type décrivent toujours le fichier d’origine.
integer | null
requis
La taille du fichier en octets. null tant que le téléversement n’est pas terminé.
object
En-têtes à envoyer avec le PUT de téléversement. Présent uniquement à la création.
string
requis
L’étape du cycle de téléversement à laquelle se trouve le fichier.Options disponibles : pending, processing, ready, failed
string | null
URL présignée vers laquelle envoyer (PUT) les octets du fichier. Présent uniquement à la création, et uniquement pour les téléversements en une seule partie.
string | null
requis
Une URL pour télécharger le fichier. Les fichiers publics reçoivent une URL CDN permanente, et les fichiers privés une URL signée qui expire. null tant que le téléversement n’est pas terminé. Lorsque la modération supprime le fichier, une URL d’image de remplacement.
string
requis
Les fichiers public sont servis depuis une URL CDN non signée. Les fichiers private sont servis depuis une URL signée qui expire.Options disponibles : public, private
string | null
requis
URL de la forme d’onde audio. Null lorsqu’elle n’est pas disponible ou qu’elle a été supprimée par la modération.
integer | null
requis
Largeur de l’image ou de la vidéo en pixels. Null lorsqu’elle n’est pas disponible ou qu’elle a été supprimée par la modération.
boolean
Indique si une explication écrite peut remplacer les fichiers justificatifs requis.
boolean
Indique si cette exigence nécessite également des fichiers justificatifs.
string[]
Valeurs d’options sélectionnées qui rendent visible le champ de fichiers justificatifs.
string
requis
Ce qu’il faut envoyer comme réponse, afin que vous n’ayez jamais à le déduire : files (un document, sous forme de liste de ses pages), id_document (envoyez documents avec les clés d’emplacement de la pièce d’identité que vous téléversez), text, date, phone ou select (envoyez value), text_with_files (envoyez value et éventuellement files), address (envoyez address), ou liveness (ouvrez action_url, puis envoyez value à true une fois terminé).
object[]
Documents d’une vérification par téléversement de documents et leur avancement. Présent uniquement sur les vérifications individuelles créées en envoyant documents. Les documents pending_upload n’ont pas encore été acceptés — renvoyez l’ensemble complet avec un nouvel appel à Create Verification.

Propriétés

string
Clé d’emplacement du document, telle que id_card_front, id_card_back ou selfie.
string | null
Raison du rejet de la soumission précédente, lorsque le fournisseur a demandé de nouveaux documents ou refusé la vérification.
string
pending_upload jusqu’à ce que le document ait été transmis pour examen ; submitted ensuite.Options disponibles : pending_upload, submitted
string | null
URL de la session de vérification hébergée permettant à l’utilisateur d’effectuer les contrôles d’identité. Expire 7 jours après sa création.
string
État actuel de la vérification. not_started avant l’existence de toute session ; pending tant qu’une session attend une action de l’utilisateur ; processing pendant l’exécution des contrôles automatisés du fournisseur sur une nouvelle soumission ; action_required lorsque requested_information attend des réponses ; manual_review pendant l’examen d’informations déjà envoyées — une réponse d’audit, ou un document détenu par le fournisseur de versements — rien à soumettre, généralement terminé sous 3 jours ouvrés ; approved en cas de succès ; rejected en cas d’échec. Appelez à nouveau Create Verification pour démarrer une nouvelle session.Options disponibles : not_started, pending, processing, manual_review, approved, rejected, action_required
string
Date de dernière mise à jour du profil de vérification, sous forme d’horodatage ISO 8601.
Verification