> 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-2.md).

# Search for Party Reference

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

***

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

A operação permite pesquisar uma referência de parte (cliente) no diretório de dados de referência, a partir de um critério de pesquisa (`PartyReferenceSearchType`) e do respectivo valor (`PartyReferenceSearchValue`). Os tipos de pesquisa suportados incluem número de telefone, email, número de identificação fiscal (TaxID) ou identificador de cliente (CustomerID).

Como resposta, é devolvido o registo da parte correspondente, incluindo o nome, o tipo de parte (individual ou empresa), as identificações associadas, os detalhes de contacto e a referência de identidade emitida pelo banco (ex: identificador de banca por internet).

***

## 2. Payload de Pedido (Request)

### 2.1 Exemplo

```json
{
  "PartyReferenceDataDirectoryEntryRetrievalActionRequest": {
    "PartyReferenceSearchCriteria": {
      "PartyReferenceSearchType": "PhoneNumber",
      "PartyReferenceSearchValue": "+244 948088007"
    }
  }
}
```

### 2.2 Dicionário de Campos

| Campo                                                    | Tipo   | Descrição                                                                                                                          |
| -------------------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------- |
| `PartyReferenceDataDirectoryEntryRetrievalActionRequest` | object | Objecto raiz do pedido de pesquisa.                                                                                                |
| `PartyReferenceSearchCriteria`                           | object | Critério de pesquisa da parte.                                                                                                     |
| `PartyReferenceSearchType`                               | enum   | Tipo de critério de pesquisa. Valores: `PhoneNumber` \| `Email` \| `TaxID` \| `CustomerID`.                                        |
| `PartyReferenceSearchValue`                              | string | Valor de pesquisa correspondente ao `PartyReferenceSearchType` seleccionado (ex: número de telefone, email, NIF ou ID de cliente). |

***

## 3. Payload de Resposta (Response)

### 3.1 Exemplo

```json
{
  "PartyReferenceDataDirectoryEntryInstanceReference": "GBANCA0005",
  "PartyReference": "148311",
  "PartyDirectoryEntryProfile": {
    "PartyName": {
      "Name": "Antonio Gaspar"
    },
    "PartyType": "Individual",
    "PartyIdentification": [
      {
        "PartyIdentificationType": "TaxID",
        "PartyIdentificationValue": "000010040MO003",
        "PartyIdentificationStatus": "Active"
      }
    ],
    "PartyContactDetails": [
      {
        "ContactPointType": "PhoneNumber",
        "PhoneNumbers": [
          {
            "PhoneNumberType": "",
            "PhoneNumberValue": "+244 948088007"
          }
        ]
      }
    ],
    "BankIssuedIdentityReference": {
      "PartyIdentificationType": "InternetBankingID",
      "PartyIdentification": {
        "IdentifierValue": {
          "Value": "agaspar76"
        },
        "IdentifierIssuingAuthority": "Banco KEVE",
        "IdentifierStartDate": {
          "DateTimeContent": {
            "Text": "2025-08-12"
          }
        }
      }
    }
  }
}
```

### 3.2 Objecto Raiz

| Campo                                               | Tipo   | Descrição                                                           |
| --------------------------------------------------- | ------ | ------------------------------------------------------------------- |
| `PartyReferenceDataDirectoryEntryInstanceReference` | string | Identificador único da entrada do diretório de referência da parte. |
| `PartyReference`                                    | string | Referência da parte (cliente).                                      |
| `PartyDirectoryEntryProfile`                        | object | Perfil da entrada do diretório da parte. Ver secção 3.3.            |

### 3.3 Objecto: `PartyDirectoryEntryProfile`

| Campo                         | Tipo   | Descrição                                                    |
| ----------------------------- | ------ | ------------------------------------------------------------ |
| `PartyName.Name`              | string | Nome da parte.                                               |
| `PartyType`                   | enum   | Tipo de parte. Valores: `Individual` \| `Corporate`.         |
| `PartyIdentification`         | array  | Lista de identificações da parte. Ver secção 3.4.            |
| `PartyContactDetails`         | array  | Lista de detalhes de contacto da parte. Ver secção 3.5.      |
| `BankIssuedIdentityReference` | object | Referência de identidade emitida pelo banco. Ver secção 3.6. |

### 3.4 Objecto: `PartyIdentification[]`

| Campo                       | Tipo   | Descrição                                                                |
| --------------------------- | ------ | ------------------------------------------------------------------------ |
| `PartyIdentificationType`   | enum   | Tipo de identificação. Valores: `NationalID` \| `TaxID` \| `CustomerID`. |
| `PartyIdentificationValue`  | string | Valor da identificação.                                                  |
| `PartyIdentificationStatus` | enum   | Estado da identificação. Valores: `Active` \| `Inactive`.                |

### 3.5 Objecto: `PartyContactDetails[]`

| Campo                             | Tipo   | Descrição                                                                                |
| --------------------------------- | ------ | ---------------------------------------------------------------------------------------- |
| `ContactPointType`                | enum   | Tipo de ponto de contacto. Valores: `PhoneNumber` \| `Email` \| `TaxID` \| `CustomerID`. |
| `PhoneNumbers[].PhoneNumberType`  | enum   | Tipo de número de telefone. Valores: `Primary` \| `Secondary` \| `SecondSecondary`.      |
| `PhoneNumbers[].PhoneNumberValue` | string | Número de telefone.                                                                      |

### 3.6 Objecto: `BankIssuedIdentityReference`

| Campo                                                          | Tipo              | Descrição                                                           |
| -------------------------------------------------------------- | ----------------- | ------------------------------------------------------------------- |
| `PartyIdentificationType`                                      | string            | Tipo de identificação emitida pelo banco (ex: `InternetBankingID`). |
| `PartyIdentification.IdentifierValue.Value`                    | string            | Valor do identificador emitido pelo banco.                          |
| `PartyIdentification.IdentifierIssuingAuthority`               | string            | Entidade emissora do identificador (ex: nome do banco).             |
| `PartyIdentification.IdentifierStartDate.DateTimeContent.Text` | string (ISO 8601) | Data de início de validade do identificador.                        |


---

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