Sign in

v2

latestSwagger 2.02026-08-0610101.9 MB
Legal persons

Search legal persons

Returns a list of legal persons whose legal names match the search-query supplied in the request. Takes an optional 'equals onboarded' filter.

post/v0/organizations/{organization-id}/legal-persons/search

Path parameters

organization-idstring required

Query parameters

includestring[]

For each legal person returned, include any roles in companies (significant control or directorship) in the response under the included attribute.

filter[legal-person-status][eq]'onboarded'

Return only legal persons with the given legal-person-status.

Request body

search-querystring required

Response

OK

Example response

{
  "search-results": [
    {
      "latest-decision": {
        "verification-url": "/v0/verifications/vn.IHZlcmlmaWNhdGlvbi1pZA",
        "decision-user-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
        "decision-user-username": "user@example.com"
      },
      "latest-risk-rating-url": "/v0/risk-ratings/rr.ICByaXNrLXJhdGluZy1pZA",
      "display-name": "Company name"
    }
  ]
}