> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.withverifa.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.withverifa.com/_mcp/server.

# Replace the organization's proof-of-address policy

PUT https://api.withverifa.com/api/v1/settings/proof-of-address
Content-Type: application/json

Replaces the stored policy wholesale — send the complete settings
object, not a patch. Accepts either the settings object directly or
`{"settings": {...}}`.

Validation is shared with the workflow node config, so the two can
never diverge: unknown keys are dropped, unknown document types are
rejected, recency windows must be 1–365 days, thresholds must be
between 0 and 1, and each `*_match_review` threshold must be less than
or equal to its `*_match_pass` counterpart. Every problem is reported
at once in the `422` detail.

Requires the `manage_settings` permission and the
`proof_of_address_check` feature. Writes a
`settings.proof_of_address.update` audit log entry.

Reference: https://docs.withverifa.com/api-reference/organization-settings/update-proof-of-address-settings

## Request

### Headers

- `Verifa-Version` (date, optional) — API version date string (e.g. `2026-02-01`). If omitted, the version pinned to your API key is used.

### Body (application/json)

This endpoint expects a map from string to any.

- `map from string to any`

## Response

### 200

Policy saved.

- `status` (string, required)
- `settings` (map from string to any, required) — The cleaned, normalised settings as stored.
- `effective` (PoaPolicySnapshot, required) — The effective proof-of-address policy this check ran under, resolved from four layers — built-in defaults, the regional preset, your organization's settings, then the workflow node's config, each overriding the last. Snapshotted into the result so a decision stays explainable after the policy changes.

## Errors

### 401 Unauthorized Error

Missing or invalid API key.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

### 403 Forbidden Error

Missing the `manage_settings` permission, or the plan does not include proof-of-address checks.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

### 404 Not Found Error

Resource not found.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

### 422 Unprocessable Entity Error

Request validation failed.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

## Types

### PoaPolicySnapshot

The effective proof-of-address policy this check ran under, resolved from four layers — built-in defaults, the regional preset, your organization's settings, then the workflow node's config, each overriding the last. Snapshotted into the result so a decision stays explainable after the policy changes.

- `preset` (enum, optional)
  - Allowed values: `custom`, `us`, `uk`, `eu`, `in`, `mx`, `au`, `ca`, `za`
- `accepted_types` (list of enum, optional) — Empty means every non-review-only type is accepted.
  - Allowed values: `utility_bill`, `mobile_phone_bill`, `bank_statement`, `credit_card_statement`, `council_tax`, `tax_document`, `government_letter`, `benefits_letter`, `mortgage_statement`, `lease_agreement`, `insurance_statement`, `payslip`, `id_with_address`, `institution_letter`, `other`
- `max_age_days_by_type` (map from string to integer, optional) — Per-type recency windows layered over each type's default.
- `country_overrides` (map from string to map from string to any, optional) — ISO-2 country code → `{accepted_types, max_age_days_by_type}`, applied when the document's issuing country matches.
- `allow_po_box` (boolean, optional)
- `allow_business_address` (boolean, optional)
- `allow_screenshots` (boolean, optional)
- `allow_mobile_phone_bill` (boolean, optional)
- `id_with_address_satisfies` (boolean, optional)
- `require_declared_address` (boolean, optional) — Guided flow. When false the flow is unguided — the address is extracted but never scored against a reference, and the check reports `address_not_compared`.
- `address_source` (enum, optional)
  - Allowed values: `user_declared`, `id_document`
- `name_match_pass` (double, optional)
- `name_match_review` (double, optional)
- `address_match_pass` (double, optional)
- `address_match_review` (double, optional)
- `date_match_tolerance_days` (integer, optional)
- `classifier_disagreement` (enum, optional)
  - Allowed values: `review`, `ignore`, `fail`
- `country_mismatch_action` (enum, optional)
  - Allowed values: `review`, `ignore`, `fail`
- `max_age_days` (integer, optional, nullable) — Legacy flat window, expanded across every type at resolution time.

## Examples

**Request**

```json
{
  "preset": "uk",
  "accepted_types": [
    "utility_bill",
    "bank_statement",
    "council_tax"
  ],
  "max_age_days_by_type": {
    "utility_bill": 60
  },
  "country_overrides": {
    "IN": {
      "max_age_days_by_type": {
        "utility_bill": 60
      }
    }
  },
  "allow_po_box": false,
  "address_match_pass": 0.8,
  "address_match_review": 0.55,
  "country_mismatch_action": "review"
}
```

**Response**

```json
{
  "status": "ok",
  "settings": {},
  "effective": {
    "preset": "custom",
    "accepted_types": [
      "utility_bill"
    ],
    "max_age_days_by_type": {},
    "country_overrides": {},
    "allow_po_box": true,
    "allow_business_address": true,
    "allow_screenshots": true,
    "allow_mobile_phone_bill": true,
    "id_with_address_satisfies": true,
    "require_declared_address": true,
    "address_source": "user_declared",
    "name_match_pass": 1.1,
    "name_match_review": 1.1,
    "address_match_pass": 1.1,
    "address_match_review": 1.1,
    "date_match_tolerance_days": 1,
    "classifier_disagreement": "review",
    "country_mismatch_action": "review",
    "max_age_days": 1
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.withverifa.com/api/v1/settings/proof-of-address"

payload = {
    "preset": "uk",
    "accepted_types": ["utility_bill", "bank_statement", "council_tax"],
    "max_age_days_by_type": { "utility_bill": 60 },
    "country_overrides": { "IN": { "max_age_days_by_type": { "utility_bill": 60 } } },
    "allow_po_box": False,
    "address_match_pass": 0.8,
    "address_match_review": 0.55,
    "country_mismatch_action": "review"
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.withverifa.com/api/v1/settings/proof-of-address';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"preset":"uk","accepted_types":["utility_bill","bank_statement","council_tax"],"max_age_days_by_type":{"utility_bill":60},"country_overrides":{"IN":{"max_age_days_by_type":{"utility_bill":60}}},"allow_po_box":false,"address_match_pass":0.8,"address_match_review":0.55,"country_mismatch_action":"review"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withverifa.com/api/v1/settings/proof-of-address"

	payload := strings.NewReader("{\n  \"preset\": \"uk\",\n  \"accepted_types\": [\n    \"utility_bill\",\n    \"bank_statement\",\n    \"council_tax\"\n  ],\n  \"max_age_days_by_type\": {\n    \"utility_bill\": 60\n  },\n  \"country_overrides\": {\n    \"IN\": {\n      \"max_age_days_by_type\": {\n        \"utility_bill\": 60\n      }\n    }\n  },\n  \"allow_po_box\": false,\n  \"address_match_pass\": 0.8,\n  \"address_match_review\": 0.55,\n  \"country_mismatch_action\": \"review\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.withverifa.com/api/v1/settings/proof-of-address")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"preset\": \"uk\",\n  \"accepted_types\": [\n    \"utility_bill\",\n    \"bank_statement\",\n    \"council_tax\"\n  ],\n  \"max_age_days_by_type\": {\n    \"utility_bill\": 60\n  },\n  \"country_overrides\": {\n    \"IN\": {\n      \"max_age_days_by_type\": {\n        \"utility_bill\": 60\n      }\n    }\n  },\n  \"allow_po_box\": false,\n  \"address_match_pass\": 0.8,\n  \"address_match_review\": 0.55,\n  \"country_mismatch_action\": \"review\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api.withverifa.com/api/v1/settings/proof-of-address")
  .header("Content-Type", "application/json")
  .body("{\n  \"preset\": \"uk\",\n  \"accepted_types\": [\n    \"utility_bill\",\n    \"bank_statement\",\n    \"council_tax\"\n  ],\n  \"max_age_days_by_type\": {\n    \"utility_bill\": 60\n  },\n  \"country_overrides\": {\n    \"IN\": {\n      \"max_age_days_by_type\": {\n        \"utility_bill\": 60\n      }\n    }\n  },\n  \"allow_po_box\": false,\n  \"address_match_pass\": 0.8,\n  \"address_match_review\": 0.55,\n  \"country_mismatch_action\": \"review\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.withverifa.com/api/v1/settings/proof-of-address', [
  'body' => '{
  "preset": "uk",
  "accepted_types": [
    "utility_bill",
    "bank_statement",
    "council_tax"
  ],
  "max_age_days_by_type": {
    "utility_bill": 60
  },
  "country_overrides": {
    "IN": {
      "max_age_days_by_type": {
        "utility_bill": 60
      }
    }
  },
  "allow_po_box": false,
  "address_match_pass": 0.8,
  "address_match_review": 0.55,
  "country_mismatch_action": "review"
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.withverifa.com/api/v1/settings/proof-of-address");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"preset\": \"uk\",\n  \"accepted_types\": [\n    \"utility_bill\",\n    \"bank_statement\",\n    \"council_tax\"\n  ],\n  \"max_age_days_by_type\": {\n    \"utility_bill\": 60\n  },\n  \"country_overrides\": {\n    \"IN\": {\n      \"max_age_days_by_type\": {\n        \"utility_bill\": 60\n      }\n    }\n  },\n  \"allow_po_box\": false,\n  \"address_match_pass\": 0.8,\n  \"address_match_review\": 0.55,\n  \"country_mismatch_action\": \"review\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [
  "preset": "uk",
  "accepted_types": ["utility_bill", "bank_statement", "council_tax"],
  "max_age_days_by_type": ["utility_bill": 60],
  "country_overrides": ["IN": ["max_age_days_by_type": ["utility_bill": 60]]],
  "allow_po_box": false,
  "address_match_pass": 0.8,
  "address_match_review": 0.55,
  "country_mismatch_action": "review"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.withverifa.com/api/v1/settings/proof-of-address")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```