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

再利用可能なドキュメントの取得

MarkdownChatGPTClaude

このエンドポイントを使用して、新しいドキュメントキャプチャフローを開始する前に、ユーザーがすでに再利用可能なドキュメントを保有しているかどうかを確認します。ドキュメントが見つかった場合、その documentId を直接 POST /processes/v1（ドキュメントタイプ）に渡すことで、キャプチャステップを省略できます。

エンドポイント​

環境URL
本番GET https://api.idcloud.unico.app/documents/v1
サンドボックスGET https://api.idcloud.uat.unico.app/documents/v1

リクエスト​

ヘッダー
ヘッダー値
AuthorizationBearer <access_token>（認証を参照）
APIKEYドキュメントキャプチャと再利用が有効化されたプロビジョニング済みのAPIキー。
クエリパラメータ
パラメータ型必須説明
codestringはいユーザー識別子（CPFまたはCURP、フォーマットなし）。
typestringはい照会するドキュメントタイプ。受け入れ可能な値: BR_RG、BR_CNH、BR_CIN、BR_PASSPORT。
メモ

上記の type の値はこのエンドポイントに固有のものです。以下と混同しないでください:

  • POSTリクエストの subject.duiType — DUI_TYPE_* プレフィックスを使用し、ドキュメントタイプではなく人物を識別します（例: DUI_TYPE_BR_CPF）。
  • レスポンスの documentType — 完全なレジストリパスを使用します（例: unico.moja.dictionary.br.cnh.v2.Cnh）。

例​

curl -X GET "https://api.idcloud.unico.app/documents/v1?code=12345678909&type=BR_CNH" \
  -H "Authorization: Bearer $TOKEN" \
  -H "APIKEY: $API_KEY"

レスポンス​

200 OK
{
  "items": [
    {
      "documentType": "unico.moja.dictionary.br.cnh.v2.Cnh",
      "documentId": "doc-abc-123"
    }
  ]
}
フィールド型説明
itemsarrayユーザーに対して見つかった再利用可能なドキュメントのリスト。指定された code と type で再利用可能なドキュメントが見つからなかった場合は空配列。
items[].​documentTypestringドキュメントタイプ識別子。可能な値: unico.​moja.​dictionary.​br.​rg.​v2.​Rg、unico.​moja.​dictionary.​br.​cnh.​v2.​Cnh、unico.​moja.​dictionary.​br.​cin.​v1.​Cin、unico.​moja.​dictionary.​br.​passaporte.​v1.​Passaporte。
items[].documentIdstringドキュメント識別子。ドキュメントを再利用するには、この値を POST /processes/v1 の document.documentId に渡してください。

再利用のための documentId の使用​

documentId を取得したら、それをドキュメントプロセスリクエストに渡してキャプチャを省略します:

{
  "subject": {
    "code": "12345678909",
    "name": "Luke Skywalker"
  },
  "document": {
    "purpose": "onboarding",
    "authProcessId": "<biometric-process-id>",
    "documentId": "doc-abc-123"
  }
}
フィールド説明
document.purposeこのドキュメントプロセスのビジネス目的。受け入れ可能な値: creditprocess、carpurchase、paybypaycheck、onboarding、fgts。これらの値はDocument API固有のものであり、生体認証SDKの purpose enumとは異なります。
document.​authProcessIdこのユーザーに対して以前に作成された生体認証プロセスのID（POST /processes/v1 から）。
document.documentIdこのエンドポイントのレスポンスから取得したドキュメントID。指定された場合、document.files は省略できます — プラットフォームが以前にキャプチャされたドキュメントを自動的に取得します。

エラーコード​

コードメッセージ説明
20507O parâmetro subject.code é inválido.識別子の値（CPFまたはCURP）が不正な形式または存在しない場合。
20002O parâmetro APIKey não foi informado.APIKEYヘッダーが欠落している場合。
20001O parâmetro authtoken não foi informado.認証トークンヘッダーが欠落している場合。
最終更新 に