概要
API URL:
/api/v1/zoloz/idnetwork/get
API の説明: レコードの詳細を照会するために使用される機能を提供します。
構造
リクエストパラメーター
パラメーター | データ型 | 最大長 | 説明 | 例 |
itemId | String | 64 | 必須。照会するレコード ID。これは、渡された時点での IDN から返されたデータレコード ID です。 | "AIN20220725875271649639" |
レスポンスパラメーター
パラメーター | データ型 | 説明 | 例 |
result | Result | 結果コード、結果ステータス、および結果メッセージを含む API リクエスト結果。 | { "resultStatus":"S", "resultCode":"SUCCESS", "resultMessage":"Success" } |
transactionId | String | IDN によって生成される一意のビジネス ID。 | "8365364ceddd411da027cdb15fea92ed" |
imageInfo | ImageInfo | 返されたイメージに関する情報です。詳細については、「ImageInfo」をご参照ください。 | { "docImage":"eA3AW/6dxn6QAAAABJRU5ErkJggg==...", "faceImage":"p+AY/b2OF/F1CxAAAAAElFTkSuQmCC..." } |
basicInfo | BasicInfo | 返される基本情報です。詳細については、「BasicInfo」をご参照ください。 | { "idType":"00000001003", "idNumber":"4608211987081189**", "certName":"Tom", "dateOfBirth":"19870811" } |
userId | String | 加盟店定義のユーザー ID。 | "e9830710-0d70" |
createTime | String | レコードが作成された日時。13 桁のタイムスタンプを使用します。 | "1660728158749" |
ImageInfo
フィールド | データ型 | 説明 | 例 |
docImage | String | オプション。ID 画像を返します。 | "eA3AW/6dxn6QAAAABJRU5ErkJggg==..." |
faceImage | String | オプション。顔画像を返します。 | "p+AY/b2OF/F1CxAAAAAElFTkSuQmCC..." |
BasicInfo
フィールド | データ型 | 説明 | 例 |
idType | String | ドキュメントの種類を指定します。 | "00000001003" |
certName | String | 名前。 | "Tom" |
idNumber | String | ID 番号。 | "4608211987081189**" |
dateOfBirth | String | 生年月日。 | "19870811" |
サンプル
リクエストサンプル
POST https://ip:port/api/v1/zoloz/idnetwork/get
# POST 本文:
{
"itemId":"AIN20220725875271649639"
}
レスポンスサンプル
コピー
# レスポンス本文
{
"result":{
"resultStatus":"S",
"resultCode":"SUCCESS",
"resultMessage":"Success"
},
"transactionId":"8365364ceddd411da027cdb15fea92ed",
"imageInfo":{
"docImage":"eA3AW/6dxn6QAAAABJRU5ErkJggg==...",
"faceImage":"p+AY/b2OF/F1CxAAAAAElFTkSuQmCC..."
},
"basicInfo":{
"idType":"00000001003",
"idNumber":"4608211987081189**",
"certName":"Tom",
"dateOfBirth":"19870811"
},
"userId":"e9830710-0d70",
"createTime" : "1660728158749"
}