跳到主要内容

共享对象

许多数据在各 API 之间共享。以下是这些对象定义的集中说明，方便查阅。

email 对象​

Request Body
{
  "email": "johnsample@test.com",
  "validation_type":"zaig_api",
  "validation_key": "e9f0de49-16fb-431e-be1a-ee4bf1096eda"
}

email 对象用于在整个 API 中表示电子邮件地址，以及是否使用了某种验证方式。其结构如下：

名称类型限制条件描述
emailstring1–100 个字符注册的电子邮件地址。(必填)
validation_typeenumzaig_api 或 company_email注册电子邮件时使用的验证类型。
validation_keyguidUUID（xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx）QI Tech 邮件验证 API 返回的 Id。

cnh 对象​

Request Body
{
  "register_number": "05163811694",
  "issuer_state": "PR",
  "first_issuance_date":"2011-03-21",
  "issuance_date":"2016-06-29",
  "expiration_date":"2021-06-25",
  "category": "AB",
  "validation_type":"zaig_sdk",
  "ocr_key":"a5cf9c8f-2f66-4490-a7db-8a5bc70c1b76"
}

cnh 对象用于在整个 API 中表示驾驶证（CNH），以及是否使用了某种验证方式。其结构如下：

名称类型描述
register_numberstring注册的驾驶证编号。
issuer_stateenum驾驶证签发州的枚举值。
first_issuance_datedate首次领证日期。
issuance_datedate签发日期。
expiration_datedate到期日期。
categoryenum驾驶证类别，大写字母。
validation_typeenum注册文件时使用的验证类型。
ocr_keyguidQI Tech 文件验证 API 返回的 Id。

validation_type 的枚举值如下：zaig_api 和 zaig_sdk。

rg 对象​

Request Body
{
  "number": "4.366.477-8",
  "issuer": "II",
  "issuer_state": "PR",
  "issuance_date":"2002-01-12",
  "validation_type":"zaig_sdk",
  "ocr_front_key":"a5cf9c8f-2f66-4490-a7db-8a5bc70c1b76",
  "ocr_back_key":"a5cf9c8f-2f66-4490-a7db-8a5bc70c1b76"
}

rg 对象用于在整个 API 中表示身份证（RG），以及是否使用了某种验证方式。其结构如下：

名称类型描述
numberstring注册文件的编号，包含格式（点、连字符、斜杠等）。
issuerstring文件签发机构（缩写，如：II、SESP...）
issuer_stateenum文件签发州。
issuance_datedate文件签发日期。
validation_typeenum注册文件时使用的验证类型。
ocr_keyguidQI Tech 文件验证 API 返回的 Id。

validation_type 的枚举值如下：zaig_api 和 zaig_sdk。

ie 对象​

Request Body
{
  "number": "388.108.598.269",
  "issuer": "JUCESP",
  "issuer_state": "SP",
  "issuance_date":"2002-01-12",
  "validation_type": "zaig_api",
  "ocr_key": "c64627db-1ba4-48b6-979d-06222a25d5e9"
}

ie 对象用于在 legal_person 端点的 documents 对象中表示州注册证（Inscrição Estadual），以及是否使用了某种验证方式。其结构如下：

名称类型描述
numberstring注册文件的编号，包含格式（点、连字符、斜杠等）。
issuerstring文件签发机构（缩写，如：JUCESP、JUCEGO...）
issuer_stateenum文件签发州。
issuance_datedate文件签发日期。
validation_typeenum注册文件时使用的验证类型。
ocr_keyguidQI Tech 文件验证 API 返回的 Id。

validation_type 的枚举值如下：zaig_api。

company_statute 对象​

Request Body
{
  "ocr_key": "60ed79c4-5aba-4cc7-aebb-5de5f92b7d0d"
}

company_statute 对象用于在 legal_person 端点的 documents 对象中表示公司设立文件，例如公司章程。其结构如下：

名称类型描述
ocr_keyguidQI Tech OCR API 在收到公司设立文件图片或 PDF 后返回的 Id。

letter_attorney 对象​

Request Body
{
  "ocr_key": "13571175-b1d9-4507-82e0-d266516fc5ae"
}

letter_attorney 对象用于在 legal_person 端点的 documents 对象中表示授予法定代表人权限的授权书。其结构如下：

名称类型描述
ocr_keyguidQI Tech OCR API 在收到授权书图片或 PDF 后返回的 Id。

address 对象​

Request Body
{
  "street": "Rua do Teste",
  "number": "111",
  "neighborhood": "Bairro do Exemplo",
  "city": "Aparecida de Goiânia",
  "uf": "GO",
  "complement": "Térreo",
  "postal_code": "00000-000",
  "country": "BRA",
  "validation_type":"visit",
  "ocr_key": "265b1b74-4b93-41dc-ac78-e1c37467225d"
}

address 对象用于在整个 API 中表示地址，巴西境内的地址表示如下：

名称类型限制条件描述
streetstring1–100 个字符地址的街道名称，包含地址类型，尽量避免缩写。
numberstring1–50 个字符房产编号，如有字母也需包含。
neighborhoodstring1–100 个字符社区名称，不使用缩写。
例如：Santa Felicidade
citystring1–100 个字符城市全名，不使用缩写。
ufenum巴西州缩写（2 个字母）联邦州。
例如：SP、GO、MG
complementstring1–500 个字符定位房产的任何补充信息。
例如：Apartamento 101, Conjunto 12
postal_codestring格式 XXXXX-XXX含连字符的巴西邮政编码（CEP），恰好 9 个字符。示例：01310-100 (必填)
countrystring3 个大写字母地址所在国家的 ISO 3166-1 alpha-3 代码。示例：BRA
validation_typeenumvisit 或 zaig_ocr注册地址时使用的验证类型。
ocr_keyguidUUID（xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx）QI Tech OCR API 或 SDK 在收到居住证明图片后返回的 Id。

对于国家非巴西（BRA）的地址，postal_code 和 uf 字段可自由填写。

phone 对象​

Request Body
{
  "international_dial_code": "1",
  "area_code": "11",
  "number": "999999999",
  "type": "mobile",
  "validation_type": "zaig_sms",
  "validation_key": "82589b39-e34f-44f9-b0fe-d8fc0ee6129c"
}

phone 对象表示一个电话号码（巴西境内或境外）及其分类。各字段如下：

名称类型限制条件描述
international_dial_codestring1–7 个字符，仅数字国际拨号代码，不含零或 +。示例：巴西为 55 (必填)
area_codestring1–10 个字符，仅数字区号，不含零。示例：11 (必填)
numberstring1–20 个字符电话号码，不含连字符 (必填)
typeenumresidential、commercial 或 mobile号码类型。
validation_typeenumzaig_sms、zaig_call、company_sms 或 company_call注册电话时使用的验证类型。
validation_keyguidUUID（xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx）QI Tech 电话验证 API 返回的 Id。

source 对象​

Request Body
  {
    "channel": "app",
    "platform": "android",
    "ip":"211.7.142.62",
    "session_id": "733adf2c-a994-4113-aa59-beb646091fea",
  }

source 对象表示客户用于注册的平台信息集合。各字段如下：

名称类型描述
channelstring客户的销售/注册渠道
platformstring客户用于注册的平台
ipstring客户注册所用设备采集的 IP 地址
session_idstring会话的唯一标识符，用于将设备扫描与对应注册进行关联

face 对象​

Request Body
  {
    "type":"zaig_face_sdk",
    "registration_key":"46f38cf4-07b2-4de6-93e9-64b51a68378a"
  }

face 对象表示您在提交注册前，通过 QI Tech 的 API 或 SDK 对客户真实性进行人脸识别验证的结果。各字段如下：

名称类型描述
validation_typeenum执行的人脸识别验证类型。
registration_keyguidQI Tech API 或 SDK 返回的用于识别该注册记录的标识符。
validation_keyguidQI Tech API 或 SDK 返回的用于识别该验证记录的标识符。

人脸验证类型的枚举值如下：zaig_api 和 zaig_sdk。

partner 对象​

Request Body
  {
    "name": "John Partner",
    "document_number": "111.111.111-11",
    "birthdate": "1992-09-15",
    "gender": "male",
    "nationality": "BRA",
    "mother_name": "Maria Partner's Mother",
    "occupation": "Teacher",
    "emails":[
      {
        "email": "johnsample@test.com",
        "validation_type":"zaig_api",
        "validation_key": "e9f0de49-16fb-431e-be1a-ee4bf1096eda"
      }
    ],
    "documents": {
      "rg": {
        "number": "4.366.477-8",
        "issuer": "II",
        "issuer_state": "PR",
        "issuance_date":"2002-01-12",
        "validation_type":"zaig_sdk",
        "ocr_front_key":"a5cf9c8f-2f66-4490-a7db-8a5bc70c1b76",
        "ocr_back_key":"a5cf9c8f-2f66-4490-a7db-8a5bc70c1b76"
      },
      "cnh": {
        "register_number": "05163811694",
        "issuer_state": "PR",
        "first_issuance_date":"2011-03-21",
        "issuance_date":"2016-06-29",
        "expiration_date":"2021-06-25",
        "category": "AB",
        "validation_type":"zaig_sdk",
        "ocr_key":"a5cf9c8f-2f66-4490-a7db-8a5bc70c1b76"
      }
    },
    "address": {
      "street": "Rua do Teste",
      "number": "111",
      "neighborhood": "Bairro do Exemplo",
      "city": "Aparecida de Goiânia",
      "uf": "GO",
      "complement": "Térreo",
      "postal_code": "00000-000",
      "country": "BRA",
      "validation_type":"visit",
    },
    "phones": [
      {
        "international_dial_code": "1",
        "area_code": "11",
        "number": "999999999",
        "type": "mobile",
        "validation_type": "zaig_sms",
        "validation_key": "82589b39-e34f-44f9-b0fe-d8fc0ee6129c"
      }
    ],
    "source": {
      "channel": "app",
      "platform": "android",
      "ip":"255.321.321.1",
      "session_id": "54b8e3cf-15de-41e5-9305-0ecf059d6e2a"
    },
    "face":
    {
      "type":"zaig_sdk",
      "registration_key":"46f38cf4-07b2-4de6-93e9-64b51a68378a"
    }
  }

partner 对象表示被注册公司的股东数据，以及该股东在注册过程中接受的各类验证信息。各字段如下：

名称类型描述
namestring被注册股东的完整姓名
document_numberstring被注册股东的 CPF，含点和连字符，遵循标准格式 (必填)
birthdatedate股东的出生日期，遵循标准格式
genderenum股东的性别：'male' 或 'female'
nationalitystring股东的国籍，采用 ISO 3166-1 alpha-3 格式
mother_namestring股东母亲的完整姓名
occupationstring被注册股东的职业
emailsEmailEmail 类型对象列表，描述股东的电子邮件地址
documentsDocumentDocument 类型对象，包含股东注册时提交的任何文件
addressAddressAddress 类型对象，描述股东的居住地址
phonesPhone 列表Phone 类型对象列表，包含股东的电话号码列表
sourceSourceSource 类型对象，描述用于提交注册的应用程序特征
faceFaceFace 类型对象，描述人脸验证信息
Request Body
  {
    "name": "Frederic Attorney",
    "document_number": "111.111.111-11",
    "birthdate": "1987-06-12",
    "gender": "male",
    "nationality": "BRA",
    "mother_name": "Jackie Attorney Mother",
    "occupation": "Accountant",
    "emails":[
      {
        "email": "frederic@attorney.com",
        "validation_type":"zaig_api",
        "validation_key": "d174d522-6003-4b05-adb2-e92e92632c67"
      }
    ],
    "documents": {
      "letter_of_attorney": {
        "ocr_key": "6972894d-d2ef-4b5f-b54f-10f178bf3e5d"
      },
      "cnh": {
        "register_number": "05163811694",
        "issuer_state": "PR",
        "first_issuance_date":"2011-03-21",
        "issuance_date":"2016-06-29",
        "expiration_date":"2021-06-25",
        "category": "AB",
        "validation_type":"zaig_sdk",
        "ocr_key":"a5cf9c8f-2f66-4490-a7db-8a5bc70c1b76"
      }
    },
    "address": {
      "street": "Avenida de Exemplo",
      "number": "99",
      "neighborhood": "Vila do Exemplo",
      "city": "Jundiaí",
      "uf": "SP",
      "complement": "Ap 82",
      "postal_code": "00000-000",
      "country": "BRA",
      "validation_type":"proof_of_address",
      "ocr_key": "265b1b74-4b93-41dc-ac78-e1c37467225d"
    },
    "phones": [
      {
        "international_dial_code": "55",
        "area_code": "11",
        "number": "999998877",
        "type": "mobile",
        "validation_type": "zaig_sms",
        "validation_key": "e390d2b3-cb71-4991-9d94-1b7f8b43a04e"
      }
    ],
    "source": {
      "channel": "app",
      "platform": "ios",
      "ip":"175.92.122.2",
      "session_id": "93c68588-7a41-472f-95b3-835ea6ee1ede"
    },
    "face":
    {
      "type":"zaig_sdk",
      "registration_key":"d2677a8c-d575-44e1-a54d-ec00f9310f34"
    }
  }

legal_representative 对象表示被注册公司的法定代表人数据，以及该代表人在注册过程中接受的各类验证信息。各字段如下：

名称类型描述
namestring被注册法定代表人的完整姓名
document_numberstring被注册法定代表人的 CPF，含点和连字符，遵循标准格式
birthdatedate法定代表人的出生日期，遵循标准格式
genderenum法定代表人的性别：'male' 或 'female'
nationalitystring法定代表人的国籍，采用 ISO 3166-1 alpha-3 格式
mother_namestring法定代表人母亲的完整姓名
occupationstring被注册法定代表人的职业
emailsEmailEmail 类型对象列表，描述法定代表人的电子邮件地址
documentsDocumentDocument 类型对象，包含法定代表人注册时提交的任何文件
addressAddressAddress 类型对象，描述法定代表人的居住地址
phonesPhone 列表Phone 类型对象列表，包含法定代表人的电话号码列表
sourceSourceSource 类型对象，描述用于提交注册的应用程序特征
faceFaceFace 类型对象，描述人脸验证信息