Shared Objects

Many data structures are shared across different APIs. Below, you'll find simplified definitions for these shared objects.

email Object

Request Body

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

The email object is used to represent emails across the entire API, as well as whether any validation method was used. They are represented as follows:

name	type	description
email	string	Registered email address. (required)
validation_type	enum	Type of validation used during the email registration.
validation_key	guid	ID returned by QI Tech’s email validation API.

The following enumerators exist for validation_type: zaig_api, company_email.

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.

ie Object

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

The ie object is used to represent State Registration documents within the documents object in the legal_person endpoint, including information on whether any validation method was used. It is 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.: JUCESP, JUCEGO...).
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.

company_statute Object

Request Body

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

The company_statute object is used to represent company formation documents, such as an Articles of Incorporation, within the documents object in the legal_person endpoint. It is represented as follows:

name	type	description
ocr_key	guid	ID returned by QI Tech’s OCR API after sending the image or PDF of a company formation document.

letter_attorney Object

Request Body

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

The letter_attorney object is used to represent powers of attorney that grant authority to legal representatives within the documents object in the legal_person endpoint. It is represented as follows:

name	type	description
ocr_key	guid	ID returned by QI Tech’s OCR API after sending the image or PDF of a power of attorney document.

address Object

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

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

name	type	description
street	string	Street name, including thoroughfare, avoiding abbreviations whenever possible.
number	string	Property number, including letters if applicable.
neighborhood	string	Neighborhood, without abbreviations. e.g.: Santa Felicidade
city	string	Full city name, without abbreviations.
uf	string	Federal unit (state), using two uppercase letters. e.g.: SP
complement	string	Any additional information to help locate the property. e.g.: Apartment 101, Suite 12
postal_code	string	Postal code for the address, including the hyphen. (required)
country	string	ISO 3166-1 alpha-3 country code for the address.
validation_type	enum	Type of validation used during the address registration.
ocr_key	guid	ID returned by QI Tech’s OCR API or SDK after submitting the image of the proof of residence.

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

The following enumerators exist for validation_type: visit, zaig_ocr.

phone Object

Request Body

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

A phone object represents a phone number, either domestic or international, and its classification. The fields are:

name	type	description
international_dial_code	string	International dialing code, without zero or +, numbers only (required)
area_code	string	Area code, without zero, numbers only (required)
number	string	Phone number, without hyphen (required)
type	enum	Type of number: mobile, residential, commercial, etc.
validation_type	enum	Type of validation used during phone registration.
validation_key	guid	ID returned by QI Tech’s phone validation API.

The following enumerators exist for phone type: residential, commercial, and mobile.

The following enumerators exist for phone validations: zaig_sms, zaig_call, company_sms, company_call.

source Object

Request Body

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

A source object represents the set of information about the platform used by the client during their registration. The fields are:

name	type	description
channel	string	Sales channel/ client registration
platform	string	Platform used by the client to complete their registration
ip	string	IP address collected from the device at the time of registration
session_id	string	Unique session identifier, used to match the device scan with the corresponding registration

face Object

Request Body

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

A face object represents a facial recognition validation performed through QI Tech’s APIs or SDKs to verify the authenticity of the client prior to registration submission. The fields are:

name	type	description
validation_type	enum	Type of facial recognition validation performed.
registration_key	guid	Identifier returned by QI Tech’s API or SDK to represent the registration.
validation_key	guid	Identifier returned by QI Tech’s API or SDK to represent the validation.

The following enumerators exist for validation_type: zaig_api and zaig_sdk.

partner Object

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

A partner object represents the data of a company's partner being registered, as well as information related to any validations the partner underwent during the registration process. The fields are:

name	type	description
name	string	Full name of the partner being registered
document_number	string	CPF of the partner, with periods and hyphens, following the standard format (required)
birthdate	date	Partner’s birthdate in the expected format
gender	enum	Partner’s gender: 'male' or 'female'
nationality	string	Nationality of the partner, in ISO 3166-1 alpha-3
mother_name	string	Full name of the partner’s mother
occupation	string	Profession of the partner being registered
emails	Email	List of Email objects describing the partner’s email addresses
documents	Document	Document object representing any documents submitted during the partner’s registration
address	Address	Address object representing the partner’s residential address
phones	List of Phone	List of phone objects with the partner’s phone numbers
source	Source	Source object describing the platform used for submitting the registration
face	Face	Face object containing information on the facial validation

legal_representative Object

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

A legal_representative object represents the data of a company’s legal representative being registered, as well as information regarding any validations they underwent during the registration process. The fields are:

name	type	description
name	string	Full name of the legal representative being registered
document_number	string	CPF of the legal representative, with periods and hyphens, following the standard format
birthdate	date	Legal representative’s birthdate in the expected format
gender	enum	Legal representative’s gender: 'male' or 'female'
nationality	string	Nationality of the legal representative, in ISO 3166-1 alpha-3
mother_name	string	Full name of the legal representative’s mother
occupation	string	Profession of the legal representative being registered
emails	Email	List of Email objects describing the legal representative’s email addresses
documents	Document	Document object representing any documents submitted during the representative’s registration
address	Address	Address object representing the legal representative’s residential address
phones	List of Phone	List of phone objects with the legal representative’s phone numbers
source	Source	Source object describing the platform used for submitting the registration
face	Face	Face object containing information on the facial validation

Shared Objects

email Object​

cnh Object​

rg Object​

ie Object​

company_statute Object​

letter_attorney Object​

address Object​

phone Object​

source Object​

face Object​

partner Object​

legal_representative Object​

email Object

cnh Object

rg Object

ie Object

company_statute Object

letter_attorney Object

address Object

phone Object

source Object

face Object

partner Object

legal_representative Object