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

# Initiate Collateral Allocation

## Initiate Collateral Allocation

> Allocates a percentage of a collateral account's value against a credit account, optionally covering an overdraft limit.

```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":{"CollateralAllocationRate":{"type":"object","description":"Percentage of a collateral's value to allocate.","properties":{"rateValue":{"type":"number","format":"double","minimum":0,"exclusiveMinimum":true,"maximum":100,"description":"Allocation percentage. Example: `11` represents 11%."},"rateDescription":{"type":"string","description":"Free-text description of the rate."}}},"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"}}}},"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"}}}},"Conflict":{"description":"The resource already exists, or is in a terminal/incompatible state for this operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"UnprocessableEntity":{"description":"A business rule was violated (e.g. insufficient balance, currency mismatch, amount exceeds the outstanding balance).","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/allocation/initiate":{"post":{"summary":"Initiate Collateral Allocation","description":"Allocates a percentage of a collateral account's value against a credit account, optionally covering an overdraft limit.","tags":["collateral-allocation-management"],"operationId":"initiateCollateralAllocation","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["collateralAllocationManagement"],"properties":{"collateralAllocationManagement":{"type":"object","description":"Root object with the collateral allocation data.","required":["collateralAccountIdentification","creditAccountIdentification","overdraftLimitIndicator","collateralAllocationRate"],"properties":{"collateralAccountIdentification":{"type":"object","description":"Identifier of the collateral account to associate.","required":["identifierValue"],"properties":{"identifierValue":{"type":"object","required":["value"],"properties":{"value":{"type":"string","description":"Unique identifier of the collateral account."}}}}},"creditAccountIdentification":{"type":"object","description":"Identifier of the credit account that will receive the new collateral.","required":["identifierValue"],"properties":{"identifierValue":{"type":"object","required":["value"],"properties":{"value":{"type":"string","description":"Unique identifier of the credit account to which the collateral will be allocated."}}}}},"overdraftLimitIndicator":{"type":"boolean","description":"Whether the allocation covers an overdraft limit."},"collateralAllocationRate":{"allOf":[{"$ref":"#/components/schemas/CollateralAllocationRate"}],"description":"Defines the percentage of the collateral's value to allocate."}}}}}}}},"responses":{"204":{"description":"Collateral allocation initiated successfully. No content is returned."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"422":{"$ref":"#/components/responses/UnprocessableEntity"},"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-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.