Normalise, verify and geocode one address as it was typed

POST /addresses/verify

Normalise, verify and geocode one address as it was typed: the platform address it is, down to the unit (Unit 3, Level 4, read from either line) — put its pad_ id on the organization's record as verifiedAddressId — and, for a unit, its building, the record routing and zones group by.

Each carries its confidence: a score from 0 to 1 that rises with the official sources, carriers and customers that confirmed it (verified from 0.85, probable from 0.6). An address nothing can verify is 422 AddressUnverified with how it was read and the nearest addresses known, and is not stored; 422 CountryNotSupported; 503 AddressProviderUnavailable. Appends addresses.address-registered the first time an address (and a unit's building) is verified, under the registry's own actor — never the caller's. Idempotent by content: the id is derived from the normalised address, so verifying it again, by anyone, answers the same record and appends nothing. The answer is the address alone — the same whether or not anyone verified it before — and nothing about who else uses it.

Access

Requires orders:write or customers:write or companies:write or locations:write or purchasing:write.

Any one of these scopes is enough.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

Retries

Idempotent by content: the id is derived from the normalised address, so verifying it again, by anyone, answers the same record and appends nothing.

Why every write carries a key: Idempotency and retries.

Facts appended

addresses.address-registered

What a fact is: Facts and the journal.

AI agent tool

Agents call this as addresses_verify_address (Addresses: Verify address), in the crm toolset.

Connecting an agent: AI agents.

Example

curl

curl -X POST 'https://addresses.getmanifold.io/addresses/verify' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "address1": "Level 4, 200 Collins Street",
  "city": "Melbourne",
  "provinceCode": "VIC",
  "zip": "3000",
  "countryCode": "AU"
}'

JavaScript (fetch)

const response = await fetch("https://addresses.getmanifold.io/addresses/verify", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "address1": "Level 4, 200 Collins Street",
    "city": "Melbourne",
    "provinceCode": "VIC",
    "zip": "3000",
    "countryCode": "AU"
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Request body · application/json

{
  "address1": "Level 4, 200 Collins Street",
  "city": "Melbourne",
  "provinceCode": "VIC",
  "zip": "3000",
  "countryCode": "AU"
}

Response · 200 · application/json

{
  "address": {
    "id": "pad_5d81a0c2-9e3b-4f17-a6d4-2c8e0b7f9a31",
    "countryCode": "AU",
    "streetNumber": "200",
    "streetName": "COLLINS",
    "streetType": "ST",
    "locality": "MELBOURNE",
    "region": "VIC",
    "postcode": "3000",
    "street": "200 Collins Street",
    "lines": [
      "Level 4, 200 Collins Street",
      "Melbourne VIC 3000"
    ],
    "geocode": {
      "latitude": -37.8152,
      "longitude": 144.9671,
      "precision": "rooftop"
    },
    "unit": "LEVEL 4",
    "buildingId": "pad_0b3f6c1e-4a7d-8e29-9c51-7f2d4e8a6b10",
    "verification": "platform-verified",
    "confidence": {
      "score": 0.6,
      "level": "probable"
    }
  },
  "building": {
    "id": "pad_0b3f6c1e-4a7d-8e29-9c51-7f2d4e8a6b10",
    "countryCode": "AU",
    "streetNumber": "200",
    "streetName": "COLLINS",
    "streetType": "ST",
    "locality": "MELBOURNE",
    "region": "VIC",
    "postcode": "3000",
    "street": "200 Collins Street",
    "lines": [
      "200 Collins Street",
      "Melbourne VIC 3000"
    ],
    "geocode": {
      "latitude": -37.8152,
      "longitude": 144.9671,
      "precision": "rooftop"
    },
    "verification": "platform-verified",
    "confidence": {
      "score": 0.9,
      "level": "verified"
    }
  }
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: address-manager.openapi.json. Base URL https://addresses.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

`401`

Refusal	What it means	What to do
`Unauthorized` reason	The token is missing, expired or not one Manifold issued.	Get a fresh token and send the call again.
`TokenAlreadyUsed` tokenId	A single-use app token was already spent.	Mint a new token for this call.

`402`

Refusal	What it means	What to do
`SubscriptionRequired` status	The organization's subscription has lapsed, so writes are refused.	An owner settles billing. Reads still work meanwhile.

`403`

Refusal	What it means	What to do
`TenantRequired` userId	The token names no organization.	Choose the organization, then get a new token.
`ScopeRequired` required	The token's roles do not grant the scope this call needs.	Ask an owner or admin for a role that grants it.

`409`

Refusal	What it means	What to do
`MirroredFromSource` source	This area is fed by your source system until the organization goes live.	Make the change in the source system, or go live first.

`422`

Refusal	What it means	What to do
`AddressUnverified` normalised, candidates	The request was refused, and nothing changed.	Fix the request. Sending it again unchanged gets the same answer.
`CountryNotSupported` countryCode	The request was refused, and nothing changed.	Fix the request. Sending it again unchanged gets the same answer.

`503`

Refusal	What it means	What to do
`AddressProviderUnavailable` reason	A service this call needs did not answer, so nothing changed.	Send the same request again shortly.
`RequestLogUnavailable` tokenId, reason	The service could not record the request, so it did nothing.	Send the same request again shortly.

How refusals work everywhere: Errors.