Objeto Natural Person

Ao final do cadastro de uma pessoa física em sua plataforma, é necessário executar a avaliação de fraude e de KYC deste cliente, o que deve ser realizado através do endpoint de Natural Person. Os dados enviados deverão ser os dados finais, que não serão alterados em hipótese alguma, isto é, não deverá existir a possibilidade de se realizar uma alteração nos dados básicos de cadastro como CPF, Nome, Data de Nascimento e outros após este processo. Isto é muito importante para garantir dois pontos:

• Consistência dos dados na base de dados do Antifraude
• Avaliação realista do risco, evitando fraudes em momentos posteriores da operação

Definição do Objeto Natural Person

Request Body

{
  "id": "12345678",
  "registration_id": "12345678",
  "registration_date": "2019-12-11T11:37:15.12-03:00",
  "client_category": "Premium User",
  "name": "John Sample",
  "document_number": "111.111.111-11",
  "birthdate": "1992-09-15",
  "gender": "male",
  "nationality": "BRA",
  "mother_name": "Maria Sample",
  "father_name": "John Sample",
  "monthly_income": 500000,
  "declared_assets": 7500000,
  "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",
    "ocr_key": "265b1b74-4b93-41dc-ac78-e1c37467225d"
  },
  "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.201.26.1",
    "session_id": "54b8e3cf-15de-41e5-9305-0ecf059d6e2a"
  },
  "face":
  {
    "type":"zaig_sdk",
    "registration_key":"46f38cf4-07b2-4de6-93e9-64b51a68378a"
  }
}

Todas as trocas de informação de um cadastro utilizam a seguinte definição para este objeto. Em alguns casos, para facilitar a implementação e diminuir o fluxo de dados entre as partes, algumas informações poderão ser omitidas.

nome	tipo	descrição
id	string	Identificador da análise. É essencial que este número seja único para cada requisição (obrigatório)
registration_id	string	Identificador do cadastro no sistema do cliente. Para realizar mais de uma análise referente a um mesmo cadastro, apenas utilize o mesmo registration_id nas diferentes análises. Este campo não é obrigatório e terá o mesmo valor do id quando não enviado.
registration_date	datetime	Data e hora do cadastro (obrigatório)
client_category	string	Categoria do cliente de acordo com a classificação da sua plataforma ou seu programa de fidelidade
name	string	Nome completo do indivíduo sendo cadastrado
document_number	string	CPF do indivíduo sendo cadastrado, com pontos e hífens, de acordo com a padronização (obrigatório)
birthdate	date	Data de nascimento do indivíduo de acordo com a padronização
gender	enum	Gênero do indivíduo: 'male' ou 'female'
nationality	string	A nacionalidade do cadastro, em ISO 3166-1 alfa-3
mother_name	string	Nome completo da mãe
father_name	string	Nome completo do pai
monthly_income	integer	Renda mensal bruta em centavos de reais
declared_assets	integer	Patrimônio declarado em centavos de reais
occupation	string	Profissão do indivíduo sendo cadastrado
emails	Lista de Email	Lista de objetos do tipo Email que descreve o endereço de e-mail do indíviduo
documents	Document	Objetos do tipo CNH e RG
address	Address	Objeto do tipo Address que descreve o endereço da moradia do indivíduo
phones	Lista de Phone	Lista de objetos do tipo phone que possui a lista de telefones do indivíduo
source	Source	Objeto do tipo Source que descreve as informações provenientes da aplicação utilizada para envio do cadastro
face	Face	Objeto do tipo Face que descreve as informações da validação facial executada no cadastro, caso haja

Enviar um Natural Person

Request Body

  {
    "id": "12345",
    ...
  }

Response Body

  {
    "id": "12345",
    "analysis_status": "automatically_approved",
    "reason": "rule_decision_enum"
  }

Para realizar a avaliação de um Cadastro, basta enviar um objeto do tipo Natural Person ao seguinte endpoint com a flag setada adequadamente:

POST https://api.caas.qitech.app/onboarding/natural_person?analyze=true

O parâmetro analyze existe para identificar se o cadastro enviado deve ou não ser analisado pelos algoritmos da QI Tech. Caso um cadastro seja enviado com o parâmetro com o valor false, ele não será analisado nem cobrando, mas seus dados serão considerados pelos algoritmos da QI Tech para uma análise futura. O valor padrão deste parâmetro é true, de maneira que somente cadastros que forem explicitamente enviados com a flag false não serão analisados.