# Basiq API Documentation > Documentation for Basiq API This file lists one part of the documentation. The full index is at https://api.basiq.io/llms.txt. ## API: BASIQ API - [Introduction to Basiq](https://api.basiq.io/reference/introduction.md) - [Developer Hub](https://api.basiq.io/reference/developer-hub.md): Basiq simplifies finance with an Open Finance API platform that empowers businesses to create innovative financial solutions and connect consumers with their financial data. - [Testing](https://api.basiq.io/reference/testing.md) ## API: Connect - Authentication - [Generate an auth token](https://api.basiq.io/reference/posttoken.md): Use this endpoint to retrieve a token that will be passed as authorization header for Basiq API - Users - [Create a user](https://api.basiq.io/reference/createuser.md): Creates a new Basiq user object - [Retrieve a user](https://api.basiq.io/reference/getuser.md): Retrieves the details of an existing user. You need only supply the unique user identifier that was returned upon user creation. - [Update a user](https://api.basiq.io/reference/updateuser.md): Updates the specified user by setting the values of the parameters passed. Any parameters not provided will be left unchanged. - [Delete a user](https://api.basiq.io/reference/deleteuser.md): Permanently deletes a user along with all of their associated connection details. All data associated with this user will deleted. You need only supply the unique user identifier that was returned… - Consents - [Retrieve consents](https://api.basiq.io/reference/getconsents.md): Retrieves a list of the user consents - [Delete a consent](https://api.basiq.io/reference/deleteconsent.md): Permanently deletes a users consent, this action cannot be undone. - Connections - [List all connections](https://api.basiq.io/reference/getconnections.md): Returns a list of connections belonging to this user. Each entry in the array is a separate object. If no data is returned, the resulting array will be empty. - [Refresh all connections](https://api.basiq.io/reference/refreshconnections.md): Use this to refresh all connections belonging to the specified user. - [Retrieve a connection](https://api.basiq.io/reference/getconnection.md): Use this to retrieve details of a specific connection. Note that due to security the loginId, password, securityCode are never returned. - [Delete a connection](https://api.basiq.io/reference/deleteconnection.md): Permanently deletes a connection. - [Refresh a connection](https://api.basiq.io/reference/refreshconnection.md): Use this to refresh an existing connection. This will not return a new connection. Instead will return a job resource which is resonsible for refreshing the connection and fetching data… - [Purge connection data](https://api.basiq.io/reference/purgeconnectiondata.md): Use this endpoint to remove all user data related to a specific institution. Purging is only applicable for active user connections. When Enrich data is updated, the Enrich results under… - Jobs - [Get user jobs](https://api.basiq.io/reference/getuserjobs.md): Retrieves the details of all existing and previous jobs associated with a user. **Note:** This endpoint only returns jobs that are less than 7 days old. - [Retrieve a job](https://api.basiq.io/reference/getjobs.md): Retrieves the details of an existing job. You need only supply the unique job identifier that was returned upon job creation. - [Create MFA response](https://api.basiq.io/reference/postjobmfa.md): Ensure that you generate an authentication token with scope = CLIENT_ACCESS and basiq-version = 3.0 to create this resource - Accounts - [List all accounts](https://api.basiq.io/reference/getaccounts.md): List all accounts belonging to a user - [Retrieve an account](https://api.basiq.io/reference/getaccount.md): Retrieve a specific account belonging to a user - Transactions - [List all transactions](https://api.basiq.io/reference/gettransactions.md): List all transactions belonging to a specified user - [Retrieve a transaction](https://api.basiq.io/reference/gettransaction.md): Retrieve an existing transaction ## API: Enrich - Enrich - [Enrich](https://api.basiq.io/reference/enrich.md): The Enrich resource enables you to retrieve details by passing in a search query containing a bank transaction description. The service enriches transaction data with multiple attributes, returning a… - [Search Merchants](https://api.basiq.io/reference/merchantsearch.md): Retrieves merchant details. At least one of `abn` or `merchantName` is required for a successful search. Optional filters for suburb and entity type can also be applied. - [Retrieve a merchant](https://api.basiq.io/reference/getmerchantbyid.md): Retrieves a single merchant's details using its unique ID. ## API: CDR Insights - Insights - [Create an Insight](https://api.basiq.io/reference/createinsight.md): Creates a new insight for one or more users. Supported insight types are EXPENSE_RATIO_VERIFICATION, BALANCE_VERIFICATION, ACCOUNT_VERIFICATION, IDENTITY_VERIFICATION, and INCOME_VERIFICATION.… - [List all Insights](https://api.basiq.io/reference/listuserinsights.md): Returns a paginated list of previously generated insights for the specified user. Supports filtering by creation date and insight type. Maximum 20 insights per page. - [Retrieve an Insight](https://api.basiq.io/reference/getinsightbyid.md): Returns detailed information for a specific insight by ID - [List Insight Types](https://api.basiq.io/reference/getinsighttypes.md): Returns the list of supported CDR Insight types and the Insight-specific input schema (`data`) each type expects. - [Retrieve Insight Type](https://api.basiq.io/reference/getinsighttype.md): Returns the definition of a single supported CDR Insight type identified by `{typeId}`. - [Account Insights](https://api.basiq.io/reference/getaccountinsights.md): Retrieve account insights for a specific user based on account number - [Account Balance Insights](https://api.basiq.io/reference/getbalanceinsights.md): Retrieve balance insights for a user's accounts based on specified minimum and maximum balance criteria - [Identity Insights](https://api.basiq.io/reference/getidentityinsights.md): Retrieve identity insights for a specific user by comparing provided personal details (name, phone, email, address). - [Income Insights](https://api.basiq.io/reference/verifyincomeinsight.md): Verifies if a user's income falls within a specified range. Returns a match result with confidence level based on the user's financial data. - [Expense Ratio Insights](https://api.basiq.io/reference/getexpenseratioinsights.md): Calculate and return the expense-to-income ratio. ## API: REPORTING - Reports - [Create a report](https://api.basiq.io/reference/createreport.md): Use this endpoint to create a new report. Report creation is an asynchronous task, meaning a job will be returned to let you know the progress of the report generation. You can poll the job to know… - [List all reports](https://api.basiq.io/reference/listallreports.md): Use this endpoint to retrieve a list of created reports. Every created report is saved as a snapshot and can be retrieved up to 24 hours after creation.You can call the reports/types endpoint to see… - [Retrieve a report](https://api.basiq.io/reference/retrievereport.md): Use this endpoint to retrieve a specific report. Ensure you check the documentation for the schema of each report type. | Request Header | Description… - [Delete a report](https://api.basiq.io/reference/deletereport.md): Permanently deletes a report and all associated snapshot data. - [Retrieve Report transactions](https://api.basiq.io/reference/retrievereporttransactions.md): Retrieve transactions belonging to the report identified by {reportId}. - [List report types](https://api.basiq.io/reference/listreporttypes.md): Use this endpoint to retrieve a list of supported reports. This identifies the complete list of supported reports, which can be used to create reports on. - [Retrieve a report type](https://api.basiq.io/reference/retrievespecificreporttype.md): Retrieve information about a specific report type identified by {reportId}. ## API: Identity - Identities - [Retrieve identities](https://api.basiq.io/reference/getuseridentities.md): Returns a list with a data property that contains an array of user identities. Each entry in the array is a separate object. If no data is returned, the resulting array will be empty. - [Retrieve an identity](https://api.basiq.io/reference/getuseridentity.md): Returns a specific identity object. ## API: Platform - AuthLinks - [Create an auth_link](https://api.basiq.io/reference/postauthlink.md): Create a new auth_link object by making a POST request to the auth_link endpoint. The new auth_link will effectively delete previous auth_link for that user, rendering the previous URL(s) invalid.… - [Retrieve an auth_link](https://api.basiq.io/reference/getauthlink.md): Returns the latest/last auth_link generated for the specified user. Returns an error otherwise. - [Delete an auth_link](https://api.basiq.io/reference/deleteauthlink.md):
Note that this action cannot be undone.
The auth_link is a URL that directs a User to Basiq's hosted consent workflow to link banks and securely share data. When… - Connectors - [Retrieve connectors](https://api.basiq.io/reference/getconnectors.md): NOTE: This end point requires authentication. - [Retrieve a connector](https://api.basiq.io/reference/getconnector.md): NOTE: This end point requires authentication. - Events - [List all events](https://api.basiq.io/reference/getevents.md): Returns a list of all events that have taken place. - [Retrieve an event](https://api.basiq.io/reference/gettypebyid.md): Returns a single event type based on the parameter input. - [List event types](https://api.basiq.io/reference/listeventtypes.md): Returns a list of event types. - [Retrieve an event type](https://api.basiq.io/reference/geteventtypebyid.md): Returns a single event type based on the parameter input. - Payees - [List Payees](https://api.basiq.io/reference/getpayees.md): Retrieves a paginated list of payees for a specific user. Supports filtering by payee type, connection ID, and creation date. - [Get Payee Details](https://api.basiq.io/reference/getpayeedetails.md): Retrieves detailed information for a specific payee. The response includes type-specific details based on the payee type (domestic, biller, international, or digitalWallet). - Statements - [Create a statement](https://api.basiq.io/reference/createstatement.md): Create a new statement by uploading an official PDF bank statement or CSV file. The server will create a job that processes the following steps: 1. **verify-credentials**: Verify the file, validate… - Analytics - [User Analytics](https://api.basiq.io/reference/getuseranalytics.md): Retrieve user analytics, such as number of users and connections created for an application over a given time interval. - [Connection Analytics](https://api.basiq.io/reference/getconnectionanalytics.md): Retrieve connection analytics, including connection creation, status distribution, method distribution, and disruption rates over a given time interval. ## API: Webhooks - Webhooks - [Create a webhook](https://api.basiq.io/reference/addwebhook.md) - [List all webhooks](https://api.basiq.io/reference/listappwebhooks.md) - [Update a webhook](https://api.basiq.io/reference/updatewebhook.md) - [Delete a webhook](https://api.basiq.io/reference/deletewebhook.md) - [Retrieve a webhook](https://api.basiq.io/reference/getwebhook.md) - [List all messages](https://api.basiq.io/reference/listmessages.md) - [Retrieve a message](https://api.basiq.io/reference/getwebhookmessage.md) - [Post a test message](https://api.basiq.io/reference/testmessage.md) - [Get webhook delivery statistics](https://api.basiq.io/reference/getwebhookstats.md) ## API: Affordability (LEGACY) - Affordability - [List affordability summaries](https://api.basiq.io/reference/getaffordabilitylist.md): Returns a list of affordability summaries that have been generated for a specific user. - [Create an affordability summaries](https://api.basiq.io/reference/postaffordability.md): Create an affordability summaries for a user - [Retrieve an affordability summary](https://api.basiq.io/reference/getaffordability.md): Retrieves a specific, pre existing affordability summaries - [List affordability summary transactions](https://api.basiq.io/reference/getaffordabilitysnapshottransactions.md): Use this endpoint to retrieve a paginated list of transactions associated with an affordability summary. - Expenses - [Create an expense summary](https://api.basiq.io/reference/postexpenses.md): Create a new expense summary for a user - [Retrieve an expense summary](https://api.basiq.io/reference/getexpenses.md): Retrieve an existing expense summary for a specific user - Income - [Create an income summary](https://api.basiq.io/reference/postincome.md): Create an income summary for a specific user - [Retrieve an income summary](https://api.basiq.io/reference/getincome.md): Retrieve an existing income summary for a specific user ## API: AI Tools - [Overview](https://api.basiq.io/reference/ai-tools-overview.md) - [MCP Server](https://api.basiq.io/reference/mcp-server.md) - [LLM Resources](https://api.basiq.io/reference/llm-resources.md) - [OpenAPI](https://api.basiq.io/reference/openapi.md)