Search Persons


About this API

To get the ins and outs of this API, please refer to our documentation page here


Service limitations

To ensure platform stability and fair use, rate limits are applied. If the allowed limit is exceeded, the API will respond with an ‘HTTP 429 (Too Many Requests)’ status code.


How to use this page?

  1. Pick a preferred language on the right.
  2. Enter your API key in the header field. Don't have one yet or don't know what that is? Please refer to the following page here.
  3. Enter the required parameters below or try something yourself!
  4. Click the Try It! button!
📘

You can also press one of the HTTP response codes on the right to see an example of that specific response!

Query Params
enum
Defaults to kyc_aml

the provider of the compliance screening data

Allowed:
match
object

All the parameters that can be applied to the persons search

page
object

sizedefines the number of records to return in each page. default value: 10, maximum value: 20.
numberspecifies the page number.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.api+json