API version

API reference / Summarize addresses by verification status

Summarize addresses by verification status

GET/addresses/summary

Count addresses by verification status across every organization your credential owns; send an Organization-Id, Connection-Id or Entity-Id selector to narrow to one. Filter the counted set with country, the has* presence filters and addressNotEmpty, and with addressType. total is the sum of byStatus.

Authorization

Api-KeystringRequired

Your secret API key. Include it with every request.

Headers

Api-Versiondate

Release date, as YYYY-MM-DD. Defaults to 2026-07-21.

Organization-Idstring

Narrow the request to one organization (Organization-Id selector).

Connection-Idstring

Narrow the request to a connection's organization.

Entity-Idstring

Narrow the request to a platform entity's organization.

Entity-Sourcestring

Optional source to disambiguate an Entity-Id.

Query

Every query parameter below is optional. Combine as many as you need and append them to the endpoint as a query string. The example shows a few to get you started.

/addresses/summary?addressType=<addressType>&country=<country>&hasCountry=<hasCountry>

addressTypePublicAddressTypeEnum

Address role to filter by (e.g. SHIP_TO).

Available options:BILL_TOSHIP_TOSHIP_FROMBILL_FROM

countrystring

ISO-3166 alpha-2 country code to filter by.

hasCountryboolean

Filter to addresses that do (true) or do not (false) have a country.

hasStateboolean

Filter to addresses that do (true) or do not (false) have a state.

hasCityboolean

Filter to addresses that do (true) or do not (false) have a city.

hasCountyboolean

Filter to addresses that do (true) or do not (false) have a county.

hasPostalCodeboolean

Filter to addresses that do (true) or do not (false) have a postal code.

addressNotEmptyboolean

true keeps only addresses with at least one of state, city, postal code or county; false keeps only fully empty ones.

Response

totalintegerRequired

Total addresses in scope, the sum of byStatus.

byStatusAddressStatusCount[]Required

One entry per status present in scope. A status with no addresses is omitted rather than reported as zero.

200

Successful Response

400

The request was invalid.

401

Authentication failed or was missing.

403

The credential is not permitted for this request.

404

The requested resource was not found.

409

The request conflicts with existing state.

422

The request failed validation.

cURL

GET /addresses/summary?addressType={addressType}&country={country}&hasCountry={hasCountry}

-H "Api-Key: ***"

-H "Api-Version: 2026-07-21"

Example request

https://api.trykintsugi.com/addresses/summary?addressType={addressType}&country={country}&hasCountry={hasCountry}

Response

{

"total": 20,

"byStatus": [

{

"status": "UNVERIFIED",

"count": 12

}

]

}