Third-party Auth Info

The tp_auth_info claim provides third-party authorization details for the authenticated user.

This claim is only returned in the Userinfo Endpoint response if

1. tpauthinfo scope is present

2. The digital service that the user is logging in to supports third-party functionality on Corppass.

3. The user has third-party authorisations for the digital service.

Note: A user may have multiple third-party authorizations for a given Digital Service.

Example: For the GST Digital Service, a user from a third-party firm is authorized to file GST on behalf of 5 client entities. In this case, all 5 third-party authorizations will be returned in the tp_auth_info claim.

tp_auth_info Attributes

Field	Data Type	Length	Description
Result_Set	JSON	-	Digital Service authorization result set.

tp_auth_info.Result_Set attributes

Field	Data Type	Length	Description
ESrvc_Row_Count	Integer	10	The number of Digital Services for which the authorizations are present in the Result_Set.ESrvc_Result JSON object. For third-party authorisations, this value will always be set to 1.
ESrvc_Result	Array of JSON	-	Array of JSON objects, each containing third-party authorization details for the Digital Service. For third-party authorisations, there will only be a single JSON object. Refer to E-Service item attributes for more details.

E-Service item attributes (tp_auth_info.Result_Set.ESrvc_Result[] item)

Contains authorization details for the digital service.

Field	Data Type	Length	Description
CPESrvcID	String	25	The readable ID of the Digital Service.
Auth_Set	JSON	-	JSON object. Contains third-party assignment details for the Digital Service. Refer to Third-Party Assignment Result Set attributes for more details.

Third-Party Assignment Result Set attributes (tp_auth_info.Result_Set.ESrvc_Result[].Auth_Set)

Field	Data Type	Length	Description
ENT_ROW_COUNT	Integer	10	Indicates the number of rows in the third-party assignment. This is equal to the number of client entities that the user is authorized as third party for that Digital Service.
TP_Auth	Array of JSON	-	Array of JSON objects, each JSON object represents an third-party authorization of the user for the client entity. Refer to Third-Party Assignment Item attributes for more details.

Third-Party Assignment Item attributes (tp_auth_info.Result_Set.ESrvc_Result[].Auth_Set.TP_Auth[] item)

Field	Data Type	Length	Description
CP_Clnt_ID	String	10	Client entity ID (eg. UEN).
CP_ClntEnt_TYPE	String	10	Client entity type. The possible values for entity type are: UEN NON-UEN (Includes non-UEN entities as well as ASGD/ITR entities) GSTN
Auth_Result_Set	Array of JSON	-	JSON object. Contains third-party user assignment details for the client entity. Refer to User Assignment Result Set attributes for more details.

User Assignment Result Set attributes (tp_auth_info.Result_Set.ESrvc_Result[].Auth_Set.TP_Auth[].Auth_Result_Set)

Field	Data Type	Length	Description
Row_Count	Integer	10	The count of the number of rows included in the result set (ie. number of third-party assignments the user has for the given client entity). E.g. If the user is granted two separate third-party assignments to the same e-service on behalf of the same entity, this value will be 2 . The following result set will contain then contain two objects, each representing one assignment.
Row	Array of JSON	-	Array of JSON objects, where each JSON object describes a single third-party assignment. Refer to User Assignment Item attributes for more details.

User Assignment Item attributes (tp_auth_info.Result_Set.ESrvc_Result[].Auth_Set.TP_Auth[].Auth_Result_Set.Row[] item)

Field	Data Type	Length	Description
CPEntID_SUB	String	32	Sub-UEN value of that entity to which the user is assigned the authorization. If the Digital Service requires a mandatory Sub-UEN attribute but no value was supplied, "ERROR_MISSING_VALUE" will be returned for the field.
CPRole	String	20	The role assigned to the user in this particular authorisation.
StartDate	String (format YYYY-MM-DD)	10	The start date for validity of the authorisation.
EndDate	String (format YYYY-MM-DD)	10	The end date for validity of the authorisation.
Parameter	Array of JSON	-	This is an optional array of parameters (JSON objects containing only name and value pair attributes) defined by Digital Service administrator. These parameters will be populated as required. These parameters use a name-value pair format. If no parameters are defined this will be returned as empty array. If a parameter is defined as mandatory by the Digital Service administrator but no value was supplied, "ERROR_MISSING_VALUE" will be returned for the field. Refer to User Assignment Parameter attributes for more details.

User Assignment Parameter attributes (tp_auth_info.Result_Set.ESrvc_Result[].Auth_Set.TP_Auth[].Auth_Result_Set.Row[].Parameter)

Field	Data Type	Length	Description
name	String	30	Parameter name defined by defined by Digital Service administrator
value	String	66	Parameter value defined by defined by Digital Service administrator

Sample Payload

User with two third-party authorisations

Third-Party authorization info payload for a User with two third-party authorisations for the e-service SAMPLE-ESERVICE:

• One acting on behalf of entity T00YY8888X

• One acting on behalf of entity T99BB0000A

{
  "tp_auth_info": {
    "Result_Set": {
      "ESrvc_Row_Count": 1,
      "ESrvc_Result": [
        {
          "CPESrvcID": "SAMPLE-ESERVICE",
          "Auth_Set": {
            "ENT_ROW_COUNT": 2,
            "TP_Auth": [
              {
                "CP_Clnt_ID": "T00YY8888X",
                "CP_ClntEnt_TYPE": "UEN",
                "Auth_Result_Set": {
                  "Row_Count": 1,
                  "Row": [
                    {
                      "CP_ClntEnt_SUB": "",
                      "CPRole": "Maker",
                      "StartDate": "2025-09-05",
                      "EndDate": "9999-12-31",
                      "Parameter": []
                    }
                  ]
                }
              },
              {
                "CP_Clnt_ID": "T99BB0000A",
                "CP_ClntEnt_TYPE": "UEN",
                "Auth_Result_Set": {
                  "Row_Count": 1,
                  "Row": [
                    {
                      "CP_ClntEnt_SUB": "",
                      "CPRole": "Checker",
                      "StartDate": "2025-09-05",
                      "EndDate": "9999-12-31",
                      "Parameter": []
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  },
}