Skip to main content
PATCH
TypeScript

Autorisationer

Authorization
string
header
påkrævet

An Account API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

identity:write

Overskrifter

Api-Version-Date
string

Pins the request to a dated API version.

Eksempel:

"2026-11-17"

Sti-parametre

id
string
påkrævet

Verification profile ID, prefixed idpf_.

Krop

application/json

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

business_name
string

Legal business name for a sole proprietor or single-member LLC.

Eksempel:

"Shine Time Auto Detailing"

business_structure
string

Entity type for sole proprietors, such as single_member_llc. Supported values vary by country of incorporation — see Business structures.

Eksempel:

"sole_proprietorship"

business_tax_identification_number
string

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

Eksempel:

"12-3456789"

country
string

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

Eksempel:

"US"

date_of_birth
string

Formatted as YYYY-MM-DD.

Eksempel:

"2026-01-01"

first_name
string
Eksempel:

"Marcus"

last_name
string
Eksempel:

"Webb"

personal_address
object

Personal address for the individual.

requested_information
object[]

Answers to items in requested_information. Each entry pairs the item id with one answer payload matching its type.

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.

Eksempel:

"123456789"

Svar

verification updated

account_ids
string[]
påkrævet

Accounts this verification was read for, each prefixed biz_: the account you listed by, the account or subaccount it belongs to with include_subaccounts, or every account you can read that it belongs to when retrieved by ID. Usually one. Empty for a personal verification.

Eksempel:
owners
object[]
påkrævet

Owners of the business and the progress of each one's own verification. Empty for individual verifications.

address
object | null

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

business_name
string | null

Legal business name.

Eksempel:

"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.

Eksempel:

"sole_proprietorship"

country
string | null

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

Eksempel:

"US"

created_at
string

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

Eksempel:

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

date_of_birth
string | null

Formatted as YYYY-MM-DD.

Eksempel:

"1990-01-01"

email
string | null

Email address on the verification profile.

Eksempel:

"marcus@shinetime.example"

first_name
string | null
Eksempel:

"Marcus"

id
string

Verification profile ID, prefixed idpf_.

Eksempel:

"idpf_xxxxxxxxxxxx"

incorporation_date
string | null

Date the business was incorporated, formatted as YYYY-MM-DD, as on file for the business verification. Business verifications only; null until it is sent.

Eksempel:

"2021-03-15"

kind
enum<string>
Tilgængelige muligheder:
individual,
business
Eksempel:

"individual"

last_name
string | null
Eksempel:

"Webb"

phone
string | null

Phone number on the verification profile.

Eksempel:

"+15551234567"

place_of_incorporation
string | null

State or region where the business is incorporated, as on file for the business verification. Business verifications only; null until it is sent.

Eksempel:

"Delaware"

registration_number
string | null

Number the business was registered under in its place of incorporation, such as a state file number in the US or a Company Number in the UK. Business verifications only; as on file for the business verification, or null until it is sent.

Eksempel:

"7654321"

requested_information
object[]

What Whop still needs before review can continue, with one requirement per entry. Answer with Update Verification. Nothing from the response is echoed back. Keys that don't apply are omitted. For a business verification created with documents or owners, this includes the business details and documents still missing before it can be sent for review. Each owner's documents are listed under that owner.

required_documents
object[]

Documents for a document-upload verification and their progress. Present only on individual 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.

Eksempel:

"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.

Tilgængelige muligheder:
not_started,
pending,
processing,
manual_review,
approved,
rejected,
action_required
Eksempel:

"action_required"

updated_at
string

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

Eksempel:

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