> 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/collateral-allocation-management/operations/main-1.md).

# Retrieve Collateral Allocations

## Retrieve Collateral Allocations

> Returns a paginated list of a customer's collateral allocations.

```json
{"openapi":"3.0.3","info":{"title":"NEXUS Banking Services API","version":"1.0.0"},"tags":[{"name":"collateral-allocation-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":{"MonetaryAmount":{"type":"object","description":"Generic monetary amount and currency pair.","properties":{"amountValue":{"type":"number","format":"double","description":"Monetary value."},"amountCurrency":{"type":"object","properties":{"currencyCode":{"type":"string","description":"ISO 4217 currency code."}}}}},"TypedDate":{"type":"object","description":"Date paired with a type/role describing what it represents.","properties":{"dateContent":{"type":"string","format":"date","description":"The date value."},"dateType":{"type":"string","description":"Role of the date (e.g. `MaturityDate`, `RepaymentStartDate`)."}}},"PaginationLinks":{"type":"object","description":"HAL-style pagination links.","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"URL of the current page."}}},"next":{"type":"object","properties":{"href":{"type":"string","description":"URL of the next page, when available."}}}}},"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"}}}},"Forbidden":{"description":"Authenticated, but missing the scope required for this operation.","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"}}}},"BadGateway":{"description":"The core banking system is unavailable or returned an invalid response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"GatewayTimeout":{"description":"The call to the core banking system timed out.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}},"paths":{"/v1/collateral-allocation-management/collateral-allocations/{collateralAllocationCustomerReference}/retrieve":{"get":{"summary":"Retrieve Collateral Allocations","description":"Returns a paginated list of a customer's collateral allocations.","tags":["collateral-allocation-management"],"operationId":"retrieveCollateralAllocations","parameters":[{"name":"collateralAllocationCustomerReference","in":"path","required":true,"description":"Unique identifier of the customer.","schema":{"type":"string"}},{"name":"accountIdentificationValue","in":"query","required":false,"description":"Cursor pagination value — account identification of the last item on the previous page.","schema":{"type":"string"}},{"name":"accountIdentificationType","in":"query","required":false,"description":"Type of collateral account to filter by.","schema":{"type":"string","enum":["GARR","GARP"],"default":"GARR"}},{"name":"size","in":"query","required":false,"description":"Maximum number of allocations to return.","schema":{"type":"integer","default":20,"maximum":20}}],"responses":{"200":{"description":"A paginated list of collateral allocations.","content":{"application/json":{"schema":{"type":"object","properties":{"collateralAllocationManagement":{"type":"object","description":"Root object with the customer's data and allocated collateral.","properties":{"collateralAllocationCustomerReference":{"type":"string","description":"Reference of the customer in the Banka system."},"collateralAllocationPartyIdentification":{"type":"object","description":"Identification of the party (customer).","properties":{"partyName":{"type":"object","properties":{"name":{"type":"string","description":"Full name of the customer."}}}}},"collateralAllocations":{"type":"array","description":"List of allocated collateral.","items":{"type":"object","properties":{"collateralAccountIdentification":{"type":"object","properties":{"accountIdentificationType":{"type":"string","enum":["GARR","GARP"],"description":"Type of collateral account (`GARR` - Guarantees Received; `GARP` - Guarantees Given)."},"accountDescription":{"type":"string","description":"Description of the collateral account type."},"identifierValue":{"type":"object","properties":{"value":{"type":"string","description":"Collateral account number."}}}}},"collateralAllocationAmount":{"allOf":[{"$ref":"#/components/schemas/MonetaryAmount"}],"description":"Value of the collateral, up to 2 decimal places."},"collateralAllocationDueDate":{"allOf":[{"$ref":"#/components/schemas/TypedDate"}],"description":"Maturity date of the collateral."},"collateralStatus":{"type":"string","description":"Status of the collateral. `N`=Normal (GARR/GARP), `E`=Encerrada (GARR/GARP), `X`=Relevado Extrap (GARP only).","enum":["N","E","X"]}}}}}},"_links":{"allOf":[{"$ref":"#/components/schemas/PaginationLinks"}],"description":"Pagination navigation links (self, next)."}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/InternalServerError"},"502":{"$ref":"#/components/responses/BadGateway"},"504":{"$ref":"#/components/responses/GatewayTimeout"}}}}}}
```


---

# 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/collateral-allocation-management/operations/main-1.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.