Skip to content

Profile

Profile schema combining person information with additional profile-specific fields.

```typescript
const profile: Profile = {
name: "John Smith",
displayName: "John",
first: "John",
last: "Smith",
gender: "male",
phone: "+1-555-1234",
id: "prof_123",
refId: "ext_456",
location: "New York, NY",
links: ["https://linkedin.com/in/johnsmith"],
company: "Acme Inc",
tenantId: "tenant_789"
};
## Fields
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | `string` | ✓ | |
| `photoURL` | `string \| null` | ✓ | |
| `displayName` | `string` | | Preferred display name for the person. Often a shortened or preferred version of their full name. |
| `first` | `string` | ✓ | |
| `last` | `string` | ✓ | |
| `gender` | `string \| string \| string \| string \| null` | ✓ | |
| `birthdate` | `string \| null` | ✓ | |
| `age` | `number` | | |
| `email` | `string \| null` | ✓ | |
| `phone` | `string \| null` | ✓ | |
| `id` | `string` | | Unique identifier for the profile. Optional as it may not exist for new profiles. |
| `refId` | `string \| null` | ✓ | Reference ID from an external system or integration. Can be null if not linked to external system. |
| `location` | `string \| null` | | Geographic location or city/region string. Can be null if not specified. |
| `links` | `string[]` | | Array of social media links or profile URLs. Optional, may be empty or undefined. |
| `company` | `string` | | Company or organization name. Optional. |
| `addresses` | `unknown[]` | | Array of addresses associated with this profile. Optional and loosely typed for flexibility. |
| `tenantId` | `string` | | Tenant ID for multi-tenant systems. Optional. |
### Field Examples
**id:**
```text
"prof_abc123"
"user_def456"

refId:

"ext_123456"
"stripe_cus_abc123"
null

location:

"New York, NY"
"San Francisco, CA"
null

links:

["https://linkedin.com/in/johnsmith", "https://twitter.com/johnsmith"]
[]

company:

"Acme Inc"
"Tech Corp"

addresses:

[\{ address_1: "123 Main St", city: "NYC", ... \}]

tenantId:

"tenant_abc123"
"org_def456"