メインコンテンツへスキップ
POST
curl

住所ベースのサービス

居住地の住所や公共料金の請求先住所を検証するサービスでは、単一のaddressを送信でき、Diditがチェックの処理前にそれを分割します。最も高い一致率を得るには、構造化されたDiditの住所フィールドを直接送信してください。 構造化フィールドは単一のaddressの値より優先されます。postal_codeはaddress_element_5のエイリアスとして受け付けられます。

同意

一部のデータベースサービスでは、プロバイダーへの照会前にエンドユーザーの明示的な同意が必要です。サービスカタログでは、これらの行にrequires_consent=trueが付いています。 選択したサービスに対するユーザーの同意がある場合は、consent=trueを送信してください。 選択したサービスが同意を必要とするのにそれを送信しなかった場合、Diditはプロバイダーへの呼び出しや請求が発生する前にリクエストを拒否します。

ファイルのアップロード

データベース検証ではmultipart/form-dataを使用します。selfieを必要とする生体認証サービスでは、APIプレイグラウンドでこれがファイルアップロードフィールドとして表示されるため、パスやbase64文字列を貼り付ける代わりに画像を直接選択できます。 コードでは、通常のmultipart構文でファイルをアップロードします。

検証エラー

Diditは、プロバイダーを呼び出す前に、必須フィールド、住所の構造、サービス固有の形式を検証します。たとえば、chn_national_idやchn_passport_verificationなどの中国の登録情報サービスでは、full_nameを元の中国語表記で指定する必要があります。また、chn_national_idでは、チェックサムが正しい15桁または18桁の有効な中国の身分証番号も必要です。 リクエストを実行できない場合、APIは明示的なフィールドエラーを返し、利用料金は請求されません。事前チェックの通過後にプロバイダーが失敗した場合、レスポンスにはvalidation_errorsが含まれ、保存されたAPIリクエストでは、それらのエラーがデータベースの検証結果に保存されます。

拒否された入力と利用できない結果

どのサービスも利用可能な結果を返さなかった場合は、再試行するかどうかを判断する前に、validation_errorsの各エントリを確認してください。 HTTPステータスだけでは、再試行が適切かどうかは判断できません。 code: "provider_rejected_input"とretryable: falseを含む400レスポンスは、結果が返されなかったすべての試行で入力が明示的に拒否されたことを意味します。 再試行する前に、送信したデータを修正してください。 これらの試行は請求されません。 code: "empty_provider_response"とretryable: trueを含む502レスポンスは、別の理由によりサービスが利用可能な結果を生成できなかったことを意味します。 これには、入力が拒否された後にフォールバックが利用できなかった場合や、フォールバックが理由を示さなかった場合が含まれます。 時間をおいて再試行してください。このレスポンスは、入力が誤っていることを示すものではありません。 データベースで障害が続く場合、Diditは障害が継続していると判断した時点で、そのデータベースを最近利用した組織にメールで通知し、実際のチェックで応答が確認された時点で再度通知します。詳しくは可用性の通知を参照してください。 選択したサービスの一部のみが失敗した場合、リクエストは成功として扱われます。レスポンスは200となり、失敗したサービスはdatabase_validation.errors[]の下に、それぞれ同じcodeおよびretryableフィールドとともに一覧表示されます。 この場合、database_validation.statusは応答したサービスの結果に従い、Approvedになることもあります。そのため、4xxや5xxの場合だけでなく、すべてのレスポンスでerrors[]を確認してください。 そこに記載されたサービスはvalidationsとservices_usedには含まれず、請求もされません。そのサービスのみを個別に再試行してください。 その他の502エラーでは、入力の修正が必要になる場合があります。 たとえば、provider_invalid_inputとprovider_validation_errorは情報源が拒否した入力を示しており、従来のレスポンスでretryableが省略されている場合でも、変更しないまま再試行してはなりません。 empty_provider_responseに関する再試行のガイダンスは、これらのコードには適用されません。 一致なしという確定的な結果は完了したチェックであり、可用性の障害ではありません。

承認

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

ボディ

issuing_state
string
必須

照合先レジストリのISO 3166-1 alpha-3国コード(例: BRA、ESP、COL)。利用可能なサービスはこれによって決まります。サポートされていないコードは、有効な選択肢の完全な一覧とともに400を返します。

例:

"BRA"

services
string[]

この国で実行するカタログのservice_id(例: ["bra_cpf"])。単一の文字列、またはカンマ区切りやJSONエンコードされた文字列も受け付けます。省略した場合または空の場合は、デフォルトのサービスが1つだけ実行されます。これはその国で最も長く提供されている稼働中のサービスです。新しいサービス、生体認証サービス、従量課金サービスは明示的に指定する必要があります。servicesを送信すると、レスポンスが拡張形式に切り替わります(services_usedとmatch_scoreが追加されます)。すべてのIDが存在し、かつissuing_stateで稼働している必要があります。オンボーディングが必要なサービスは、組織で有効化されるまで400を返します。国ごとに利用可能なサービスは、GET /v1/organization/database-validation-countries/(この仕様には記載されていないカタログエンドポイント)またはBusiness Consoleのワークフローエディターで確認できます。

例:
validation_type
string
非推奨

非推奨。後方互換性のため受け付けますが、無視されます。レスポンスのvalidation_typeは、完全一致したサービスの数から算出されるようになりました。特定のサービスを指定するにはservicesを使用してください。

エンドユーザーが選択した検証サービスに明示的に同意した場合はtrueに設定します。カタログでrequires_consent=trueとフラグ付けされたサービスでは必須です。指定しない場合、それらのサービスはservices_requiring_consentを含む400を返します。

identification_number
string

汎用の識別番号です。国ごとの正しいフィールドに自動的にマッピングされるため、personal_number/tax_number/document_numberの代わりに使用できます:ARG→document_number (DNI)、BOL→document_number (CI)、BRA→tax_number (CPF、11桁)、CHL→personal_number (RUT)、COL→personal_number (Cédula)、CRI→personal_number (Cédula)、DOM→personal_number (Cédula、11桁)、ECU→personal_number (Cédula、10桁)、ESP→personal_number (DNI/NIE)、GTM→document_number (DPI)、HND→document_number (DNI)、MEX→personal_number (CURP、18文字)、PAN→personal_number (Cédula)、PER→personal_number (DNI、8桁)、PRY→document_number (CI)、SLV→document_number (DUI)、URY→personal_number (CI)、VEN→document_number (Cédula)。明示的に指定された国別フィールドを上書きすることはありません。

first_name
string

個人の名です。一部のサービスや国で必須です。

例:

"John"

last_name
string

個人の姓です。一部のサービスや国で必須です。

例:

"Doe"

middle_name
string

ミドルネーム。一部の国のサービス(AUS、NZL、…)で使用されます。

full_name
string

氏名。一部のサービスでは、名と姓の代わりにこれを受け付けます(例:ネイティブ表記の氏名で照合するCHNのサービス)。

date_of_birth
string<date>

生年月日(YYYY-MM-DD)。多くのサービスで必須です。

例:

"1980-01-01"

personal_number
string

政府が発行する固有の個人識別番号。使用国: CHL(RUT)、COL(Cédula)、CRI、DOM、ECU、ESP(DNI/NIE)、MEX(CURP)、PAN(Cédula)、PER(DNI)、URY。代わりにidentification_numberの使用を検討してください。

tax_number
string

納税者番号。使用国: BRA(CPF、11桁)。代わりにidentification_numberの使用を検討してください。

document_number
string

書類番号。使用する国: ARG(DNI)、BOL(CI)、GTM(DPI)、HND(DNI)、PRY(CI)、SLV(DUI)、VEN(Cédula)。代わりにidentification_numberの使用を検討してください。

document_type
enum<string>

検証対象の書類の種類:Pはパスポート、DLは運転免許証、IDは国民IDカード、RPは在留許可証(ほかにSSC、HIC、WP、TC、VISA、PSC、BC、OTHER)。一部のサービス(例:ESP)で必須です。

利用可能なオプション:
P,
DL,
ID,
RP,
SSC,
HIC,
WP,
TC,
VISA,
PSC,
BC,
OTHER
expiration_date
string<date>

書類の有効期限(YYYY-MM-DD)。ESP(スペイン)の検証に必須です。

例:

"2030-01-15"

date_of_issue
string<date>

書類の発行日(YYYY-MM-DD、fecha de expedición)。COL(コロンビア)のcédula検証に必須です。

例:

"2015-06-20"

nationality
string

ISO 3166-1 alpha-3形式の国籍。一部のサービスでは必須です。

gender
enum<string>

性別:M、F、またはX(その他/不明)。アルゼンチンのRENAPER検証(arg_renaper)で必須です。

利用可能なオプション:
M,
F,
X
address

居住住所です。構造化オブジェクト{"street_1":"123 Main St","street_2":"Apt 4B","city":"Springfield","region":"IL","postal_code":"62701","country":"US"}を推奨しますが、完全な1行の文字列も引き続き受け付けられます。住所検証サービスでは必須です。サービスが住所の要件を定義している場合、不足している項目があるとaddress_fields_required_byを含む400が返されます。

address_element_1
string

番地と通りの種別を含む通りの住所。省略した場合はaddressから導出されます。

address_element_2
string

部屋番号、ユニット、建物、階、または追加の住所行。明示的に把握している場合にのみ送信してください。

address_element_3
string

市区町村、郊外、地区、地域、または近隣地区。省略した場合はaddressから導出されます。

address_element_4
string

州、県、地域、または町。省略した場合はaddressから導出されます。

address_element_5
string

郵便番号。postal_codeもエイリアスとして受け付けます。

postal_code
string

住所ベースのサービスで使用する郵便番号(address_element_5のエイリアス)。

driver_license_number
string

政府の書類検証サービス(AUS、NZL、IND)向けの運転免許証番号。

driver_license_card_number
string

運転免許証番号とは別に必要な場合の、物理的な運転免許証カードの番号(AUS)。

driver_license_state
string

運転免許証の発行州または準州(AUS)。

driver_license_version
string

運転免許証のバージョンコード(NZL)。

passport_number
string

政府のパスポート検証サービス(AUS、NZL、IND、CHN)で使用するパスポート番号。

passport_expiration_date
string<date>

パスポートの有効期限(YYYY-MM-DD)。パスポート検証サービスで使用します。

passport_file_number
string

パスポートのファイル番号(IND)。

passport_issue_country
string

パスポート検証サービスで使用する、パスポートの発行国(ISO 3166-1 alpha-3)です。

medicare_card_number
string

Medicareカード番号(オーストラリア)です。

immi_card_number
string

オーストラリアのImmiCardの番号。

immi_card_expiry_date
string<date>

オーストラリアのImmiCardの有効期限。

citizenship_certificate_number
string

市民権証明書番号(AUS)。

birth_registration_number
string

出生証明書の登録番号(AUS)。

birth_registration_date
string<date>

出生証明書の登録日(AUS)。

birth_registration_state
string

出生証明書の登録州(AUS)。

marriage_certificate_number
string

婚姻証明書番号(AUS)。

change_of_name_certificate_number
string

改名証明書番号(AUS)。

first_partner_name
string

結婚証明書に記載された配偶者の名(AUS)。

last_partner_name
string

婚姻証明書に記載されたパートナーの姓(AUS)。

voter_id
string

有権者登録番号(IND EPIC、IRL)。

epic_card
string

インドのEPIC有権者カード番号。

pan
string

インドのPAN(Permanent Account Number)。

national_id
string

国民ID番号(CHN、MYS、KEN、KHM、NGA、ZAF、…)。

cic
string

メキシコINE/IFEのCódigo de Identificación de Credencial(CIC)、9桁。メキシコINE資格証有効性確認サービス(mex_ine_vigencia)で使用します。

identificador_ciudadano
string

メキシコINEのIdentificador del Ciudadano(9桁)。mex_ine_vigenciaで、現行INEモデル(E/F/G/H)に対してcicと組み合わせて使用します。

ocr
string

メキシコINEのOCR番号(13桁、カード裏面)。mex_ine_vigenciaで、モデルDに対してcicと組み合わせて使用します。

voter_number
string

メキシコINEのClave de Elector(18文字)。mex_ine_vigenciaで、旧IFEモデル(A/B/C)に対してemission_numberと組み合わせて使用します。

emission_number
string

メキシコINEのNúmero de Emisión。mex_ine_vigenciaで、旧IFEモデル(A/B/C)に対してvoter_numberと組み合わせて使用します。

bvn
string

ナイジェリアの銀行認証番号(Bank Verification Number)。

bank_card_number
string

銀行カード番号(CHNの銀行カード認証)。

company_registration_number
string

会社登記所が発行した会社の登記番号です。ブラジルではCNPJ(例:11222333000181)、南アフリカでは登記番号(例:1936/007721/06)が該当します。法人登記サービスおよび会社取締役サービス(bra_company_registry、bra_company_directors、zaf_company_registry、zaf_company_directors)で必須です。

company_name
string

登記されている企業名で、登記簿の記載と照合されます。zaf_company_registryでは省略可能です。

initials
string

書類に印字されているこの人物のイニシャルです。zaf_drivers_licenseでは必須で、zaf_bank_account_holderでも指定できます。

licence_number
string

zaf_drivers_license用の、カードに記載されている運転免許証番号。省略した場合はdocument_numberが使用されます。

refugee_file_number
string

南アフリカ内務省(Department of Home Affairs)が発行する難民ファイル番号。zaf_refugeeで必須です。

bank_name
string

口座を保有する銀行の名称。zaf_bank_account_holderで必須です。

bank_account_number
string

銀行口座番号。zaf_bank_account_holderでは必須で、zaf_fraud_preventionでも指定できます。

account_type
string

zaf_bank_account_holder用の銀行口座種別です。current、savings、transmission、subscriptionShareまたはnotKnownのいずれかで、大文字と小文字は区別されません。それ以外の値を指定すると400が返されます。種別が不明な場合は省略してください。その場合、口座種別の照合結果は未確認として報告されます。

phone_number
string

連絡先の携帯電話番号。連絡可能性を照合するサービス(zaf_bank_account_holder、zaf_fraud_prevention、zaf_refugee)で使用されます。

right_thumb
string

zaf_dha_fingerprint_match用の、Base64エンコードされた右手親指の指紋です。left_thumbと併用するか、単独で指定します。

left_thumb
string

zaf_dha_fingerprint_match用の、Base64エンコードされた左手親指の指紋です。right_thumbと併用するか、単独で指定します。

score_level
integer

zaf_criminal_face_screeningの生体認証スコアレベルの最小値。デフォルトは3です。

max_matches
integer

zaf_criminal_face_screeningが返す候補一致の最大数です。デフォルトは1です。

vehicle_register_number
string

車両登録番号。zaf_vehicle_ownershipでは、vehicle_licence_plateおよびvinとともに必須です。

vehicle_licence_plate
string

車両のナンバープレート番号。zaf_vehicle_ownershipでは、vehicle_register_numberおよびvinとともに必須です。

vin
string

車両識別番号(VINまたは車台番号)。zaf_vehicle_ownershipでは、vehicle_register_numberおよびvehicle_licence_plateとともに必須です。

ssn
string

社会保障番号(米国)。

phone
string

電話番号検証サービス用の電話番号。

landline
string

電話番号検証サービス用の固定電話番号。

email
string<email>

本人確認サービス用のメールアドレス。

country_of_residence
string

居住国を示すISO 3166-1 alpha-2コード。グローバルなID情報エンリッチメントサービス(例: glb_identity_enrichment)が照会対象を絞り込むために使用します。

例:

"US"

partial_match_action
enum<string>
デフォルト:NO_ACTION

partial_matchの場合にdatabase_validation.statusがどうなるか。デフォルトはNO_ACTIONです(ステータスはApprovedのままで、警告が付きます)。

利用可能なオプション:
DECLINE,
NO_ACTION
no_match_action
enum<string>
デフォルト:DECLINE

no_matchの場合にdatabase_validation.statusがどうなるか。デフォルトはDECLINEです。

利用可能なオプション:
DECLINE,
NO_ACTION
save_api_request
boolean
デフォルト:true

検証をセッションとして保存します(コンソールでの表示、判定エンドポイント、status.updatedのWebhook)。validationsレスポンスの形式も変わります。true(デフォルト)の場合はサービスごとのオブジェクト、falseの場合は統合されたフィールドマップになります。

vendor_data
string

検証対象ユーザーに対するお客様側の識別子です。そのまま返され、セッションとともに保存されます。

metadata
object | null

リクエストとともに保存され、そのまま返される自由形式のJSON。

レスポンス

検証完了。選択したサービスのうち少なくとも1つが利用可能な結果を返しました。集約された結果はdatabase_validation.match_type、サービスごとのフィールド比較とoutcome_codeはvalidations、失敗したサービスはerrors(存在する場合)で確認してください。

request_id
string<uuid>

save_api_request=trueの場合は保存されたセッションID(GET /v3/session/{sessionId}/decision/で使用可能)、それ以外の場合は一時的な相関UUIDです。

database_validation
object
vendor_data
string | null

送信したvendor_dataをそのまま返します。

metadata
object | null

送信したmetadataのエコー。

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