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:

NomeDescriçãoTipoValores VálidosObrigatório
checkParamsParâmetros de consulta de background checkTabela - CheckParams-Não
servicesLista de serviços a serem consultadosString[]"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:

  1. De momento o serviço "PEM" está disponível apenas para chamadas API, não sendo possíveis chamadas via interface.
  2. Agrupamento dos serviços referente às listas restritivas nacionais: "CEAF", "CEIS", "CNEP", "QGI", "TCU" e "ForcedLabour".
  3. Agrupamento dos serviços referente às listas restritivas internacionais: "OFAC", "UN", "EUCL", "FBI" e "GovUK".
  4. Agrupamento dos serviços referente a antecedentes criminais: "CriminalRecordsDPF", "CriminalRecordsPCMG e "CriminalRecordsPCSP".

Check Params

NomeDescriçãoTipoObrigatório
documentCPF a ser consultadoStringNão (1)
nameNome completo do CPF a ser consultadoStringNão (1)
socialNameNome social do CPF a ser consultadoStringNão (1)
birthDateData de nascimentoStringNão (1)
motherNameNome completo da mãeStringNão (1)
fatherNameNome completo do paiStringNão (1)
rgNúmero do rgStringNão (1)
issuanceDateRgData de emissão do RGStringNão (1)
genderGêneroStringNão (1)
emailEmailStringNão (1)
addressEndereçosTabela - AddressNão (1)
phonesTelefonesTabela - PhoneNão (1)

Address

NomeDescriçãoTipoObrigatório
streetEndereçoStringNão (1)
numberNúmero endereçoStringNão (1)
cityCidadeStringNão (1)
stateEstadoStringNão (1)
zipCodeCEPStringNão (1)

Phones

NomeDescriçãoTipoObrigatório
areaCodeCódigo da áreaStringNão (1)
numberNúmero telefoneStringNão (1)

Observações:

  1. 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:

DadoDescrição
transactionIdIdentificador da transação da Plataforma Data Trust.
backgroundCheckIdIdentificador da requisição de Background Check.