> For the complete documentation index, see [llms.txt](https://selenium-4.gitbook.io/nexus-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://selenium-4.gitbook.io/nexus-docs/service-domain/party-reference-data-directory/operacoes/main-3.md).

# Retrieve Party Classification Reference Data

| Campo              | Valor                                                                                               |
| ------------------ | --------------------------------------------------------------------------------------------------- |
| **Service Domain** | Party Reference Data Management                                                                     |
| **BIAN Version**   | 14.0.0                                                                                              |
| **Operation**      | Retrieve Party Classification Reference Data                                                        |
| **Method**         | GET                                                                                                 |
| **API Name**       | Party Reference Data Management API                                                                 |
| **Versão**         | v1.0.0                                                                                              |
| **Endpoint**       | `GET /v1/party-data-management/party-directory-entry/reference-data/party-classifications/retrieve` |
| **Autenticação**   | Bearer Token (OAuth 2.0 / OIDC)                                                                     |

***

## 1. Descrição da Operação

A operação permite consultar os dados de referência relativos à classificação de partes (`PartyType`), devolvendo a lista de entradas do diretório de dados de referência para esse tipo. Cada entrada inclui o código e o nome do tipo de parte, bem como a respectiva categoria de parte (ex: Particular, Empresa).

***

## 2. Payload de Resposta (Response)

### 2.1 Exemplo

```json
{
  "PartyReferenceDataDirectoryRecord": {
    "PartyReferenceDataType": "PartyType",
    "PartyReferenceDataDirectoryEntryRecord": [
      {
        "PartyReferenceDataEntryReference": "S",
        "PartyReferenceDataEntryDetails": {
          "PartyTypeCode": "S",
          "PartyTypeName": "Entidade Simplificada",
          "PartyTypePartyCategory": {
            "PartyTypePartyCategoryCode": "P",
            "PartyTypePartyCategoryName": "Particular"
          }
        }
      },
      {
        "PartyReferenceDataEntryReference": "I",
        "PartyReferenceDataEntryDetails": {
          "PartyTypeCode": "I",
          "PartyTypeName": "Empresário em Nome Individual",
          "PartyTypePartyCategory": {
            "PartyTypePartyCategoryCode": "P",
            "PartyTypePartyCategoryName": "Particular"
          }
        }
      },
      {
        "PartyReferenceDataEntryReference": "F",
        "PartyReferenceDataEntryDetails": {
          "PartyTypeCode": "F",
          "PartyTypeName": "Empresa NÃO Residente",
          "PartyTypePartyCategory": {
            "PartyTypePartyCategoryCode": "P",
            "PartyTypePartyCategoryName": "Particular"
          }
        }
      },
      {
        "PartyReferenceDataEntryReference": "M",
        "PartyReferenceDataEntryDetails": {
          "PartyTypeCode": "M",
          "PartyTypeName": "Menor",
          "PartyTypePartyCategory": {
            "PartyTypePartyCategoryCode": "P",
            "PartyTypePartyCategoryName": "Particular"
          }
        }
      }
    ]
  }
}
```

### 2.2 Objecto Raiz

| Campo                                    | Tipo   | Descrição                                                              |
| ---------------------------------------- | ------ | ---------------------------------------------------------------------- |
| `PartyReferenceDataDirectoryRecord`      | object | Objecto raiz do registo de dados de referência.                        |
| `PartyReferenceDataType`                 | string | Tipo de dado de referência devolvido. Valor observado: `PartyType`.    |
| `PartyReferenceDataDirectoryEntryRecord` | array  | Lista de entradas do diretório de dados de referência. Ver secção 2.3. |

### 2.3 Objecto: `PartyReferenceDataDirectoryEntryRecord[]`

| Campo                              | Tipo   | Descrição                                                             |
| ---------------------------------- | ------ | --------------------------------------------------------------------- |
| `PartyReferenceDataEntryReference` | string | Código da entrada de classificação de parte (ex: `S`, `I`, `F`, `M`). |
| `PartyReferenceDataEntryDetails`   | object | Detalhes da entrada de classificação. Ver secção 2.4.                 |

### 2.4 Objecto: `PartyReferenceDataEntryDetails`

| Campo                    | Tipo   | Descrição                                                                                                                                 |
| ------------------------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `PartyTypeCode`          | string | Código do tipo de parte (ex: `S` - Entidade Simplificada, `I` - Empresário em Nome Individual, `F` - Empresa Não Residente, `M` - Menor). |
| `PartyTypeName`          | string | Nome/descrição do tipo de parte.                                                                                                          |
| `PartyTypePartyCategory` | object | Categoria da parte associada a este tipo. Ver secção 2.5.                                                                                 |

### 2.5 Objecto: `PartyTypePartyCategory`

| Campo                        | Tipo   | Descrição                                            |
| ---------------------------- | ------ | ---------------------------------------------------- |
| `PartyTypePartyCategoryCode` | string | Código da categoria de parte (ex: `P` - Particular). |
| `PartyTypePartyCategoryName` | string | Nome da categoria de parte (ex: `Particular`).       |


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://selenium-4.gitbook.io/nexus-docs/service-domain/party-reference-data-directory/operacoes/main-3.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.