Search

All Highnote API entities use the same search and sorting conventions. You can use the following examples to build your queries when filtering for matches. Results will always return as a paginated list you can traverse using cursors.

Searching across multiple years of data may introduce minimal additional latency, though this impact is typically imperceptible in normal usage.

Highnote's Search API experiences a synchronization delay of up to 2 minutes for newly created objects.

When you create a new object (such as an account holder), it's immediately stored in the main database but takes up to 2 minutes to synchronize with the search database. During this period, the new object won't appear in search results. This process is illustrated below:

Highnote maintains the following data retention periods through the standard API:

• Issuing transactions: 4 years
• Acquiring transactions: 2 years

You can fetch issuing and acquiring data beyond the retention period from Highnote Data Share.

Different fields can filter every entity in our graph. However, all fields of the same type follow similar conventions.

To filter by date range, use the following filters:

• greaterThan
• lessThan
• greaterThanOrEqualTo
• lessThanOrEqualTo
• equals
• notEquals

To filter by numbers, use the following filters:

• greaterThan
• lessThan
• greaterThanOrEqualTo
• lessThanOrEqualTo
• equals
• notEquals

To filter with common string matching, use the following filters:

• contains
• equals
• notEquals
• startsWith
• endsWith

You can filter multiple values by choosing what values to include or exclude from the results. In the following example, the request is filtered to include AUTHORIZATION_EVENT and CLEARING_EVENT:

You can filter enums by including the enum values you wish to include, exclude, or match exactly. In the following example, the request is filtered to equal AUTHORIZATION_EVENT:

You can combine multiple filters to construct more advanced queries. In the following example, an enum, number, and date filter are used:

You can use the Highnote API to search Account Holder applications based on status, updatedAt, and createdAt search fields.

The following example query would return the first 20 account holder applications with an APPROVED status: