Skip to main content
Accounts en gebruikers voltooien een verificatie wanneer Whop moet bevestigen wie ze zijn voordat uitbetalingen of compliance-gevoelige workflows worden ingeschakeld. Gebruik de Verifications API om een gehoste verificatiesessie te starten of te hervatten, de beoordelingsstatus te controleren en gevraagde gegevens of documenten in te dienen. Als requested_information items bevat, dien je de antwoorden in met Update Verification.
Vervangt de Legacy-resource Verifications. Bestaande Legacy-integraties blijven werken; zie API-versies voor de stabiliteitsafspraken.

Endpoints

Attributen

string
Verificatieprofiel-ID, met prefix idpf_.
string[]
vereist
Accounts waarvoor deze verificatie is gelezen, elk met prefix biz_: het account waarop je hebt gefilterd, het account of subaccount waartoe deze behoort met include_subaccounts, of elk account dat je kunt lezen waartoe deze behoort wanneer opgehaald op ID. Meestal één. Leeg voor een persoonlijke verificatie.
object | null
Adres op het verificatieprofiel. null wanneer er geen adres is ingesteld.

Eigenschappen

string | null
string | null
Tweeletterige ISO 3166-1-landcode, bijvoorbeeld US, DE of GB.
string
Eerste regel van het straatadres.
string | null
Tweede regel van het straatadres.
string | null
Postcode.
string | null
Code van staat, provincie of regio, bijvoorbeeld CA.
string | null
Officiële bedrijfsnaam.
string | null
Rechtsvorm van de onderneming, zoals private_corporation of sole_proprietorship. Ondersteunde waarden verschillen per land van oprichting — zie Bedrijfsstructuren.
string | null
Tweeletterige ISO 3166-1-landcode, bijvoorbeeld US, DE of GB.
string
Wanneer het verificatieprofiel is aangemaakt, als ISO 8601-tijdstempel.
string | null
Opgemaakt als YYYY-MM-DD.
string | null
E-mailadres op het verificatieprofiel.
string | null
string | null
Datum waarop de onderneming is opgericht, opgemaakt als YYYY-MM-DD, zoals vastgelegd voor de bedrijfsverificatie. Alleen bedrijfsverificaties; null totdat deze is verzonden.
string
Beschikbare opties: individual, business
string | null
object[]
vereist
Eigenaren van de onderneming en de voortgang van de eigen verificatie van elk van hen. Leeg voor individuele verificaties.

Eigenschappen

string
vereist
Eigenaar-ID, met prefix own_. Stuur deze mee in owners van Update Verification om de eigenaar te wijzigen of te verwijderen, inclusief een eigenaar die in de gehoste sessie is toegevoegd.
string | null
vereist
De vastgelegde geboortedatum van de eigenaar, opgemaakt als YYYY-MM-DD.
string | null
vereist
string | null
vereist
number | null
vereist
Aandeel in de onderneming dat de persoon bezit, van 0 tot 100.
string[]
vereist
Wat de provider heeft afgewezen toen de verificatie van de eigenaar werd teruggestuurd: details (naam, geboortedatum of andere gegevens komen niet overeen met het identiteitsbewijs), identity_document of selfie. Corrigeer alleen deze met Update Verification. Anders leeg.Beschikbare opties: details, identity_document, selfie
object[]
vereist
De documenten van de eigenaar en hun voortgang. Leeg voor een eigenaar die is toegevoegd met verification_id.

Eigenschappen

string
Sleutel van het documentslot, zoals id_card_front, id_card_back of selfie.
string | null
Waarom de vorige inzending is afgewezen, wanneer de provider nieuwe documenten heeft gevraagd of de verificatie heeft afgewezen.
string
pending_upload totdat het document voor beoordeling is doorgestuurd; daarna submitted.Beschikbare opties: pending_upload, submitted
string[]
vereist
Wat de persoon voor de onderneming is.Beschikbare opties: ubo, director, representative, shareholder
string
vereist
De status van de eigen verificatie van de eigenaar, in dezelfde statussen als status. action_required wanneer de documenten opnieuw moeten worden verzonden.Beschikbare opties: not_started, pending, processing, manual_review, approved, rejected, action_required
string | null
Telefoonnummer op het verificatieprofiel.
string | null
Staat of regio waar de onderneming is opgericht, zoals vastgelegd voor de bedrijfsverificatie. Alleen bedrijfsverificaties; null totdat deze is verzonden.
string | null
Nummer waaronder de onderneming is geregistreerd op de plaats van oprichting, zoals een state file number in de VS of een Company Number in het VK. Alleen bedrijfsverificaties; zoals vastgelegd voor de bedrijfsverificatie, of null totdat deze is verzonden.
object[]
Wat Whop nog nodig heeft voordat de beoordeling kan doorgaan, met één vereiste per item. Beantwoord met Update Verification. Niets uit het antwoord wordt teruggegeven. Sleutels die niet van toepassing zijn, worden weggelaten. Voor een bedrijfsverificatie die is aangemaakt met documents of owners omvat dit de bedrijfsgegevens en documenten die nog ontbreken voordat deze ter beoordeling kan worden verzonden. De documenten van elke eigenaar worden onder die eigenaar vermeld.

Eigenschappen

string
vereist
ID van het gevraagde informatie-item, met prefix inrqi_.
string
URL voor een gerelateerde actie, zoals het voltooien van een liveness-verificatie of het bekijken van een betaling. Afwezig wanneer er geen actie beschikbaar is.
string
Een document dat dit item beantwoordt in plaats van value, zoals een IRS EIN-brief wanneer het EIN niet kon worden gematcht. Stuur de pagina’s mee in files, met of zonder gecorrigeerde value. Afwezig wanneer alleen value wordt geaccepteerd.
string
Vervolgvraag die bij deze vereiste wordt getoond.
boolean
Of het vervolgantwoord verplicht is wanneer het zichtbaar is.
string[]
Geselecteerde optiewaarden die de vervolgvraag zichtbaar maken.
object[]
Aanwezig na een afgewezen inzending.

Eigenschappen

string
Stabiele foutcode.
string
Waarom het is afgewezen.
string
vereist
Instructie om aan de gebruiker te tonen. Bevat letterlijk de notitie van de beoordelaar wanneer die er is.
boolean
true wanneer het item kan worden overgeslagen.
string[]
De waarden die value kan aannemen bij een select-item. Bij een id_document-item zijn dit de geaccepteerde typen identiteitsbewijs, en het gekozen type bepaalt welke documents-slots moeten worden verzonden. Afwezig wanneer er bij het item niets te kiezen valt.
string
vereist
Wat er nodig is: een documentnaam zoals bank_statement, of een veldsleutel zoals ssn of identity_document. Verwerk onbekende waarden op basis van type.
string
Optioneel native invoerformaat voor een tekstantwoord.Beschikbare opties: yes_no, yes_no_na, date, url, number, tel
string
Of een vraag met options één waarde of meerdere waarden accepteert.Beschikbare opties: single, multiple
object[]
Documenten die ter context bij de vereiste worden geleverd.

Eigenschappen

string
vereist
De ID van het bestand, met prefix file_.
string | null
vereist
BlurHash-placeholder voor een afbeelding of video. Null wanneer niet beschikbaar of verwijderd door moderatie.
string | null
vereist
Het MIME-type van het oorspronkelijke bestand, bijvoorbeeld application/pdf. Dit blijft behouden wanneer moderatie het bestand verwijdert.
string
vereist
Wanneer het bestand is aangemaakt, als ISO 8601-tijdstempel.
number | null
vereist
Duur van audio of video in seconden. Null wanneer niet beschikbaar of verwijderd door moderatie.
string | null
vereist
De oorspronkelijke bestandsnaam, inclusief extensie.
integer | null
vereist
Hoogte van afbeelding of video in pixels. Null wanneer niet beschikbaar of verwijderd door moderatie.
integer | null
De grootte in bytes die elk deel (behalve het laatste) moet hebben. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.
string | null
De ID van de multipart-upload, die wordt teruggegeven aan complete. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.
object[] | null
De presigned URL voor elk deel. Alleen aanwezig bij aanmaken, en alleen voor multipart-uploads.

Eigenschappen

integer
vereist
De 1-gebaseerde index van dit deel binnen de multipart-upload.
string
vereist
De presigned URL waarnaar de bytes van dit deel met PUT moeten worden verzonden.
string
vereist
Het type van dit object, altijd file.
boolean
vereist
Of moderatie het bestand heeft verwijderd. Wanneer true, levert url een vervangende afbeelding. filename, size en content_type beschrijven nog steeds het oorspronkelijke bestand.
integer | null
vereist
De bestandsgrootte in bytes. null totdat de upload is voltooid.
object
Headers om mee te sturen met de upload-PUT. Alleen aanwezig bij aanmaken.
string
vereist
Waar het bestand zich in de uploadlevenscyclus bevindt.Beschikbare opties: pending, processing, ready, failed
string | null
Presigned URL waarnaar de bytes van het bestand met PUT moeten worden verzonden. Alleen aanwezig bij aanmaken, en alleen voor uploads in één deel.
string | null
vereist
Een URL om het bestand te downloaden. Openbare bestanden krijgen een permanente CDN-URL en privébestanden krijgen een ondertekende URL die verloopt. null totdat de upload is voltooid. Wanneer moderatie het bestand verwijdert, een URL van een vervangende afbeelding.
string
vereist
public-bestanden worden geleverd via een niet-ondertekende CDN-URL. private-bestanden worden geleverd via een ondertekende URL die verloopt.Beschikbare opties: public, private
string | null
vereist
URL van de audiowaveform. Null wanneer niet beschikbaar of verwijderd door moderatie.
integer | null
vereist
Breedte van afbeelding of video in pixels. Null wanneer niet beschikbaar of verwijderd door moderatie.
boolean
Of een schriftelijke toelichting de vereiste ondersteunende bestanden mag vervangen.
boolean
Of deze vereiste ook ondersteunende bestanden nodig heeft.
string[]
Geselecteerde optiewaarden die het invoerveld voor ondersteunende bestanden zichtbaar maken.
string
vereist
Wat er als antwoord moet worden verzonden, zodat je het nooit hoeft af te leiden: files (een document, als lijst van pagina’s), id_document (stuur documents met de slotsleutels voor het identiteitsbewijs dat je uploadt), text, date, phone of select (stuur value), text_with_files (stuur value en optioneel files), address (stuur address), of liveness (open action_url en stuur daarna value als true na voltooiing).
object[]
Documenten voor een verificatie via documentupload en hun voortgang. Alleen aanwezig bij individuele verificaties die zijn aangemaakt door documents te verzenden. pending_upload-documenten zijn nog niet geaccepteerd — stuur de volledige set opnieuw met een nieuwe Create Verification-aanroep.

Eigenschappen

string
Sleutel van het documentslot, zoals id_card_front, id_card_back of selfie.
string | null
Waarom de vorige inzending is afgewezen, wanneer de provider nieuwe documenten heeft gevraagd of de verificatie heeft afgewezen.
string
pending_upload totdat het document voor beoordeling is doorgestuurd; daarna submitted.Beschikbare opties: pending_upload, submitted
string | null
URL van de gehoste verificatiesessie waarin de gebruiker de identiteitscontroles voltooit. Verloopt 7 dagen na aanmaak.
string
Huidige verificatiestatus. not_started voordat er een sessie bestaat; pending zolang een sessie invoer van de gebruiker nodig heeft; processing terwijl de geautomatiseerde controles van de provider op een nieuwe inzending draaien; action_required wanneer requested_information antwoorden nodig heeft; manual_review terwijl al verzonden informatie wordt beoordeeld — een auditantwoord, of een document dat de uitbetalingsprovider aanhoudt — niets in te dienen, meestal binnen 3 werkdagen afgerond; approved bij succes; rejected bij mislukking. Roep Create Verification opnieuw aan om een nieuwe sessie te starten.Beschikbare opties: not_started, pending, processing, manual_review, approved, rejected, action_required
string
Wanneer het verificatieprofiel voor het laatst is bijgewerkt, als ISO 8601-tijdstempel.
Verification