# Halo Partner API

Instructions for AI Agents:

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.haloinvest.ng/_mcp/server

## Docs

- [Authentication](https://docs.haloinvest.ng/authentication.md)
- [Errors and response envelope](https://docs.haloinvest.ng/errors-and-response-envelope.md)
- [Amounts](https://docs.haloinvest.ng/amounts.md)
- [Idempotency and retries](https://docs.haloinvest.ng/idempotency-and-retries.md)
- [Rate limits](https://docs.haloinvest.ng/rate-limits.md)

## API Docs

- [Test your API key](https://docs.haloinvest.ng/api-reference/getting-started/test-api-key.md): API Reference > Getting Started
- [Create account](https://docs.haloinvest.ng/api-reference/accounts/create-account.md): API Reference > Accounts
- [List accounts](https://docs.haloinvest.ng/api-reference/accounts/list-accounts.md): API Reference > Accounts
- [Get account](https://docs.haloinvest.ng/api-reference/accounts/get-account.md): API Reference > Accounts
- [Get account identity](https://docs.haloinvest.ng/api-reference/accounts/get-account-identity-info.md): API Reference > Accounts
- [Get balance](https://docs.haloinvest.ng/api-reference/accounts/get-balance.md): API Reference > Accounts
- [Upgrade account tier](https://docs.haloinvest.ng/api-reference/accounts/upgrade-account-tier.md): API Reference > Accounts
- [Close account](https://docs.haloinvest.ng/api-reference/accounts/close-account.md): API Reference > Accounts
- [Get customer details](https://docs.haloinvest.ng/api-reference/customers/get-customer-details.md): API Reference > Customers
- [Update customer BVN](https://docs.haloinvest.ng/api-reference/customers/update-customer-bvn.md): API Reference > Customers
- [Update customer details](https://docs.haloinvest.ng/api-reference/customers/update-customer-details.md): API Reference > Customers
- [Name enquiry](https://docs.haloinvest.ng/api-reference/transfers-and-debits/name-enquiry.md): API Reference > Transfers and Debits
- [Same-bank transfer](https://docs.haloinvest.ng/api-reference/transfers-and-debits/local-funds-transfer.md): API Reference > Transfers and Debits
- [Interbank transfer](https://docs.haloinvest.ng/api-reference/transfers-and-debits/interbank-transfer.md): API Reference > Transfers and Debits
- [Debit customer account](https://docs.haloinvest.ng/api-reference/transfers-and-debits/debit-user-account.md): API Reference > Transfers and Debits
- [Debit account](https://docs.haloinvest.ng/api-reference/transfers-and-debits/debit-account.md): API Reference > Transfers and Debits
- [Check transaction status](https://docs.haloinvest.ng/api-reference/transfers-and-debits/check-transaction-status.md): API Reference > Transfers and Debits
- [List pool account transactions](https://docs.haloinvest.ng/api-reference/transactions-and-statements/list-pool-transactions.md): API Reference > Transactions and Statements
- [List account transactions](https://docs.haloinvest.ng/api-reference/transactions-and-statements/list-account-transactions.md): API Reference > Transactions and Statements
- [Get account statement](https://docs.haloinvest.ng/api-reference/transactions-and-statements/get-account-statement.md): API Reference > Transactions and Statements
- [Upload KYC documents](https://docs.haloinvest.ng/api-reference/identity-and-kyc/upload-kyc-documents.md): API Reference > Identity and KYC
- [Get KYC status](https://docs.haloinvest.ng/api-reference/identity-and-kyc/get-kyc-status.md): API Reference > Identity and KYC
- [Verify BVN](https://docs.haloinvest.ng/api-reference/identity-and-kyc/verify-bvn.md): API Reference > Identity and KYC
- [Verify NIN](https://docs.haloinvest.ng/api-reference/identity-and-kyc/verify-nin.md): API Reference > Identity and KYC
- [Get NIN check status](https://docs.haloinvest.ng/api-reference/identity-and-kyc/get-nin-status.md): API Reference > Identity and KYC
- [List investment categories](https://docs.haloinvest.ng/api-reference/investments/list-investment-categories.md): API Reference > Investments
- [List investment types](https://docs.haloinvest.ng/api-reference/investments/list-investment-types.md): API Reference > Investments
- [List investment products](https://docs.haloinvest.ng/api-reference/investments/list-investment-products.md): API Reference > Investments
- [Get investment product](https://docs.haloinvest.ng/api-reference/investments/get-investment-product.md): API Reference > Investments
- [List products by type](https://docs.haloinvest.ng/api-reference/investments/list-investment-products-by-type.md): API Reference > Investments
- [List products by category](https://docs.haloinvest.ng/api-reference/investments/list-investment-products-by-category.md): API Reference > Investments
- [List banks](https://docs.haloinvest.ng/api-reference/reference-data/list-banks.md): API Reference > Reference Data
- [List banks (short form)](https://docs.haloinvest.ng/api-reference/reference-data/list-banks-short.md): API Reference > Reference Data

## OpenAPI Specification

- [OpenAPI JSON](https://docs.haloinvest.ng/openapi.json): raw OpenAPI 3.1 specification for this API, JSON format
- [OpenAPI YAML](https://docs.haloinvest.ng/openapi.yaml): raw OpenAPI 3.1 specification for this API, YAML format