Verifications

Create Verification

Changed on

Starts a hosted verification session for an account or user, or returns the active session when one already exists; any fields you send prefill it. To skip the hosted session, send documents to verify the person from files in this request, share_token to reuse a verification another Sumsub account completed, or verification_id to reuse one the signed-in user completed on Whop. For a business, documents adds company formation documents to the verification and the hosted session collects the rest. Once the account has an approved verification, every mode except verification_id is rejected — unlink it first to start a new one.

post/verifications

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/verifications
  • Auth: HTTP bearer

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

OR

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

OK

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.

registration_numberstring nullable

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; null until the business verification is approved.

session_urlstring nullable

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

status'not_started' | 'pending' | 'processing' | 'manual_review' | 'approved' | 'rejected' | 'action_required'

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",
  "registration_number": "7654321",
  "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

  • 507636677fe9Revision changes
    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

  • c1dceb26e505Revision changes
    • info

      added the new optional query request parameter user_id

    • info

      the query request parameter account_id became optional