IDを取得

get https://id.ap-northeast-1.cloud.japancv.co.jp/api/v1/identities/{userId}

IDの情報を取得します。

Responses

Response body

object

userId

string

required

length ≤ 255

ID（アイデンティティ）を指定するための一意のID

firstName

string | null

required

IDの名

lastName

string | null

required

IDの姓

type

int32

required

0 to 10

IDのタイプインジケーター。 0 はnullを表します。追加時にこのフィールドを指定しない場合は、テンプレートに設定されているデフォルトのタイプが自動的に適用されます。

string | null

required

IDのメールアドレス。nullでない場合は、一意である必要があります。

cardNo

string | null

required

アクセスで使用されるIDのICカードNo.

phoneCode

string | null

required

Defaults to null

IDの電話番号の国番号

+81 +1 +1-242 +1-246 +1-264 +1-268 +1-284 +1-340 +1-345 +1-441 +1-473 +1-649 +1-664 +1-670 +1-671 +1-684 +1-758 +1-767 +1-784 +1-868 +1-869 +1-876 +20 +211 +212 +213 +216 +218 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237 +238 +239 +240 +241 +242 +243 +244 +245 +246 +248 +249 +250 +251 +252 +253 +254 +255 +256 +257 +258 +260 +261 +262 +263 +264 +265 +266 +267 +268 +269 +27 +290 +291 +297 +298 +299 +30 +31 +32 +33 +34 +350 +351 +352 +353 +354 +355 +356 +357 +358 +358-18 +359 +36 +370 +371 +372 +373 +374 +375 +376 +377 +378 +379 +380 +381 +382 +383 +385 +386 +387 +389 +39 +40 +41 +420 +421 +423 +427 +43 +44 +44-1481 +44-1534 +44-1624 +45 +46 +47 +48 +49 +500 +501 +502 +503 +504 +505 +506 +507 +508 +509 +51 +52 +53 +54 +55 +56 +57 +58 +590 +591 +592 +593 +594 +595 +596 +597 +598 +599 +60 +61 +62 +63 +64 +65 +66 +670 +672 +673 +674 +675 +676 +677 +678 +679 +680 +681 +682 +683 +685 +686 +687 +688 +689 +690 +691 +692 +7 +82 +84 +850 +852 +853 +855 +856 +86 +870 +880 +886 +90 +91 +92 +93 +94 +95 +960 +961 +962 +963 +964 +965 +966 +967 +968 +970 +971 +972 +973 +974 +975 +976 +977 +98 +992 +993 +994 +995 +996 +998

phoneNumber

string | null

required

IDの電話番号の国番号、国番号を含めません

validFrom

date-time | null

required

IDの有効期間を指定する開始UTCタイムスタンプ。これは一部のソリューションサービスに適用されます。値はvalidToより小さい必要があります。

validTo

date-time

required

IDの有効期間を指定する終了UTCタイムスタンプ。これは一部のソリューションサービスに適用されます。値はvalidFromより大きい必要があります。

customized

array of objects

required

length ≤ 20

ユーザー定義のテンプレート項目リスト

customized*

object

name

string

required

length ≤ 255

ユーザー定義のテンプレート項目名

value

required

ユーザー定義のテンプレート項目値

groups

array of uuids

required

groups*

portrait

object

required

storeFace

boolean

required

顔認証用の顔データが登録されたかどうか

qualityCheck

boolean

required

品質チェックが実施されたかどうか

createdAt

date-time

required

IDが追加されたときのUTC時刻

updatedAt

date-time

required

IDが更新されたときのUTC時刻

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://id.ap-northeast-1.cloud.japancv.co.jp/api/v1/identities/ \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200取得のリクエストは成功しました。

401リクエストには、認証ヘッダーフィールドを含むユーザー認証情報が必要です。

404サーバーは要求されたリソースを見つかりできません。

405リクエストHTTPメソッドは無効になっており、そのリソースには使用できません。

413リクエスト本文は、サーバーによって定義された制限よりも大きいです。（画像ファイルは5MB以下）

414クライアントがリクエストしたURIがサーバーの処理制限よりも大きいです。（8k）

429ユーザーが指定された時間内に送信したリクエストが多すぎます。（プランの制限を参照してください）

431ヘッダーフィールドがサーバーの処理制限よりも大きいです。（25KB）

500サーバーで予期しない状態が発生したため、サーバーは要求を実行できません。

502サーバーは、リクエストを処理するために必要な応答を取得するためのゲートウェイとして機能しているときに、無効な応答を受け取りました。

503サーバーはリクエストを処理する準備ができていません。

504サーバーはゲートウェイとして機能しており、時間内にリクエストの応答を取得できません。