GRgriffin
Legal persons

List legal persons

Changed on

Returns a paginated list of all legal persons for the given organization.

By default, results are sorted descending by created-at (newest first). To sort ascending by created-at, provide a ?sort=created-at query parameter.

get/v0/organizations/{organization-id}/legal-persons

Request

Path parameters

organization-idstring required

Query parameters

sort'-status-changed-at' | 'status-changed-at' | '-created-at' | 'created-at'
includestring[]

For each legal person returned, include its latest verification (if one exists), any roles in companies (significant control or directorship), and/or its latest risk rating (if one exists) in the response under the included attribute.

filter[legal-person-status][in][]string[]

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

filter[application-status][eq]'referred' | 'errored' | 'declined' | 'submitted' | 'accepted'

Return only legal persons with the given application-status.

filter[has][]string[]

Return only legal persons with the given attributes.

page[size]integer
page[after]string byte

A base64 encoded opaque string returned in paginated responses.

page[before]string byte

A base64 encoded opaque string returned in paginated responses.

Response

OK

Example response

{
  "legal-persons": [
    {
      "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"
    }
  ]
}

Changes