---
title: "Archive Enrollment"
method: DELETE
path: "/enrollments/{enrollmentKey}"
tags: ["Enrollments"]
---

# Archive Enrollment

`DELETE /enrollments/{enrollmentKey}`

## Request

- Base URL: `https://eu-west-1.api.silverflow.com/v1`
- URL: `https://eu-west-1.api.silverflow.com/v1/enrollments/{enrollmentKey}`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
- TypeScript: <https://skmtc.dev/silverflow/apis/silverflow-api/docs/enrollments/:enrollmentKey/delete.ts> (a function with typed inputs; its response is checked against the schema)

This operation starts the archival process of an Enrollment.
The Enrollment entity will be marked as `archived` and have `pendingUnenroll` as `enrollmentStatus`.
Confirmed and successful unenrollments have `unenrolled` as `enrollmentStatus`.
**ISSM**: The entity will be removed from the list endpoint but will not unenroll from ISSM Merchant Enrollment, as it has been decommissioned by Mastercard.

Requires `enrollments:Archive` permission.

## Path parameters

- `enrollmentKey` string, required

## Request body

- union
  - AmexSponsoredMerchantEnrollmentArchive: Archive Sponsored Merchant request for American Express.
    - `type` 'amex_sm', required: Type of the enrollment. * `amex_sm` - American Express, Sponsored Merchant (**Please reach out to your technical account manager to enable your production access**) * `issm` - Mastercom Identity Solutions Service Manager [DEPRECATED]
    - `reason` 'derogatory' | 'non_derogatory', required: This field required when cancelling an AMEX Enrollment.
  - IssmEnrollmentArchive: Unenroll from ISSM and archive the enrollment
    - `type` 'issm': Type of the enrollment. * `amex_sm` - American Express, Sponsored Merchant (**Please reach out to your technical account manager to enable your production access**) * `issm` - Mastercom Identity Solutions Service Manager [DEPRECATED]
    - `deleteReason` 'Data Entry Error' | 'Merchant No Longer Participating' | 'Acquirer BIN Change' | 'Acquirer Primary ICA Change' | 'Other': Issm Unenrollment reason. If empty `Other` will be used.

## Response `204`

Enrollment archived successfully

## Other responses

- `400`: The request was malformed. See the response body for details
- `401`: Authentication information is missing or invalid
- `403`: The authenticated client is forbidden to make the request for the resource identified.
- `404`: The requested resource was not found
- `405`: The attempted operation/action is not allowed.
- `409`: The request could not be completed due to a conflict with the current state of the resources involved in the request.
- `429`: The number of requests (per minute) has exceeded the configured maximum

---

[API](https://skmtc.dev/silverflow/apis/silverflow-api.md) - [All operations](https://skmtc.dev/silverflow/apis/silverflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/silverflow/apis/silverflow-api/revisions/43ecbe4fd6ea?raw)