Platform addresses by id

GET /addresses

Platform addresses by id (ids, at most 100) — the canonical form, coordinates, building and confidence a organization's record references by verifiedAddressId: what routing measures distance with and a badge shows.

An id the registry does not hold is left out. Appends nothing: a read.

Access

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

Any one of these scopes is enough.

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

AI agent tool

No agent tool. Platform addresses by id, for routing's distances and the admin's verified badge; addresses_verify_address answers the platform address whole, and a record's address carries it.

Connecting an agent: AI agents.

Example

curl

curl -X GET 'https://addresses.getmanifold.io/addresses?ids=pad_5d81a0c2-9e3b-4f17-a6d4-2c8e0b7f9a31%2Cpad_0b3f6c1e-4a7d-8e29-9c51-7f2d4e8a6b10' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN"

JavaScript (fetch)

const response = await fetch("https://addresses.getmanifold.io/addresses?ids=pad_5d81a0c2-9e3b-4f17-a6d4-2c8e0b7f9a31%2Cpad_0b3f6c1e-4a7d-8e29-9c51-7f2d4e8a6b10", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}` },
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Response · 200 · application/json

{
  "items": [
    {
      "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"
      }
    },
    {
      "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.

`503`

Refusal	What it means	What to do
`RequestLogUnavailable` tokenId, reason	The service could not record the request, so it did nothing.	Try again shortly.

How refusals work everywhere: Errors.