customers

List claims for a person

Changed on

Lists the person's claims that still apply, newest first, each with its latest version and its latest verified version. Set include_history for every version.

get/persons/{person_id}/claims

Request

Path parameters

person_idstring required

The ID of the person.

Query parameters

claim_type'identity' | 'nationalities' | 'residence' | 'tax_residencies' | 'fatca_status' | 'pep_status' | 'education_level' | 'employment' | 'financial_profile' | 'investment_experience' | 'expected_activity' | 'relationships' | 'registration' | 'contact_details' | 'lei' | 'registered_address' | 'operating_address' | 'business_nature'

If set, only claims of this type.

status'pending' | 'verified'

Before ClaimsV2 only: filter rows by status (pending or verified).

include_historyboolean nullable

Include every version under versions (default false). Before ClaimsV2: every row is returned unless set to false.

Response

Successful Response

archived_atstring date-time nullable required

When the claim stopped applying; null while it applies.

claim_type'identity' | 'nationalities' | 'residence' | 'tax_residencies' | 'fatca_status' | 'pep_status' | 'education_level' | 'employment' | 'financial_profile' | 'investment_experience' | 'expected_activity' | 'relationships' | 'registration' | 'contact_details' | 'lei' | 'registered_address' | 'operating_address' | 'business_nature' required
created_atstring date-time required

When the claim was first held.

idstring required

Unique resource identifier.

is_archivableboolean required

Whether the claim can be archived. False for a claim a person cannot do without, such as identity or residence.

personstring required

ID of the person the claim is about.

Example response

[
  {
    "latest_verified_version": {
      "number": 2
    },
    "latest_version": {
      "number": 2
    },
    "versions": [
      {
        "number": 2
      }
    ]
  }
]

Changes

    • breaking

      for the query request parameter include_history, default value true was removed

    • breaking

      the response's property type changed from no type to object for status

    • info

      query request parameter include_history list-of-types was widened by adding types null

    • info

      for the query request parameter include_history, the type was generalized from boolean to no type

    • info

      added the optional property / to the response with the status

    • info

      removed discriminator from response property for the response status

    • info

      removed from the response property oneOf list for the response status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the // response's property type changed from no type to string for status