Skip to main content
Scope
  • OIDC: GET /userinfo
  • REST API: GET /verifications/{id}/userinfo

​
User (shape)

// TS-like structural shape (snake_case keys)
type UserShape = {
  // Profile
  name?: string
  given_name?: string
  family_name?: string
  middle_name?: string
  preferred_username?: string
  nickname?: string
  picture?: string

  // Personal details
  birthdate?: string // YYYY-MM-DD
  gender?: string
  nationality?: string // ISO-3166-1 alpha-2

  // Contacts
  email?: string
  email_verified?: boolean
  phone_number?: string // E.164
  phone_number_verified?: boolean

  // Address (OIDC Address Claim)
  address?: {
    formatted?: string
    street_address?: string
    locality?: string
    region?: string
    postal_code?: string
    country?: string
    [k: string]: unknown // provider-specific extensions
  }

  [k: string]: unknown // provider-specific extensions
}

​
Copy & Paste Types

  • TypeScript
  • Go
  • C#
  • Java
export interface User {
  // Profile
  name?: string
  given_name?: string
  family_name?: string
  middle_name?: string
  preferred_username?: string
  nickname?: string
  picture?: string

  // Personal details
  birthdate?: string // YYYY-MM-DD
  gender?: string
  nationality?: string // ISO-3166-1 alpha-2

  // Contacts
  email?: string
  email_verified?: boolean
  phone_number?: string
  phone_number_verified?: boolean

  // Address (OIDC Address Claim)
  address?: {
    formatted?: string
    street_address?: string
    locality?: string
    region?: string
    postal_code?: string
    country?: string
    [key: string]: any
  }

  [key: string]: any
}

​
Notes

  • Providers may include additional properties under user.*.