> 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/documentation/party-reference-data-management/operations/main.md).

# Search for Party Reference

## Search for Party Reference

> Searches the party directory by a criteria type (phone number, email, tax ID or customer ID) and value.

```json
{"openapi":"3.0.3","info":{"title":"NEXUS Banking Services API","version":"1.0.0"},"tags":[{"name":"party-reference-data-management"}],"servers":[{"url":"https://sandbox.nexus.selenium.ao","description":"Sandbox"},{"url":"https://api-mock.selenium.ao","description":"Mock"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer Token (OAuth2 / OIDC or JWT) passed in the `Authorization` header."}},"schemas":{"PartyDirectoryEntryProfile":{"type":"object","description":"Registration profile of a party.","properties":{"PartyName":{"type":"object","properties":{"Name":{"type":"string","description":"Name of the party."}}},"PartyType":{"type":"string","enum":["Individual","Corporate"],"description":"Type of party."},"PartyIdentification":{"type":"array","description":"Identifications of the party.","items":{"type":"object","properties":{"PartyIdentificationType":{"type":"string","enum":["NationalID","TaxID","CustomerID"],"description":"Type of identification."},"PartyIdentificationValue":{"type":"string","description":"Value of the identification."},"PartyIdentificationStatus":{"type":"string","enum":["Active","Inactive"],"description":"Status of the identification."}}}},"PartyContactDetails":{"type":"array","description":"Contact details of the party.","items":{"type":"object","properties":{"ContactPointType":{"type":"string","enum":["PhoneNumber","Email","TaxID","CustomerID"],"description":"Type of contact point."},"PhoneNumbers":{"type":"array","items":{"type":"object","properties":{"PhoneNumberType":{"type":"string","enum":["Primary","Secondary","SecondSecondary"],"description":"Type of phone number."},"PhoneNumberValue":{"type":"string","description":"The phone number."}}}}}}},"BankIssuedIdentityReference":{"type":"object","description":"Bank-issued identity reference of the party.","properties":{"PartyIdentificationType":{"type":"string","description":"Type of the bank-issued identification."},"PartyIdentification":{"type":"object","properties":{"IdentifierValue":{"type":"object","properties":{"Value":{"type":"string","description":"Identifier value (e.g. Internet Banking username)."}}},"IdentifierIssuingAuthority":{"type":"string","description":"Issuing authority of the identifier."},"IdentifierStartDate":{"type":"object","properties":{"DateTimeContent":{"type":"object","properties":{"Text":{"type":"string","description":"ISO 8601 date."}}}}}}}}}}},"ErrorEnvelope":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Error"}}},"Error":{"type":"object","required":["status","reason","message","path"],"properties":{"status":{"type":"integer","description":"HTTP status code of the error."},"reason":{"type":"string","description":"High-level error category code."},"message":{"type":"string","description":"Human-readable description of the problem."},"path":{"type":"string","description":"HTTP method and endpoint path that originated the error."},"errordetail":{"type":"array","description":"Detailed error list. May be absent for generic errors (e.g. 500).","items":{"$ref":"#/components/schemas/ErrorDetail"}}}},"ErrorDetail":{"type":"object","properties":{"code":{"type":"string","description":"Domain-specific error code."},"reason":{"type":"string","description":"Textual identifier of the specific cause."},"message":{"type":"string","description":"Detailed message, with concrete values where applicable."}}}},"responses":{"BadRequest":{"description":"The request payload is invalid — inconsistent dates, an amount ≤ 0, an invalid currency, or missing required fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"Unauthorized":{"description":"Missing, expired or invalid Bearer Token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"NotFound":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"InternalServerError":{"description":"Unexpected internal error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}},"paths":{"/party-reference/party-reference-data-directory/search/retrieve":{"post":{"summary":"Search for Party Reference","description":"Searches the party directory by a criteria type (phone number, email, tax ID or customer ID) and value.","tags":["party-reference-data-management"],"operationId":"searchPartyReference","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PartyReferenceDataDirectoryEntryRetrievalActionRequest"],"properties":{"PartyReferenceDataDirectoryEntryRetrievalActionRequest":{"type":"object","description":"Root object of the search request.","properties":{"PartyReferenceSearchCriteria":{"type":"object","description":"Search criteria for the party.","properties":{"PartyReferenceSearchType":{"type":"string","enum":["PhoneNumber","Email","TaxID","CustomerID"],"description":"Type of search criteria."},"PartyReferenceSearchValue":{"type":"string","description":"Value to search for, matching the selected `PartyReferenceSearchType`."}}}}}}}}}},"responses":{"200":{"description":"Matching party reference.","content":{"application/json":{"schema":{"type":"object","properties":{"PartyReferenceDataDirectoryEntryInstanceReference":{"type":"string","description":"Unique identifier of the party directory entry."},"PartyReference":{"type":"string","description":"Reference identifier of the party."},"PartyDirectoryEntryProfile":{"allOf":[{"$ref":"#/components/schemas/PartyDirectoryEntryProfile"}],"description":"Registration profile of the party."}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}}}}}}
```


---

# 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/documentation/party-reference-data-management/operations/main.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.
