Skip to main content
A Verification represents an identity review for a person or business. Accounts and users complete verification when Whop needs to confirm who they are before enabling payouts or compliance-sensitive workflows. Use the Verifications API to start or resume a hosted verification session, check review status, and submit requested details or documents. If requested_information contains items, submit answers with Update Verification.

​
Endpoints

​
Attributes

​
id
string
Verification profile ID, prefixed idpf_.
​
address
object | null
Address on the verification profile. null when no address is set.

Properties

​
city
string | null
​
country
string | null
Two-letter ISO 3166-1 country code, for example US, DE, or GB.
​
line1
string
First line of the street address.
​
line2
string | null
Second line of the street address.
​
postal_code
string | null
Postal or ZIP code.
​
state
string | null
State, province, or region code, for example CA.
​
business_name
string | null
Legal business name.
​
business_structure
string | null
Legal entity structure of the business, such as private_corporation or sole_proprietorship. Supported values vary by country of incorporation — see Business structures.
​
country
string | null
Two-letter ISO 3166-1 country code, for example US, DE, or GB.
​
created_at
string
When the verification profile was created, as an ISO 8601 timestamp.
​
date_of_birth
string | null
Formatted as YYYY-MM-DD.
​
first_name
string | null
​
kind
string
Available options: individual, business
​
last_name
string | null
​
requested_information
object[]
Fields or documents Whop still needs before review can continue. Submit answers with the Update Verification endpoint.

Properties

​
id
string
Requested information item ID, prefixed inrqi_. Include this ID when submitting an answer.
​
description
string | null
Additional instructions for this requested item, or null.
​
error_message
string | null
Reason a previously submitted value was rejected. null if no submitted value has been rejected.
​
field
string
Stable field key, such as ssn or business_description.
​
label
string
Human-readable label for the field, such as Social Security Number.
​
options
string[]
Allowed values for a select field (e.g. account_type, business_structure) — the submitted value must be one of these; empty for other types.
​
requested_files
object[]
Document upload slots for this item. Present when type is files; upload one file for each required slot and include the slot’s category when submitting the answer.

Properties

​
category
string | null
File category to include with the uploaded file so Whop can route the document correctly. null for a generic upload.
​
is_optional
boolean
Whether this slot can be left empty.
​
kind
string | null
Specific document type requested, such as Bank Statement. null for standard identity and business document uploads.
​
label
string
Label for this upload slot, such as Front of ID Document.
​
multiple
boolean
Whether this slot accepts more than one file.
​
type
string | null
Input type expected for this item: text, date, phone, address, files, or select.
​
required_documents
object[]
Documents for a document-upload verification and their progress. Present only on verifications created by sending documents. pending_upload documents were not accepted yet — send the full set again with another Create Verification call.

Properties

​
document
string
Document slot key, such as id_card_front, id_card_back, or selfie.
​
rejection_reason
string | null
Why the previous submission was rejected, when the provider requested new documents or declined the verification.
​
status
string
pending_upload until the document has been relayed for review; submitted afterwards.Available options: pending_upload, submitted
​
session_url
string | null
Hosted verification session URL for the user to complete identity checks. Expires 7 days after creation.
​
status
string
Current verification state. not_started before any session has been created; pending while a session is in progress and needs the user’s input; processing while the provider reviews submitted documents — nothing to do but wait; action_required when items in requested_information need answers before review can continue; approved once verification succeeds; rejected if it fails. Call the Create Verification endpoint again to start a new session.Available options: not_started, pending, processing, approved, rejected, action_required
​
updated_at
string
When the verification profile was last updated, as an ISO 8601 timestamp.
Verification