Address Check API

When to use this API

Address Check API helps standardize user-provided addresses and detect quality issues before the data enters fulfillment or billing systems. It returns provider-backed normalization, confidence and precision signals for operational review, not guaranteed postal deliverability or legal address confirmation.

• You need consistent address quality before shipping or invoicing.
• You want to reduce manual correction of customer addresses.
• You need structured address output for storage and matching.

Typical use cases

• Checkout address validation.
• Address normalization during CRM import.
• Data quality gates in fulfillment workflows.

Billing and APIRAPTOR token model

Address Check usage is metered per provider-backed address check through the `address_check` service billing event.

• Tokens are the APIRAPTOR communication unit: 1 token = 100 subtokens.
• Trial availability, token amount and duration come from Billing configuration.
• All services are available from day one; Address Check is not premium-gated per plan.
• This is service billing event metering, not ordinary API-call billing.

Result boundary

Address Check returns provider-dependent address quality signals for operational workflows.

• It does not guarantee postal deliverability, legal address confirmation, residence or business-location proof.
• Confirmed/probable/ambiguous/not_found statuses should be read together with confidence and precision.
• Provider availability and locale coverage affect normalization depth and result certainty.

Sync and async usage

Sync and async requests use the same canonical Address Check POST endpoint.

• Sync uses POST /v1/address-check with mode=sync, or the default sync mode when omitted.
• Async create uses POST /v1/address-check with mode=async.
• Jobs endpoints are used for status/result metadata, not job creation. File artifacts are returned as file_id values for authenticated API download or signed URLs when direct download is enabled, and generated file artifacts are deleted automatically no later than 48 hours after creation.