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

既存のプロセスを識別子で取得します。APIコントラクトの仕様上、結果はプロセス作成時にすでに同期的に返されているため、このエンドポイントは再照会・監査・サポート対応に使用します。

警告

プロセスを取得する前に、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ユーザーがジャーニーを実行するために開くCbUページの完全な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_* の値を持つ notificationChannel を含みます（例: WHATSAPP、SMS、EMAIL）。
phoneCountryCodeAlpha3電話番号のISO alpha-3国コード（例: BRA）。空の場合があります。
会社データフィールド
フィールド意味
branchIdテナントの支店識別子。支店で区分されていない場合は空になります。
countryCodeISO alpha-3形式の会社の国（例: BRA）。
ドキュメントタイプと OCR フィールド

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

統合スキーマ — フィールドリファレンス の 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 として返されます。

個別スキーマ

独自のフィールドスキーマを使用するドキュメントタイプ — フィールドリファレンス の 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 が 2 つ）、メキシコのパスポートは PASAPORTE（S が 1 つ）で、それぞれ自国のディクショナリの綴りを反映しています。誤字ではありません。この 2 つの値を同一のものとして扱わないでください。

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

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

全体のレスポンス構造は変わらず、単一の結果がデフォルトです。

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

{
  "process": {
    "id": "53060f52-f146-4c12-a234-5bb5031f6f5b",
    "flow": "idchecktrust",
    "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": "smart_revalidation",
    "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_INCONCLUSIVE",
      "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本人確認書類なしでプロセスが作成され、Set Process 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 を返します。

短縮形の列挙値

短縮値（例: livenessResult = LIVE、authenticationResult = INCONCLUSIVE）は、ここで説明されている完全な列挙値（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）にキャメルケースを使用し、ドキュメントレベルのフィールド（doc_id、consent_granted、face_match など）にスネークケースを使用します。これは実際の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を購読し、このエンドポイントはフォールバックとしてのみ呼び出すことです。Webhooks and Eventsを参照してください。

次のステップ​

  • キャプチャされたセルフィーについては、Get Selfieを参照してください。
  • 証拠の監査バンドルについては、Get Evidence Setを参照してください。
最終更新 に