跳到主要内容

共享对象

以下是文档中使用的其他对象的定义。

对象 Address​

Request Body
{
  "street": "Rua do Exemplo",
  "number": "111" ,
  "neighborhood": "Bairro do Teste",
  "city": "Aparecida de Goiânia",
  "uf": "GO",
  "complement": "Apt 903",
  "postal_code": "00000-000"
}

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

名称类型描述
streetstring地址街道，包含地址类型，尽量避免缩写 （必填）。
numberstring门牌号，包含字母（如有）（必填）。
neighborhoodstring街区，不使用缩写 （必填）。
例：Santa Felicidade
citystring城市全称，不使用缩写 （必填）。
ufstring两位大写字母的州代码 （必填）。
例：SP
complementstring用于定位物业的任何补充信息。
例：Apartamento 101, Conjunto 12
postal_codestring包含连字符的邮政编码 （必填）。
countrystring地址所在国家的 ISO 3166-1 alpha-3 代码 （必填）。

对于非巴西（"BRA"）地址，postal_code 和州代码可自由填写。

对象 Phone​

Request Body
{
  "international_dial_code": "1",
  "area_code": "11",
  "number": "999999999",
  "type": "mobile"
}

Phone 对象表示国内或国际电话号码及其分类，包含以下字段：

名称类型描述
international_dial_codestring国际拨号代码，不含零或加号，仅数字 （必填）。
area_codestring区号，不含前置零，仅数字 （必填）。
numberstring电话号码，不含连字符 （必填）。
typeenum号码类型：手机、住宅、商务等。

电话类型枚举值：residential、commercial、mobile

对象 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已注册 CNH 的登记编号。
issuer_stateenum颁发 CNH 的州代码枚举值
first_issuance_datedate首次颁发日期。
issuance_datedate颁发日期
expiration_datedate到期日期
categoryenumCNH 类别（大写字母）
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。

对象 NaturalPerson​

Request Body
{
  "name": "Melissa Lima Melo",
  "document_number": "677.498.846-61",
  "birthdate": "1960-11-21",
  "email": "exemplo2@sample.com",
  "nationality": "BRA",
  "gender": "female",
  "mother_name": "Raíssa Lima",
  "father_name": "Ronaldo Melo",
  "monthly_income": 800000,
  "declared_assets": 18600000,
  "occupation": "law",
  "address": {
    "country": "BRA",
    "street": "Rua Castro Alves",
    "number": "100",
    "complement": "Ap 202",
    "neighborhood": "Parque Estrela Dalva I",
    "city": "Luziânia",
    "state": "GO",
    "postal_code": "72804-050"
  },
  "phones": [
    {
      "international_dial_code": "55",
      "area_code": "11",
      "number": "21158745",
      "type": "residential"
    }
  ]
}

NaturalPerson 对象表示借款人本人、担保人或借款企业的股东数据，由以下字段组成：

名称类型描述
namestring全名 （必填）。
document_numberstringCPF，格式正确 （必填）。
birthdatedate出生日期。
emailstring电子邮件地址。
genderenum性别，依据枚举列表。
addressAddress居住地址。
phoneslist of Phone联系电话列表。

性别枚举值：

  • male
  • female
  • undefined

对象 LegalPerson​

Request Body
{
  "legal_name": "QI Tech Tecnologia LTDA",
  "trading_name": "QI Tech",
  "document_number": "35.472.523/0001-15",
  "constitution_date": "1990-01-01",
  "constitution_type": "llc",
  "email": "exemplo@sample.com",
  "address": { ... },
  "phones": [ { ... } ],
  "shareholders": [ { ... }]
}

LegalPerson 对象表示借款企业或担保企业（保证人）的数据，由以下字段组成：

名称类型描述
legal_namestring公司全称 （必填）。
trading_namestring商号名称
document_numberstringCNPJ，按本文档规定的格式填写 （必填）。
constitution_datedate公司注册成立日期，依据商业登记
constitution_typeenum公司组织形式：LLC、corp
emailstring公司代表的电子邮件
addressAddress公司总部地址
phoneslist of Phone公司联系电话列表
shareholderslist of NaturalPerson公司股东，以自然人模式（NaturalPerson 对象）表示

对象 Source​

Request Body: 通过自有网站进行的信用申请
{
  "channel": "website",
  "ip": "201.81.161.86",
  "session_id": "b8da64db-e8f8-47fc-8d8e-11ce26da499f"
}
Request Body: 通过自有应用程序进行的信用申请
{
  "channel": "app",
  "platform": "android",
  "ip": "201.81.161.86",
  "session_id": "b8da64db-e8f8-47fc-8d8e-11ce26da499f"
}

source 对象表示信用申请的来源渠道。

对象 Warrant​

对于具有某种担保的信用分析，可以使用 warrant 对象将其告知我们的 API。目前仅接受不动产担保，如需其他类型的担保，请联系我们的支持团队

Request Body
  {
    "warrant_type": "real_estate",
    "address": { ... },
    "property_type": "house",
    "estimated_value": 100000000,
    "forced_selling_value": 60000000
  }

对于 real_estate 类型的担保，对象由以下字段组成：

名称类型描述
warrant_typeenum定义担保类型。目前仅实现了 real_estate。
addressAddress作为担保的不动产的 Address 类型对象
property_typeenum不动产类型，目前可用：house、commercial_building、office、appartment
estimated_valueinteger不动产估计价值
forced_selling_valueinteger不动产估计强制拍卖价值

对象 ScrParameters​

Request Body
  {
    "scr_parameters": {
      "signers": [
        {
          "document_number": "111.222.333-44",
          "name": "Felipe Marques da Silva",
          "email": "felipe.silva@qitech.com.br",
          "phone": {
            "number": "991722315",
            "area_code": "16",
            "international_dial_code": "55"
          }
        }
      ],
      "signature_evidence": {
        "ip_address": "179.104.42.245",
        "session_id": "ddb1d063-4fdf-4330-af9c-3316e9142ff3",
        "access_token":         "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQSflKxwRJSMeKKF2QT4fwpMeJf36PO6yJV_adQssw5d",
        "additional_data": {
          ...
        },
        "signed_term": {
          "raw_text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas elementum erat et tempus dapibus. Donec eu sapien tortor. Pellentesque 
            et tortor eget erat pulvinar mattis. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Proin ornare diam arcu, sit amet auctor lorem varius quis. Ut pretium venenatis magna sed ultrices. Donec quis tortor odi."
        }
      }
    }
  }
名称类型描述
signersList of Signer将要签署或已签署 SCR 查询同意授权的人员列表。此对象仅在法人信用分析时需要发送。
signature_evidenceSignatureEvidence当在客户平台上请求授权时，用于发送在授权同意时收集的信息的对象。

对象 Signer​

Request Body
  {
    "document_number": "111.222.333-44",
    "name": "Felipe Marques da Silva",
    "email": "felipe.silva@qitech.com.br",
    "phone": {
      "number": "991722315",
      "area_code": "16",
      "international_dial_code": "55"
    }
  }
名称类型描述
document_numberstring签署人的文件编号。
namestring签署人姓名。
emailstring签署人电子邮件。
phonePhone签署人电话。

对象 Signature_Evidence​

Request Body
  {
    "signature_evidence": {
      "ip_address": "179.104.42.245",
      "session_id": "ddb1d063-4fdf-4330-af9c-3316e9142ff3",
      "access_token":         "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQSflKxwRJSMeKKF2QT4fwpMeJf36PO6yJV_adQssw5d",
      "additional_data": {
        ...
      },
      "signed_term": {
        "raw_text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas elementum erat et tempus dapibus. Donec eu sapien tortor. Pellentesque 
          et tortor eget erat pulvinar mattis. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Proin ornare diam arcu, sit amet auctor lorem varius quis. Ut pretium venenatis magna sed ultrices. Donec quis tortor odi."
      }
    }
  }
名称类型描述
ip_addressstring签署人的 IP 地址
session_idstring用户在您平台上的会话标识符，应为可通过该标识符请求审计您平台 OptIn 操作的某个标识符。
access_tokenstring已登录用户在您平台上的标识符，应可通过该标识符请求该用户的注册审计。
additional_dataobject可配置的 JSON 对象，用于容纳合作伙伴认为相关的、能增加其平台内签署操作可信度/真实性的附加信息。
signed_termSignedTerm包含用于收集同意的条款相关信息的对象。

对象 SignedTerm​

Request Body
  {
    "raw_text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas elementum erat et tempus dapibus. Donec eu sapien tortor. Pellentesque et tortor eget erat pulvinar mattis. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Proin ornare diam arcu, sit amet auctor lorem varius quis. Ut pretium venenatis magna sed ultrices. Donec quis tortor odi."
  }
名称类型描述
raw_textstring正在签署的条款的纯文本内容。