メインコンテンツへスキップ
POST
curl
Diditの住所検証APIは、郵便住所が実在することを確認し、配送先住所行、住所の構成要素、座標とともに正規化された形で返します。バックエンドが保持している住所について、実在するかどうか、また正規化するとどのような形になるかを知る必要がある場合は、POST /v3/address-validation/を使用します。 住所検証が確認するのは住所のみです。住所を人物と紐付けることは決してありません。verifiedという結果は、その場所が実在することを意味し、誰かがそこに住んでいることを意味するものではありません。

住所を送信する

住所はaddressに1行で送信するか、構造化されたフィールドとして送信してください。構造化する場合はaddress_line_1と、利用可能であればaddress_line_2、city、region、postal_codeを使用します。 1つのリクエストで両方の形式を送信しないでください。 countryは常に必須で、ISO 3166-1 alpha-2またはalpha-3コードで指定します。

レスポンスを解釈する

  • address_validation.statusは、以降の処理の基準となる結果です。
    • verified: 住所が建物(または部屋や私書箱)の単位まで確認されました。
    • partially_verified: 通りの単位まで、またはその場所について郵便参照データが保持する最も詳細なレベルまでしか確認されませんでした。
    • not_verified: 一致したのは地域または都市のみであるか、何も一致しませんでした。
    • unavailable: 検証を実行できませんでした。後で再試行してください。
  • address_validation.verification_levelは、一致した最も詳細なレベルで、administrative_area、locality、thoroughfare、premise、delivery_pointのいずれかです。
  • address_validation.addressとaddress_validation.formatted_addressには、その国の表記方法に従って正規化された住所が格納されます。
  • address_validation.latitudeとaddress_validation.longitudeは、一致した住所の位置を示します。
  • request_idはリクエストを識別します。セッションは作成されず、結果はこのレスポンスでのみ返されるため、必要な情報は保存してください。
HTTPステータスは、unavailableを含め、完了したすべてのリクエストで200です。

ワークフロー内での住所検証

同じチェックは、本人確認および住所証明のワークフローステップのアドオンとしても利用できます。 ステップの設定でaddress_validation_enabledを有効にすると、本人が提供した住所(本人確認書類または住所証明書類に記載されたもの)が、アップロードされた書類が読み取られると検証されます。 結果は、セッションの判定におけるそのステップのエントリ(id_verifications[]またはpoa_verifications[])のaddress_validationオブジェクトに格納されます。 partially_verifiedまたはnot_verifiedの住所はADDRESS_NOT_VERIFIED警告を発生させます。その警告のアクションはステップのaddress_not_verified_actionです(デフォルトはNO_ACTIONで、警告を記録するだけです)。 unavailableの検証がこの警告を発生させることはなく、認証結果を変えることもありません。

サンドボックスでの動作

サンドボックスキーはリクエストを検証し、送信したアドレスをそのまま返す決定論的なverified結果を常に返します。クレジットは消費しません。

請求

住所検証APIの呼び出しは、検証された住所1件あたり$0.10です。 `unavailable`の結果は課金されません。 ワークフローでは、アドオンの料金はステップが検証した住所1件あたり$0.10です。

承認

x-api-key
string
header
必須

お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権(なし、読み取り、書き込み)、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys

ボディ

application/json

住所1件。1行(address)、または少なくともaddress_line_1を含む構造化フィールドのいずれかで指定します。両方を指定することはできません。

country
string
必須

住所の国を示すISO 3166-1 alpha-2またはalpha-3コード。

Maximum string length: 3
例:

"US"

address
string

1行で表した住所全体。

Maximum string length: 500
例:

"Paseo de la Castellana 259, 28046 Madrid"

address_line_1
string

通り名と番地。

Maximum string length: 255
例:

"1600 Amphitheatre Pkwy"

address_line_2
string

部屋番号、スイート、階、または建物名。

Maximum string length: 255
city
string

都市または地域。

Maximum string length: 128
例:

"Mountain View"

region
string

州、県、または地域。

Maximum string length: 128
例:

"CA"

postal_code
string
Maximum string length: 32
例:

"94043"

レスポンス

検証が完了しました。address_validation.statusを確認してください。完了したリクエストのHTTPステータスは常に200です。

request_id
string<uuid>
必須

このリクエストの識別子です。サポートへの問い合わせ時に伝えてください。セッションは作成されません。

address_validation
object
必須

1件のAddress Validationの結果です。住所が存在するかどうかと、その正規化された形式を示します。住所の確認のみを行い、住所を個人と紐付けることはありません。

created_at
string<date-time>
必須
最終更新日 2026年11月1日