Pular para o conteúdo principal

Objetos Compartilhados

Boa parte dos dados são compartilhados entre várias APIs. Abaixo as definições destes objetos podem ser localizadas de maneira facilitada.

Objeto email

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

O objeto email é utilizado para representar os e-mails 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
emailstringEndereço de e-mail cadastrado. (obrigatório)
validation_typeenumTipo de validação utilizada durante o cadastro do e-mail.
validation_keyguidId retornado pela API de validação de e-mail da QI Tech.

Existem os seguintes enumeradores para validation_type: zaig_api, company_email.

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 ie

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

O objeto ie é utilizado para representar as Inscrições Estaduais dentro do objeto de documents no endpoint de legal_person, bem como se foi utilizado algum meio de validação do mesmo. Ele é representado 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.: JUCESP, JUCEGO...)
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.

Objeto company_statute

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

O objeto company_statute é utilizado para representar documentos de constituição de empresas, como por exemplo um Contrato Social dentro do objeto de documents no endpoint de legal_person. Ele é representado da seguinte maneira:

nometipodescrição
ocr_keyguidId retornado pela API de OCR da QI Tech após envio da imagem ou PDF de um documento de constuição de uma empresa.

Objeto letter_attorney

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

O objeto letter_attorney é utilizado para representar procurações que instituem poderes a representantes legais dentro do objeto de documents no endpoint de legal_person. Ele é representado da seguinte maneira:

nometipodescrição
ocr_keyguidId retornado pela API de OCR da QI Tech após envio da imagem ou PDF de uma procuração.

Objeto address

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

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.
numberstringNúmero do imóvel, incluindo letras caso possua.
neighborhoodstringBairro, sem abreviações.
e.g.: Santa Felicidade
citystringNome completo da cidade, sem abreviações
ufstringA unidade federativa, com duas letras maiúsculas.
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.
validation_typeenumTipo de validação utilizada durante o cadastro do endereço.
ocr_keyguidId retornado pela API ou SDK de OCR da QI Tech após o envio da imagem comprovante de residência.

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.

Existem os seguintes enumeradores para validation_type: visit, zaig_ocr.

Objeto phone

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

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.
validation_typeenumTipo de validação utilizada durante o cadastro do telefone.
validation_keyguidId retornado pela API de validação de telefone da QI Tech.

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

Existem os seguintes enumeradores para as validações de telefone: zaig_sms, zaig_call, company_sms, company_call.

Objeto source

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

Um objeto source representa o conjunto de informações da plataforma utilizada pelo cliente para seu cadastramento. Para isso, os campos são:

nometipodescrição
channelstringCanal de venda/cadastro do cliente
platformstringPlataforma utilizada pelo cliente para realizar seu cadastro
ipstringIP coletado do device que o cliente foi cadastrado
session_idstringIdentificador único da sessão, utilizado para fazer o cruzamento do device scan com o cadastro em questão

Objeto face

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

Um objeto face representa uma validação de reconhecimento facial feita através das APIs ou SDKs da QI Tech por você para verificar a autenticidade do cliente prévio ao envio do cadastro. Para isso, os campos são:

nometipodescrição
validation_typeenumTipo da validação de reconhecimento facial realizada.
registration_keyguidIdentificador que a API ou SDK da QI Tech retornou para identificar aquele registro.
validation_keyguidIdentificador que a API ou SDK da QI Tech retornou para identificar aquela validação.

Existem os seguintes enumeradores para as validações de face: zaig_api e zaig_sdk.

Objeto partner

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

Um objeto partner representa os dados de um sócio da empresa que está sendo cadastrada, bem como informações referentes às validações que o sócio foi submetido durante seu processo de cadastro. Para isso, os campos são:

nometipodescrição
namestringNome completo do sócio sendo cadastrado
document_numberstringCPF do sócio sendo cadastrado, com pontos e hífens, de acordo com a padronização (obrigatório)
birthdatedateData de nascimento do sócio de acordo com a padronização
genderenumGênero do sócio: 'male' ou 'female'
nationalitystringA nacionalidade do sócio, em ISO 3166-1 alfa-3
mother_namestringNome completo da mãe do sócio
occupationstringProfissão do sócio sendo cadastrado
emailsEmailLista de objetos do tipo Email que descreve o endereço de e-mail do sócio
documentsDocumentObjeto do tipo Document de quaisquer documentos enviados no momento do cadastro do sócio
addressAddressObjeto do tipo Address que descreve o endereço da moradia do sócio
phonesLista de PhoneLista de objetos do tipo phone que possui a lista de telefones do sócio
sourceSourceObjeto do tipo Source que descreve as características da aplicação utilizada para envio do cadastro
faceFaceObjeto do tipo Face que descreve as informações da validação facial
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"
}
}

Um objeto legal_representative representa os dados de um representante legal da empresa que está sendo cadastrada, bem como informações referentes às validações que o representante legal foi submetido durante seu processo de cadastro. Para isso, os campos são:

nometipodescrição
namestringNome completo do representante legal sendo cadastrado
document_numberstringCPF do representante legal sendo cadastrado, com pontos e hífens, de acordo com a padronização
birthdatedateData de nascimento do representante legal de acordo com a padronização
genderenumGênero do representante legal: 'male' ou 'female'
nationalitystringA nacionalidade do representante legal, em ISO 3166-1 alfa-3
mother_namestringNome completo da mãe do representante legal
occupationstringProfissão do representante legal sendo cadastrado
emailsEmailLista de objetos do tipo Email que descreve o endereço de e-mail do representante legal
documentsDocumentObjeto do tipo Document de quaisquer documentos enviados no momento do cadastro do representante legal
addressAddressObjeto do tipo Address que descreve o endereço da moradia do representante legal
phonesLista de PhoneLista de objetos do tipo phone que possui a lista de telefones do representante legal
sourceSourceObjeto do tipo Source que descreve as características da aplicação utilizada para envio do cadastro
faceFaceObjeto do tipo Face que descreve as informações da validação facial