📘Homologação: POST https://datatrustapihml.clearsale.com.br/v1/transaction/\{transactionId}/backgroundcheck/company
Produção: POST https://datatrustapi.clearsale.com.br/v1/transaction/\{transactionId}/backgroundcheck/company
Acesse aqui a documentação técnica
Os serviços do Background Check Company tem retorno assíncrono. Primeiro faça a chamada do módulo passando o(s) serviço(s) desejado(s), depois, faça a consulta do resultado utilizando o método GET. Você também pode implementar um Webhook para ser notificado quando o resultado estiver pronto.
Nome | Descrição | Tipo | Valores Válidos | Obrigatório |
---|
checkParams | Parâmetros de consulta de background check | Tabela - CheckParams | - | Não |
services | Lista de serviços a serem consultados | String[] | "BasicInfos", "BasicInfosFull", "ReceitaFederal", "Verification" | Sim |
Nome | Descrição | Tipo | Obrigatório |
---|
document | CNPJ a ser consultado | String | Não (1) |
companyName | Nome do CNPJ a ser consultado | String | Não (1) |
fantasyName | Nome fantasia do CNPJ a ser consultado | String | Não (1) |
openingDate | Data de abertura do CNPJ | String | Não (1) |
email | E-mail contato do CNPJ | String | Não (1) |
address | Endereços | Tabela Address | Não (1) |
partners | Sócios do CNPJ | Tabela Partners | Não (1) |
legalRepresentatives | Representantes legais | Tabela LegalRepresentatives | Não (1) |
phones | Telefones | Tabela Phones | Não (1) |
cnaes | Códigos CNAE | Tabela Cnaes | Não (1) |
Nome | Descrição | Tipo | Obrigatório |
---|
street | Endereço | String | Não (1) |
number | Número endereço | String | Não (1) |
city | Cidade | String | Não (1) |
state | Estado | String | Não (1) |
zipCode | CEP | String | Não (1) |
Nome | Descrição | Tipo | Obrigatório |
---|
document | CPF do sócio | String | Não (1) |
partnerName | Nome do sócio | String | Não (1) |
Nome | Descrição | Tipo | Obrigatório |
---|
document | CPF do representante legal | String | Não (1) |
name | Nome do representante legal | String | Não (1) |
Nome | Descrição | Tipo | Obrigatório |
---|
areaCode | Código da área | String | Não (1) |
number | Número telefone | String | Não (1) |
Nome | Descrição | Tipo | Obrigatório |
---|
code | Código CNAE | String | Não (1) |
Observações:
- Parâmetros obrigatórios para alguns serviços. Caso um serviço em específico necessite da informação e ela não exista ainda em nossa base de dados, o serviços irá retornar que um parâmetro obrigatório não foi informado e será necessária nova requisição, informando o parâmetro faltante.
Dado | Descrição |
---|
transactionId | Identificador da transação da Plataforma Data Trust. |
backgroundCheckId | Identificador da requisição de Background Check. |