> 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/integration-guide/4.-userinfo-endpoint/entity-info.md).

# Entity Info

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

{% hint style="info" %}
This claim is only returned in the [Userinfo Endpoint](/technical-specifications/corppass-authorization-api-fapi-2.0/integration-guide/4.-userinfo-endpoint.md) response when

1. [**Myinfo Business entity scopes**](/technical-specifications/corppass-authorization-api-fapi-2.0/scopes/myinfo-business-scopes/entity-scopes.md) are requested.
2. The digital service is a [**Myinfo Business application**](/products/myinfo-business.md).
   {% endhint %}

## `entity_info` Attributes

Attributes in `entity_info` are scope-driven.

Each attribute maps directly to a requested [Entity Scope](/technical-specifications/corppass-authorization-api-fapi-2.0/scopes/myinfo-business-scopes/entity-scopes.md) 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**:

{% file src="/files/lXMe7LqYQSE4LGboBJ16" %}

### 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.

```json
{
  "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.

```json
{
  "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.

```json
{
  "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.

```json
{
 "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.

```json
{
  "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

<details>

<summary><code>entity_info.basic_profile.name</code> attribute for the scope <code>entity.basic_profile.name</code></summary>

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

</details>


---

# 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/integration-guide/4.-userinfo-endpoint/entity-info.md?ask=<question>
```

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.