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

EntityInfo Claim Structure

The table below provides a detailed description of each attribute in the EntityInfo object, which is a mandatory claim in all Corppass ID Tokens.

Mandatory Attributes: These attributes will always be present in the EntityInfo 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 appear if data is available and are not strictly required by the schema.

Field
Description
Data Type
Length
Mandatory

CPEntID

Unique identifier for the entity, such as UEN (Unique Entity Number).

String

10

Yes

CPEnt_Status

Status of the entity in Corppass as provided by issuance agencies. The possible values for entity status are:

  • Registered

  • De-Registered

  • Withdrawn

  • Blank (Specific for Non-UEN scenario)

String

20

Yes

CPEnt_TYPE

Type of Entity that the user belongs to. The possible values for entity type are:

  • UEN

  • NON-UEN (Includes non-UEN entities as well as ASGD/ITR entities)

  • GSTN

String

10

Yes

CPNonUEN_RegNo

Entity registration number of Non-UEN entity which is entered during Corppass Admin registration. Value will be "" if user belongs to UEN entity.

String

15

Yes

CPNonUEN_Country

Country of incorporation of Non-UEN entity which is provided during Corppass Admin registration. Value will be "" if user belongs to UEN entity.

String

2

Yes

CPNonUEN_Name

Name of Non-UEN entity which is entered during Corppass Admin registration. Value will be "" if user belongs to UEN entity.

String

100

Yes

PreviousUserInfo Claim StructureNextAccess Token Structure

Last updated 2 months ago