Get Sandbox Keys
API Reference

Retrieve Search Data

get
https://api.cloud.mbanq.com/v1/search

The Retrieve Search Data API enables users to obtain detailed information about various entities based on defined search parameters.

Behaviour - A successful response from this API indicates that all relevant search data for the specified entities was retrieved. The response contains detailed information about each entity, including their current status and hierarchical relationships, facilitating efficient data management and operations.

Query Params
string
required
Defaults to loan

The search term to be used in the query.
This is the keyword that will be searched across the specified resources.

string
required
Defaults to clients,clientIdentifiers,groups,savings,shares,loans,old_savings

A comma-separated list of resources to search within.
Available resources include clients, clientIdentifiers, groups, savings, shares, loans, old_savings.

boolean
Defaults to false

Specifies whether to match the query exactly.
Set to true for exact matches, false for partial matches.

Headers
string
required

The ID of your banking instance visible in the MBANQ Console.

Response

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?