プロセスドキュメントの設定

書類なしで作成されたプロセスに識別書類（CPF、CURP、SSN、またはその他の duiType）を設定します。一度設定すると、書類は変更できません。

書類なしでの作成を許可する Custom Flow を持つプロセス（つまり、AWAITING_FOR_DOCUMENT 状態のプロセス）でのみ利用可能です。

エンドポイント

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

リクエスト

ヘッダー

ヘッダー	値
Authorization	Bearer <access_token>（認証を参照）
Content-Type	application/json

パスパラメーター

フィールド	型	必須	説明
processId	string	はい	作成時に process.id で返されたプロセス ID。

ボディパラメーター

フィールド	型	必須	説明
duiType	enum	はい	書類タイプ。値: DUI_TYPE_BR_CPF、DUI_TYPE_MX_CURP、DUI_TYPE_US_SSN。このエンドポイントはプロセス作成で受け入れられる書類タイプのサブセットをサポートします — オプションの書類作成を許可する Custom Flow は現在、この限定されたリストに対して検証されます。
duiValue	string	はい	フォーマットなしの書類番号。最大 320 文字（エンコードされた識別子または複合識別子に対応; CPF や CURP などの標準的な書類番号はこれよりはるかに短い）。

例

cURL

curl -X POST https://api.idcloud.unico.app/client/v1/process/abc-123/document \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "duiType": "DUI_TYPE_BR_CPF",
    "duiValue": "12345678901"
  }'

Node.js

import fetch from 'node-fetch';

const res = await fetch(
  'https://api.idcloud.unico.app/client/v1/process/abc-123/document',
  {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${process.env.UNICO_ACCESS_TOKEN}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      duiType: 'DUI_TYPE_BR_CPF',
      duiValue: '12345678901',
    }),
  }
);

const { process: proc } = await res.json();
// proc.id, proc.person.duiType, proc.person.duiValue

レスポンス

200 OK

{
  "process": {
    "id": "abc-123",
    "person": {
      "duiType": "DUI_TYPE_BR_CPF",
      "duiValue": "12345678901"
    }
  }
}

フィールド	型	説明
process.id	string	プロセス識別子。
process.person.duiType	string	プロセスに設定された書類タイプ。
process.person.duiValue	string	プロセスに設定された書類の値。

400 Bad Request

リクエストのペイロードが不正、必須フィールドが欠落、またはプロセスの状態が操作を許可しない場合に返されます。

401 Unauthorized

Bearer トークンが欠落、期限切れ、または無効です。認証を参照してください。

404 Not Found

プロセスが見つかりません。

429 Too Many Requests

レート制限に達しました。詳細なエラーコードは提供されません — HTTP ステータスのみ。

エラーコード

400 Bad Request

コード	メッセージ	説明
3	process id is invalid	プロセス ID が無効な場合。
3	dui_type is required	書類タイプが指定されていない場合。
3	dui_value is required	書類番号が指定されていない場合。
3	dui_value exceeds maximum length	書類番号が最大文字数を超えた場合。
9	process is not awaiting for document	指定されたプロセスが書類の送信を受け付けない場合。
9	process expired	指定されたプロセスが期限切れの場合。
9	document already set, cannot be modified	プロセスにすでに書類が関連付けられている場合。
9	process already finished	プロセスがすでに完了している場合。
9	flow does not allow optional document	フローで書類が必須の場合。

401 Unauthorized

メッセージ	説明
Jwt header is an invalid JSON	使用されたアクセストークンに不正な文字が含まれている場合。
Jwt is expired	使用されたアクセストークンが期限切れの場合。

404 Not Found

コード	メッセージ	説明
5	error getting process: rpc error: code = NotFound desc = process not found	プロセス ID が見つからなかった場合。

429 Too Many Requests

このステータスに対する詳細なエラーコードは提供されていません — HTTP ステータスコードのみ。

500 Internal Server Error

コード	メッセージ	説明
99999	Internal failure! Try again later	内部エラーが発生した場合。

次のステップ

• 書類を設定した後、プロセスはパイプラインを継続します。プロセスの取得を呼び出して結果を取得するか、webhookを待ちます。