Skip to main content
PATCH
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-25"

Path Parameters

verification_id
string
required

Verification profile ID, prefixed idpf_.

Body

application/json

Fields that can be updated on an individual (KYC) verification. At least one field is required.

business_tax_identification_number
string

The business ID number of the company, as appropriate for the company's country. Examples are an Employer Identification Number (EIN) in the US, a Business Number in Canada, or a Company Number in the UK.

country
string

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

date_of_birth
string

Formatted as YYYY-MM-DD.

first_name
string
last_name
string
personal_address
object

Personal address for the individual.

requested_information
object[]

Answers to items returned in requested_information. Each entry must include the requested item id and exactly one answer payload matching the item's type: value for text, date, or phone; address for address; files for files.

tax_identification_number
string

The government-issued ID number of the person being verified — the individual for a KYC verification, or the business representative for a KYB verification — as appropriate for their country. Examples are a Social Security Number (SSN) in the US, or a Social Insurance Number in Canada.

Response

verification updated

address
object | null

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

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
id
string

Verification profile ID, prefixed idpf_.

kind
enum<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.

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.

status
enum<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.