Payout Account - Whop Docs

{
  "address": {
    "city": "<string>",
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "postal_code": "<string>",
    "state": "<string>"
  },
  "business_name": "<string>",
  "business_representative": {
    "date_of_birth": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "middle_name": "<string>"
  },
  "email": "<string>",
  "id": "poact_xxxxxxxxxxxx",
  "latest_verification": {
    "id": "verf_xxxxxxxxxxxxx",
    "last_error_code": "abandoned",
    "last_error_reason": "Document image was too blurry to read.",
    "status": "requires_input"
  },
  "phone": "<string>",
  "status": "connected"
}

address

object | null

required

The physical address associated with this payout account

Show child attributes

city

string | null

required

The city of the address.

country

string | null

required

The country of the address.

line1

string | null

required

The line 1 of the address.

line2

string | null

required

The line 2 of the address.

postal_code

string | null

required

The postal code of the address.

state

string | null

required

The state of the address.

business_name

string | null

required

The company’s legal name

business_representative

object | null

required

The business representative for this payout account

Show child attributes

date_of_birth

string | null

required

The date of birth of the business representative in ISO 8601 format (YYYY-MM-DD).

first_name

string | null

required

The first name of the business representative.

last_name

string | null

required

The last name of the business representative.

middle_name

string | null

required

The middle name of the business representative.

string | null

required

The email address of the representative

string

required

The unique identifier for the payout account.Example: poact_xxxxxxxxxxxx

latest_verification

object | null

required

The latest verification for the connected account.

Show child attributes

string

required

The numeric id of the verification record.Example: verf_xxxxxxxxxxxxx

last_error_code

VerificationErrorCodes | null

required

The most recent error code returned during verification. Null if no error has occurred.Available options: abandoned, consent_declined, country_not_supported, device_not_supported, document_expired, document_type_not_supported, document_unverified_other, email_unverified_other, email_verification_declined, id_number_insufficient_document_data, id_number_mismatch, id_number_unverified_other, phone_unverified_other, phone_verification_declined, selfie_document_missing_photo, selfie_face_mismatch, selfie_manipulated, selfie_unverified_other, under_supported_age

last_error_reason

string | null

required

A human-readable explanation of the most recent verification error. Null if no error has occurred.Example: Document image was too blurry to read.

status

VerificationStatuses

required

The current status of this verification session.Available options: requires_input, processing, verified, canceled, created, started, submitted, approved, declined, resubmission_requested, expired, abandoned, review, action_required

phone

string | null

required

The business representative’s phone

status

PayoutAccountCalculatedStatuses | null

required

The granular calculated status of the payout account reflecting its current KYC and withdrawal readiness state.Available options: connected, disabled, action_required, pending_verification, verification_failed, not_started