Skip to main content
GET
/
identity_profiles
/
{id}
Retrieve identity profile
curl --request GET \
  --url https://api.whop.com/api/v1/identity_profiles/{id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.whop.com/api/v1/identity_profiles/{id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.whop.com/api/v1/identity_profiles/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.whop.com/api/v1/identity_profiles/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.whop.com/api/v1/identity_profiles/{id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.whop.com/api/v1/identity_profiles/{id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/identity_profiles/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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"
    }
  ],
  "personal_address": {
    "city": "<string>",
    "country": "<string>",
    "line1": "<string>",
    "line2": "<string>",
    "postal_code": "<string>",
    "state": "<string>"
  },
  "phone": "<string>",
  "profile_type": "<string>",
  "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"
    }
  ]
}
{
"error": {
"code": "parameter_missing",
"message": "Missing required parameter: amount.",
"param": "amount",
"type": "invalid_request_error"
}
}
{
"error": {
"message": "Invalid or missing API key",
"type": "unauthorized"
}
}
{
"error": {
"message": "You do not have permission to access this resource",
"type": "forbidden"
}
}
{
"error": {
"message": "Resource not found",
"type": "not_found"
}
}
{
"error": null
}
{
"error": null
}
{
"error": {
"message": "An unexpected error occurred",
"type": "internal_server_error"
}
}

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Path Parameters

id
string
required

The unique identifier of the identity profile (idpf_xxx).

Example:

"idpf_xxxxxxxxxxxxx"

Response

A successful response

A consolidated identity or business profile synced from verification provider data.

business_address
object | null
required

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

business_name
string | null
required

Business entity name. Present on business profiles.

business_structure
string | null
required

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

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

created_at
string<date-time>
required

When the identity profile was first created.

Example:

"2023-12-01T05:00:00.401Z"

date_of_birth
string | null
required

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

email
string | null
required

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

first_name
string | null
required

Individual's first name.

id
string
required

The tag of the identity profile (idpf_xxx).

Example:

"idpf_xxxxxxxxxxxxx"

last_name
string | null
required

Individual's last name.

linked_companies
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).

personal_address
object | null
required

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

phone
string | null
required

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

profile_type
string
required

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

status
enum<string>
required

Derived verification status across all linked verifications.

Available options:
not_started,
pending,
approved,
rejected
updated_at
string<date-time>
required

When the identity profile was last synced from a verification.

Example:

"2023-12-01T05:00:00.401Z"

verifications
object[]
required

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