Sign in

a84d4905fdbb

latestOpenAPI 3.1.02026-08-143874115.7 MB
Verifications

Update Verification

Updates editable profile details or submits answers for items returned in requested_information. Once a verification is approved its profile details are locked and can no longer be edited.

patch/verifications/{verification_id}

Path parameters

verification_idstring required

Verification profile ID, prefixed idpf_.

Request body

OR

Example request

{
  "business_name": "Shine Time Auto Detailing",
  "business_structure": "sole_proprietorship",
  "business_tax_identification_number": "12-3456789",
  "country": "US",
  "date_of_birth": "2026-01-01",
  "first_name": "Marcus",
  "last_name": "Webb",
  "personal_address": {
    "city": "Austin",
    "country": "US",
    "line1": "4180 Burnet Rd",
    "line2": "Suite 2",
    "postal_code": "78756",
    "state": "TX"
  },
  "requested_information": [
    {
      "address": {
        "city": "Austin",
        "country": "US",
        "line1": "4180 Burnet Rd",
        "line2": "Suite 2",
        "postal_code": "78756",
        "state": "TX"
      },
      "documents": {
        "drivers_back": "file_xxxxxxxxxxxxxx",
        "drivers_front": "file_xxxxxxxxxxxxxx",
        "id_card_back": "file_xxxxxxxxxxxxxx",
        "id_card_front": "file_xxxxxxxxxxxxxx",
        "passport_front": "file_xxxxxxxxxxxxxx",
        "residence_permit_back": "file_xxxxxxxxxxxxxx",
        "residence_permit_front": "file_xxxxxxxxxxxxxx"
      },
      "files": [
        "file_xxxxxxxxxxxxxx"
      ],
      "id": "inrqi_xxxxxxxxxxxxxx",
      "value": "Mobile detailing only; no retail storefront.",
      "value_type": "raw"
    }
  ],
  "tax_identification_number": "123456789"
}

Response

verification updated

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.

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",
  "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",
      "type": "files"
    }
  ],
  "required_documents": [
    {
      "document": "id_card_front",
      "rejection_reason": "Document image was too blurry to read.",
      "status": "pending_upload"
    }
  ],
  "session_url": "https://sumsub.com/session/abc",
  "status": "action_required",
  "updated_at": "2026-06-02T12:00:00.000Z"
}