跳转到主要内容
获取流程GET

通过标识符检索已有流程。根据 API 合约，结果已在流程创建时同步返回——请将此端点用于重新查询、审计和支持场景。

MarkdownChatGPTClaude
警告

在获取流程之前，请查看我们的 webhook 配置和回退策略 — 点击此处。

端点​

环境URL
生产环境GET https://api.id.unico.app/processes/v1/{processId}
沙箱环境GET https://api.id.uat.unico.app/processes/v1/{processId}

请求​

请求头
请求头值
AuthorizationBearer <access_token>
APIKEY已配置的 API 密钥。
路径参数
参数类型必填描述
processIdstring (UUID)是由创建流程返回的流程标识符。

示例​

curl -X GET https://api.id.unico.app/processes/v1/$PROCESS_ID \
  -H "Authorization: Bearer $TOKEN" \
  -H "APIKEY: $API_KEY"

响应​

200 OK

该合约是统一的——idCloud.result 字段承载了所用功能的整合判定结果。

Unico 将已执行功能的结果整合为单一的 idCloud.result，可直接用于决定您流程的下一步——无需自行编排各项结果。

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "idCloud": {
    "result": "approved"
  }
}
字段类型描述
idstring (UUID)流程标识符。
statusinteger1（处理中）、2（差异）、3（成功完成）、4（已取消）、5（错误）。
可能的结果值
idCloud.result含义建议操作
approved真实人员且身份已验证。继续该流程。
denied身份未验证、活体检测失败，或识别到极端风险。结束该流程或跳转至备用流程。
critical-risk识别到严重风险级别。结束该流程或转至人工审核。
high-risk识别到高风险级别。转至人工审核或备用流程。
retry采集数据或评分不足，无法评估。请用户重新进行采集。
inconclusive证据不足，无法做出判定。转至人工审核或备用流程。

返回的值取决于您 APIKey 中配置的配方。各配方可返回的结果值请参见流程。

Brazil巴西的客户可能会按功能接收响应

整体响应结构保持不变——单一结果为默认方式。

巴西的集成可能会收到开放式的、按功能划分的结果。APIKey 中启用的每项功能都会在响应中新增相应的字段块——未启用功能的字段则会被省略。

{
  "id": "80371b2a-3ac7-432e-866d-57fe37896ac6",
  "status": 3,
  "unicoId": {
    "result": "yes"
  },
  "riskLevel": {
    "result": "inconclusive"
  },
  "idFace": {
    "personId": "a1b2c3d4e5f67890a1b2c3d4e5f67890a1b2c3d4e5f67890a1b2c3d4e5f67890",
    "result": "FOUND"
  },
  "identityFraudsters": {
    "result": "inconclusive"
  },
  "government": {
    "serpro": 87
  },
  "liveness": 1,
  "idAge": {
    "result": "yes"
  },
  "cardholderVerification": {
    "result": "approved"
  }
}
字段类型描述
unicoId.resultstringyes、no、inconclusive — 参见身份验证。
riskLevel.resultstringnot_approved、critical_risk、high_risk、inconclusive — 参见欺诈风险分类。
idFace.resultstringFOUND — 参见人脸标识符。
idFace.personIdstring人脸的稳定不透明标识符，与 idFace.result = FOUND 一同返回。当图像中无法识别出人脸时，流程会返回错误 20532，而不是 idFace 字段块。
identityFraudsters.resultstring已弃用。 请改用 riskLevel。仍在进行集成的客户可在与项目团队协调迁移工作的同时继续使用此字段。
government.serprointegerSerpro 相似度分数（0–100、-1、-2）。仅在巴西可用。参见 Serpro 相似度返回。
livenessinteger1（通过）、2（未通过） — 参见活体检测。
idAge.resultstringyes、no、inconclusive — 参见年龄验证。仅在巴西可用。
scoreinteger概率性风险评分。当 unicoId.result = inconclusive 且风险评分编排处于活动状态时出现。正值表示持有人身份的可能性更高；负值表示风险更高。仅在巴西可用。
cardholderVerification.resultstringapproved、unsure — 参见 Cardholder Verification。当 status 尚未达到 3（完成）时不存在此字段。仅在巴西可用。
Mexico墨西哥的客户可能会收到 RENAPO Verification 块

响应结构保持不变，并新增 idGov 块。

在墨西哥启用了 RENAPO Verification 的集成，会额外收到一个 idGov 块，其中包含 RENAPO 为用户 CURP 所持有的记录。它是与身份结果相互独立的答复。

{
  "id": "11111111-2222-3333-4444-555555555555",
  "status": 3,
  "idCloud": { "result": "approved" },
  "idGov": {
    "government_valid": true,
    "curp": "PUEA880304MDFRJN04",
    "government_name": "ANA PRUEBA EJEMPLO",
    "date_of_birth": "1988-03-04",
    "age": 38,
    "gender": "F",
    "deceased": false,
    "is_mexican": true,
    "citizenship": "MEXICO",
    "state_of_birth": "Ciudad de México",
    "state_iso": "MX-CMX",
    "issuing_entity_code": "DF",
    "municipality_registration": ""
  }
}
字段类型描述
idGovobjectCURP 对应的 RENAPO 记录。未启用该功能时不存在。RENAPO 未响应时为 {}。仅限墨西哥。参见 RENAPO Verification。

何时使用此端点​

API 合约同步返回结果，因此大多数集成不需要使用此端点。请在以下情况下使用：

  • 您仅持久化了 processId，需要稍后检索完整结果（审计、支持场景）。
  • 您怀疑原始响应在传输过程中丢失（平台完成处理后发生网络错误）。
  • 您正在构建用于审查历史流程的后台管理工具。

错误代码​

代码消息描述
20023O parâmetro processId não foi informado.缺少流程 ID 参数。
20002O parâmetro APIKey não foi informado.请求头中缺少 APIKEY 参数。
20001O parâmetro authtoken não foi informado.请求头中缺少集成令牌参数。

流程​

配方是项目 APIKey 中配置的功能组合（活体检测、身份验证、风险信号、文档等）。它定义了 Unico 在每个流程中执行的操作，以及如何将结果整合为单一的 result —— 您无需在自己一侧进行任何编排。

Unico 维护着一个预设配方目录，每个配方都有名称并进行版本管理（例如 byunico-idlive-idunico-oneresponse-std）。其中一些配方仅限巴西使用，例如包含评分、Serpro 或年龄验证的配方。

您的流程运行哪些功能？

功能组合——即您项目的流程——由您的 APIKey 配置定义。请查看预设配方，或联系您的 Unico 项目负责人进行定制。

最后更新 于