# Brass API Docs Documentation

> The Brass API provides endpoints that you can use to automate banking operations for your business.

## Guides
- [Documentation](https://docs.trybrass.com/docs.md): Brass API Docs documentation

## API Reference
- [Getting Started](https://docs.trybrass.com/reference/getting-started-with-your-api.md): This page will help you get started with the Brass API.
- [Profiles](https://docs.trybrass.com/reference/profiles.md): The various types of profiles that can be referenced in Brass
- [Calling the API](https://docs.trybrass.com/reference/calling-the-api.md): This page will describe how communicating with the API works
- [Authorization](https://docs.trybrass.com/reference/understanding-authorization-levels.md): This section describes why different authorization levels apply to the API endpoints
- [Requests](https://docs.trybrass.com/reference/requests.md): This section describes how to compose API requests
- [Status Codes](https://docs.trybrass.com/reference/status-codes.md): This section describes the response codes used across the API
- [Responses](https://docs.trybrass.com/reference/responses.md): This section describes the structure of our API responses
- [Pagination](https://docs.trybrass.com/reference/pagination.md): This section describes how to interact with endpoints that support pagination on the API
- [Timestamps](https://docs.trybrass.com/reference/timestamps.md): This section describes how timestamps are represented across the API
- [Resource Identifiers](https://docs.trybrass.com/reference/resource-identifiers.md): This section describes the use of resource identifiers on Brass
- [What is authentication?](https://docs.trybrass.com/reference/what-is-authentication.md)
- [Acquiring a JWT](https://docs.trybrass.com/reference/acquiring-a-jwt.md): This section describes the authentication process within Brass
- [Create a Profile (Sign Up)](https://docs.trybrass.com/reference/create-a-profile-sign-up.md)
- [Login](https://docs.trybrass.com/reference/login.md)
- [Authorise Login](https://docs.trybrass.com/reference/authorise-login.md)
- [Personal Access Tokens](https://docs.trybrass.com/reference/personal-access-tokens.md): This section introduces Personal Access Tokens
- [Introducing PATs](https://docs.trybrass.com/reference/introducing-personal-access-tokens.md)
- [List PATs](https://docs.trybrass.com/reference/list-pats.md): List all the currently active tokens for the user on a customer profile
- [Create PAT](https://docs.trybrass.com/reference/create-pat.md): Adds a new PAT for the current user profile on the customer
- [Revoke PAT](https://docs.trybrass.com/reference/create-pat-1.md): Revokes a PAT for a user profile
- [View PAT](https://docs.trybrass.com/reference/view-pat.md): Views the details of a specific PAT
- [Sessions](https://docs.trybrass.com/reference/sessions.md): This section describes how to interact with currently authorised identity
- [Active Session](https://docs.trybrass.com/reference/active-session.md)
- [Update User Profile](https://docs.trybrass.com/reference/update-user-profile.md)
- [Update Customer Profile](https://docs.trybrass.com/reference/update-customer-profile.md)
- [Update Customer Preferences](https://docs.trybrass.com/reference/manage-customer-preferences.md): This endpoint allows you configure the preferences on a customer's profile
- [Addresses](https://docs.trybrass.com/reference/addresses.md)
- [Validate Address](https://docs.trybrass.com/reference/validate-address.md): Verify that an address exists and geocodes it. This is useful when submitting addresses for creation
- [Contact Tags](https://docs.trybrass.com/reference/contact-tags.md)
- [List Contact Tags](https://docs.trybrass.com/reference/list-contact-tags.md): List the contact tag records
- [Create Contact Tag](https://docs.trybrass.com/reference/create-contact-tag.md): Create a new contact tag record
- [Delete Contact Tag](https://docs.trybrass.com/reference/delete-contact-tag.md): Permanently or soft-deletes a contact tag resource depending on whether or not it's in use
- [View Contact Tag](https://docs.trybrass.com/reference/view-contact-tag.md): View a single contact tag record
- [Update Contact Tag](https://docs.trybrass.com/reference/update-contact-tag.md): View a single contact tag record
- [Countries](https://docs.trybrass.com/reference/countries.md)
- [List Countries](https://docs.trybrass.com/reference/list-countries.md): List and optionally search the country records
- [Get Country](https://docs.trybrass.com/reference/get-country.md): View the details of a single country resource
- [Customer Types](https://docs.trybrass.com/reference/customer-types.md)
- [List Customer Types](https://docs.trybrass.com/reference/list-customer-types.md): List or optionally search the customer type records
- [Get Customer Type](https://docs.trybrass.com/reference/get-customer-type.md): View the details of a single customer type resource
- [Files Uploads & Downloads](https://docs.trybrass.com/reference/files-uploads-downloads.md): This page describes how files are handled for uploads and downloads
- [Working with presigned URLs](https://docs.trybrass.com/reference/working-with-presigned-urls.md)
- [Presigned Upload URL](https://docs.trybrass.com/reference/presigned-upload-url.md): Get a presigned URL to upload your file to storage.
- [Presigned Download URL](https://docs.trybrass.com/reference/presigned-download-url.md): Get a presigned URL to download or view a private file in the storage.
- [Industries](https://docs.trybrass.com/reference/industries.md): Endpoints for interacting with industry records
- [List Industries](https://docs.trybrass.com/reference/list-industries.md): List and optionally search the industry records
- [Get Industry](https://docs.trybrass.com/reference/get-industry.md): View the details of a single industry resource
- [Roles](https://docs.trybrass.com/reference/roles.md): Endpoints for interacting with role information for users
- [List Roles](https://docs.trybrass.com/reference/list-roles.md): List the available roles that are viewable and probably assignable by this user
- [States](https://docs.trybrass.com/reference/states.md)
- [List States](https://docs.trybrass.com/reference/list-states.md): List and optionally search the state records
- [Get State](https://docs.trybrass.com/reference/get-state.md): View the details of a single state resource
- [Tags](https://docs.trybrass.com/reference/tags.md)
- [List Tags](https://docs.trybrass.com/reference/list-tags.md): List and optionally search the tag records
- [Create Tag](https://docs.trybrass.com/reference/create-tag.md): Create a new tag record
- [Delete Tag](https://docs.trybrass.com/reference/delete-tag.md): Soft-delete a tag resource
- [View Tag](https://docs.trybrass.com/reference/view-tag.md): View a single tag record
- [Update Tag](https://docs.trybrass.com/reference/update-tag.md): View a single contact tag record
- [Bank Accounts](https://docs.trybrass.com/reference/bank-accounts.md)
- [List Bank Accounts](https://docs.trybrass.com/reference/list-bank-accounts.md): List and optionally search your bank accounts
- [View Bank Account](https://docs.trybrass.com/reference/view-bank-account.md): View the details of a single bak account
- [Update Bank Account](https://docs.trybrass.com/reference/update-bank-account.md): Set some options on a bank account
- [Request Statement](https://docs.trybrass.com/reference/request-statement.md): Request the account statement for a particular bank account over a time period
- [Balance change over time](https://docs.trybrass.com/reference/balance-change-over-time.md): Provides the change in the balances of an account over time - useful for displaying the graph for  an account
- [Cumulative balance change over time](https://docs.trybrass.com/reference/cumulative-balance-change-over-time.md): Provides the change in the balances of all accounts over time in a customer's profile
- [Sub Accounts](https://docs.trybrass.com/reference/sub-accounts.md): Endpoints for interacting with your Brass sub accounts
- [Create a SubAccount](https://docs.trybrass.com/reference/create-sub-account.md): Provision a sub account
- [List SubAccounts](https://docs.trybrass.com/reference/list-sub-accounts.md)
- [Banks](https://docs.trybrass.com/reference/banks.md)
- [List Banks](https://docs.trybrass.com/reference/list-banks.md): List and optionally search bank records
- [View Bank](https://docs.trybrass.com/reference/view-bank.md): View a single bank record
- [Resolve Name on Account](https://docs.trybrass.com/reference/resolve-name-on-account.md): Resolves the name on the bank account
- [Transactions](https://docs.trybrass.com/reference/transactions.md)
- [List Transactions](https://docs.trybrass.com/reference/list-transactions.md): List and filter the transactions across the bank accounts belonging to a customer profile
- [View Transaction](https://docs.trybrass.com/reference/list-transactions-1.md): View a single transaction record
- [Transaction Receipt](https://docs.trybrass.com/reference/view-transaction.md): Generates transaction receipt for a single transaction
- [Understanding Counterparties](https://docs.trybrass.com/reference/understanding-counterparties.md)
- [Contacts](https://docs.trybrass.com/reference/contacts.md)
- [List Contacts](https://docs.trybrass.com/reference/list-contacts.md): List and optionally search contact records
- [Add Contact](https://docs.trybrass.com/reference/add-contacts.md): Add a new contact record
- [Delete Contact](https://docs.trybrass.com/reference/delete-contact.md): Soft-deletes a single contact record
- [View Contact](https://docs.trybrass.com/reference/view-contact.md): View the details of a single contact record
- [Update Contact](https://docs.trybrass.com/reference/update-contact.md): Updates the details on a single contact record
- [Summary](https://docs.trybrass.com/reference/summary.md): View a quick view summary of the status of all outgoing payments on the customer profile
- [Payments](https://docs.trybrass.com/reference/payables.md)
- [List Payments](https://docs.trybrass.com/reference/list-payables.md): List and optionally search payment records
- [Create Payments](https://docs.trybrass.com/reference/create-payable.md): Creates a new payable
- [View Payment](https://docs.trybrass.com/reference/view-payables.md): View a single payable record
- [Delete Payment](https://docs.trybrass.com/reference/delete-payables.md): Deletes a single payable record
- [Retry Failed Payment](https://docs.trybrass.com/reference/retry-failed-payable.md): Attempts to process a failed payable for sending
- [Cancel Sending](https://docs.trybrass.com/reference/cancel-payable.md): Stops a payable from being sent while it's in the hold-off state
- [Recurring Payment Mandates](https://docs.trybrass.com/reference/recurring-payment-mandates.md)
- [Webhooks](https://docs.trybrass.com/reference/webhooks.md): This section of the documentation would help you learn how to listen to events when actions occur on your profile