---
title: "Anonymize an address document verification"
method: POST
path: "/address-document-verifications/{address_document_verification_id}/anonymize"
tags: ["Address Document Verification"]
---

# Anonymize an address document verification

`POST /address-document-verifications/{address_document_verification_id}/anonymize`

## Request

- Base URL: `https://identity-verification.checkout.com`
- URL: `https://identity-verification.checkout.com/address-document-verifications/{address_document_verification_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/address-document-verifications/:address_document_verification_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 from an address document verification.

## Path parameters

- `address_document_verification_id` string, required: The address document verification's unique identifier.

## Response `200`

Personal data removed successfully

- AdvAddressDocumentVerificationOutput
  - `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, required: Your configuration ID.
  - `declared_data` IdvDeclaredData: The personal details provided by the applicant.
    - `name` string, required: The applicant's name.
    - `birth_date` string, date: The applicant's birth date. <br/>Format – `YYYY-MM-DD`
  - `id` string, required: The address document verification's unique identifier.
  - `status` 'created' | 'quality_checks_in_progress' | 'checks_in_progress' | 'approved' | 'declined' | 'retry_required' | 'inconclusive', required: The address document [verification status](https://www.checkout.com/docs/developer-resources/codes/identities-codes#Check_statuses).
  - `address_document` AdvAddressDocumentResult: The result of the address document check.
    - `document_type` string: The type of address document submitted.
    - `issuer` string: The issuer of the address document.
    - `full_names` string[]: The full names of the people named on the document. This can contain more than one name, for example if the document lists joint account holders.
    - `issue_date` string, date: The date the document was issued.
    - `address` AdvAddress: The address extracted from the document.
      - `address_line1` string: The first line of the address.
      - `address_line2` string: The second line of the address.
      - `city` string: The city or town.
      - `state` string: The state, county, or province.
      - `zip` string: The postal or ZIP code.
      - `country` string: The two-letter <a href="https://www.checkout.com/docs/resources/codes/country-codes" target="_blank">ISO country code</a> of the address.
  - `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[]: One or more codes that provide more information about risks associated with the verification.
  - `_links` IdvIdentityVerificationLinks, 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

## Other responses

- `401`: Unauthorized
- `404`: Not Found
- `500`: Internal Server Error

---

[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)