Get the organization’s proof-of-address policy

GET

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

GET

/api/v1/settings/proof-of-address

$ curl https://api.withverifa.com/api/v1/settings/proof-of-address \
>      -H "X-API-Key: <apiKey>"

1 {
2   "presets": {},
3   "doc_types": [
4     {
5       "key": "utility_bill",
6       "label": "Council tax / property tax / rates",
7       "category": "utility",
8       "default_max_age_days": 1,
9       "review_only": true,
10       "counts_as_independent": true
11     }
12   ],
13   "countries": {},
14   "settings": {},
15   "effective": {
16     "preset": "custom",
17     "accepted_types": [
18       "utility_bill"
19     ],
20     "max_age_days_by_type": {},
21     "country_overrides": {},
22     "allow_po_box": true,
23     "allow_business_address": true,
24     "allow_screenshots": true,
25     "allow_mobile_phone_bill": true,
26     "id_with_address_satisfies": true,
27     "require_declared_address": true,
28     "address_source": "user_declared",
29     "name_match_pass": 1.1,
30     "name_match_review": 1.1,
31     "address_match_pass": 1.1,
32     "address_match_review": 1.1,
33     "date_match_tolerance_days": 1,
34     "classifier_disagreement": "review",
35     "country_mismatch_action": "review",
36     "max_age_days": 1
37   }
38 }

Returns the organization’s stored proof-of-address settings plus everything needed to edit them: the regional presets, the canonical document-type table, and the country list.

effective is the policy resolved from built-in defaults, then the named preset, then the stored settings — what a check would use if the workflow node says “use organization settings”. A workflow node that overrides fields layers on top of this at run time.

Requires the proof_of_address_check feature on your plan (sandbox unlocks it). Dashboard cookie only — not callable with an API key.

Returns the organization's stored proof-of-address settings plus everything needed to edit them: the regional presets, the canonical document-type table, and the country list. `effective` is the policy resolved from built-in defaults, then the named preset, then the stored settings — what a check would use if the workflow node says "use organization settings". A workflow node that overrides fields layers on top of this at run time. Requires the `proof_of_address_check` feature on your plan (sandbox unlocks it). Dashboard cookie only — not callable with an API key.

Response

The stored policy, the resolved policy, and the vocabulary needed to edit it.

presetsmap from strings to maps from strings to any

Regional starting points keyed by preset name (custom, us, uk, eu, in, mx, au, ca, za). Each is a partial policy — anything a preset omits keeps the default.

doc_typeslist of objects

The canonical proof-of-address document types.

countriesmap from strings to any

Grouped ISO-2 country list for the country-override editor.

settingsmap from strings to any

The organization’s stored policy overrides. {} when nothing is set.

effectiveobject

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

403

Forbidden Error

404

Not Found Error

Headers

Response

Errors