跳到主要内容

发送文档

使用 /image 端点发送文档，如下所示。此端点将返回文档的 GUID（全局唯一标识符），之后可在 QI Tech 系统的其他服务中引用。

发送​

要发送文档，只需通过 POST 方法以 JSON 格式将图片的 base64 代码发送至以下地址：

https://api.caas.qitech.app/ocr/image

Request Body
  {
    "document_b64": "\<BASE64_IMAGE\>",
    "template": "cnh",
    "file_type": "jpeg"
  }

将您的文档 base64 代码替换占位符。

发送属性说明​

属性描述
document_b64必填字段。以 base64 格式提交的待分析文档图片。
template必填字段。声明应用于图片分析的模板。
file_type可选字段。标识发送文件的格式，jpeg 或 pdf。如未提交，则默认值为 jpeg。

可用模板​

目前，QI Tech 提供以下可用于 OCR 分析的模板。如果您所需的文档不在此列表中，请发送电子邮件至 suporte.caas@qitech.com.br 了解此功能实施的详细信息。

模板描述
cnh完整的巴西国家驾驶执照。
cnh_front巴西国家驾驶执照正面（照片面）。
cnh_back巴西国家驾驶执照正面（签名面）。
cnh_digital巴西数字国家驾驶执照 PDF。
rg_front巴西身份证正面（照片面）。
rg_back巴西身份证背面（数据面）。
danfe电子发票辅助文档（NF-e）。
proof_of_address住址证明。
letter_of_attorney授予公司相关权限的授权书。
company_statute公司章程或合同。

图片​

为确保执行分析的可靠性，客户拍照时需遵循以下规则：

  • 从塑料袋中取出文档；
  • 确保文档在照片中居中；
  • 确保文档光线充足；
  • 确保文档的所有数据清晰、可见且可读；
  • 确保照片清晰可见。

图片要求​

为使 API 正常运行，请注意以下参数。

  • 图片必须为 JPEG 或 PDF 格式；
  • 图片必须至少有 500 像素高和 500 像素宽；
  • API 不支持手写文档的识别；
  • 图片的最大大小根据所选格式而有所不同，遵循以下限制：
格式最大支持大小
.JPEG3MB
.PNG10MB
.PDF30MB

响应​

如果您的文档读取请求处理成功，将返回 HTTP status 200 和包含指向已发送文档的标识符的 JSON 对象。

Response Body
    {
        "ocr_key": "f1c0d2e1-f950-4360-896d-36588e443fc9"
    }

响应属性说明​

属性描述
ocr_key所提供图片的标识密钥，可用于 QI Tech 系统的任何其他服务。

文档恢复​

图片恢复

    curl "https://api.caas.qitech.app/ocr/image/f4b5337a-7b50-406e-8c8e-7d0e77b5aa02/file" \
         -H "Authorization: EXAMPLE_API_KEY"

任何时候都可以恢复已发送的图片。只需向以下端点发送经适当身份验证的 GET 请求：

https://api.caas.qitech.app/ocr/image/{image_key}/file

其中 image_key 是发送图片时返回的值。

图片质量验证​

Response Body：无效图片情况
    {
        "title": "document_quality",
        "description": "A imagem enviada não pode ser processada com êxito."
    }

在图片端点发送 POST 请求时，如果图片不足以进行验证，将返回 HTTP Status Code 400，如旁边示例所示。当文档不满足前面提到的图片要求时，也会返回 Status Code 400。

注意 - 还有其他原因会导致我们返回 400（均与无效数据相关）。只有 title 为 "document_quality" 的返回才是图片质量验证的结果，因此才应转达给用户。

面部质量验证​

图片质量验证仅适用于包含面部的文档，如 RG、CNH 和护照。当图片发送至系统时，如果被识别为以下类型之一，将自动执行面部分析：

  • national_migration_registry_front
  • passport_front
  • ctps_front
  • regional_nursing_council_registry_front
  • regional_nursing_council_registry
  • national_registry_of_foreigners_back
  • passport
  • national_migration_registry
  • national_registry_of_foreigners
  • cnh_digital
  • rg_front
  • rg
  • cnh_front
  • cnh

在此分析过程中，系统会验证图片中是否有可见的面部，并评估以下方面：

  • 适当的光照（亮度）；
  • 是否佩戴太阳镜等配件；
  • 面部过近或过远；
  • 图片中完全没有面部。

如果上述任一标准表明图片不合适，将返回 title: "face_validation" 的错误和相应的 description，详情如下。

{
    "title": "face_validation",
    "description": "<错误代码>"
}

返回示例：​

未检测到面部
{
    "title": "face_validation",
    "description": "no_faces"
}

向用户显示消息的翻译表​

错误代码（description）友好提示信息
close_face图片拍摄时距离面部过近，请重新定位文档。
distant_face图片拍摄时距离面部过远，请重新定位文档。
wearing_acessories图片中的人佩戴了太阳镜或遮住眼睛的配件。
brightness_problem图片太暗，请在更充足的光线下重新发送。
no_faces无法在图片中检测到面部，请确认面部是否可见。