Archive an investor

POST

/api/v1/applications/{id}/archive

Stops ongoing monitoring for this investor and every party beneath them, drops their open review tasks out of the queues, and hides them from active lists. Nothing is deleted and the action is reversible.

Authorizations

• apiKey

Parameters

Path Parameters

id

required

string

Request Body^required

Media type application/json

object

reason

Why this investor is being archived. Recorded on the profile and in the audit log.

string

<= 1000 characters

Examples

{
  "reason": ""
}

{
  "reason": "Investor redeemed in full; relationship closed 30 Jun 2026."
}

Responses

200

Media type application/json

object

applicationIds

required

Applications whose archived state changed, including cascaded child applications

Array<string>

skippedApplicationIds

required

Applications already in the requested state, left untouched so their original reason and timestamp survive

Array<string>

partiesAffected

required

Screened parties whose ongoing monitoring was switched

number

monitoringSyncFailures

required

Parties whose monitoring intent was recorded but not confirmed by the screening provider

number

Example

{
  "applicationIds": [
    "68f2c1a9d4b1f2a3c4d5e6f7",
    "68f2c1a9d4b1f2a3c4d5e6f8"
  ],
  "skippedApplicationIds": [
    "68f2c1a9d4b1f2a3c4d5e6f9"
  ],
  "partiesAffected": 4,
  "monitoringSyncFailures": 0
}