Pular para o conteúdo principal

Business KYC

O Business KYC realiza a verificação e retorno do nome completo de uma pessoa com base nos dados fornecidos, como parte do processo de identificação e validação de identidade.


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

CampoTipoObrigatórioDescrição
AuthorizationstringSimChave de API

Buscar empresa por CNPJ

Este endpoint retorna exclusivamente os dados da empresa associada ao CNPJ consultado, como parte do processo de verificação KYC.

Método

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

Corpo da requisição

{
"document": "123124141512",
"withProcess": true
}
CampoTipoObrigatórioDescrição
documentstringSimCNPJ válido
withProcessbooleanSimCom processo

Casos de sucesso sem a flag withProcess habilitada

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

CampoTipoDescrição
_idstringIdentificador do documento
tradeNamestringNome fantasia
officialNamestringNome oficial
statusstringStatus do CNPJ
membersObjectMembros da empresa

Exemplo caso de sucesso sem a flag withProcess habilitada

{
"_id": "12345678901234",
"tradeName": "ENTERPRISE",
"officialName": "ENTERPRISE S.A",
"status": "ATIVA",
"members": [
{
"since": "2020-01-22",
"person": {
"id": "2g246ef1-d5f4-4e43-bc78-49f58177cf36",
"type": "NATURAL",
"name": "Pessoa Física",
"taxId": "***123456**",
"age": "20-30"
},
"role": {
"id": 10,
"text": "Diretor"
}
}
]
}

Casos de sucesso com a flag withProcess habilitada

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

CampoTipoDescrição
_idstringIdentificador do documento
tradeNamestringNome fantasia
officialNamestringNome oficial
statusstringStatus do CNPJ
membersObjectMembros da empresa
processesObjectProcessos judiciais da empresa

Exemplo caso de sucesso com a flag withProcess habilitada

{
"_id": "12345678901234",
"tradeName": "ENTERPRISE",
"officialName": "ENTERPRISE S.A",
"status": "ATIVA",
"members": [
{
"since": "2020-01-22",
"person": {
"id": "2g246ef1-d5f4-4e43-bc78-49f58177cf36",
"type": "NATURAL",
"name": "Pessoa Física",
"taxId": "***123456**",
"age": "20-30"
},
"role": {
"id": 10,
"text": "Diretor"
}
}
],
"processes": [
{
"number": "12345678900987654321",
"subject": "HABILITACAO / JULGAMENTO / LICITACOES, DIREITO ADMINISTRATIVO",
"status": "ATIVO"
}
]
}

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