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

承認

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

ボディ

multipart/form-data
document
file
必須

住所証明の書類です。使用できる拡張子:tiff、jpg、jpeg、png、pdf、webp。最大アップロードサイズ:15 MB(これを超えるファイルは400で拒否されます)。複数ページのPDFに対応しています(レイテンシは長くなります)。暗号化されたPDFにはdocument_passwordが必要です。画像は処理前に自動的に圧縮されます。

document_password
string
write-only

documentが暗号化されたPDFの場合に復号するためのパスワード。暗号化されたPDFをパスワードなし(または誤ったパスワード)で送信すると400が返ります。

expected_address
string

書類と照合する住所です。ジオコーディングされたうえで、抽出された住所と比較されます。一致しない場合(または想定住所をジオコーディング・検証できない場合)はADDRESS_MISMATCH_WITH_PROVIDEDが追加され、その扱いはpoa_address_mismatch_actionで制御されます。ジオコーディング後の形式はexpected_details_formatted_address / expected_details_parsed_addressで返されます。

例:

"Av. Monseñor Tavella 1291, Salta, Argentina"

expected_country
string

書類と照合する国(ISO 3166-1コード、例: ARGまたはAR)。書類の国と一致しない場合はPOA_COUNTRY_MISMATCH_WITH_PROVIDEDが追加され、その扱いはpoa_address_mismatch_actionで制御されます。

例:

"ARG"

expected_first_name
string

name_on_documentと照合する名です(音訳を考慮したあいまい一致)。スコアが一致しきい値を下回るとNAME_MISMATCH_WITH_PROVIDEDが追加され、poa_address_mismatch_actionに従って処理されます。

例:

"Sophia"

expected_last_name
string

name_on_documentと照合する姓。expected_first_nameと組み合わせて一致スコアを算出します。

例:

"Martinez"

poa_languages_allowed
string

受け付ける書類の言語をISO 639-1コードで指定するカンマ区切りのリスト(例:en,es,fr)。省略した場合または空欄の場合は、サポートされている51言語すべてを受け付けます。リストに含まれない言語の書類にはUNSUPPORTED_DOCUMENT_LANGUAGEが付与されます(poa_unsupported_language_actionで制御)。リストに不明なコードが含まれている場合は、サポートされているコードの一覧とともに400が返されます。

例:

"en,es"

poa_document_age_months
string

書類の種類ごとに書類の最大経過月数を設定する、カンマ区切りのkey:valueペア。キー: utility_bill、bank_statement、government_issued_document、other_poa_document。値: 1~120、または無制限(経過期間チェックなし)の場合は-1。省略時のデフォルト: utility_bill:3,bank_statement:3,government_issued_document:12,other_poa_document:12。上限より古い書類はPOA_DOCUMENT_EXPIREDで却下されます。注意: このフィールドを指定する場合は、受け付けるすべての種類を列挙してください。省略した種類は受け付けないものとして扱われ(情報コードPOA_DOCUMENT_NOT_SUPPORTED_FOR_APPLICATION)、その経過期間チェックはスキップされます。

例:

"utility_bill:3,bank_statement:6"

poa_name_mismatch_action
enum<string>
デフォルト:DECLINE

受け付けられますが、現在適用されていません。名前不一致の警告(NAME_MISMATCH_WITH_PROVIDED)は、代わりにpoa_address_mismatch_actionに従います。名前と住所の両方の不一致時の動作を制御するには、poa_address_mismatch_actionを設定してください。

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

ファイルの完全性に問題がある場合の処理です。実際には、このエンドポイントで生成されるのはDOCUMENT_METADATA_MISMATCHのみです。

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

書類の改ざんが疑われる場合の処理です(SUSPECTED_DOCUMENT_MANIPULATION)。たとえば、PDFがデジタル署名後に変更された、既知のPDF編集ソフトで処理された、オーバーレイテキストによる改ざんが見られる、EXIFの日付に矛盾がある、といったケースです。

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

書類の言語がpoa_languages_allowedに含まれない場合の処理です(UNSUPPORTED_DOCUMENT_LANGUAGE)。

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

抽出した情報がexpected_*フィールドと一致しない場合の対応です。ADDRESS_MISMATCH_WITH_PROVIDED、NAME_MISMATCH_WITH_PROVIDED、POA_COUNTRY_MISMATCH_WITH_PROVIDEDはいずれもこのアクションに従います。

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

書類上で発行元の会社または組織を特定できない場合の処理です(ISSUER_NOT_IDENTIFIED)。

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

true(デフォルト)の場合、呼び出しはAPIタイプのセッションとして保存されます。このセッションはBusiness Consoleに表示され、返されたrequest_idを使ってGET /v3/session/{sessionId}/decision/で取得でき、status.updatedWebhookで通知され、アップロードされた書類が保存されます。falseの場合、何も保存されず、request_idはレスポンスの照合専用の一時的なUUIDになります。

例:

true

vendor_data
string

任意の不透明な文字列(社内のユーザーID、メールアドレス、UUIDなど)です。保存されたセッションに格納され、レスポンスでそのまま返されます。API呼び出しを自社の記録と関連付けたり、後でセッションを絞り込んだりするために使用します。

例:

"user-123"

metadata
object

セッションとともに保存され(save_api_request=trueの場合)、レスポンスでそのまま返される任意のJSONオブジェクトです。マルチパートリクエストでは、JSONエンコードされた文字列フィールドとして送信してください(例: metadata={"flow":"onboarding"})。オブジェクトとして解析されます。

例:

レスポンス

書類が処理されました。poa.statusはApprovedまたはDeclinedで、検出されたすべての問題はpoa.warningsに個別に列挙されます。期限切れ、不一致、または不審な書類でもstatus: "Declined"とともに200が返されるため、HTTPコードだけでなくボディを確認してください。save_api_request=trueの場合、request_idは永続化されたセッションIDです。

request_id
string<uuid>

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

poa
object
vendor_data
string | null

送信したvendor_dataのエコー、またはnull。

metadata
object | null

送信したmetadataオブジェクトのエコー、またはnull。

created_at
string<date-time>

レスポンスが生成された日時を示すISO 8601タイムスタンプ(UTC)。

最終更新日 2026年11月1日