Identity Profile

{
	"business_address": {
		"city": "<string>",
		"country": "<string>",
		"line1": "<string>",
		"line2": "<string>",
		"postal_code": "<string>",
		"state": "<string>"
	},
	"business_name": "<string>",
	"business_structure": "<string>",
	"country": "<string>",
	"created_at": "2023-12-01T05:00:00.401Z",
	"date_of_birth": "<string>",
	"email": "<string>",
	"first_name": "<string>",
	"id": "idpf_xxxxxxxxxxxxx",
	"last_name": "<string>",
	"linked_companies": [
		{
			"id": "biz_xxxxxxxxxxxxxx",
			"title": "Pickaxe"
		}
	],
	"payout_status": "connected",
	"payouts_enabled": true,
	"personal_address": {
		"city": "<string>",
		"country": "<string>",
		"line1": "<string>",
		"line2": "<string>",
		"postal_code": "<string>",
		"state": "<string>"
	},
	"phone": "<string>",
	"profile_type": "<string>",
	"status": "not_started",
	"updated_at": "2023-12-01T05:00:00.401Z",
	"verifications": [
		{
			"created_at": "2023-12-01T05:00:00.401Z",
			"id": "verf_xxxxxxxxxxxxx",
			"last_error_code": "abandoned",
			"last_error_reason": "Document image was too blurry to read.",
			"session_url": "https://verify.stripe.com/session/abc123",
			"status": "requires_input"
		}
	]
}

object | null

required

Registered business address reported by the identity provider. Present on business profiles.

Show child attributes

string | null

required

The city of the address.

string | null

required

The country of the address.

string | null

required

The line 1 of the address.

string | null

required

The line 2 of the address.

string | null

required

The postal code of the address.

string | null

required

The state of the address.

string | null

required

Business entity name. Present on business profiles.

string | null

required

Reported legal structure of a business profile (e.g. corp, llc). Provider-specific values; present on business profiles.

string | null

required

ISO 3166-1 alpha-2 country code reported by the identity provider, such as US or GB. For individuals this is the country of citizenship or residence; for businesses, the country of incorporation.

string<date-time>

required

When the identity profile was first created.Example: 2023-12-01T05:00:00.401Z

string | null

required

ISO date (YYYY-MM-DD) reported by the identity provider. Present on individual profiles.

string | null

required

Email address reported by the identity provider. Typically present on individual profiles.

string | null

required

Individual’s first name.

string

required

The tag of the identity profile (idpf_xxx).Example: idpf_xxxxxxxxxxxxx

string | null

required

Individual’s last name.

array<object>

required

The companies this identity profile is currently linked to. Only populated for direct Whop user sessions; always empty when authenticated via API key, app, or OAuth scope (a single identity can be linked to companies the calling platform is not entitled to see).

Show child attributes

string

required

The unique identifier for the company.Example: biz_xxxxxxxxxxxxxx

string

required

The display name of the company shown to customers.Example: Pickaxe

PayoutAccountCalculatedStatuses

required

Progress of payout-account setup for this profile, independent of holds. connected means onboarding is complete; a connected status paired with payouts_enabled: false indicates an active account restriction rather than incomplete setup.Available options: connected, disabled, action_required, pending_verification, verification_failed, manual_review, denied, not_started, blocked_by_parent

boolean

required

Whether this profile can receive payouts right now. True only when payout onboarding is complete and no payout holds are active on the linked account. Treat this as the single source of truth for payout readiness.

object | null

required

Residential address reported by the identity provider. Present on individual profiles.

Show child attributes

string | null

required

The city of the address.

string | null

required

The country of the address.

string | null

required

The line 1 of the address.

string | null

required

The line 2 of the address.

string | null

required

The postal code of the address.

string | null

required

The state of the address.

string | null

required

Phone number reported by the identity provider. Typically present on individual profiles.

string

required

Whether this is an ‘individual’ or ‘business’ profile.

IdentityProfileStatuses

required

Derived verification status across all linked verifications. Returns action_required whenever the profile has an open request for information (whether a verification, payout, or audit RFI) — i.e. the merchant must submit something before it is in good standing.Available options: not_started, pending, manual_review, approved, rejected, action_required

string<date-time>

required

When the identity profile was last synced from a verification.Example: 2023-12-01T05:00:00.401Z

array<object>

required

All verification attempts attached to this identity profile, ordered most-recent first.

Show child attributes

string<date-time>

required

When the verification record was created.Example: 2023-12-01T05:00:00.401Z

string

required

The numeric id of the verification record.Example: verf_xxxxxxxxxxxxx

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

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.

string | null

required

A URL the user can visit to complete the verification process. Null if the session does not require user interaction.Example: https://verify.stripe.com/session/abc123

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, manual_review

Introduction

Developer

Ads

CRM

AI

Identity

Bounties

Cards

Engagement

Payins

Courses

Payouts

Stats