Solicitar Background Check
Endereço dos nossos serviços:
Homologação: POST https://datatrustapihml.clearsale.com.br/v1/transaction/{Id}/backgroundcheck
Produção: POST https://datatrustapi.clearsale.com.br/v1/transaction/{Id}/backgroundcheckAcesse aqui a documentação técnica
Os serviços do Background Check 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[] | "ArrestWarrent", "BasicInfos", "CEAF", "CEIS", "CNEP", "CNIA", "CriminalRecordsDPF", "CriminalRecordsPCMG", "CriminalRecordsPCSP", "EUCL", "FBI", "ForcedLabour", "GovUK", "OFAC", "PEP", "Protests 4", "QGI", "TCU", "UN", "ReceitaFederal", "RegistrationCheck", "NationalRestrictiveLists 1", "InternationalRestrictiveLists 2", "CriminalRecords 3" | Sim |
Check Params
Nome | Descrição | Tipo | Obrigatório |
---|---|---|---|
fullName | Nome completo do CPF a ser consultado | String | Não (1) |
birthDate | Data de nascimento | String | Não (1) |
mothersName | Nome completo da mãe | String | Não (1) |
fathersName | 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) |
Observações:
- Agrupamento dos serviços referente às listas restritivas nacionais: "CEAF", "CEIS", "CNEP", "CNIA", "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".
- O Serviço de Protestos está temporariamente indisponível.
Response:
Dado | Descrição |
---|---|
transactionId | Identificador da transação da Plataforma Data Trust. |
backgroundCheckId | Identificador da requisição de Background Check. |
** A partir de 27/03/2024 não retornaremos mais os dados relacionados a menores de idade em qualquer serviço do módulo (Clique no 🔗 LINK para saber mais)
Updated about 1 month ago
Veja mais: