Professions KYC

O Professions KYC realiza a verificação e retorno das profissões associadas a uma pessoa com base no documento informado, como parte do processo de identificação e análise ocupacional.

---

Autenticação

A API utiliza autenticação baseada em chave de API (API Key), que deve ser enviada no cabeçalho das requisições para garantir o acesso seguro aos endpoints.

Cabeçalho da requisição

Campo	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Chave de API

Buscar profissões por CPF

Este endpoint retorna as profissões associadas à pessoa vinculada ao CPF consultado, com base no processo de verificação KYC.

Método

POST http://kyc.del.tech/kyc/professions

Corpo da requisição

{
    "document": "98765432100"
}

Campo	Tipo	Obrigatório	Descrição
document	string	Sim	CPF válido

Casos de sucesso

Caso obtenha uma resposta 200, segue abaixo todas as informações que poderão ser retornadas:

Campo	Tipo	Descrição
_id	string	Identificador do documento
professions	array	Lista detalhada de profissões associadas ao documento
totalProfessions	number	Total de profissões encontradas
totalActiveProfessions	number	Total de profissões ativas
totalIncome	number	Renda total somada (em reais)
totalIncomeRange	string	Faixa de renda total
totalDiscounts	number	Valor total de descontos
isEmployed	boolean	Indica se a pessoa possui vínculo empregatício ativo

Exemplo caso de sucesso

{
    "_id": "98765432100",
    "professions": [
        {
            "sector": "PRIVATE - 6201500 - DESENVOLVIMENTO DE PROGRAMAS DE COMPUTADOR",
            "country": "BRAZIL",
            "cnpj": "12345678000199",
            "company": "EMPRESA DE SOFTWARE LTDA",
            "level": "MANAGER",
            "status": "ACTIVE",
            "income": 7500,
            "incomeRange": "DE 5 A 10 SM",
            "start": "2019-03-15T00:00:00Z",
            "end": "9999-12-31T23:59:59.9999999",
            "dataCreateIn": "2020-05-10T00:00:00Z",
            "dataLastUpdateIn": "2024-01-20T00:00:00Z"
        }
    ],
    "totalProfessions": 1,
    "totalActiveProfessions": 1,
    "totalIncome": 7500,
    "totalIncomeRange": "DE 5 A 10 SM",
    "totalDiscounts": 0,
    "isEmployed": true
}

---

Casos de Erro

400 - Requisição inválida

Caso o documento informado não esteja em um formato válido.

{
    "status": 400,
    "timestamp": "2024-06-01T20:59:59.999Z",
    "responseTimeMiliseconds": 9,
    "errors": [
        "Documento inválido"
    ]
}

401 - Não autorizado

Caso não seja enviado um token válido.

{
    "status": 401,
    "timestamp": "2024-06-01T20:59:59.999Z",
    "responseTimeMiliseconds": 9,
    "errors": [
        "Unauthorized"
    ]
}