Shared Objects

Below are the definitions of other objects used throughout the documentation.

Address Object

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

The _Address_ object is used to represent addresses throughout the API. Addresses located within Brazilian territory are represented as follows:

name	type	description
street	string	Street name, including full address line, avoiding abbreviations if possible (required).
number	string	Property number, including letters if applicable (required).
neighborhood	string	Neighborhood, without abbreviations (required). e.g.: Santa Felicidade
city	string	Full city name, without abbreviations (required).
uf	string	Federal unit, two uppercase letters (required). e.g.: SP
complement	string	Any additional details to help locate the property. e.g.: Apartment 101, Unit 12
postal_code	string	Postal code including hyphen (required).
country	string	ISO 3166-1 alpha-3 country code (required).

For addresses where the country is not Brazil ("BRA"), the postal_code and uf fields may be filled in freely.

Phone Object

Request Body

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

A Phone object represents a telephone number, either inside or outside Brazil, along with its classification. The fields are as follows:

name	type	description
international_dial_code	string	International dialing code, without zero or +, numbers only (required).
area_code	string	Area code, without leading zero, numbers only (required).
number	string	Phone number, without hyphen (required).
type	enum	Type of number: mobile, residential, commercial, etc.

The following enumerators are available for phone type: residential, commercial, mobile

cnh Object

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

The cnh object is used to represent driver’s licenses (CNHs) throughout the API, including information on whether any validation method was used. They are represented as follows:

name	type	description
register_number	string	Registration number of the registered CNH.
issuer_state	enum	Enumerator for the state where the CNH was issued.
first_issuance_date	date	Date of first issuance.
issuance_date	date	Date of issuance.
expiration_date	date	Expiration date.
category	enum	CNH category in uppercase letters.
validation_type	enum	Type of validation used during the document registration.
ocr_key	guid	ID returned by QI Tech’s document validation API.

The following enumerators exist for validation_type: zaig_api and zaig_sdk.

rg Object

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

The rg object is used to represent identity documents (RGs) throughout the API, including information on whether any validation method was used. They are represented as follows:

name	type	description
number	string	Registered document number, including formatting (dots, hyphens, slashes, etc.).
issuer	string	Issuing authority of the document (abbreviation, e.g.: II, SESP...).
issuer_state	enum	State (UF) where the document was issued.
issuance_date	date	Date the document was issued.
validation_type	enum	Type of validation used during the document registration.
ocr_key	guid	ID returned by QI Tech’s document validation API.

The following enumerators exist for validation_type: zaig_api and zaig_sdk.

NaturalPerson Object

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

The NaturalPerson object represents the data of an individual who may be the borrower, a guarantor, or a shareholder of a borrowing company. It consists of:

name	type	description
name	string	Full name (required).
document_number	string	CPF, properly formatted (required).
birthdate	date	Person's date of birth.
email	string	Person's email.
gender	enum	Person's gender, according to the enumerated values.
address	Address	Person's residential address.
phones	list of Phone	Person's phone numbers.

Gender enumerators:

• male
• female
• undefined

LegalPerson Object

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

The LegalPerson object represents the data of a company that is either taking out credit or acting as a guarantor. It consists of:

name	type	description
legal_name	string	Company’s legal name (required).
trading_name	string	Trade name
document_number	string	CNPJ, formatted according to the pattern defined in this documentation (required).
constitution_date	date	Company’s incorporation date, as per the Board of Trade
constitution_type	enumerator	Type of company incorporation: LLC, corp
email	string	Email of the company's representative
address	Address	Company’s headquarters address
phones	list of Phone	List of phone numbers collected from the company
shareholders	list of NaturalPerson	Company's shareholders, modeled as individuals (NaturalPerson object)

Source Object

Request Body: Credit requests made through the company's own website

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

Request Body: Credit requests made through the company's own mobile app

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

The source object represents the channel where the credit request was made.

Attention: If the desired sales channel does not fit into any of these categories, please contact the support team.

Warrant Object

For credit analyses that include any type of collateral, the warrant object can be used to inform our API. Currently, only real estate guarantees are accepted. If another type of guarantee is required, please contact our support team.

Request Body

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

For the real_estate guarantee type, the object consists of the following fields:

name	type	description
warrant_type	enum	Defines the type of guarantee. Currently, only real_estate is supported.
address	Address	Address object representing the property used as collateral
property_type	enum	Type of property. Currently supported: house, commercial_building, office, apartment
estimated_value	integer	Estimated market value of the property
forced_selling_value	integer	Estimated forced sale value of the property

Warning: If the desired guarantee does not fall into any of these categories, please contact the support team.

ScrParameters Object

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

name	type	description
signers	List of Signer	List of individuals who will or have signed the consent authorization for SCR consultation. This object should only be sent in the case of credit analyses for legal entities.
signature_evidence	SignatureEvidence	Object for sending the information collected at the time of consent authorization when the authorization is requested on the client's platform.

Signer Object

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

name	type	description
document_number	string	Signer's document number.
name	string	Signer's full name.
email	string	Signer's email address.
phone	Phone	Signer's phone number.

Signature_Evidence Object

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

name	type	description
ip_address	string	Signer's IP address.
session_id	string	User session identifier on your platform; must allow audit of the Opt-In performed using this identifier.
access_token	string	Identifier of the user logged into your platform; should support auditing of the user's registration based on this identifier.
additional_data	object	Configurable JSON object to include any extra data the partner considers relevant to enhance credibility/authenticity of the signature.
signed_term	SignedTerm	Object containing information about the consent term being used.

SignedTerm Object

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

name	type	description
raw_text	string	Plain text of the term being signed.