Skip to main content
Konti og brugere gennemfører verifikation, når Whop skal bekræfte, hvem de er, før udbetalinger eller compliance-følsomme workflows aktiveres. Brug Verifications API’et til at starte eller genoptage en hostet verifikationssession, kontrollere gennemgangsstatus og indsende anmodede oplysninger eller dokumenter. Hvis requested_information indeholder elementer, skal du indsende svar med Opdatér verifikation.
Erstatter Legacy-ressourcen Verifications. Eksisterende Legacy-integrationer fortsætter med at virke; se API-versioner for stabilitetsaftalen.

Endpoints

Attributter

string
Verifikationsprofil-ID med præfikset idpf_.
string[]
påkrævet
Konti, som denne verifikation blev læst for, hver med præfikset biz_: den konto, du listede efter, den konto eller underkonto, den tilhører med include_subaccounts, eller alle konti, du kan læse, som den tilhører, når den hentes efter ID. Normalt én. Tom for en personlig verifikation.
object | null
Adresse på verifikationsprofilen. null, når ingen adresse er angivet.

Egenskaber

string | null
string | null
Landekode på to bogstaver efter ISO 3166-1, for eksempel US, DE eller GB.
string
Første linje i gadeadressen.
string | null
Anden linje i gadeadressen.
string | null
Postnummer.
string | null
Kode for stat, provins eller region, for eksempel CA.
string | null
Virksomhedens juridiske navn.
string | null
Virksomhedens juridiske enhedsstruktur, såsom private_corporation eller sole_proprietorship. Understøttede værdier varierer efter registreringsland — se Virksomhedsstrukturer.
string | null
Landekode på to bogstaver efter ISO 3166-1, for eksempel US, DE eller GB.
string
Hvornår verifikationsprofilen blev oprettet, som et ISO 8601-tidsstempel.
string | null
Formateret som YYYY-MM-DD.
string | null
E-mailadresse på verifikationsprofilen.
string | null
string | null
Datoen, hvor virksomheden blev stiftet, formateret som YYYY-MM-DD, som registreret for virksomhedsverifikationen. Kun virksomhedsverifikationer; null, indtil den er sendt.
string
Tilgængelige muligheder: individual, business
string | null
object[]
påkrævet
Virksomhedens ejere og status for hver enkelts egen verifikation. Tom for individuelle verifikationer.

Egenskaber

string
påkrævet
Ejer-ID med præfikset own_. Send det i Update Verifications owners for at ændre eller fjerne ejeren, inklusive en, der er tilføjet i den hostede session.
string | null
påkrævet
Ejerens registrerede fødselsdato, formateret som YYYY-MM-DD.
string | null
påkrævet
string | null
påkrævet
number | null
påkrævet
Andel af virksomheden, som personen ejer, fra 0 til 100.
string[]
påkrævet
Hvad udbyderen afviste, da ejerens verifikation blev sendt tilbage: details (personens navn, fødselsdato eller andre oplysninger stemmer ikke overens med ID’et), identity_document eller selfie. Ret kun disse med Update Verification. Ellers tom.Tilgængelige muligheder: details, identity_document, selfie
object[]
påkrævet
Ejerens dokumenter og deres status. Tom for en ejer, der er tilføjet med verification_id.

Egenskaber

string
Nøgle for dokumentplads, såsom id_card_front, id_card_back eller selfie.
string | null
Hvorfor den tidligere indsendelse blev afvist, når udbyderen anmodede om nye dokumenter eller afviste verifikationen.
string
pending_upload, indtil dokumentet er videresendt til gennemgang; submitted derefter.Tilgængelige muligheder: pending_upload, submitted
string[]
påkrævet
Hvad personen er for virksomheden.Tilgængelige muligheder: ubo, director, representative, shareholder
string
påkrævet
Status for ejerens egen verifikation, i de samme tilstande som status. action_required, når deres dokumenter skal sendes igen.Tilgængelige muligheder: not_started, pending, processing, manual_review, approved, rejected, action_required
string | null
Telefonnummer på verifikationsprofilen.
string | null
Stat eller region, hvor virksomheden er registreret, som registreret for virksomhedsverifikationen. Kun virksomhedsverifikationer; null, indtil den er sendt.
string | null
Det nummer, virksomheden er registreret under på sit registreringssted, såsom et state file number i USA eller et Company Number i Storbritannien. Kun virksomhedsverifikationer; som registreret for virksomhedsverifikationen, eller null, indtil den er sendt.
object[]
Hvad Whop stadig har brug for, før gennemgangen kan fortsætte, med ét krav pr. post. Svar med Update Verification. Intet fra svaret gentages tilbage. Nøgler, der ikke er relevante, udelades. For en virksomhedsverifikation, der er oprettet med documents eller owners, inkluderer dette de virksomhedsoplysninger og dokumenter, der stadig mangler, før den kan sendes til gennemgang. Hver ejers dokumenter vises under den pågældende ejer.

Egenskaber

string
påkrævet
ID for anmodet informationselement med præfikset inrqi_.
string
URL til en relateret handling, såsom at gennemføre liveness-verifikation eller se en betaling. Fraværende, når ingen handling er tilgængelig.
string
Et dokument, der besvarer dette element i stedet for value, såsom et IRS EIN-brev, når EIN ikke kunne matches. Send dets sider i files, med eller uden en rettet value. Fraværende, når kun value accepteres.
string
Opfølgende prompt, der vises med dette krav.
boolean
Om det opfølgende svar er påkrævet, når det er synligt.
string[]
Valgte optionsværdier, der gør den opfølgende prompt synlig.
object[]
Til stede efter en afvist indsendelse.

Egenskaber

string
Stabil fejlkode.
string
Hvorfor det blev afvist.
string
påkrævet
Instruktion, der skal vises for brugeren. Indeholder korrekturlæserens note ordret, når der er en.
boolean
true, når elementet kan springes over.
string[]
De værdier, value kan antage på et select-element. På et id_document-element er disse de accepterede ID-typer, og den valgte afgør, hvilke documents-pladser der skal sendes. Fraværende, når elementet ikke har noget valg.
string
påkrævet
Hvad der er brug for: et dokumentnavn såsom bank_statement, eller en feltnøgle såsom ssn eller identity_document. Håndtér ukendte værdier ud fra type.
string
Valgfrit native inputformat for et tekstsvar.Tilgængelige muligheder: yes_no, yes_no_na, date, url, number, tel
string
Om et spørgsmål med options accepterer én værdi eller flere værdier.Tilgængelige muligheder: single, multiple
object[]
Dokumenter leveret med kravet som kontekst.

Egenskaber

string
påkrævet
Filens ID med præfikset file_.
string | null
påkrævet
BlurHash-pladsholder for et billede eller en video. Null, når den ikke er tilgængelig eller er fjernet af moderering.
string | null
påkrævet
Den oprindelige fils MIME-type, for eksempel application/pdf. Den bevares, når moderering fjerner filen.
string
påkrævet
Hvornår filen blev oprettet, som et ISO 8601-tidsstempel.
number | null
påkrævet
Lyd- eller videovarighed i sekunder. Null, når den ikke er tilgængelig eller er fjernet af moderering.
string | null
påkrævet
Det oprindelige filnavn, inklusive filtypenavnet.
integer | null
påkrævet
Billed- eller videohøjde i pixels. Null, når den ikke er tilgængelig eller er fjernet af moderering.
integer | null
Den bytestørrelse, hver del (undtagen den sidste) skal have. Kun til stede ved oprettelse, og kun for multipart-uploads.
string | null
ID’et for multipart-uploadet, som sendes tilbage til complete. Kun til stede ved oprettelse, og kun for multipart-uploads.
object[] | null
Den presignede URL for hver del. Kun til stede ved oprettelse, og kun for multipart-uploads.

Egenskaber

integer
påkrævet
Det 1-baserede indeks for denne del i multipart-uploadet.
string
påkrævet
Den presignede URL, som denne dels bytes skal PUT’es til.
string
påkrævet
Typen af dette objekt, altid file.
boolean
påkrævet
Om moderering har fjernet filen. Når true, leverer url et erstatningsbillede. filename, size og content_type beskriver stadig den oprindelige fil.
integer | null
påkrævet
Filstørrelsen i bytes. null, indtil uploadet er færdigt.
object
Headers, der skal sendes med upload-PUT’en. Kun til stede ved oprettelse.
string
påkrævet
Hvor filen er i sin upload-livscyklus.Tilgængelige muligheder: pending, processing, ready, failed
string | null
Presigned URL, som filens bytes skal PUT’es til. Kun til stede ved oprettelse, og kun for uploads i én del.
string | null
påkrævet
En URL til at downloade filen. Offentlige filer får en permanent CDN-URL, og private filer får en signeret URL, der udløber. null, indtil uploadet er færdigt. Når moderering fjerner filen, en URL til et erstatningsbillede.
string
påkrævet
public-filer leveres fra en usigneret CDN-URL. private-filer leveres fra en signeret URL, der udløber.Tilgængelige muligheder: public, private
string | null
påkrævet
URL til lydbølgeform. Null, når den ikke er tilgængelig eller er fjernet af moderering.
integer | null
påkrævet
Billed- eller videobredde i pixels. Null, når den ikke er tilgængelig eller er fjernet af moderering.
boolean
Om en skriftlig forklaring kan erstatte påkrævede understøttende filer.
boolean
Om dette krav også har brug for understøttende filer.
string[]
Valgte optionsværdier, der gør inputtet til understøttende filer synligt.
string
påkrævet
Hvad der skal sendes som svar, så du aldrig behøver at udlede det: files (et dokument, som en liste over dets sider), id_document (send documents med pladsnøglerne for det ID, du uploader), text, date, phone eller select (send value), text_with_files (send value og valgfrie files), address (send address) eller liveness (åbn action_url, og send derefter value som true efter gennemførelse).
object[]
Dokumenter til en verifikation via dokumentupload og deres status. Kun til stede på individuelle verifikationer, der er oprettet ved at sende documents. pending_upload-dokumenter er endnu ikke accepteret — send hele sættet igen med et nyt Create Verification-kald.

Egenskaber

string
Nøgle for dokumentplads, såsom id_card_front, id_card_back eller selfie.
string | null
Hvorfor den tidligere indsendelse blev afvist, når udbyderen anmodede om nye dokumenter eller afviste verifikationen.
string
pending_upload, indtil dokumentet er videresendt til gennemgang; submitted derefter.Tilgængelige muligheder: pending_upload, submitted
string | null
URL til hostet verifikationssession, hvor brugeren gennemfører identitetskontroller. Udløber 7 dage efter oprettelse.
string
Aktuel verifikationstilstand. not_started, før der findes en session; pending, mens en session kræver brugerens input; processing, mens udbyderens automatiske kontroller kører på en ny indsendelse; action_required, når requested_information skal besvares; manual_review, mens allerede sendte oplysninger er under gennemgang — et revisionssvar eller et dokument, som udbetalingsudbyderen har — intet at indsende, normalt færdigt inden for 3 hverdage; approved ved succes; rejected ved fejl. Kald Create Verification igen for at starte en ny session.Tilgængelige muligheder: not_started, pending, processing, manual_review, approved, rejected, action_required
string
Hvornår verifikationsprofilen sidst blev opdateret, som et ISO 8601-tidsstempel.
Verification