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	restrições	descrição
id	string	1–50 caracteres	Identificador da análise. É essencial que este número seja único para cada requisição (obrigatório)
registration_id	string	1–50 caracteres	Identificador do cadastro no sistema do cliente. Para realizar mais de uma análise referente a um mesmo cadastro, utilize o mesmo registration_id nas diferentes análises. Terá o mesmo valor do id quando não enviado.
registration_date	datetime	ISO 8601 com fuso horário	Data e hora do cadastro. Formato: `YYYY-MM-DDTHH:MM:SS[.ffffff]±HH:MM` ou `...Z`. Exemplo: `2019-12-11T11:37:15.12-03:00` (obrigatório)
client_category	string	1–100 caracteres	Categoria do cliente de acordo com a classificação da sua plataforma ou programa de fidelidade
name	string	1–500 caracteres	Nome completo do indivíduo sendo cadastrado
document_number	string	Formato `XXX.XXX.XXX-XX`	CPF do indivíduo. Deve conter exatamente 14 caracteres, incluindo pontos e hífen (obrigatório)
birthdate	date	Formato `YYYY-MM-DD`	Data de nascimento do indivíduo
gender	enum	`male` ou `female`	Gênero do indivíduo
nationality	string	3 letras maiúsculas	Nacionalidade em código ISO 3166-1 alfa-3. Exemplo: `BRA`
mother_name	string	1–500 caracteres	Nome completo da mãe
father_name	string	1–500 caracteres	Nome completo do pai
monthly_income	integer	1 a 100.000.000.000	Renda mensal bruta em centavos de reais
declared_assets	integer	1 a 100.000.000.000.000	Patrimônio declarado em centavos de reais
occupation	string	1–100 caracteres	Profissão do indivíduo sendo cadastrado
emails	Lista de Email	—	Lista de objetos do tipo Email com os endereços de e-mail do indivíduo
documents	Document	—	Objetos dos tipos CNH, RG e outros documentos de identificação
address	Address	—	Objeto do tipo Address com o endereço de moradia do indivíduo
phones	Lista de Phone	—	Lista de objetos do tipo Phone com os telefones do indivíduo
source	Source	—	Objeto do tipo Source com informações da aplicação utilizada para envio do cadastro
face	Face	—	Objeto do tipo Face com informações da validação facial, caso haja

Formatos de Campo

`registration_date`

Deve seguir o formato ISO 8601 com fuso horário obrigatório. Exemplos de valores aceitos:

2019-12-11T11:37:15-03:00        (sem fração de segundos, offset)
2019-12-11T11:37:15.123456-03:00 (com fração de segundos, até 6 dígitos)
2019-12-11T14:37:15Z             (UTC)

O campo não aceita datas sem o componente de fuso horário (ex.: 2019-12-11T11:37:15 é inválido).

`document_number` — CPF

O CPF deve ser enviado com pontuação, no formato XXX.XXX.XXX-XX, onde cada X é um dígito numérico. O campo possui exatamente 14 caracteres.

`birthdate`

Data no formato YYYY-MM-DD (ano-mês-dia), conforme ISO 8601.

Exemplo válido: 1992-09-15

`nationality`

Código de país de 3 letras maiúsculas, seguindo o padrão ISO 3166-1 alfa-3.

Exemplos: BRA (Brasil), USA (Estados Unidos), ARG (Argentina).

`monthly_income` e `declared_assets`

Ambos os campos são inteiros que representam valores monetários em centavos de reais. Para converter de reais para o formato esperado, multiplique por 100.

Exemplo: R$ 5.000,00 → 500000

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.

Definição do Objeto Natural Person​

Formatos de Campo​

registration_date​

document_number — CPF​

birthdate​

nationality​

monthly_income e declared_assets​

Enviar um Natural Person​