Access tokens1

Account links1

Accounts15

Ad Campaigns9

Ad Conversion Value Rules7

Ad Groups10

Ads8

Affiliates10

Ai chats5

API Keys7

Api Logs1

App Builds4

Apps8

Audiences5

Authorized users4

Bounties7

Bounty Submissions5

Cards6

Cashback Rules4

Chat channels3

Checkout Configurations4

Company token transactions3

Confirmation Tokens1

Course chapters5

Course lesson interactions2

Course lessons8

Course students2

Courses5

Deposits1

Dispute alerts2

Disputes6

Dm channels5

Dm members5

Domains5

Economic Intelligence2

Events4

Experiences8

Experiments8

Exports3

Fee markups3

Files4

Forum posts4

Forums3

Identity profiles4

Invoices9

Leads4

Ledger accounts1

Ledgers3

Media2

Members3

Memberships11

Messages5

Notifications6

Partner Referral Requests6

Partners7

Payment Method Domains5

Payment methods3

Payment Rules9

Payments12

Payout accounts1

Payout methods2

Payouts10

People2

Permissions1

Plans6

Products7

Promo Codes6

Reactions4

Refunds2

Resolution Center Cases11

Reviews2

Setup Intents6

Shipments4

Social Accounts7

Stats2

Support channels3

Swaps4

Team Members5

Topups1

Trades5

Transfers4

Users18

Verifications4

Waitlist Entries7

Webhooks9

Webhooks

Accounts3

Ad Campaigns2

Ads1

Cards13

Course lesson interactions1

Deposits1

Dispute alerts1

Disputes2

Entries4

Exports2

Invoices5

Ledger accounts1

Ledgers1

Members2

Memberships4

Messages1

Payments7

Payout accounts1

Payouts4

Plans3

Products5

Reactions1

Refunds2

Resolution Center Cases3

Setup Intents3

Shipments2

Swaps1

Transfers3

Verifications2

Verifications

Create Verification

Starts a hosted verification session for an account or user, or returns the active session when one already exists. Any fields you include in the request body are used to prefill the session. Send documents (with document_type) to instead verify the person from identity documents included in this request — no hosted session involved. Send share_token to reuse a verification another Sumsub account has already completed for this person, instead of verifying them again. Send verification_id to reuse a verification the signed-in user already completed on Whop. Every mode except verification_id is rejected once the account has an approved verification — unlink it first to start a new one — while verification_id replaces whichever verification of that kind the account currently has.

post/verifications

Query parameters

account_idstring

Business account whose identity you want to verify, prefixed biz_. Provide this or user_id.

user_idstring

The caller's own user ID, prefixed user_, for a personal verification. Provide this or account_id.

Headers

Idempotency-Keystring

Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

Example request

{
  "address": {
    "city": "Austin",
    "country": "US",
    "line1": "4180 Burnet Rd",
    "line2": "Suite 2",
    "postal_code": "78756",
    "state": "TX"
  },
  "business_name": "Shine Time Auto Detailing LLC",
  "business_structure": "private_corporation",
  "business_tax_identification_number": "12-3456789",
  "business_website": "https://shinetime.example",
  "country": "US",
  "date_of_birth": "2026-01-01",
  "document_type": "RESIDENCE_PERMIT",
  "documents": {
    "drivers_back": "/9j/4GFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFh/9k=",
    "drivers_front": "/9j/4GFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFh/9k=",
    "id_card_back": "/9j/4GFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFh/9k=",
    "id_card_front": "/9j/4GFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFh/9k=",
    "passport_front": "/9j/4GFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFh/9k=",
    "residence_permit_back": "/9j/4GFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFh/9k=",
    "residence_permit_front": "/9j/4GFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFh/9k=",
    "selfie": "/9j/4GFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFh/9k="
  },
  "first_name": "Marcus",
  "kind": "individual",
  "last_name": "Webb",
  "phone": "+xxxxxxxxxxx",
  "share_token": "_act-sbx-jwt-eyJhbGciOiJub25l",
  "tax_identification_number": "123456789",
  "verification_id": "idpf_xxxxxxxxxxxxxx"
}

Response

business_namestring nullable

Legal business name.

business_structurestring nullable

Legal entity structure of the business, such as private_corporation or sole_proprietorship. Supported values vary by country of incorporation — see Business structures.

countrystring nullable

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

created_atstring

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

date_of_birthstring nullable

Formatted as YYYY-MM-DD.

emailstring nullable

Email address on the verification profile.

first_namestring nullable

idstring

Verification profile ID, prefixed idpf_.

kind'individual' | 'business'

last_namestring nullable

phonestring nullable

Phone number on the verification profile.

session_urlstring nullable

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

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.

updated_atstring

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

Example response

{
  "address": {
    "city": "Austin",
    "country": "US",
    "line1": "4180 Burnet Rd",
    "line2": "Suite 2",
    "postal_code": "78756",
    "state": "TX"
  },
  "business_name": "Shine Time Auto Detailing, LLC",
  "business_structure": "sole_proprietorship",
  "country": "US",
  "created_at": "2026-06-01T12:00:00.000Z",
  "date_of_birth": "1990-01-01",
  "email": "marcus@shinetime.example",
  "first_name": "Marcus",
  "id": "idpf_xxxxxxxxxxxx",
  "kind": "individual",
  "last_name": "Webb",
  "phone": "+15551234567",
  "requested_information": [
    {
      "errors": [
        {
          "code": "document_not_readable",
          "reason": "The uploaded image was too blurry to read."
        }
      ],
      "id": "inrqi_xxxxxxxxxxx",
      "label": "Bank Statement or a check for account ending in 4242",
      "optional": true,
      "options": [
        "sole_proprietorship"
      ],
      "requirement": "bank_statement",
      "response_type": "yes_no",
      "selection_mode": "single",
      "supporting_documents": [
        {
          "content_type": "application/pdf",
          "created_at": "2026-01-01T12:00:00.000Z",
          "filename": "evidence.pdf",
          "id": "file_xxxxxxxxxxxxxx",
          "multipart_chunk_size": 5242880,
          "multipart_upload_id": "upload-id",
          "multipart_upload_urls": [
            {
              "part_number": 1,
              "url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
            }
          ],
          "object": "file",
          "size": 9670,
          "upload_headers": {},
          "upload_status": "pending",
          "upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf",
          "url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          "visibility": "private"
        }
      ],
      "type": "files"
    }
  ],
  "required_documents": [
    {
      "document": "id_card_front",
      "rejection_reason": "Document image was too blurry to read.",
      "status": "submitted"
    }
  ],
  "session_url": "https://sumsub.com/session/abc",
  "status": "action_required",
  "updated_at": "2026-06-02T12:00:00.000Z"
}

Changes

Changed in 13 of the 74 revisions of this API.21475

Sep 25, 2026c1dceb26e5052See the full diff
- ○
  added the new optional query request parameter user_id
  new-optional-request-parameter
- ○
  the query request parameter account_id became optional
  request-parameter-became-optional
Sep 17, 2026ef86d14ef69120See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 9, 20265fa504e786952See the full diff
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the new optional request property /
  new-optional-request-property
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 13, 202648408451a1f015See the full diff
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  the request property // became nullable
  request-property-became-nullable
- ○
  the request property // became nullable
  request-property-became-nullable
- ○
  the request property // became nullable
  request-property-became-nullable
- ○
  the request property // became nullable
  request-property-became-nullable
- ○
  the request property // became nullable
  request-property-became-nullable
- ○
  the request property // became nullable
  request-property-became-nullable
- ○
  the request property // became nullable
  request-property-became-nullable
- ○
  the request property // became nullable
  request-property-became-nullable
- ○
  the request property // became nullable
  request-property-became-nullable
- ○
  the request property // became nullable
  request-property-became-nullable
- ○
  the request property // became nullable
  request-property-became-nullable
- ○
  the request property // became nullable
  request-property-became-nullable
Aug 12, 2026ae20b30817de1See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
Aug 12, 20266fb1c04bf2554See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Aug 7, 2026f1020c3ecda424See the full diff
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 6, 2026a602de67ab25814See the full diff
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  the response property // became required for the status
  response-property-became-required
- ○
  added the required property // to the response with the status
  response-required-property-added
- ○
  added the required property // to the response with the status
  response-required-property-added
Aug 5, 20266c970f803b462See the full diff
- ▲
  the //// response's property type changed from string null to array for status
  response-property-type-changed
- ▲
  the //// response's property type changed from string null to array for status
  response-property-type-changed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 4, 2026bdd0e2c70d582See the full diff
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the new optional request property /
  new-optional-request-property
This revision also has 16 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.

Full history (13 revisions)