> 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/customer-position/operations/main.md).

# Retrieve Customer Financial Position

## Retrieve Customer Financial Position

> Returns a customer's consolidated financial position, grouped into asset, liability and other portfolios, with a net worth summary per currency.

```json
{"openapi":"3.0.3","info":{"title":"NEXUS Banking Services API","version":"1.0.0"},"tags":[{"name":"customer-position"}],"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":{"Portfolio":{"type":"object","description":"Shared shape for the asset, liability and other portfolio groupings of a customer's financial position.","properties":{"ProductHoldings":{"type":"array","description":"List of products held in this portfolio.","items":{"type":"object","properties":{"ProductDescription":{"type":"string","description":"Description of the product (e.g. Deposito à Ordem, Contas de Crédito Financiamento)."},"ProductType":{"type":"string","description":"Code of the product type, e.g. `DO`, `DP`, `CRF`, `CRR`, `ORD`, `EXT`."},"Values":{"type":"array","description":"Balance of the product, per currency.","items":{"$ref":"#/components/schemas/CurrencyAmount"}}}}},"TotalValues":{"type":"array","description":"Aggregate total of this portfolio, per currency.","items":{"$ref":"#/components/schemas/CurrencyAmount"}}}},"CurrencyAmount":{"type":"object","description":"Simple currency/amount pair, used by the customer-position portfolio summaries.","properties":{"Currency":{"type":"string","description":"ISO 4217 currency code."},"Amount":{"type":"number","format":"double","description":"Negative values indicate a liability/credit balance."}}},"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":{"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":{"/v1/customer-position/{customerReference}/retrieve":{"get":{"summary":"Retrieve Customer Financial Position","description":"Returns a customer's consolidated financial position, grouped into asset, liability and other portfolios, with a net worth summary per currency.","tags":["customer-position"],"operationId":"retrieveCustomerFinancialPosition","parameters":[{"name":"customerReference","in":"path","required":true,"description":"Unique identifier of the customer.","schema":{"type":"string"}}],"responses":{"200":{"description":"Customer financial position.","content":{"application/json":{"schema":{"type":"object","properties":{"CustomerReference":{"type":"string","description":"Unique identifier of the customer."},"CustomerPositionStateType":{"type":"string","description":"Type of the customer's position."},"CustomerPositionStateRecord":{"type":"object","description":"Consolidated record of the customer's financial position.","properties":{"PositionDate":{"type":"string","format":"date-time","description":"Reference date/time at which the position was calculated."},"PositionType":{"type":"string","description":"Type of position."},"CustomerPosition":{"type":"array","description":"List of the customer's portfolios. Each element contains one of `AssetPortfolio`, `LiabilityPortfolio` or `OtherPortfolio`.","items":{"type":"object","properties":{"AssetPortfolio":{"allOf":[{"$ref":"#/components/schemas/Portfolio"}],"description":"Portfolio of the customer's asset products (e.g. Depósito à Ordem, Depósito à Prazo)."},"LiabilityPortfolio":{"allOf":[{"$ref":"#/components/schemas/Portfolio"}],"description":"Portfolio of the customer's liability/credit products (e.g. Contas de Crédito Financiamento)."},"OtherPortfolio":{"allOf":[{"$ref":"#/components/schemas/Portfolio"}],"description":"Portfolio of the customer's other products/operations (e.g. Ordens de Financiamento)."}}}},"NetWorth":{"type":"array","description":"Customer's net worth, per currency.","items":{"$ref":"#/components/schemas/CurrencyAmount"}}}}}}}}},"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/customer-position/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.