Pular para o conteúdo principal

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:

nometipodescrição
streetstringRua do endereço, incluindo o logradouro, evitando, se possível, abreviações (obrigatório).
numberstringNúmero do imóvel, incluindo letras caso possua (obrigatório).
neighborhoodstringBairro, sem abreviações (obrigatório).
e.g.: Santa Felicidade
citystringNome completo da cidade, sem abreviações (obrigatório).
ufstringA unidade federativa, com duas letras maiúsculas (obrigatório).
e.g.: SP
complementstringQuaisquer complementos para localizar o imóvel.
e.g.: Apartamento 101, Conjunto 12
postal_codestringO código postal da localidade, contendo o hífen (obrigatório).
countrystringCó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:

nometipodescrição
international_dial_codestringCódigo de discagem internacional, sem zero ou +, somente números (obrigatório).
area_codestringCódigo de área, sem zero, somente números (obrigatório).
numberstringNúmero do telefone, sem o hífen (obrigatório).
typeenumTipo 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:

nometipodescrição
register_numberstringNúmero do registro da CNH cadastrada.
issuer_stateenumEnumerador do estado onde a CNH foi emitida
first_issuance_datedateData de primeira habilitação.
issuance_datedateData de emissão
expiration_datedateData de vencimento
categoryenumCategoria da CNH em letras maiúsculas
validation_typeenumTipo de validação utilizada durante o cadastro do documento.
ocr_keyguidId 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:

nometipodescrição
numberstringNúmero do documento cadastrado, incluindo formatação (Pontos, Hífens, Barras e outros).
issuerstringÓrgão emissor do documento (Sigla, e.g.: II, SESP...)
issuer_stateenumUF emissor do documento.
issuance_datedateData de emissão do documento.
validation_typeenumTipo de validação utilizada durante o cadastro do documento.
ocr_keyguidId 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:

nometipodescrição
namestringNome completo (obrigatório).
document_numberstringO CPF, formatado adequadamente (obrigatório).
birthdatedateA data de nascimento da pessoa.
emailstringO email da pessoa.
genderenumO gênero da pessoa, de acordo com a lista de enumeradores.
addressAddressO endereço residencial da pessoa.
phoneslist of PhoneOs 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:

nometipodescrição
legal_namestringRazão social (obrigatório).
trading_namestringNome fantasia
document_numberstringO CNPJ, formatado conforme padrão estabelecido nesta documentação (obrigatório).
constitution_datedataA data de constituição da companhia, conforme junta comercial
constitution_typeenumeradorO tipo de constituição da empresa: LLC, corp
emailstringO email do representante da empresa
addressAddressO endereço da matriz da companhia
phoneslist of PhoneOs telefones colhidos da companhia
shareholderslist of NaturalPersonOs 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:

nometipodescrição
warrant_typeenumDefine o tipo de garantia. No momento somente real_estate está implementado.
addressAddressObjeto do tipo Address que identifica o imóvel dado como garantia
property_typeenumO tipo de imóvel em questão, no momento estão disponíveis: house, commercial_building, office, appartment
estimated_valueintegerO valor estimado do imóvel
forced_selling_valueintegerO 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."
}
}
}
}
nometipodescrição
signersLista de SignerLista 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_evidenceSignatureEvidenceObjeto 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"
}
}
nometipodescrição
document_numberstringNúmero do documento do assinante.
namestringNome do assinante.
emailstringEmail do assinante.
phonePhoneTelefone 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."
}
}
}
nometipodescrição
ip_addressstringIP do assinante
session_idstringIdentificador 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_tokenstringIdentificador do usuário logado na sua plataforma, deve ser possível solicitar auditoria de cadastro deste usuário através deste identificador.
additional_dataobjetoObjeto 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_termSignedTermObjeto 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."
}
nometipodescrição
raw_textstringTexto plano do termo que está sendo assinado.