> For the complete documentation index, see [llms.txt](https://docs.corppass.gov.sg/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.corppass.gov.sg/technical-specifications/corppass-authorization-api-fapi-2.0/scopes/corppass-standard-scopes.md). # Corppass Standard Scopes Corppass standard scopes provide access to identity information about the transacting user, and the entity that the user is transacting on behalf of. These scopes are **available to all Corppass applications**. ## Protocol Scopes Protocol scopes are mandatory scopes required for authentication and authorization.

Scope Description

Scope	Description
`openid`	Mandatory scope to indicate the request is an OpenID Connect flow. The scope must be included in the `scope` parameter of an authorization request.

openid

Mandatory scope to indicate the request is an OpenID Connect flow.

The scope must be included in the scope parameter of an authorization request.

## Authorization Scopes Authorization scopes provide access to authorization details about the transacting user.

Scope	Description	Data Access	Endpoint
`authinfo`	View authorization details about the transacting user.	`auth_info`	UserInfo
`tpauthinfo`	View third-party authorization details about the transacting user.	`tp_auth_info`	UserInfo

## Entity Scopes Entity scopes provide access to profile information about the entity that the user is transacting on behalf of.

Scope Description & Endpoint Data Access Endpoint

Scope	Description & Endpoint	Data Access	Endpoint
`entity.identity`	View entity identity, includes: entity type registration number country of incorporation using ISO 3166-1 alpha-2 standard Refer to ISO 3166 for possible values.	`sub_attributes: - entity_type - entity_reg_number - entity_coi`	Token
`entity.basic_profile.name`	View entity name.	`sub_attributes: - entity_name`	Token
`entity.basic_profile.uen_status`	View entity UEN status.	`sub_attributes: - entity_uen_status`	Token

entity.identity

View entity identity, includes:

entity type
registration number
country of incorporation using ISO 3166-1 alpha-2 standard
Refer to ISO 3166 for possible values.

sub_attributes:
- entity_type
- entity_reg_number
- entity_coi

Token

entity.basic_profile.name

View entity name.

sub_attributes:
- entity_name

Token

entity.basic_profile.uen_status

View entity UEN status.

sub_attributes:
- entity_uen_status

Token

## User Scopes User scopes provide access to profile information about the transacting user.

Scope Description Data Access Endpoint

Scope	Description	Data Access	Endpoint
`user.identity`	View acting user's identity, includes: account type identity number country of issuance using ISO 3166-1 alpha-2 standard Refer to ISO 3166 for possible values.	`act.sub_attributes: - account_type - identity_number - identity_coi`	Token
`user.name`	View acting user's name.	`act.sub_attributes: - name`	Token

user.identity

View acting user's identity, includes:

account type
identity number
country of issuance using ISO 3166-1 alpha-2 standard
Refer to ISO 3166 for possible values.

act.sub_attributes:
- account_type
- identity_number
- identity_coi

Token

user.name

View acting user's name.

act.sub_attributes:
- name

Token

--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.corppass.gov.sg/technical-specifications/corppass-authorization-api-fapi-2.0/scopes/corppass-standard-scopes.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.