# FinCode Platform

## Docs

- [Login](https://docs.fincode.technology/api/auth/login.md): Authenticate users and obtain access tokens for API requests
- [Logout](https://docs.fincode.technology/api/auth/logout.md): Invalidate the current user session by revoking the refresh token and access token.
- [Refresh Token](https://docs.fincode.technology/api/auth/refresh-token.md): Obtain a new access token and refresh token using a valid refresh token.
- [API Reference](https://docs.fincode.technology/api/authentication.md): Complete API documentation for FinCode platform - Authentication, Remittance, Lending, and Investment endpoints.
- [Activate AML Rule](https://docs.fincode.technology/api/ciam/activate-aml-rule.md): Activates a specific AML rule.
- [Activate User Account](https://docs.fincode.technology/api/ciam/activate-user.md): Activates a user account by ID.
- [Add Default Charge](https://docs.fincode.technology/api/ciam/add-default-charge.md): Adds a default charge.
- [Add KYC Rule](https://docs.fincode.technology/api/ciam/add-kyc-rule.md): Adds a new KYC rule.
- [Submit KYC Documents](https://docs.fincode.technology/api/ciam/attach-documents.md): Attaches documents to a customer profile.
- [Awaiting Compliance Requirements](https://docs.fincode.technology/api/ciam/awaiting-compliance-requirements.md): Checks for any outstanding Know Your Customer (KYC) or regulatory documents required from the authenticated user.
- [Awaiting Payments](https://docs.fincode.technology/api/ciam/awaiting-payments.md): Updates awaiting payments.
- [Change Password](https://docs.fincode.technology/api/ciam/change-password.md): Changes the user password.
- [Start/Continue Verification](https://docs.fincode.technology/api/ciam/continue-enrolment.md): Checks or triggers the next stage of external compliance screening for a customer, typically after a Customer Risk Assessment (CRA) form submission.
- [List Attached Dynamic Forms](https://docs.fincode.technology/api/ciam/cra-forms.md): Retrieves a list of required compliance forms or documents currently attached to the authenticated user's profile.
- [Create Connector Instance](https://docs.fincode.technology/api/ciam/create-connector-instance.md): Creates a connector instance.
- [Create Customer](https://docs.fincode.technology/api/ciam/create-customer.md): Register a new customer account in the FinCode platform
- [Create Transaction PIN](https://docs.fincode.technology/api/ciam/create-transaction-pin.md): Creates a transaction PIN for the user.
- [Create User PIN](https://docs.fincode.technology/api/ciam/create-user-pin.md): Creates a login PIN for the user.
- [Get Customer By ID](https://docs.fincode.technology/api/ciam/customer-by-id.md): Get customer profile by ID
- [Deactivate AML Rule](https://docs.fincode.technology/api/ciam/deactivate-aml-rule.md): Deactivates a specific AML rule.
- [Deactivate User Account](https://docs.fincode.technology/api/ciam/deactivate-user.md): Deactivates a user account by ID.
- [Delete API Connector Instance](https://docs.fincode.technology/api/ciam/delete-api-connector-instance.md): Deletes a connector instance.
- [Delete Customer Bank Details](https://docs.fincode.technology/api/ciam/delete-customer-bank-details.md): Deletes bank details for a customer.
- [Documents Required For Transaction](https://docs.fincode.technology/api/ciam/documents-required-for-transaction.md): Checks required documents for a transaction.
- [Get Dynamic Fields](https://docs.fincode.technology/api/ciam/dynamic-fields.md): Retrieves a set of dynamic input fields required for a specific process (e.g., creating a transaction).
- [Dynamic Fields Group](https://docs.fincode.technology/api/ciam/dynamic-fields-group.md): Retrieves dynamic fields for a group.
- [Edit Employee](https://docs.fincode.technology/api/ciam/edit-employee.md): Updates employee details.
- [Edit KYC Rule](https://docs.fincode.technology/api/ciam/edit-kyc-rule.md): Updates an existing KYC rule.
- [Edit Customer Profile](https://docs.fincode.technology/api/ciam/edit-profile.md): Updates the user profile.
- [Fetch Organisation Preference](https://docs.fincode.technology/api/ciam/fetch-organisaction-preference.md): Fetches organisation preferences.
- [Find Customer By Search](https://docs.fincode.technology/api/ciam/find-customer-by-name-or-phone-no.md): Finds a customer by name or phone number.
- [Generate and Send OTP to Email](https://docs.fincode.technology/api/ciam/generate-and-send-otp-toemail.md): Generates and sends an OTP to the specified email.
- [KYC Detail By ID](https://docs.fincode.technology/api/ciam/kyc-detail-by-id.md): Retrieves KYC details by ID.
- [KYC Requirements by Country](https://docs.fincode.technology/api/ciam/kyc-requirements-by-isocountry.md): Retrieves KYC requirements for a specific country.
- [List AML Rules](https://docs.fincode.technology/api/ciam/list-aml-rules.md): Lists AML rules.
- [List Connectors](https://docs.fincode.technology/api/ciam/list-connectors.md): Lists connectors.
- [List Customers](https://docs.fincode.technology/api/ciam/list-customers.md): Lists customers.
- [List Employees](https://docs.fincode.technology/api/ciam/list-employees.md): Lists employees.
- [List Pay Centers by Type](https://docs.fincode.technology/api/ciam/list-paycenters-by-type.md): Lists pay centers for a specific type.
- [List Allocated Payout Points](https://docs.fincode.technology/api/ciam/listallocatedpayoutpoints.md): Lists allocated payout points.
- [List Payment Collectors by Address](https://docs.fincode.technology/api/ciam/listpaymentcollectorsbyaddress.md): Lists payment collectors for an address.
- [List Payout Points](https://docs.fincode.technology/api/ciam/listpayoutpoints.md): Lists payout points.
- [List Pay Points](https://docs.fincode.technology/api/ciam/listpaypoints.md): Lists pay points.
- [Get Pay Centre By ID](https://docs.fincode.technology/api/ciam/pay-centre-by-id.md): Retrieves pay centre details by ID.
- [Payout Center Branches](https://docs.fincode.technology/api/ciam/payoutCenter-branches.md): Lists payout center branches.
- [Product Payment Details](https://docs.fincode.technology/api/ciam/product-payment-details.md): Retrieves product payment details.
- [Customer Profile](https://docs.fincode.technology/api/ciam/profile.md): Retrieves the detailed profile information for the authenticated user.
- [Reset Password](https://docs.fincode.technology/api/ciam/reset-password.md): Resets the user password.
- [Submit CRA Form](https://docs.fincode.technology/api/ciam/submit-cra.md): Submits the data collected from a dynamic form, such as a Customer Risk Assessment (CRA), for processing and compliance evaluation.
- [Update AML Rules](https://docs.fincode.technology/api/ciam/update-aml-rules.md): Updates AML rules.
- [Update Connector Instance](https://docs.fincode.technology/api/ciam/update-connector-instance.md): Updates a connector instance.
- [Update Organisation Preference](https://docs.fincode.technology/api/ciam/update-organisaction-preference.md): Updates organisation preferences.
- [Upload Profile Picture](https://docs.fincode.technology/api/ciam/upload-profile-picture.md): Uploads a profile picture.
- [Verify Customer](https://docs.fincode.technology/api/ciam/verify-customer.md): Verifies a customer by ID.
- [Verify Login OTP](https://docs.fincode.technology/api/ciam/verify-login-otp.md): Verifies the login OTP.
- [View Password Policy](https://docs.fincode.technology/api/ciam/view-password-policy.md): Views the password policy.
- [Awaiting Payment Actions](https://docs.fincode.technology/api/deposit-engine/awaiting-payment-actions.md): Perform actions on an awaiting payment record such as marking it as 'paid' or 'cancel'. Returns the updated list of awaiting payments based on filters.
- [List Awaiting Payments](https://docs.fincode.technology/api/deposit-engine/awaiting-payments.md): Retrieve all pending/awaiting payment records for a customer based on filters such as date range, currency, and reference search.
- [Bank Pay Later (Wallet)](https://docs.fincode.technology/api/deposit-engine/bank-iwillpaylater.md): Notify the system that a customer will pay later via bank transfer. Creates an awaiting payment entry for the given PCN and payable type.
- [Make Payment from Wallet](https://docs.fincode.technology/api/deposit-engine/make-payment-from-wallet.md): Process payment for any payable item using customer wallet balance.
- [Notify Bank Transfer Payment](https://docs.fincode.technology/api/deposit-engine/notify-bank-transfer-payment.md): Notify the system that a customer has made a bank transfer payment, alerting Admin to verify or take appropriate action.
- [Payment Methods Charges](https://docs.fincode.technology/api/deposit-engine/payment-methods-charges.md): Retrieve applicable charges for a selected payment method based on transaction or transfer details.
- [Process Card Payment](https://docs.fincode.technology/api/deposit-engine/process-card-payment.md): Process a card payment by providing card details, transaction amount, and request type. Returns the payment gateway response.
- [Fund Customer Wallet by Payment Token](https://docs.fincode.technology/api/deposit-engine/process-payment-with-token.md): Verify a payment token and process a payment request. If a token is provided, the payment gateway is used; otherwise, the wallet is used.
- [Supported Payment Methods](https://docs.fincode.technology/api/deposit-engine/supported-payment-methods.md): Retrieve available payment methods with charges, fees, and metadata for a specific transaction or payment amount.
- [Create Investment Application](https://docs.fincode.technology/api/investment/create-investment-application.md): Creates a new investment application for a customer.
- [Fund Wallet](https://docs.fincode.technology/api/investment/fund-wallet.md): Adds funds to a user wallet account.
- [Get Investment Quote](https://docs.fincode.technology/api/investment/get-quote.md): Retrieves a quote for purchasing a specific number of units of an investment product.
- [Get Total Investments](https://docs.fincode.technology/api/investment/get-total-investments.md): Retrieves dashboard information including total investments and interest accrued for a user.
- [List Customer Portfolios](https://docs.fincode.technology/api/investment/list-portfolios.md): Retrieves a paginated list of all investment portfolios for a customer.
- [Account Balance](https://docs.fincode.technology/api/ledger/account-balance.md): Retrieves the current balance and account details for a specific account.
- [Change Account Permission](https://docs.fincode.technology/api/ledger/change-account-permission.md): Changes the permission level for a specific account.
- [Ledger History](https://docs.fincode.technology/api/ledger/ledger-history.md): Retrieves paginated transaction history for a specific account.
- [Ledger History by Idempotency Key](https://docs.fincode.technology/api/ledger/ledger-history-idempotency-key.md): Retrieves ledger entries matching a specific idempotency key.
- [Ledger History by ID](https://docs.fincode.technology/api/ledger/ledger-history-interaction-id.md): Retrieves ledger entries matching a specific interaction ID (external correlation ID).
- [List Accounts](https://docs.fincode.technology/api/ledger/list-accounts.md): Retrieves a list of all accounts owned by a specific account owner (customer).
- [Post to Account](https://docs.fincode.technology/api/ledger/post-account.md): Executes a double-entry transaction by debiting and crediting accounts.
- [Accept Loan Offer](https://docs.fincode.technology/api/lending/accept-loan-offer.md): Accepts the loan offer.
- [Accept Loan Terms](https://docs.fincode.technology/api/lending/accept-loan-terms.md): Allows customers to accept loan terms and conditions, which triggers automatic loan disbursement.
- [Add Bank Account](https://docs.fincode.technology/api/lending/add-bank-account.md): Allows customers to add a bank account to their profile for loan disbursements and repayments.
- [Calculate APR](https://docs.fincode.technology/api/lending/calculate-apr.md): Calculates the Annual Percentage Rate (APR) for a loan application based on the loan amount, interest rate, and fees.
- [Get Application](https://docs.fincode.technology/api/lending/get-application.md): Retrieves detailed information about a specific loan application by its ID.
- [Available Banks](https://docs.fincode.technology/api/lending/get-available-banks.md): Retrieves a list of all available banks that customers can use for transfers and account registration.
- [Loan History](https://docs.fincode.technology/api/lending/get-loan-history.md): Retrieves a paginated history of all loans for a customer, including active, completed, and cancelled loans.
- [Get Loan Offer](https://docs.fincode.technology/api/lending/get-loan-offer.md): Retrieves the current loan offer for the customer.
- [Get Loan Terms](https://docs.fincode.technology/api/lending/get-loan-terms.md): Retrieves the loan terms and conditions for a specific organization.
- [Customers Total Loan](https://docs.fincode.technology/api/lending/get-total-loan.md): Retrieves dashboard summary information including total borrowed amounts for a user.
- [List Bank Accounts](https://docs.fincode.technology/api/lending/list-customer-bank-accounts.md): Retrieves a list of saved bank accounts for the customer.
- [List Customer Repayments](https://docs.fincode.technology/api/lending/list-customer-repayments.md): Retrieves a list of all repayments for a specific customer across all their loans.
- [List Loan Products](https://docs.fincode.technology/api/lending/list-products.md): Retrieves a list of all activated loan products available to customers.
- [List Repayments](https://docs.fincode.technology/api/lending/list-repayments.md): Retrieves a paginated list of all repayments for a loan or across all loans.
- [Loan Application Details](https://docs.fincode.technology/api/lending/loan-application-details.md): Retrieves comprehensive details of a loan application including full application information and loan product name.
- [Loan Details with Payment History](https://docs.fincode.technology/api/lending/loan-details-with-payment-history.md): Retrieves comprehensive loan application details including payment history and installment schedule.
- [Eligibility Questions](https://docs.fincode.technology/api/lending/loan-eligibility-questions.md): Retrieves the eligibility questions required for a specific loan product.
- [Request Loan](https://docs.fincode.technology/api/lending/loan-request.md): Creates a new loan application request from a customer or agent.
- [Manage Loans](https://docs.fincode.technology/api/lending/manage-loans.md): Retrieves active loans that are due for repayment.
- [Payoff Loan](https://docs.fincode.technology/api/lending/payoff-loan.md): Allows customers to pay off their entire loan balance in a single transaction.
- [Pending Repayments](https://docs.fincode.technology/api/lending/pending-repayments.md): Retrieves a paginated list of pending repayments for a user across all their loans.
- [Reject Loan Offer](https://docs.fincode.technology/api/lending/reject-loan-offer.md): Rejects the loan offer.
- [Repaid Transactions](https://docs.fincode.technology/api/lending/repaid-transactions.md): Retrieves a list of all repaid transactions for a user.
- [Repay Loan](https://docs.fincode.technology/api/lending/repay-loan.md): Allows customers to make a partial repayment for their loan.
- [Repayment Instructions](https://docs.fincode.technology/api/lending/repayment-instructions.md): Retrieves detailed repayment instructions for a loan, including payment methods and account details.
- [Transfer Funds to Bank](https://docs.fincode.technology/api/lending/transfer-funds.md): Allows customers to transfer funds from their loan wallet to a bank account.
- [Transfer History](https://docs.fincode.technology/api/lending/transfer-history.md): Retrieves the history of transfers (withdrawals) made by the customer.
- [Transfer Status](https://docs.fincode.technology/api/lending/transfer-status.md): Checks the settlement status of a fund transfer transaction.
- [Update Loan Offer](https://docs.fincode.technology/api/lending/update-application.md): Allows customers to accept or withdraw from a loan offer that has been sent to them.
- [Verify Bank Account](https://docs.fincode.technology/api/lending/verify-bank-account.md): Verifies a bank account number against a bank code.
- [View Bank Account](https://docs.fincode.technology/api/lending/view-bank-account.md): Retrieves details of a specific bank account by its ID.
- [Active Countries](https://docs.fincode.technology/api/security/active-countries.md): Retrieves the systems's saved country list.
- [Fetch Preference](https://docs.fincode.technology/api/security/fetch-preference.md): Retrieves the current system and configuration preferences for the authenticated organisation/tenant.
- [List Countries](https://docs.fincode.technology/api/security/list-countries.md): Retrieves the systems's saved country list.
- [Password Policy](https://docs.fincode.technology/api/security/password-policy.md): Retrieves the organization's current password complexity and validity rules.
- [Bank Account Validation](https://docs.fincode.technology/api/songhai-exchange/bank-account-validation.md): Validate bank account number.
- [Change Password](https://docs.fincode.technology/api/songhai-exchange/change-password.md): Change user password.
- [Create Transaction](https://docs.fincode.technology/api/songhai-exchange/create-transaction.md): Create a bank transfer transaction.
- [Domiciliary Account (Account Number)](https://docs.fincode.technology/api/songhai-exchange/domiciliary-account-with-account-number.md): Automatically create a domiciliary account using an existing Naira account number. Only supported in Nigeria.
- [Domiciliary Account (BVN)](https://docs.fincode.technology/api/songhai-exchange/domiciliary-account-with-bvn.md): Automatically create a domiciliary account using Bank Verification Number (BVN). Only supported in Nigeria.
- [Client End-of-Day Report](https://docs.fincode.technology/api/songhai-exchange/end-of-day-report.md): Get client end of day report.
- [Exchange Rate](https://docs.fincode.technology/api/songhai-exchange/exchange-rate.md): Get exchange rate quote.
- [Generate Token](https://docs.fincode.technology/api/songhai-exchange/generate-token.md): Authenticate and generate an access token for API requests.
- [Mobile Money Creation](https://docs.fincode.technology/api/songhai-exchange/mobile-money-creation.md): Create a mobile money transaction to send funds to a beneficiary's mobile wallet. Only supported in Ghana.
- [Mobile Money Validation](https://docs.fincode.technology/api/songhai-exchange/mobile-money-validation.md): Validate mobile money wallet number and retrieve wallet details.
- [Check Transaction Status](https://docs.fincode.technology/api/songhai-exchange/transaction-status.md): Check the status of a transaction.
- [Generating Wallet Account Statement](https://docs.fincode.technology/api/songhai-exchange/wallet-account-statement.md): Generate wallet account statement.
- [Add Bank Details](https://docs.fincode.technology/api/transactions/add-bank-details.md): Links a validated bank account to a beneficiary profile.
- [Beneficiary Details](https://docs.fincode.technology/api/transactions/beneficiary-details.md): Retrieves the full profile and banking details for a specific saved beneficiary.
- [Find All Beneficiary](https://docs.fincode.technology/api/transactions/beneficiary-list.md): Retrieves a list of all saved beneficiaries associated with the authenticated customer or managed by the agent.
- [Get Transaction Quote](https://docs.fincode.technology/api/transactions/call-quote.md): Calculates the real-time exchange rate, fees, and total cost for an intended transaction.
- [Create Beneficiary](https://docs.fincode.technology/api/transactions/create-beneficiary.md): Creates a new beneficiary profile.
- [Create Transaction](https://docs.fincode.technology/api/transactions/create-transaction.md): Initiate a new remittance transaction using existing customer profiles.
- [Create Transaction (Direct)](https://docs.fincode.technology/api/transactions/create-transaction-direct.md): Initiate a new remittance transaction providing full sender and recipient KYC details inline.
- [Delivery Currencies](https://docs.fincode.technology/api/transactions/delivery-currencies.md): Retrieves the list of currencies available for the recipient to receive, given the sender's payment currency.
- [Destination Countries](https://docs.fincode.technology/api/transactions/destination-countries.md): Retrieves a list of valid destination countries for a given sending country and payout method, used for defining remittance corridors.
- [Customer Transaction History](https://docs.fincode.technology/api/transactions/history-data.md): Retrieves a paginated and filtered list of transactions for the authenticated customer or a customer managed by the agent/manager.
- [List Mobile Operators](https://docs.fincode.technology/api/transactions/list-mobile-operators.md): Retrieves the list of supported mobile money operators for a country.
- [List Supported Banks](https://docs.fincode.technology/api/transactions/list-supported-banks.md): Retrieves the list of supported banks for a specific country.
- [Payment Methods](https://docs.fincode.technology/api/transactions/payment-methods.md): Retrieves available payment methods for a specific transaction context.
- [Required Bank Fields](https://docs.fincode.technology/api/transactions/required-bank-fields.md): Retrieves the specific bank fields required for a destination country.
- [Supported Currencies](https://docs.fincode.technology/api/transactions/supported-currencies.md): Retrieves the list of supported currencies for a specific remittance corridor and delivery method.
- [Transaction Types](https://docs.fincode.technology/api/transactions/transaction-types.md): Retrieves a list of all supported transaction types available on the platform for the current organization.
- [Validate Recipient Account](https://docs.fincode.technology/api/transactions/validate-account.md): Validates bank account details before beneficiary creation.
- [Wallet Account List](https://docs.fincode.technology/api/transactions/wallet-account.md): Retrieves a list of all wallet accounts associated with the authenticated user.
- [Webhook Security](https://docs.fincode.technology/api/webhook-security.md): Securing your webhook endpoint and handling encrypted payloads.
- [Webhooks](https://docs.fincode.technology/api/webhooks.md): Receive real-time notifications when transaction statuses change.
- [Authentication](https://docs.fincode.technology/authentication.md): Secure authentication and role-based access control for the FinCode platform.
- [Overview](https://docs.fincode.technology/ciam/overview.md)
- [Bank Transfers](https://docs.fincode.technology/deposit-engine/bank-transfers.md)
- [Card Payments](https://docs.fincode.technology/deposit-engine/card-payments.md)
- [Overview](https://docs.fincode.technology/deposit-engine/overview.md)
- [Payment Lifecycle](https://docs.fincode.technology/deposit-engine/payment-lifecycle.md)
- [Process Flow](https://docs.fincode.technology/deposit-engine/process-flows.md)
- [Wallet Payments](https://docs.fincode.technology/deposit-engine/wallet-payments.md)
- [Welcome to FinCode](https://docs.fincode.technology/index.md): Enterprise-grade multitenant platform for remittance, digital lending, investment services, and crossboarder transaction switching.
- [Encryption Keys & API Tokens](https://docs.fincode.technology/integration/encryption-keys-and-tokens.md): Secure your integration with payload encryption and long-lived API tokens.
- [Go Live](https://docs.fincode.technology/integration/go-live.md)
- [Payload Encryption Guide](https://docs.fincode.technology/integration/payload-encryption-guide.md)
- [Payment Methods](https://docs.fincode.technology/integration/payment-methods.md)
- [Testing](https://docs.fincode.technology/integration/testing.md)
- [Account Opening](https://docs.fincode.technology/investment/account-opening.md)
- [Overview](https://docs.fincode.technology/investment/overview.md)
- [Portfolio management](https://docs.fincode.technology/investment/portfolio-management.md)
- [Process Flow](https://docs.fincode.technology/investment/process-flow.md)
- [Trading Flow](https://docs.fincode.technology/investment/trading-flow.md)
- [Withdrawal Process](https://docs.fincode.technology/investment/withdrawal-process.md)
- [Balance Management](https://docs.fincode.technology/ledger/balance-management.md)
- [Double-Entry Posting](https://docs.fincode.technology/ledger/double-entry-posting.md)
- [Overview](https://docs.fincode.technology/ledger/overview.md)
- [Process Flow](https://docs.fincode.technology/ledger/process-flow.md)
- [Transaction History & Audit](https://docs.fincode.technology/ledger/transaction-history.md)
- [Disbursement & Withdrawal](https://docs.fincode.technology/lending/disbursement.md)
- [Loan Lifecycle](https://docs.fincode.technology/lending/loan-lifecycle.md)
- [Overview](https://docs.fincode.technology/lending/overview.md)
- [Process Flow](https://docs.fincode.technology/lending/process-flow.md)
- [Repayment Flow](https://docs.fincode.technology/lending/repayment-flow.md)
- [Underwriting](https://docs.fincode.technology/lending/underwriting.md)
- [System Architecture](https://docs.fincode.technology/overview/architecture.md)
- [Multitenancy](https://docs.fincode.technology/overview/multitenancy.md)
- [Security](https://docs.fincode.technology/overview/security.md)
- [Quick Start Guide](https://docs.fincode.technology/quickstart.md): Get your integration up and running in under 15 minutes.
- [Beneficiary Lifecycle](https://docs.fincode.technology/remittance/beneficiary-lifecycle.md)
- [FX Conversion](https://docs.fincode.technology/remittance/fx-rates.md): Understanding exchange rates, and how currency conversion works in remittance.
- [Overview](https://docs.fincode.technology/remittance/overview.md)
- [Process Flow](https://docs.fincode.technology/remittance/process-flows.md)
- [Transaction Lifecycle](https://docs.fincode.technology/remittance/transactions.md): Understand transaction states, transitions, and what triggers each status change.
- [Overview](https://docs.fincode.technology/songhai-exchange/overview.md)

## OpenAPI Specs

- [openapi](https://docs.fincode.technology/openapi.json)