Entity Info

The entity_info claim provides business-related information about the entity the user is transacting on behalf of.

This claim is only returned in the Userinfo Endpoint response when

1. Myinfo Business entity scopes are requested.

2. The digital service is a Myinfo Business application.

entity_info Attributes

Attributes in entity_info are scope-driven.

Each attribute maps directly to a requested Entity Scope and will only be included in the response if that scope is present.

For the full set of attributes and their structures, refer to the OpenAPI specifications:

openapi.yaml

293KB

Open

Common Attribute Patterns

Depending on the type of data, attributes may follow one of the patterns below:

Pattern A: Metadata + Value

Used when the field contains a single value.

{
  "classification": "C",
  "source": "1",
  "lastupdated": "2019-03-26",
  "value": "2018-01-31"
}

Pattern B: Metadata + Code + Description

Used for coded values with a human-readable description.

{
  "classification": "C",
  "source": "1",
  "lastupdated": "2019-03-26",
  "code": "LC",
  "desc": "Local Company"
}

Pattern C: Metadata at Parent Level, Value in Child Fields

Used when multiple related values share the same metadata.

{
  "appointment_date": {
    "value": "2018-01-31"
  },
  "classification": "C",
  "source": "1",
  "lastupdated": "2019-03-26"
}

Pattern D: Metadata at Parent Level, Code/Desc in Child Fields

Used when child fields contain coded values.

{
 "position": {
    "code": "23",
    "desc": "Partner"
  },
  "classification": "C",
  "source": "1",
  "lastupdated": "2019-01-01"
}

Pattern E: Unavailable Data

Used when data is not available from the source.

{
  "classification": "C",
  "source": "1",
  "lastupdated": "2019-03-26",
  "unavailable": true
}

Note:

• Not all attributes follow the same structure.

• The exact structure depends on the type of data being returned.

• Developers should refer to the OpenAPI specification for the complete schema definition.

Sample Payload

entity_info.basic_profile.name attribute for the scope entity.basic_profile.name

{
  "entity_info": {
    "basic_profile": {
      "name": {
        "classification": "C",
        "lastupdated": "2018-01-31",
        "source": "1",
        "value": "ABC LL"
      }
    }
  }
}