Identity profiles

Retrieve identity profile

Changed on

Retrieves the details of an existing identity profile.

Required permissions:

  • identity:read
get/identity_profiles/{id}

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/identity_profiles/{id}
  • Auth: HTTP bearer

Path parameters

idstring required
Example:idpf_xxxxxxxxxxxxx

The unique identifier of the identity profile (idpf_xxx).

Response

A successful response

business_namestring nullable required

Business entity name. Present on business profiles.

business_structurestring nullable required

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

countrystring nullable 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.

created_atstring date-time required

When the identity profile was first created.

date_of_birthstring nullable required

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

emailstring nullable required

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

first_namestring nullable required

Individual's first name.

idstring required

The tag of the identity profile (idpf_xxx).

last_namestring nullable required

Individual's last name.

payout_status'connected' | 'disabled' | 'action_required' | 'pending_verification' | 'verification_failed' | 'manual_review' | 'denied' | 'not_started' | 'blocked_by_parent' required

The granular calculated statuses reflecting payout account KYC and payout readiness.

payouts_enabledboolean 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.

phonestring nullable required

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

profile_typestring required

Whether this is an 'individual' or 'business' profile.

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

Derived verification status for an identity profile.

updated_atstring date-time required

When the identity profile was last synced from a verification.

Example response

{
  "created_at": "2023-12-01T05:00:00.401Z",
  "id": "idpf_xxxxxxxxxxxxx",
  "linked_companies": [
    {
      "id": "biz_xxxxxxxxxxxxxx",
      "title": "Pickaxe"
    }
  ],
  "updated_at": "2023-12-01T05:00:00.401Z",
  "verifications": [
    {
      "created_at": "2023-12-01T05:00:00.401Z",
      "id": "verf_xxxxxxxxxxxxx",
      "last_error_reason": "Document image was too blurry to read.",
      "session_url": "https://verify.stripe.com/session/abc123"
    }
  ]
}

Changes

  • 099fdc3be422Revision changes
    • warning

      added the new blocked_by_parent enum value to the response property for the response status

    • warning

      added the new denied enum value to the response property for the response status

    • warning

      added the new manual_review enum value to the response property for the response status

    • warning

      added the new manual_review enum value to the response property for the response status

    • warning

      added the new manual_review enum value to the // response property for the response status

  • 60bbb4a6ffbcRevision changes
    • warning

      added the new action_required enum value to the response property for the response status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status