JOjoinsophic
customers

Archive a claim

Changed on

Archives one of the person's claims: it no longer applies. Its versions are kept, and a later value of the same type starts a new claim. A claim a person of its type must have cannot be archived (400). Send based_on to have it refused with 409 when the claim has moved on.

delete/persons/{person_id}/claims/{claim_id}

Request

Path parameters

person_idstring required

The ID of the person.

claim_idstring required

The ID of the claim.

Query parameters

based_oninteger nullable

The version number you read.

Response

OK

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