メインコンテンツへスキップ
プロセスの取得GET

識別子によって既存のプロセスを取得します。APIコントラクトにより、結果はプロセス作成時に同期的にすでに返されています — このエンドポイントは再照会、監査、サポート用に使用してください。

MarkdownChatGPTClaude
警告

プロセスを取得する前に、Webhookの設定とフォールバック戦略を確認してください — こちらをクリック。

エンドポイント​

環境URL
本番GET https://api.idcloud.unico.app/client/v1/process/{processId}
サンドボックスGET https://api.idcloud.uat.unico.app/client/v1/process/{processId}

リクエスト​

ヘッダー
ヘッダー値
AuthorizationBearer <access_token>
パスパラメータ
パラメータ型必須説明
processIdstring (UUID)はいプロセスの作成が返すプロセス識別子。

例​

curl -X GET https://api.idcloud.unico.app/client/v1/process/$PROCESS_ID \
  -H "Authorization: Bearer $TOKEN"

レスポンス​

200 OK
{
  "process": {
    "id": "226fd950-4b80-4da6-a476-ba9d397ddc91",
    "flow": "id_r2",
    "callbackUri": "/",
    "userRedirectUrl": "https://cadastro.uat.unico.app/flow?collect-data=true&dynamic-wrapper=true&id=226fd950-4b80-4da6-a476-ba9d397ddc91",
    "state": "PROCESS_STATE_FINISHED",
    "result": "PROCESS_RESULT_APPROVED",
    "createdAt": "2026-08-06T01:42:21.693615Z",
    "finishedAt": "2026-08-06T01:43:03.080508Z",
    "person": {
      "duiType": "DUI_TYPE_BR_CPF",
      "duiValue": "40*******50",
      "friendlyName": "teste",
      "email": "",
      "phone": "5511999999999",
      "notifications": [
        { "notificationChannel": "NOTIFICATION_CHANNEL_WHATSAPP" }
      ],
      "phoneCountryCodeAlpha3": ""
    },
    "purpose": "personAuthentication",
    "services": [],
    "authenticationInfo": { "authenticationId": "55cba227-9828-49df-a16f-bcdaa7bdaa4d" },
    "capacities": ["PROCESS_CAPACITY_IDCLOUDONE"],
    "expiresAt": "2026-08-13T01:42:21.536500Z",
    "token": "",
    "companyData": { "branchId": "", "countryCode": "BRA" },
    "simulated": false
  }
}
プロセスのフィールド
フィールド意味
idプロセスUUID。フローを照会・追跡するためのキー。
flow実行されたジャーニーのタイプ（例: id_r2、idlivetrust_r2、idtrust_r2、...）。
callbackUriフローの終了時にクライアントアプリがリダイレクトされるコールバックURI。
userRedirectUrlユーザーがジャーニーを実行するために開く Web Journey ページの完全なURL（id と挙動フラグを保持）。
stateプロセスのライフサイクル状態。PROCESS_STATE_* の値（例: CREATED、FAILED、FINISHED、AWAITING_FOR_DOCUMENT、UNSPECIFIED）。
result評価の最終判定。PROCESS_RESULT_* の値（例: APPROVED、AUTHENTICATED、NOT_APPROVED、...）。state = PROCESS_STATE_FINISHED の場合のみ確定します。
createdAtプロセス作成のタイムスタンプ（UTC）。
finishedAtプロセス完了のタイムスタンプ（UTC）。
person検証対象の人物のデータを含むサブオブジェクト。
purposeプロセスの目的（例: personAuthentication、本人登録）。
servicesプロセスに付随する追加サービスのリスト。ない場合は空。
authenticationInfo.​authenticationIdフローによって生成された本人認証イベントのID。
capacities使用されたケイパビリティ/製品。PROCESS_CAPACITY_* の値（例: IDCLOUDONE）。
expiresAtプロセス/リンクの失効タイムスタンプ（UTC）。
tokenプロセスに関連付けられたセッション/アクセストークン（空の場合があります）。
companyDataプロセスを所有する会社/テナントのデータを含むサブオブジェクト。
simulatedブール値。シミュレーション/サンドボックスプロセス（true）か、実際のプロセス（false）かを示します。
人物のフィールド
フィールド意味
duiType一意の識別ドキュメントのタイプ。DUI_TYPE_* の値（例: BR_CPF）。
duiValueドキュメントの値（例: CPF番号）。
friendlyName人物のフレンドリーネーム/ニックネーム（自由入力、検証されません）。
email人物のメールアドレス。空の場合があります。
phoneE.164形式の電話番号（国番号 + エリアコード + 番号）。
notifications通知チャネルのリスト。各アイテムは NOTIFICATION_CHANNEL_* の値（例: WHATSAPP、SMS、EMAIL）を持つ notificationChannel を含みます。
phoneCountryCodeAlpha3電話番号のISO alpha-3国コード（例: BRA）。空の場合があります。
会社データのフィールド
フィールド意味
branchIdテナントの支店識別子。支店で区分されていない場合は空。
countryCode会社の国をISO alpha-3で表したもの（例: BRA）。
ドキュメントタイプとOCRフィールド

統一スキーマを使用するドキュメントタイプ — フィールドリファレンスにおける unified_schema — は、キャプチャ時に識別されたタイプの大文字表記として報告されます: IDCARD、DRIVERLICENSE、PASSPORT、または VOTERID。 米国のパスポートは PASSPORT に統合されず、そのバリアントを維持するため、POLYCARBONATEPASSPORT、PASSPORTCARD、PAPERPASSPORT などの値も返されます。 例えば、unico.moja.dictionary.ar.generic.v1.IdCard と unico.moja.dictionary.us.generic.v1.PolycarbonatePassport は、それぞれ IDCARD と POLYCARBONATEPASSPORT として報告されます。

process.services[].documents[].doc.code は、ドキュメントタイプを短い大文字コードとして報告します。unico.moja.dictionary.br.cnh.v2.Cnh は CNH になります。 このコードには国もスキーマバージョンも含まれません。バージョンは doc.version で個別に返されます。

個別スキーマ

独自のフィールドスキーマを使用するドキュメントタイプ — フィールドリファレンスの specific_document_schemas に記載 — は、以下の表に示されています。各スキーマをそのファイルで検索するには、ディクショナリタイプを使用してください。

国doc.codeディクショナリタイプドキュメント
BRRGunico.​moja.​dictionary.​br.​rg.​v2.​RgRG
BRCNHunico.​moja.​dictionary.​br.​cnh.​v2.​CnhCNH（運転免許証）
BRCINunico.​moja.​dictionary.​br.​cin.​v1.​CinCIN
BRPASSAPORTEunico.​moja.​dictionary.​br.​passaporte.​v1.​Passaporteパスポート
MXINEunico.​moja.​dictionary.​mx.​ine.​v1.​IneINE 有権者証明書
MXLPCunico.​moja.​dictionary.​mx.​lpc.​v1.​LpcLicencia para conducir（運転免許証）
MXPASAPORTEunico.​moja.​dictionary.​mx.​pasaporte.​v1.​Pasaporteパスポート
—UNKNOWNunico.​moja.​dictionary.​other.​unknown.​v1.​Unknownタイプを識別できませんでした — doc.data は空です
PASSAPORTE と PASAPORTE は異なるドキュメントです

ブラジルのパスポートは PASSAPORTE（S二重）、メキシコのパスポートは PASAPORTE（S単一）で、それぞれ自身のディクショナリの表記を反映しています。これはタイプミスではありません — 2つの値を同等として扱わないでください。

doc.code が UNKNOWN の場合、OCR抽出は行われず、doc.data にフィールドは報告されません。

Brazilブラジルのお客様は完全なプロセスペイロードを受け取る場合があります

全体のレスポンス構造は同じままです — 単一の結果がデフォルトです。

ブラジルでの統合では、以下の完全なプロセスオブジェクトを受け取る場合があり、authenticationInfo内にケイパビリティ別の結果が含まれます。

{
  "process": {
    "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
    "flow": "iddocs_r2",
    "callbackUri": "https://example.com/callback",
    "userRedirectUrl": "https://example.com/redirect",
    "state": "PROCESS_STATE_FINISHED",
    "result": "PROCESS_RESULT_OK",
    "createdAt": "2024-01-01T10:00:00Z",
    "finishedAt": "2024-01-01T10:15:00Z",
    "expiresAt": "2024-01-08T10:00:00Z",
    "purpose": "VERIFICATION",
    "clientReference": "client-ref-abc",
    "useCase": "USE_CASE_LOGIN",
    "capacities": ["liveness", "face_match"],
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "person": {
      "duiType": "DUI_TYPE_BR_CPF",
      "duiValue": "12345678909",
      "friendlyName": "Luke Skywalker",
      "notifications": [
        {
          "notificationChannel": "email"
        }
      ]
    },
    "authenticationInfo": {
      "authenticationId": "auth-123",
      "livenessResult": "LIVENESS_RESULT_LIVE",
      "authenticationResult": "AUTHENTICATION_RESULT_INCONCLUSIVE",
      "identityFraudstersResult": "TRUST_RESULT_UNSPECIFIED",
      "bioTokenEngineResult": "BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED",
      "smartRevalidationResult": "SMART_REVALIDATION_RESULT_UNSPECIFIED",
      "idAgeResult": "ID_AGE_RESULT_UNSPECIFIED",
      "scoreEngineResult": {
        "scoreEnabled": "SCORE_ENABLED_TRUE",
        "score": 85.5
      }
    },
    "companyData": {
      "branchId": "branch-123",
      "countryCode": "BR"
    },
    "bioTokenData": {
      "referenceProcessId": "ref-proc-123",
      "authenticationId": "auth-ref-123"
    },
    "services": [
      {
        "envelopeId": "4d4f3d90-04a3-4259-b63b-930ab10d2e47",
        "documentIds": ["doc-abc-123"],
        "consent_granted": true,
        "documents": [
          {
            "doc_id": "doc-abc-123",
            "typified": true,
            "cpf_match": true,
            "face_match": true,
            "validate_doc": true,
            "reused_doc": false,
            "signed_url": "https://example.com/doc?token=xyz",
            "doc": {
              "version": 1,
              "code": "CNH",
              "data": {
                "numero": "044589731564",
                "cpfNumero": "12345678909",
                "nomeCivil": "Luke Skywalker",
                "dataNascimento": "1990-05-12T00:00:00Z",
                "dataExpiracao": "2027-12-07T00:00:00Z",
                "categoria": "B"
              }
            }
          }
        ]
      }
    ]
  }
}
トップレベルフィールド
フィールド型説明
process.idstring (UUID)プロセス識別子。
process.flowstring作成時に送信されたフロー識別子。
process.callbackUristringプロセスイベント用に設定されたコールバックURL。
process.​userRedirectUrlstringジャーニー完了後にユーザーをリダイレクトするURL。
process.stateenum現在のプロセス状態。以下の値を参照してください。
process.resultenum検証結果。state = PROCESS_STATE_FINISHED の場合のみ存在します。
process.createdAtstring (datetime)プロセスが作成されたISO 8601タイムスタンプ。
process.finishedAtstring (datetime)プロセスが完了したISO 8601タイムスタンプ。state = PROCESS_STATE_FINISHED の場合のみ存在します。
process.expiresAtstring (datetime)プロセスが失効するISO 8601タイムスタンプ。
process.purposestringフローで設定されたプロセスの目的。
process.​clientReferencestringポータルでのインデックス作成用の任意のクライアント側リファレンス。
process.useCasestringフローに関連付けられたシナリオ識別子。
process.capacitiesarray of stringsこのプロセスで有効化されたケイパビリティのリスト。
process.tokenstringSDK統合用の署名済みJWT。
process.personobject作成時に提供された識別情報。
process.​person.​notificationsarrayジャーニー用に設定された通知チャネル（例: email）。
process.​authenticationInfoobjectケイパビリティ別の結果。以下を参照してください。
process.companyDataobject会社と支店のコンテキスト。
process.​companyData.​branchIdstring支店識別子。
process.​companyData.​countryCodestringISO 3166-1 alpha-2国コード。
process.​bioTokenDataobjectリファレンスプロセス情報 — 1:1 バリデーションおよびスマート再検証フローでのみ存在します。
process.servicesarray署名済みエンベロープ、キャプチャされたドキュメント、その他のサービス出力。以下を参照してください。
process.state の値
値意味
PROCESS_STATE_CREATEDプロセスが作成されました。ユーザーはまだジャーニーを完了していません。
AWAITING_FOR_DOCUMENT識別ドキュメントなしでプロセスが作成されました。カスタムフローが任意のドキュメントを許可している場合のみ存在します。プロセスドキュメントの設定でドキュメントを送信してください。
PROCESS_STATE_FINISHEDジャーニーが完了しました。result と authenticationInfo を確認してください。
PROCESS_STATE_FAILED処理エラー。
状態の命名の不整合

AWAITING_FOR_DOCUMENT は、他の状態が使用している PROCESS_STATE_* プレフィックスの規則に従っていません。これは現在のAPIにおける既知の命名の不整合です。

process.result の値
値意味
PROCESS_RESULT_OKすべてのケイパビリティが肯定的な結果を返しました。
PROCESS_RESULT_INVALID_IDENTITY少なくとも1つのケイパビリティが確定的な否定を返しました（例: ライブネス失敗、本人確認不一致）。
PROCESS_RESULT_ERROR結果処理中のエラー。
PROCESS_RESULT_EXPIREDジャーニーが完了する前にプロセスが失効しました。
PROCESS_RESULT_UNSPECIFIEDプロセスがまだ完了していません。
authenticationInfo におけるケイパビリティの結果

すべてのフィールドは、フローにかかわらず常に返されます。フローで使用されないケイパビリティのフィールドは *_UNSPECIFIED を返します。

省略されたenum値

短縮された値（例: livenessResult = LIVE、authenticationResult = INCONCLUSIVE）は、ここで説明されている完全なenum値（LIVENESS_RESULT_LIVE、AUTHENTICATION_RESULT_INCONCLUSIVE など）に直接対応します — プレフィックスは簡潔さのために省略されています。

フィールドケイパビリティ可能な値
authenticationId—この認証試行の一意識別子。
livenessResultライブネスLIVENESS_RESULT_LIVE、LIVENESS_RESULT_NOT_LIVE、LIVENESS_RESULT_UNSPECIFIED
authenticationResult本人確認AUTHENTICATION_RESULT_POSITIVE、AUTHENTICATION_RESULT_NEGATIVE、AUTHENTICATION_RESULT_INCONCLUSIVE、AUTHENTICATION_RESULT_UNSPECIFIED
identityFraudstersResult不正リスク分類TRUST_RESULT_YES、TRUST_RESULT_INCONCLUSIVE、TRUST_RESULT_UNSPECIFIED
bioTokenEngineResult1:1 バリデーションBIO_TOKEN_ENGINE_RESULT_POSITIVE、BIO_TOKEN_ENGINE_RESULT_NEGATIVE、BIO_TOKEN_ENGINE_RESULT_UNSPECIFIED
smartRevalidationResultスマート再検証SMART_REVALIDATION_RESULT_POSITIVE、SMART_REVALIDATION_RESULT_NEGATIVE、SMART_REVALIDATION_RESULT_UNSPECIFIED
idAgeResult年齢確認ID_AGE_RESULT_POSITIVE、ID_AGE_RESULT_NEGATIVE、ID_AGE_RESULT_INCONCLUSIVE、ID_AGE_RESULT_UNSPECIFIED
scoreEngineResult.​scoreEnabledリスクスコアSCORE_ENABLED_TRUE、SCORE_ENABLED_FALSE、SCORE_ENABLED_UNSPECIFIED
scoreEngineResult.​scoreリスクスコア-100から+100までの数値。authenticationResult = AUTHENTICATION_RESULT_INCONCLUSIVE かつリスクスコアが有効な場合に存在します。
serproResult.scoreSerpro類似度返却0–100（類似度）；-1（このCPFに顔データがない）；-2（統合エラー）。
process.services のフィールド
services における命名規則の混在

services 配列は、エンベロープレベルのフィールド（envelopeId、documentIds）にはcamelCase、ドキュメントレベルのフィールド（doc_id、consent_granted、face_match など）にはsnake_caseを使用します。これは実際のAPIレスポンスを反映したものであり、両方の規則は意図的なものでドキュメントの誤りではありません。

フィールド型説明
envelopeIdstring (UUID)署名済みエンベロープ識別子。
documentIdsarray of stringsこのサービスでキャプチャされたドキュメントのID。
consent_grantedbooleanユーザーがデータ共有への同意を許可したかどうか。
documentsarrayOCRデータと検証結果を持つキャプチャされたドキュメント。
documents[].doc_idstringドキュメント識別子。
documents[].​typifiedbooleanドキュメントタイプが正常に識別されたかどうか。
documents[].​cpf_matchbooleanドキュメント上のCPFが提供されたCPFと一致するかどうか（ブラジルのみ）。
documents[].​face_matchbooleanセルフィーがドキュメント上の写真と一致するかどうか。
documents[].​validate_docbooleanドキュメントが真正性の検証に合格したかどうか。
documents[].​reused_docbooleanこのドキュメントが以前のプロセスから再利用されたかどうか。
documents[].​signed_urlstringドキュメントPDFをダウンロードするための事前署名付きURL（有効期限5分 — 更新するには再取得してください）。
documents[].​doc.​versionintegerOCRスキーマバージョン。
documents[].​doc.​codestring短いドキュメントタイプコード（例: CNH）。すべての値とコードの導出方法については、ドキュメントタイプとOCRフィールドを参照してください。
documents[].​doc.​dataobject抽出されたOCRフィールド。内容はドキュメントタイプによって異なります — 完全なカタログについては完全なフィールドリファレンスを参照してください。doc.data 内のフィールド名（例: nomeCivil、dataNascimento）はポルトガル語で返されます — これらはOCRエンジンが生成する実際の値です。

エラーコード​

コードメッセージ説明
3process id is invalidプロセスIDが無効な場合。

ポーリング vs Webhook​

進行状況を確認するためにこのエンドポイントをポーリングすることもできますが、推奨されるパターンはWebhookをサブスクライブし、このエンドポイントはフォールバックとしてのみ呼び出すことです。WebhookとEventsを参照してください。

次のステップ​

最終更新 に