Corppass
  • INTRODUCTION
    • About Corppass
    • Corppass Design Guidelines
      • Brand Guidelines
      • Button Guidelines
  • Technical Specifications
    • Corppass Authorization API
      • Key concepts
        • Client JWKS
        • JWS and JWE
        • Client Assertion JWT
        • Proof Key of Code Exchange (PKCE)
      • Staging and Production URLs
      • Well-known Endpoints
        • OpenID Discovery Endpoint
        • JWKS Endpoint
      • Scopes
      • Authorization Endpoint
        • Authorization Code with Proof Key of Code Exchange (PKCE) Flow
        • Pushed Authorization Request (PAR) Flow
      • Token Endpoint
        • ID Token Structure
          • UserInfo Claim Structure
          • EntityInfo Claim Structure
        • Access Token Structure
      • Authorization Info Endpoint
        • AuthInfo Structure
        • TPAuthInfo Structure
      • Pushed Authorization Request (PAR) Endpoint
  • Corppass Developer Portal (CDP)
    • User Guide
      • Getting Started
      • Login to CDP
      • Available Digital Service Settings
        • FAQs
      • Toggle Between Staging and Production Environments
      • Portal Features
        • Updating the Digital Service and Managing Metadata
      • User Roles and Permissions
      • Frequently Asked Questions (FAQ)
        • Login Issues
        • Access and Permissions
        • How is CDP Different from Corppass Agency Admin (AA) Portal?
        • Other Common Issues
  • MORE INFORMATION
    • Is Corppass working?
    • Contact Us
Powered by GitBook
On this page
  1. Technical Specifications
  2. Corppass Authorization API
  3. Token Endpoint
  4. ID Token Structure

UserInfo Claim Structure

The table below provides descriptions of the attributes included in the UserInfo claim of the ID Token. The value of the UserInfo claim is a JSON object, and it is a mandatory attribute in all Corppass ID Tokens.

Mandatory Attributes: These attributes will always be present in the UserInfo object and will always contain a value, which could be a blank string if no data is available.

Non-Mandatory Attributes: These attributes will only be included in the UserInfo object if data is available and they are not required by the schema.

The table below provides a detailed description of each attribute in the UserInfo claim of the ID Token.

Field
Description
Data Type
Length
Mandatory

CPAccType

Corppass account type of the user. Indicates if the user is a Corppass Administrator, Sub-Administrator, User, or Enquiry User.

String

30

Yes

CPUID_FullName

Full name of the authenticated user.

String

100

Yes

ISSPHOLDER

Indicates whether the user is a Singpass holder (i.e., has activated their Corppass ID using SingPass). Possible values are YES or NO.

String

3

Yes

PreviousID Token StructureNextEntityInfo Claim Structure

Last updated 2 months ago