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

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

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

エンドポイント​

環境URL
本番GET https://api.id.unico.app/documents/v1
サンドボックスGET https://api.id.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.id.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 にこの値を渡してください。
403 Forbidden

Bearerトークンまたは APIKEY が欠落、期限切れ、または無効です。

429 Too Many Requests

レート制限に達しました。Retry-After レスポンスヘッダーに示された間隔の後に再試行してください。レート制限を参照してください。

再利用のための 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 列挙型とは異なります。
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.認証トークンヘッダーが欠落しています。
最終更新 に