---
title: "Anonymize a face authentication"
method: POST
path: "/face-authentications/{face_authentication_id}/anonymize"
tags: ["Face Authentication"]
---

# Anonymize a face authentication

`POST /face-authentications/{face_authentication_id}/anonymize`

## Request

- Base URL: `https://identity-verification.checkout.com`
- URL: `https://identity-verification.checkout.com/face-authentications/{face_authentication_id}/anonymize`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `string` scopes: `identity-verification`
  - API key in header `Authorization`
- TypeScript: <https://skmtc.dev/checkout/apis/checkout-com-api-reference/docs/face-authentications/:face_authentication_id/anonymize/post.ts> (a function with typed inputs; its response is checked against the schema)

<span style="font-size: 12px; font-weight: 500; color: rgb(0, 0, 0); background-color: rgb(255, 176, 97); border-radius: 4px; padding: 2px 6px" >Beta</span><p></p>
Remove the personal data in a [face authentication](https://www.checkout.com/docs/business-operations/manage-identities/authenticate-with-biometrics).

## Path parameters

- `face_authentication_id` string, required

## Response `200`

Personal data removed successfully

- FavFaceAuthenticationOutput
  - `created_on` string, date-time, required: The date and time when the resource was created, in UTC. <br/>Format – `yyyy-mm-ddThh:mm:ss.sss`
  - `modified_on` string, date-time, required: The date and time when the resource was modified, in UTC. <br/>Format – `yyyy-mm-ddThh:mm:ss.sss`
  - `applicant_id` string, required: The applicant's unique identifier.
  - `user_journey_id` string: Your configuration ID.
  - `status` 'approved' | 'capture_in_progress' | 'checks_in_progress' | 'created' | 'declined' | 'inconclusive' | 'pending' | 'refused' | 'retry_required', required: The [face authentication status](https://www.checkout.com/docs/developer-resources/codes/identities-codes#Check_statuses).
  - `face` IdvFace: The details of the image of the applicant's face extracted from the video.
    - `image_signed_url` string, uri, required: The pre-signed URL to the captured image of the document.
  - `response_codes` IdvResponseCode[], required: One or more [response codes](https://www.checkout.com/docs/developer-resources/codes/identities-codes#Response_codes) that provide more information about the status.
    - `code` integer, required: The [response code](https://www.checkout.com/docs/developer-resources/codes/identities-codes#Response_codes).
    - `summary` string, required: The description of the [response code](https://www.checkout.com/docs/developer-resources/codes/identities-codes#Response_codes).
  - `risk_labels` IdvRiskLabel[], required: One or more codes that provide more information about risks associated with the verification.
  - `_links` FavFaceAuthenticationLinks, required: The details of links related to the resource.
    - `self` IdvHalLink, required: The URL to the applicant profile resource.
      - `href` string, uri, required
    - `applicant` IdvHalLink, required: The URL to the applicant profile resource.
      - `href` string, uri, required
  - `id` string, required: The face authentication's unique identifier.

## Other responses

- `401`: Unauthorized
- `404`: Not Found
- `422`: Unprocessable Content
- `500`: Internal Server Error
- `503`: Service Unavailable

---

[API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)
