Objetos Compartilhados

Abaixo as definições de outros objetos utilizados ao longo da documentação.

Objeto 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"
}

O objeto Address é utilizado para representar endereços em toda a API, endereços no território brasileiro são representados da seguinte maneira:

nome	tipo	descrição
street	string	Rua do endereço, incluindo o logradouro, evitando, se possível, abreviações (obrigatório).
number	string	Número do imóvel, incluindo letras caso possua (obrigatório).
neighborhood	string	Bairro, sem abreviações (obrigatório). e.g.: Santa Felicidade
city	string	Nome completo da cidade, sem abreviações (obrigatório).
uf	string	A unidade federativa, com duas letras maiúsculas (obrigatório). e.g.: SP
complement	string	Quaisquer complementos para localizar o imóvel. e.g.: Apartamento 101, Conjunto 12
postal_code	string	O código postal da localidade, contendo o hífen (obrigatório).
country	string	Código ISO 3166-1 alfa-3 do país do endereço (obrigatório).

No caso dos endereços cujo país não seja Brasil ("BRA"), o postal_code e a unidade federativa poderão ser preenchidos livremente.

Objeto Phone

Request Body

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

Um objeto Phone representa um número telefônico, dentro ou fora do Brasil e sua classificação. Para isso, os campos são:

nome	tipo	descrição
international_dial_code	string	Código de discagem internacional, sem zero ou +, somente números (obrigatório).
area_code	string	Código de área, sem zero, somente números (obrigatório).
number	string	Número do telefone, sem o hífen (obrigatório).
type	enum	Tipo de número: celular, residencial, comercial, etc.

Existem os seguintes enumeradores para tipo de telefone: residential, commercial, mobile

Objeto 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"
}

O objeto cnh é utilizado para representar as CNHs em toda a API bem como se foi utilizado algum meio de validação dos mesmos. Eles são representados da seguinte maneira:

nome	tipo	descrição
register_number	string	Número do registro da CNH cadastrada.
issuer_state	enum	Enumerador do estado onde a CNH foi emitida
first_issuance_date	date	Data de primeira habilitação.
issuance_date	date	Data de emissão
expiration_date	date	Data de vencimento
category	enum	Categoria da CNH em letras maiúsculas
validation_type	enum	Tipo de validação utilizada durante o cadastro do documento.
ocr_key	guid	Id retornado pela API de validação de documento da QI Tech.

Existem os seguintes enumeradores para validation_type: zaig_api e zaig_sdk.

Objeto 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"
}

O objeto rg é utilizado para representar os RGs em toda a API bem como se foi utilizado algum meio de validação dos mesmos. Eles são representados da seguinte maneira:

nome	tipo	descrição
number	string	Número do documento cadastrado, incluindo formatação (Pontos, Hífens, Barras e outros).
issuer	string	Órgão emissor do documento (Sigla, e.g.: II, SESP...)
issuer_state	enum	UF emissor do documento.
issuance_date	date	Data de emissão do documento.
validation_type	enum	Tipo de validação utilizada durante o cadastro do documento.
ocr_key	guid	Id retornado pela API de validação de documento da QI Tech.

Existem os seguintes enumeradores para validation_type: zaig_api e zaig_sdk.

Objeto 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"
    }
  ]
}

O objeto NaturalPerson representa os dados de uma pessoa que pode ser o próprio tomador, um garantidor ou um sócio de uma empresa tomadora. Ele é composto por:

nome	tipo	descrição
name	string	Nome completo (obrigatório).
document_number	string	O CPF, formatado adequadamente (obrigatório).
birthdate	date	A data de nascimento da pessoa.
email	string	O email da pessoa.
gender	enum	O gênero da pessoa, de acordo com a lista de enumeradores.
address	Address	O endereço residencial da pessoa.
phones	list of Phone	Os telefones colhidos da pessoa.

Enumeradores de gênero:

male
female
undefined

Objeto 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": [ { ... }]
}

O objeto LegalPerson representa os dados de uma empresa que está tomando crédito ou garantindo o crédito (Fiador). Ele é composto por:

nome	tipo	descrição
legal_name	string	Razão social (obrigatório).
trading_name	string	Nome fantasia
document_number	string	O CNPJ, formatado conforme padrão estabelecido nesta documentação (obrigatório).
constitution_date	data	A data de constituição da companhia, conforme junta comercial
constitution_type	enumerador	O tipo de constituição da empresa: LLC, corp
email	string	O email do representante da empresa
address	Address	O endereço da matriz da companhia
phones	list of Phone	Os telefones colhidos da companhia
shareholders	list of NaturalPerson	Os sócios da companhia, no modelo de pessoa física (Objeto NaturalPerson)

Objeto Source

Request Body: Pedidos de crédito realizados por meio do site próprio

{
  "channel": "website",
  "ip": "201.81.161.86",
  "session_id": "b8da64db-e8f8-47fc-8d8e-11ce26da499f"
}

Request Body: Pedidos de crédito realizados por meio de aplicativo próprio

{
  "channel": "app",
  "platform": "android",
  "ip": "201.81.161.86",
  "session_id": "b8da64db-e8f8-47fc-8d8e-11ce26da499f"
}

O objeto source representa o local onde o pedido de crédito foi realizado.

Objeto Warrant

Para análises de crédito que possuam algum tipo de garantia, o objeto warrant pode ser utilizado para informá-lo à nossa API. No momento, somente garantias de imóvel são aceitas e caso seja necessário outro tipo de garantia, basta entrar em contato com o nosso suporte

Request Body

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

Para a garantia do tipo real_estate, o objeto é formado pelos seguintes campos:

nome	tipo	descrição
warrant_type	enum	Define o tipo de garantia. No momento somente real_estate está implementado.
address	Address	Objeto do tipo Address que identifica o imóvel dado como garantia
property_type	enum	O tipo de imóvel em questão, no momento estão disponíveis: house, commercial_building, office, appartment
estimated_value	integer	O valor estimado do imóvel
forced_selling_value	integer	O valor de venda forçada estimado do imóvel

Objeto 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."
        }
      }
    }
  }

nome	tipo	descrição
signers	Lista de Signer	Lista de pessoas que vão assinar ou assinaram a autorização de consentimento para consulta SCR. Este objeto só deve ser enviado no caso de análises de crédito de pessoas jurídicas.
signature_evidence	SignatureEvidence	Objeto que para envio das informações coletadas no momento da autorização de consentimento quando a autorização é solicitada na plataforma do cliente.

Objeto 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"
    }
  }

nome	tipo	descrição
document_number	string	Número do documento do assinante.
name	string	Nome do assinante.
email	string	Email do assinante.
phone	Phone	Telefone do assinante.

Objeto 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."
      }
    }
  }

nome	tipo	descrição
ip_address	string	IP do assinante
session_id	string	Identificador de sessão do usuário na sua plataforma, deve ser algum identificador que permita solicitar auditoria de um OptIn feito na sua plataforma através deste identificador.
access_token	string	Identificador do usuário logado na sua plataforma, deve ser possível solicitar auditoria de cadastro deste usuário através deste identificador.
additional_data	objeto	Objeto JSON configurável para acomodar informações adicionais que o parceiro julgar relevantes que adicionem fidelidade/credibilidade/autent icidade na assinatura realizada dentro de sua plataforma.
signed_term	SignedTerm	Objeto que traz informações sobre o termo que está sendo utilizado para coleta de consentimento.

Objeto 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."
  }

nome	tipo	descrição
raw_text	string	Texto plano do termo que está sendo assinado.

Objetos Compartilhados

Objeto Address​

Objeto Phone​

Objeto cnh​

Objeto rg​

Objeto NaturalPerson​

Objeto LegalPerson​

Objeto Source​

Objeto Warrant​

Objeto ScrParameters​

Objeto Signer​

Objeto Signature_Evidence​

Objeto SignedTerm​

Objeto Address

Objeto Phone

Objeto cnh

Objeto rg

Objeto NaturalPerson

Objeto LegalPerson

Objeto Source

Objeto Warrant

Objeto ScrParameters

Objeto Signer

Objeto Signature_Evidence

Objeto SignedTerm