Skip to main content
GET
Retrieve Verification

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-08-13"

Path Parameters

id
string
required

Verification profile ID, prefixed idpf_.

Response

verification retrieved

address
object | null

Address on the verification profile. null when no address is set.

business_name
string | null

Legal business name.

Example:

"Shine Time Auto Detailing, LLC"

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.

Example:

"sole_proprietorship"

country
string | null

Two-letter ISO 3166-1 country code, for example US, DE, or GB.

Example:

"US"

created_at
string

When the verification profile was created, as an ISO 8601 timestamp.

Example:

"2026-06-01T12:00:00.000Z"

date_of_birth
string | null

Formatted as YYYY-MM-DD.

Example:

"1990-01-01"

email
string | null

Email address on the verification profile.

Example:

"marcus@shinetime.example"

first_name
string | null
Example:

"Marcus"

id
string

Verification profile ID, prefixed idpf_.

Example:

"idpf_xxxxxxxxxxxx"

kind
enum<string>
Available options:
individual,
business
Example:

"individual"

last_name
string | null
Example:

"Webb"

phone
string | null

Phone number on the verification profile.

Example:

"+15551234567"

requested_information
object[]

What Whop still needs before review can continue — one requirement per entry. Answer with Update Verification; nothing from the response is echoed back. Keys that don't apply are omitted.

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.

session_url
string | null

Hosted verification session URL for the user to complete identity checks. Expires 7 days after creation.

Example:

"https://sumsub.com/session/abc"

status
enum<string>

Current verification state. not_started before any session exists; pending while a session needs the user's input; processing while the provider's automated checks run on a fresh submission; action_required when requested_information needs answers; manual_review while information already sent is under review — an audit answer, or a document the payout provider holds — nothing to submit, usually done within 3 business days; approved on success; rejected on failure. Call Create Verification again to start a new session.

Available options:
not_started,
pending,
processing,
manual_review,
approved,
rejected,
action_required
Example:

"action_required"

updated_at
string

When the verification profile was last updated, as an ISO 8601 timestamp.

Example:

"2026-06-02T12:00:00.000Z"