Pessoa Física
Endereço dos nossos serviços:Homologação: POST https://datatrustapihml.clearsale.com.br/v1/transaction/{transactionId}/backgroundcheck/person
Produção: POST https://datatrustapi.clearsale.com.br/v1/transaction/{transactionId}/backgroundcheck/person
Acesse aqui a documentação técnica
Os serviços do Background Check Person 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.
Dicionário de Dados
Request:
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[] | "ArrestWarrant", "BasicInfos", "CEAF", "CEIS", "CNEP", "CriminalRecordsDPF", "CriminalRecordsPCMG", "CriminalRecordsPCSP", "EUCL", "FBI", "ForcedLabour", "GovUK", "OFAC", "PEM1","PEP" 2", "QGI", "ReceitaFederal", "RegistrationCheck","TCU", "UN", "NationalRestrictiveLists 3", "InternationalRestrictiveLists 4", "CriminalRecords 5" | Sim |
Observações:
- De momento o serviço "PEM" está disponível apenas para chamadas API, não sendo possíveis chamadas via interface.
- Agrupamento dos serviços referente às listas restritivas nacionais: "CEAF", "CEIS", "CNEP", "QGI", "TCU" e "ForcedLabour".
- Agrupamento dos serviços referente às listas restritivas internacionais: "OFAC", "UN", "EUCL", "FBI" e "GovUK".
- Agrupamento dos serviços referente a antecedentes criminais: "CriminalRecordsDPF", "CriminalRecordsPCMG e "CriminalRecordsPCSP".
Check Params
Nome | Descrição | Tipo | Obrigatório |
---|---|---|---|
document | CPF a ser consultado | String | Não (1) |
name | Nome completo do CPF a ser consultado | String | Não (1) |
socialName | Nome social do CPF a ser consultado | String | Não (1) |
birthDate | Data de nascimento | String | Não (1) |
motherName | Nome completo da mãe | String | Não (1) |
fatherName | Nome completo do pai | String | Não (1) |
rg | Número do rg | String | Não (1) |
issuanceDateRg | Data de emissão do RG | String | Não (1) |
gender | Gênero | String | Não (1) |
String | Não (1) | ||
address | Endereços | Tabela - Address | Não (1) |
phones | Telefones | Tabela - Phone | Não (1) |
Address
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) |
Phones
Nome | Descrição | Tipo | Obrigatório |
---|---|---|---|
areaCode | Código da área | String | Não (1) |
number | Número telefone | 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.
Response:
Dado | Descrição |
---|---|
transactionId | Identificador da transação da Plataforma Data Trust. |
backgroundCheckId | Identificador da requisição de Background Check. |
Updated about 9 hours ago