Search person

POST /v1/search/person

JavaScript

JavaScript

import Openregister from 'openregister';

const client = new Openregister({
  apiKey: process.env['OPENREGISTER_API_KEY'], // This is the default and can be omitted
});

const response = await client.search.findPersonV1();

console.log(response.pagination);

200

{
  "results": [
    {
      "id": "<string>",
      "name": "<string>",
      "city": "<string>",
      "date_of_birth": "<string>",
      "active": true
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total_pages": 123,
    "total_results": 123
  }
}

Search for a person

Search for natural persons by name, city, date of birth, or other attributes. Find people based on their business roles and filter by criteria such as the number of companies they’re involved with or their management positions. Use this endpoint to identify individuals for due diligence or to research business networks. More information about filtering can be found here.

Cost: 10 credits

Authorizations

Authorization · string · header · required

API Key Authentication Provide your API key as a Bearer token in the Authorization header.

Body

application/json

query · object

Search query to filter people.

Show child attributes

filters · object[]

Filters to filter people.

Show child attributes

pagination · object

Pagination parameters.

Show child attributes

Response

200

application/json

Successful search operation

results · object[] · required

List of people matching the search criteria.

Show child attributes

pagination · object · required

Show child attributes