Filtering

See how filtering can be used to refine our responses.

You can filter results returned from the API by passing them as query parameters using a standard URI format.

                  host          resource
          ┌────────┴───────┐    ┌──┴──┐
  https://api.complycube.com/v1/clients?type=company&email=example%40example.com
  └─┬─┘                     └┬┘        └───────────────────┬───────────────────┘
  scheme                 API version                     query           

Supported attributes

Each endpoint provides a list of filter attributes.

When multiple filters are requested, they are all applied using an AND operator.

Passing an incorrectly formatted filter or using an unsupported operator will return a 200 response with no results.

Supported characters

As filters are passed as URL query string parameters, we must ensure all filters are URL safe and are strict about the characters that can be used in a filter.

Characters	Can it be used in the filter?
A-Z (upper & lower case)	Yes
0-9	Yes
$ - _ * .	Yes
(space)	Yes
+	Only when URL encoded (%2B)

URL encoding filters

Some characters cannot be part of a URL (for example, space), and some other characters have a special meaning in a URL.

We recommend URL encoding filters to escape special characters. For example, you can encode the full filter so that email=[e-mail] become email=john.doe%40example.com.

It is also recommended that you use URL building libraries to automatically encode your URLs to ensure the URLs are properly escaped before sending them to ComplyCube.

For more detail on filtering, see the Filtering section under each endpoint.