Este documento tem o objetivo de descrever todas as funções e módulos do sistema bem como auxiliar a integração com a API da T-Shield Tecnologia e os sistemas de sua empresa. Em caso de dúvidas durante o processo de integração, entre em contato conosco através do seguinte endereço de e-mail:
\n\nO primeiro passo para ter acesso a API da T-Shield Tecnologia, é acessar nosso painel de controle. Lá você poderá realizar a gestão dos usuários que terão acesso ao painel, configurar os seus modelos de análises e os acessos a API.
\nPara ter acesso ao Painel de Controle entre em contato com um consultor da T-Shield Tecnologia.
\nPara ter acesso a API, é preciso realizar, anteriormente, a configuração do ambiente da T-Shield. Após o cadastro da empresa e dos usuários será enviado os dados de acesso para a utilização dos serviços via API:
\n* Login
* Senha
* Empresa
Ao realizar o login, iremos enviar um token de autenticação JWT de deverá ser inserido Header das próximas chamadas. Para mais informações sobre o token JWT acesse jwt.io
\nEm nosso painel é possível realizar o cadastro de tipos de análises, onde vamos adicionar quais os serviços serão incluídos na análise e quais as regras e pesos serão utilizados para a definição do Score.
\nÉ possível realizar a criação de mais de um Tipo de Análise (Client Validation), que poderá ser utilizado para fluxos de validações diferentes.
\nO Id do tipo de análise (Client Validation Id) é exclusivo para o ambiente configurado, logo, ao configurar a o ambiente para produção, será gerado uma nova configuração e um novo Id.
\nIndicamos que o local onde são inseridos os parâmetros das credenciais também possua um campo de fácil alteração para o ID de validação do cliente.
\nApós a criação dos modelos de análises dentro do portal, será possível realizar a criação de link, para a capturar as imagens de selfie e documento, através de nosso ambiente white label.
\nCaso sua empresa já tenha um aplicativo ou web site para a coleta dessas informações, é possível enviar esses dados diretamente para a criação da análise.
\nPara realizar a criação de um link e/ou análise, é necessário informar qual o modelo de análise que iremos realizar, podendo ser informado de maneira pré-definida ou dinâmica.
\nPara criar um link e/ou análise de maneira pré-definida, será necessário informar o número de identificação do modelo de análise criado anteriormente no painel.
\nSegue abaixo um exemplo de como realizar a criação de um link através do modelo da análise pré-definido:
\n{\n \"client_validation_id\": 1234\n}\n\nTambém é possível realizar a escolha do modelo da análise, ao criar um novo link e/ou análise, de maneira dinâmica.
\nDentro do Painel, será possível criar regras com base em valores e ids para a escolha de qual modelo de análise ser realizado.
\nConforme a regra de negócio de sua empresa, essa decisão poderá ser realizada pelo valor de uma compra, quantidade de itens ou até mesmo sobre um produtos específico:
\nDiferente do link e/ou análise com escolha pré-definida de modelo de análise, para a escolha dinâmica é necessário enviar um lista de objetos contendo \"id\", número identificador do seu produto ou serviço, e \"value\", sendo o valor total ou unitário, para que, segunda as regras cadastradas, seja identificado qual o modelo será utilizado para a análise.
\nPara o caso da escolha do parâmetro \"Comparar Texto\" os campos \"id\" e \"value\" serão do tipo string.
\nSegue abaixo um exemplo de criar um link com o modelo de análise dinâmico:
\n{\n \"parameter_list\": [\n {\n \"id\": 1234,\n \"value\": 1400\n }\n ]\n}\n\nSegue abaixo a lista e a descrição das APIs oferecias pela T-Shield para integração com os sistemas de nossos clientes:
\n\n\nPara aplicações desenvolvidas em Java é necessário realizar a configuração considerando o encoding UTF-8.
\n
Os webhooks são uma forma dos aplicativos da web receberem notificações em tempo real quando o processamento de uma análise for concluído.
\nDepois de registrar um URI para receber webhooks em nosso portal, a T-Shield enviará uma solicitação HTTP para esse URI toda vez que houver um processamento for concluído, enviando as seguintes informações:
\nSegue abaixo exemplos de retorno do webhook:
\n{\n \"id\":90000,\n \"number\":\"ef8bef91-ac47-4348-b3a2-e749d3ace803\",\n \"token\":\"33be402d-cadd-48e8-995b-2ed760367ee8\",\n \"create_date\":\"2022-06-24T10:56:27.72\",\n \"cpf\":\"32586413822\",\n \"clientvalidation\":\"Modelo de Análise\",\n \"score\":null,\n \"id_check\":{\n \"status_process\":{\n \"id\":9,\n \"description\":\"Aprovado\"\n },\n \"score\":90.0\n },\n \"credit\":{\n \"status_process\":{\n \"id\":9,\n \"description\":\"Aprovado\"\n },\n \"score\":100.0\n },\n \"risk\":{\n \"status_process\":{\n \"id\":9,\n \"description\":\"Aprovado\"\n },\n \"score\":100.0\n },\n \"kyc\":{\n \"status_process\":{\n \"id\":3,\n \"description\":\"Concluído\"\n }\n },\n \"emails_confirmation\":[\n {\n \"confirmed\":true,\n \"email\":\"diegopassos1@gmail.com\",\n \"sent_date\":\"2022-06-24T10:56:28.903\",\n \"confirmed_date\":\"2022-06-24T10:58:23.77\"\n }\n ],\n \"log\":[\n ],\n \"status\":{\n \"id\":9,\n \"status\":\"Aprovado\",\n \"date\":\"2022-06-24T11:02:01.093\",\n \"user\":112258,\n \"description\":\"Aprovação automática\"\n }\n}\n\nAcesse o site webhook.site para realizar os teste de recebimento do webhook.
\nAbaixo estão os possíveis status de processamento da análise:
\nEm nosso portal, é possível configurar um modelo de análise específico para sua empresa, ou até mesmo uma análise para cada processo específico. Para isso, disponibilizamos os seguintes produtos:
\nId Check
\nAnálise de Crédito
\nAnálise de Risco
\nKYC (Know Your Customer)
\nDevice ID
\nAssinatura de Contratos
\nSolução para validação de identidades para prevenção a fraude, ferramenta que utiliza soluções de prova de vida, checagem de biometria facial em banco próprio e/ou de parceiros, análise automatizada de características de documentos e cruzamento de dados em bureaus de informação.
\nA validação de identidade é dividida nas seguintes partes:
\n* Face Id
* Prova de Vida
* Documento
* Dados de Contato
Com base na verificação desses itens, é possível realizar a confirmação de identidade da pessoa, obtendo assim um score. Abaixo estão os possíveis retornos para o score, e o risco representado.
\nAutomatize os processos de análises manuais com diversas consultas à mais de 200 fontes disponíveis e tome suas decisões de forma segura e assertiva.
\nChecagem e validação dos dados de pessoas do cadastrado, por consultas realizadas em fontes governamentais e privadas para análise de risco e fraude do seu processo. Verificamos: antecedentes criminais, óbito, status na Receita Federal, dívidas, processos jurídicos e etc.
\nA análise de crédito tem a finalidade de mitigar o risco nas operações de empréstimos realizadas com os seus clientes pessoa física e jurídica. Consultamos os principais bureaus de crédito do mercado, como Boa Vista, SPC, SERASA e Quod. É possível também utilizar suas credencias para consultas em serviços já contratados pela sua empresa.
\nA análise KYC (e-KYC) tem por finalidade consultar fontes relacionadas à prevenção de lavagem de dinheiro de modo a subsidiar as decisões da empresa contratante quando realizadas operações comerciais ou de crédito com os titulares, que importem em risco financeiro.
\nO Device Id é um token de identificação do dispositivo vinculado ao usuário. No momento da coleta de dados, conseguimos recuperar todas as caracteristicas do dispositivo, como nome e versão do navegador, sistema operacional e resolução de tela. Também é possível recuperar os dados de acesso, como geolocalização e IP.
Para os clientes que fazem a captura das informações, disponibilizamos um arquivo javascript que poderá ser incorporado em sua aplicação web:
https://portal.tshield.com.br/assets/vendor/deviceid/deviceid.prod.min.js
\nAdicione os seguinte código:
\n<comment class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'> Device Id -->\n<script src=\"js/deviceid.prod.min.js\" type=\"text/javascript\"></script>\n<script>\n DeviceID.send('ABc7DEdssf', '98765432100');\n</script>\n\nAo chamar o metodo DevideID.send(token, cpf), vamos automaticamente buscar os dados do dispositivo e enviá-los via API e gravar um token de identificação nos cookies do navegador.
\nOs parametros a serem enviados são:
\nToken de acesso fornecido pela T-Shield Tecnologia
\nNúmero do CPF do usuário do sistema para vincular o dispositivo
\nOferecemos a assinatura de contratos com validação biométrica, garantindo segurança e praticidade para o seu negócio. Desenvolvemos os modelos de contrato personalizados, integrando regras específicas para validação da biometria facial do cliente. O contrato é preenchido automaticamente com os dados fornecidos pelo cliente ou inseridos durante a criação do link. O cliente final receberá um link para coletar sua biometria facial, enviar documentos, confirmar seus dados e concluir a assinatura do contrato de forma simples e segura.
\nA configuração do modelo de contrato é feita no Painel de Controle da T-Shield, permitindo a adição de informações variáveis. Esses dados podem ser inseridos por meio de campos de 'Pré-Cadastro', preenchidos no momento da criação do link, ou através dos 'Campos Adicionais', onde o cliente final será responsável por fornecer as informações necessárias.
\nPara tanto, temos os seguintes fluxo:
\nContrato Pessoa Física
\nContrato Pessoa Jurídica
\nPara realizar a assinatura do contrato de pessoa física, devemos seguir os seguintes passos:
\nConfigurar o contrato no painel de controle da T-Shield
\nRealizar a chamada de API para Criar Link
\nEnviar link criado para o cliente final
\nConfigurar o recebimento da análise via Webhook
\nRealizar a chamada da API para buscar PDF do contrato assinado
\nPara realizar a assinatura do contrato de pessoa jurídica, devemos seguir os seguintes passos:
\nConfigurar o contrato no painel de controle da T-Shield
\nRealizar a chamada de API para Criar Análise - Pessoa Jurídica
\nRealizar a chamada de API para criar um novo link Criar Link
\nEnviar o link para o cliente final
\nConfigurar o recebimento da análise via Webhook
\nRealizar a chamada da API para buscar PDF do contrato assinado
\nNo fluxo de assinatura de contrato em PDF, recebemos o arquivo que precisa ser assinado pelo usuário no momento da criação do link. Para esse fluxo não temos a substituição de variáveis, ou seja, o arquivo PDF deve ser a versão final do contrato, já preenchidos.
\nPara realizar o envio do documento, é possivel enviar o arquivo em base64 ou através da URL. Para realizar o envio em base64, é necessário realizar a chamada Contrato - Enviar PDF
\nPara realizar a assinatura do contrato com o arquivo PDF, devemos seguir os seguintes passos:
\nEnviar o arquivo PDF via base64 (opcional) Contrato - Enviar PDF
\nRealizar a chamada de API para criar um novo link com o arquivo Contrato - Criar Link com PDF
\nEnviar o link para o cliente final
\nConfigurar o recebimento da análise via Webhook
\nRealizar a chamada da API para buscar PDF do contrato assinado
\nA seguir estão os métodos disponíveis para integração com a T-Shield:
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Produtos","slug":"produtos"},{"content":"Id Check","slug":"id-check"},{"content":"Análise de Risco","slug":"analise-de-risco"},{"content":"Análise de Crédito","slug":"analise-de-credito"},{"content":"KYC (Know Your Costumer)","slug":"kyc-know-your-costumer"},{"content":"Device Id","slug":"device-id"},{"content":"Assinatura de Contratos","slug":"assinatura-de-contratos"},{"content":"EndPoints","slug":"endpoints"}],"owner":"1143068","collectionId":"9fca7409-b3a8-411c-8c4c-a71a61347973","publishedId":"UVeJKQeT","public":true,"customColor":{"top-bar":"377dff","right-sidebar":"303030","highlight":"377dff"},"publishDate":"2026-02-11T12:38:44.000Z"},"item":[{"name":"Login","event":[{"listen":"test","script":{"id":"298c8708-8843-4043-98bd-79cd1564fd42","exec":["var jsonData = JSON.parse(responseBody);\r","pm.environment.set(\"authToken\", jsonData.user.token);"],"type":"text/javascript"}}],"id":"9557cd67-4d83-4189-99c5-1d4379d5a6fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"login\": \"{{login}}\",\r\n \"password\": \"{{password}}\",\r\n \"client\": \"{{client}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apih.tshield.com.br/api/login","description":"Chamada para realizar a autenticação com a API da T-Shield, retornando os dados de usuário e o token de acesso JWT para ser incorporado nas demais chamadas.
\nEsta chamada é utilizada para a criação de um token e link, que será enviado ao cliente final para a coleta de dados, como selfie e foto do documento, nas telas externas da T-Shield.
\nApós a configuração das características do token no portal da T-Shield, será possível gerar um token único, no qual possibilitará o vínculo do token ao usuário em seu sistema.
\nO resultado da análise será fornecido através do webhook onde forneceremos o número do token para a identificação de seu usuário final.
\nEsta chamada é realizada para criar uma nova análise, onde a coleta das informações do usuário final é realizada dentro de seu ambiente.
\nO resultado da análise será fornecido através do webhook onde forneceremos o número da análise para a identificação de seu usuário final.
\nEsta chamada é realizada para criar uma nova análise para pessoa jurídica, onde a coleta das informações da empresa é realizada dentro de seu ambiente.
\nO resultado da análise será fornecido através do webhook onde forneceremos o número da análise para a identificação de seu usuário final.
\nEsta chamada é utilizada para realizar o Id Check, ou seja, a validação de identidade, de maneira transacional.
\nTambém é possível realizar o Liveness 2D, onde realizamos a validação da foto enviada, verificando se era uma foto de foto. Caso retorne suspeita de foto de foto, recomendamos solicitar uma nova imagem.
\nAo receber os dados da pessoa, o processo de validação de identidade é realizado na hora, sem a necessidade da implementação do webhook.
\nPara realizar o Face Id, é necessário informar qual a fonte de dados será consultada:
\n* Simple
* Advanced
A confirmação de identidade se dará através o status de retorno, podendo retornar as seguintes opções:
\nEsta chamada é utilizada para realizar a análise Shield Pay, de maneira transacional.
\nAo receber os dados da pessoa, o processo de análise antifraude é realizado na hora, sem a necessidade da implementação do webhook.
\nTodas as configuração e escolhas de serviços verificados são realizadas dentro de nosso painel de controle, bem como a porcentagem de aprovação e reprovação dessa análise.
\nÉ possível realizar a configuração de mais de um tipo de análise, onde o Id deverá ser informado na chamda do Antifraude Web.
\n","urlObject":{"protocol":"https","path":["api","consultas","sync-query"],"host":["apih","tshield","com","br"],"query":[],"variable":[]}},"response":[{"id":"1b3cd8de-18b5-467f-a7dd-d0cc4b1a079c","name":"Sync Query","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 0,\r\n \"dados_pessoais\": {\r\n \"nome\": \"string\",\r\n \"cpf\": \"string\",\r\n \"endereco\": {\r\n \"logradouro\": \"string\",\r\n \"numero\": \"string\",\r\n \"bairro\": \"string\",\r\n \"cidade\": \"string\",\r\n \"uf\": \"string\",\r\n \"cep\": \"string\",\r\n \"complemento\": \"string\"\r\n },\r\n \"telefone\": {\r\n \"ddd\": \"string\",\r\n \"numero\": \"string\"\r\n },\r\n \"email\": \"string\"\r\n },\r\n \"cartao_de_credito\": {\r\n \"quatro_ultimos_numeros\": \"string\",\r\n \"nome\": \"string\",\r\n \"cpf\": \"string\"\r\n },\r\n \"dados_da_compra\": {\r\n \"data\": \"2022-09-28T12:40:53.626Z\",\r\n \"origem\": {\r\n \"cidade\": \"string\",\r\n \"UF\": \"string\",\r\n \"pais\": \"string\"\r\n },\r\n \"destino\": {\r\n \"cidade\": \"string\",\r\n \"UF\": \"string\",\r\n \"pais\": \"string\"\r\n },\r\n \"cia_aerea\": \"string\",\r\n \"valor_parcela\": 0,\r\n \"quantidade_parcelas\": 0\r\n },\r\n \"acompanhantes\": [\r\n {\r\n \"nome\": \"string\",\r\n \"cpf\": \"string\",\r\n \"relacao\": 0\r\n }\r\n ],\r\n \"device\": {\r\n \"history_guid\": \"string\",\r\n \"device_id\": \"string\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apih.tshield.com.br/api/consultas/sync-query"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"data_count\": 0,\n \"data\": {\n \"id\": 0,\n \"cpf\": \"string\",\n \"number\": \"string\",\n \"status_process_id\": 0,\n \"status_process\": \"string\",\n \"score\": 0,\n \"pep\": true,\n \"create_date\": \"2022-09-28T12:40:53.759Z\",\n \"info_check\": [\n {\n \"id\": 0,\n \"service\": {\n \"service_id\": 0,\n \"name\": \"string\",\n \"description\": \"string\",\n \"logo_image_path\": \"string\"\n },\n \"rule\": [\n {\n \"name\": \"string\",\n \"description\": \"string\",\n \"result\": true,\n \"query_related_person_id\": 0,\n \"point_when_true\": true,\n \"additional_information\": \"string\"\n }\n ],\n \"status_process\": {\n \"id\": 0,\n \"description\": \"string\",\n \"key\": \"string\"\n },\n \"start_process\": \"2022-09-28T12:40:53.759Z\",\n \"end_process\": \"2022-09-28T12:40:53.759Z\",\n \"log\": [\n {\n \"type\": 0,\n \"description\": \"string\",\n \"create_date\": \"2022-09-28T12:40:53.759Z\",\n \"error_id\": 0\n }\n ],\n \"person_face_result\": {\n \"face_result_avaliable\": true,\n \"face_result_probability\": \"string\",\n \"face_result_similarity\": 0,\n \"situation_code\": true,\n \"emotion\": 0,\n \"sadness\": 0,\n \"neutral\": 0,\n \"disgust\": 0,\n \"anger\": 0,\n \"surprise\": 0,\n \"fear\": 0,\n \"hapiness\": 0,\n \"age\": 0,\n \"smile\": 0,\n \"face_quality\": 0,\n \"ethnicity\": \"string\",\n \"log\": [\n {\n \"type\": 0,\n \"description\": \"string\",\n \"create_date\": \"2022-09-28T12:40:53.759Z\",\n \"error_id\": 0\n }\n ],\n \"match_score_total_average\": 0,\n \"face_match\": true,\n \"match_score\": 0,\n \"gender\": \"string\",\n \"process_id\": \"string\",\n \"has_biometry\": true,\n \"liveness\": 0,\n \"score\": 0,\n \"status\": 0,\n \"ocr_code\": 0,\n \"face_match_unico\": 0,\n \"status_description\": \"string\",\n \"event_date\": \"string\",\n \"event\": \"string\",\n \"rules\": [\n {\n \"name\": \"string\",\n \"description\": \"string\",\n \"result\": true,\n \"query_related_person_id\": 0,\n \"point_when_true\": true,\n \"additional_information\": \"string\"\n }\n ]\n }\n }\n ],\n \"log\": [\n {\n \"type\": 0,\n \"description\": \"string\",\n \"create_date\": \"2022-09-28T12:40:53.759Z\",\n \"error_id\": 0\n }\n ],\n \"device\": {\n \"cpf\": \"string\",\n \"guid\": \"string\",\n \"device_name\": \"string\",\n \"device_type_id\": 0,\n \"operational_system\": \"string\",\n \"operational_system_version\": \"string\",\n \"browser\": \"string\",\n \"browser_version\": \"string\",\n \"screen_resolution\": \"string\",\n \"create_date\": \"2022-09-28T12:40:53.759Z\",\n \"last_access_date\": \"2022-09-28T12:40:53.759Z\",\n \"access_total\": 0,\n \"log_access\": [\n {\n \"cpf\": \"string\",\n \"access_ip\": \"string\",\n \"log_access_date\": \"2022-09-28T12:40:53.759Z\",\n \"country_abbreviation\": \"string\",\n \"country\": \"string\",\n \"state\": \"string\",\n \"city\": \"string\",\n \"log_guid\": \"string\",\n \"latitude\": 0,\n \"longitude\": 0\n }\n ],\n \"latitude\": 0,\n \"longitude\": 0\n }\n },\n \"errors\": \"string\"\n}"}],"_postman_id":"b5195662-4d78-427e-9bb2-0e9c6ed2df98"},{"name":"Processos Judiciais","id":"0ec58c10-8056-4850-875f-525a71fac5d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"cpf_cnpj\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apih.tshield.com.br/api/consultas/processos-judiciais","description":"Esta chamada é utilizada para realizar a busca por Processos Judiciais.
\nA busca é realizada através do recebimento dos número do CPF, para busca por processos de pessoa física, e do número do CNPJ, para busca por precessos de pessoa jurídica.
\nAlém dos detalhes de processos, é retornado as seguintes validações:
\nAbaixo segue dados que retornamos dos processos:
\n","urlObject":{"protocol":"https","path":["api","consultas","processos-judiciais"],"host":["apih","tshield","com","br"],"query":[],"variable":[]}},"response":[{"id":"6bccf8c4-556d-4204-ad8e-742e8696029a","name":"Processos Judiciais","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"cpf_cnpj\": \"12345678900\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apih.tshield.com.br/api/consultas/processos-judiciais"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 30 Jan 2023 21:28:46 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"data_count\": 1,\n \"data\": {\n \"regras\": [\n {\n \"description\": \"Possui processo?\",\n \"result\": true\n },\n {\n \"description\": \"É réu em processo?\",\n \"result\": false\n }\n ],\n \"processos\": [\n {\n \"area\": \"CIVEL\",\n \"valorCausa\": {\n \"moeda\": \"R$\",\n \"valor\": 1234\n },\n \"grauProcesso\": 1,\n \"unidadeOrigem\": \"FORO DE UBATUBA\",\n \"urlProcesso\": \"https://esaj.tjsp.jus.br/cpopg/search.do\",\n \"sistema\": \"ABCD-TJSP\",\n \"dataProcessamento\": \"2022-11-02T03:24:01.326644\",\n \"partes\": [\n {\n \"tipo\": \"REQUERENTE\",\n \"polo\": \"ATIVO\",\n \"advogados\": [\n {\n \"oab\": {\n \"uf\": \"SP\",\n \"tipo\": \"ADVOGADO\",\n \"numero\": 222333\n },\n \"tipo\": \"ADVOGADO\",\n \"cpf\": \"98765432100\",\n \"nome\": \"NOME COMPLETO DO ADVOGADO\"\n }\n ],\n \"cpf\": \"123456789000\",\n \"nome\": \"NOME COMPLETO DA PARTE\"\n },\n {\n \"tipo\": \"REQUERIDA\",\n \"polo\": \"PASSIVO\",\n \"advogados\": [\n {\n \"oab\": {\n \"uf\": \"SP\",\n \"tipo\": \"ADVOGADO\",\n \"numero\": 333444\n },\n \"tipo\": \"CURESP\",\n \"cpf\": \"23456789011\",\n \"nome\": \"NOME COMPLETO DO ADVOGADO\"\n }\n ],\n \"cpf\": \"34567890122\",\n \"nome\": \"NOME COMPLETO DA PARTE\"\n }\n ],\n \"tribunal\": \"TJ-SP\",\n \"juiz\": \"NOME COMPLETO DO JUIZ\",\n \"uf\": \"SP\",\n \"segmento\": \"JUSTICA ESTADUAL\",\n \"dataDistribuicao\": \"2016-04-29T00:00:00\",\n \"movimentos\": [\n {\n \"data\": \"2019-05-10T00:00:00\",\n \"indice\": 184,\n \"eMovimento\": true,\n \"nomeOriginal\": [\n \"ARQUIVADO DEFINITIVAMENTE\"\n ]\n }\n \n ],\n \"processosRelacionados\": [\n {\n \"numeroProcesso\": \"0001234567890123456\"\n }\n ],\n \"classeProcessual\": {\n \"codigoCNJ\": \"7\",\n \"nome\": \"PROCEDIMENTO COMUM CIVEL\"\n },\n \"orgaoJulgador\": \"3ª VARA\",\n \"eProcessoDigital\": true,\n \"numeroProcessoUnico\": \"0001234567890123456\",\n \"statusObservacao\": \"EXTINTO\",\n \"assuntosCNJ\": [\n {\n \"codigoCNJ\": \"9593\",\n \"titulo\": \"LOCACAO DE IMOVEL\"\n },\n {\n \"codigoCNJ\": \"7768\",\n \"titulo\": \"RESCISAO DO CONTRATO E DEVOLUCAO DO DINHEIRO\"\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"0ec58c10-8056-4850-875f-525a71fac5d9"},{"name":"Detalhes da Análise","id":"e366e38a-49d8-431e-b287-fbd3dd88f955","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://apih.tshield.com.br/api/query/number/{{queryNumber}}","description":"Esta chamada é utilizada para realizar a busca de todos os detalhes da análise, bem como suas regras, validações, imagens recebidas e processadas.
\nPara melhor utilização da API, recomenda-se a realização desta chamada após o recebimento do webhook.
\nEsta chamada é utilizada para realizar a busca de todos os detalhes da última análise recebida de um CPF específico, bem como suas regras, validações, imagens recebidas e processadas.
\nPara melhor utilização da API, recomenda-se a realização desta chamada após o recebimento do webhook.
\n","urlObject":{"protocol":"https","path":["api","query","cpf","{{cpf}}"],"host":["apih","tshield","com","br"],"query":[],"variable":[]}},"response":[{"id":"7826519b-351c-42da-b602-ada493e4688d","name":"Detalhes da Análise","originalRequest":{"method":"GET","header":[],"url":"https://apih.tshield.com.br/api/query/cpf/{{cpf}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 11 Mar 2022 13:34:42 GMT"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 123456,\n \"cpf\": \"33598712477\",\n \"number\": \"d4962689-e5fc-4146-a97d-abfcbf111c52\",\n \"clientvalidation\": \"Tipo de Análise\",\n \"client_validation_id\": 1234,\n\t\"status_process\": {\n\t\t\"id\": 9,\n\t\t\"description\": \"Aprovado\"\n\t},\n \"create_date\": \"2022-02-21T15:47:19.82\",\n\t\"id_check\": {\n\t\t\"status_process\": {\n\t\t \"id\": 3,\n\t\t \"description\": \"Concluído\"\n\t\t},\n\t\t\"score\": 91,\n\t\t\"document\": {\t\t\n\t\t\t\"document_analyzer\": true,\n\t\t\t\"ocr\": {\n\t\t\t \"person\": {\n\t\t\t\t\"name\": \"LUCAS DE SOUSA NETO\",\n\t\t\t\t\"mothers_name\": \"FABIANA DE SOUSA OLIVEIRA\",\n\t\t\t\t\"fathers_name\": \"JOÃO PEREIRA DA SILVA\"\n\t\t\t },\n\t\t\t \"document\": {\n\t\t\t\t\"issuing_agency\": \"SSP\",\n\t\t\t\t\"issuing_agency_state\": \"SP\",\n\t\t\t\t\"date_of_expedition\": \"2018-08-14T00:00:00\",\n\t\t\t\t\"date_of_expiration\": \"2023-08-14T00:00:00\",\n\t\t\t\t\"date_of_first_drivers_licence\": \"2009-01-20T00:00:00\",\n\t\t\t\t\"local\": \"SAO PAULO, SP\",\n\t\t\t\t\"category\": \"B\",\n\t\t\t\t\"idcnh1\": \"VALIDA EM TODO\",\n\t\t\t\t\"rg_number\": \"29987662\",\n\t\t\t\t\"cpf_number\": \"335.987.124-77\",\n\t\t\t\t\"cnh_number\": \"0499865476\"\n\t\t\t },\n\t\t\t \"log\": []\n\t\t\t},\t\t\t\n\t\t\t\"images\": [\n\t\t\t {\n\t\t\t\t\"base64\": \"/9j/4AAQSkZJRgABAQAASABIAAD/...\",\n\t\t\t\t\"type\": \"DocumentoFrente\",\n\t\t\t\t\"url\": \"\"\n\t\t\t }\n\t\t\t]\n\t\t},\n\t\t\"face\": {\n\t\t\t\"liveness\": true,\n\t\t\t\"face_match\": true,\n\t\t\t\"face_id\": true,\n\t\t\t\"images\": [\n\t\t\t {\n\t\t\t\t\"base64\": \"/9j/4AAQSkZJRgABAQAASABIAAD/...\",\n\t\t\t\t\"type\": \"SelfieSorrindo\",\n\t\t\t\t\"url\": \"\"\n\t\t\t }\n\t\t\t]\n\t\t},\n\t\t\"contact_details\": {\n\t\t\t\"telephones\": [\n\t\t\t {\n\t\t\t\t\"ddd\": \"11\",\n\t\t\t\t\"telephone\": \"998776655\",\n\t\t\t\t\"ramal\": \"\",\n\t\t\t\t\"verified\": true\n\t\t\t }\n\t\t\t],\n\t\t\t\"emails\": [\n\t\t\t {\n\t\t\t\t\"email\": \"email@email.com\",\n\t\t\t\t\"verified\": true\n\t\t\t }\n\t\t\t],\n\t\t\t \"address\": [\n\t\t\t\t{\n\t\t\t\t \"address\": \"AV. BRASIL\",\n\t\t\t\t \"number\": \"1500\",\n\t\t\t\t \"complement\": \"\",\n\t\t\t\t \"district\": \"JARDINS\",\n\t\t\t\t \"city\": \"SAO PAULO\",\n\t\t\t\t \"uf\": \"SP\",\n\t\t\t\t \"postal_code\": \"01234000\",\n\t\t\t\t \"verified\": true\n\t\t\t\t}\n\t\t\t ]\n\t\t},\n\t\t\"start_process\": \"2022-02-21T15:47:23.527\",\n\t\t\"end_process\": \"2022-02-21T15:48:04.587\",\n\t\t\"log\": []\n\t},\n\t\"credit\": {\n\t\t\"status_process\": {\n\t\t \"id\": 1,\n\t\t \"description\": \"Aprovado\"\n\t\t},\n\t\t\"score\": 91,\n\t\t\"start_process\": \"2022-02-21T15:47:23.527\",\n\t\t\"end_process\": \"2022-02-21T15:48:04.587\",\n\t\t\"services\": [\n\t\t\t{\n\t\t\t\t\"name\": \"Service.TrabalhoEscravo\",\n\t\t\t\t\"description\": \"Cadastro de Empregador de Trabalho Escravo\",\n\t\t\t\t\"rule\": [\n\t\t\t\t {\n\t\t\t\t\t\"name\": \"Service.TrabalhoEscravo\",\n\t\t\t\t\t\"description\": \"Está na lista Empregadores envolvidos com Trabalho Escravo?\",\n\t\t\t\t\t\"result\": false,\n\t\t\t\t\t\"point_when_true\": false\n\t\t\t\t }\n\t\t\t\t],\n\t\t\t\t\"status_process\": {\n\t\t\t\t \"id\": 3,\n\t\t\t\t \"description\": \"Concluído\"\n\t\t\t\t},\n\t\t\t\t\"start_process\": \"2022-02-23T16:48:25.51\",\n\t\t\t\t\"end_process\": \"2022-02-23T16:48:25.543\",\n\t\t\t\t\"log\": []\n\t\t\t}\n\t\t],\n\t\t\"log\": [\n\t\t]\n\t}, \n\t\"risk\": {\n\t\t\"status_process\": {\n\t\t \"id\": 1,\n\t\t \"description\": \"Aprovado\"\n\t\t},\n\t\t\"score\": 91,\n\t\t\"start_process\": \"2022-02-21T15:47:23.527\",\n\t\t\"end_process\": \"2022-02-21T15:48:04.587\",\n\t\t\"services\": [\n\t\t\t{\n\t\t\t\t\"name\": \"Service.TrabalhoEscravo\",\n\t\t\t\t\"description\": \"Cadastro de Empregador de Trabalho Escravo\",\n\t\t\t\t\"rule\": [\n\t\t\t\t {\n\t\t\t\t\t\"name\": \"Service.TrabalhoEscravo\",\n\t\t\t\t\t\"description\": \"Está na lista Empregadores envolvidos com Trabalho Escravo?\",\n\t\t\t\t\t\"result\": false,\n\t\t\t\t\t\"point_when_true\": false\n\t\t\t\t }\n\t\t\t\t],\n\t\t\t\t\"status_process\": {\n\t\t\t\t \"id\": 3,\n\t\t\t\t \"description\": \"Concluído\"\n\t\t\t\t},\n\t\t\t\t\"start_process\": \"2022-02-23T16:48:25.51\",\n\t\t\t\t\"end_process\": \"2022-02-23T16:48:25.543\",\n\t\t\t\t\"log\": []\n\t\t\t}\n\t\t],\n\t\t\"log\": [\n\t\t]\n\t}, \n\t\"kyc\": {\n\t\t\"status_process\": {\n\t\t \"id\": 1,\n\t\t \"description\": \"Aprovado\"\n\t\t},\n\t\t\"start_process\": \"2022-02-21T15:47:23.527\",\n\t\t\"end_process\": \"2022-02-21T15:48:04.587\",\n\t\t\"services\": [\n\t\t\t{\n\t\t\t\t\"name\": \"Service.TrabalhoEscravo\",\n\t\t\t\t\"description\": \"Cadastro de Empregador de Trabalho Escravo\",\n\t\t\t\t\"rule\": [\n\t\t\t\t {\n\t\t\t\t\t\"name\": \"Service.TrabalhoEscravo\",\n\t\t\t\t\t\"description\": \"Está na lista Empregadores envolvidos com Trabalho Escravo?\",\n\t\t\t\t\t\"result\": false\n\t\t\t\t }\n\t\t\t\t],\n\t\t\t\t\"status_process\": {\n\t\t\t\t \"id\": 3,\n\t\t\t\t \"description\": \"Concluído\"\n\t\t\t\t},\n\t\t\t\t\"start_process\": \"2022-02-23T16:48:25.51\",\n\t\t\t\t\"end_process\": \"2022-02-23T16:48:25.543\",\n\t\t\t\t\"log\": []\n\t\t\t}\n\t\t],\n\t\t\"log\": [\n\t\t]\n\t},\n \"birth_date\": \"1985-01-01\",\n \"full_name\": \"LUCAS DE SOUSA NETO\",\n \"mothers_name\": \"FABIANA DE SOUSA OLIVEIRA\",\n \"fathers_name\": \"JOÃO PEREIRA DA SILVA\",\n \"log\": [],\n \"device\": {\n \"guid\": \"79ce2fcc-705a-4207-932f-9092eea32aae\",\n \"device_type_id\": 3,\n \"operational_system\": \"iOS\",\n \"operational_system_version\": \"15.1\",\n \"browser\": \"Mobile Safari\",\n \"browser_version\": \"15.1\",\n \"screen_resolution\": \"414X896\",\n \"create_date\": \"2022-01-27T15:19:44.657-03:00\",\n \"last_access_date\": \"0001-01-01T00:00:00\",\n \"access_total\": 0,\n \"log_access\": [\n {\n \"cpf\": \"33598712477\",\n \"access_ip\": \"177.25.199.127\",\n \"log_access_date\": \"2022-02-21T15:41:27.453\",\n \"country_abbreviation\": \"BR\",\n \"country\": \"BRAZIL\",\n \"state\": \"SAO PAULO\",\n \"city\": \"BAURU\",\n \"log_guid\": \"48afe582-d147-49d4-ae6d-ba2f45266426\"\n }\n ]\n }\n }\n}"}],"_postman_id":"9666a5e1-d114-4a15-aadd-db1a7ad56b20"},{"name":"Buscar Contrato","id":"3b46321b-82ce-4895-8902-f9a13fa945f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://apih.tshield.com.br/api/query/{{queryNumber}}/contract-pdf","description":"Esta chamada é utilizada para realizar a busca do arquivo PDF, quando existe um contrato assinado previamente.
\n","urlObject":{"protocol":"https","path":["api","query","{{queryNumber}}","contract-pdf"],"host":["apih","tshield","com","br"],"query":[],"variable":[]}},"response":[{"id":"fc39734e-6eaa-4484-be6a-0ee242796179","name":"Buscar Contrato","originalRequest":{"method":"GET","header":[],"url":"https://apih.tshield.com.br/api/query/{{queryNumber}}/contract-pdf"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"121"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Permissions-Policy","value":"geolocation=(self \"https://livenessh.tshield.com.br\"),camera=(self \"https://livenessh.tshield.com.br\")"},{"key":"Content-Security-Policy","value":"default-src 'self' data: blob:; font-src 'self' fonts.googleapis.com fonts.gstatic.com stackpath.bootstrapcdn.com; img-src 'self' data: blob: *.googletagmanager.com logodownload.org *.blob.core.windows.net ws-public.interpol.int ; script-src 'self' 'unsafe-inline' 'unsafe-eval' blob: cdnjs.cloudflare.com www.googletagmanager.com maxcdn.bootstrapcdn.com; style-src 'self' 'unsafe-inline' unpkg.com maxcdn.bootstrapcdn.com stackpath.bootstrapcdn.com fonts.googleapis.com; frame-src 'self' livenessh.tshield.com.br *.google.com; connect-src 'self' data: apih.tshield.com.br apideviceh.tshield.com.br *.google-analytics.com; frame-ancestors 'self' https://particularmilhas.com.br https://www.w3schools.com https://teste-tshield.azurewebsites.net http://homologaws.vivakey.com.br https://homologaws.vivakey.com.br https://satbank-pt5728.flutterflow.app;"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"Date","value":"Tue, 15 Oct 2024 15:38:01 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": \"https://tshieldpublico.blob.core.windows.net/temporary/03aa7fda-2dfa-489e-84a7-47efd41234.pdf\"\n}"}],"_postman_id":"3b46321b-82ce-4895-8902-f9a13fa945f8"},{"name":"Quiz","id":"0fc28562-32e5-4bf9-be17-d0b3d178ac2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"number\": \"{{queryNumber}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apih.tshield.com.br/api/quiz","description":"Esta chamada realiza a criação de um questionário para ajudar na validação de identidade do usuário final.
\nPara realizar essa chamada, primeiro é necessário realizar a criação de uma nova nova análise, para que o questionário seja vinculado.
\nA quantidade e tipos de perguntas, bem como as possíveis questões devem ser primeiramente configuradas no portal da T-Shield.
\nEsta chamada é usada para enviar as respostas do questionário e obter o resultado do quiz.
\nAo receber as respostas, será confrontado as informações recebidas com as informações de nossa base de dados, para obter um score e o risco dessa operação.
\nEsta chamada é usada para criar um link de liveness 3D.
\nAo realizar essa chamada, retornaremos um token de identificação e uma URL para realizar o liveness 3D. Esse link deverá ser carregado dentro de seu site ou aplicativo através de um IFrame e/ou Web View.
\nO resultado da análise será obtido através da chamada da API de detalhes do liveness. Essa chamada deverá ser realizada com um intervalo mínimo de 5 segundos, até obtermos os valores para \"facetec_session_id\" e \"query_number\".
\nEsta chamada é utilizada para obter o resultado da liveness 3D.
\nEsta chamada é utilizada para enviar um arquivo de contrato em PDF no formato base64.
\nA T-Shield irá armazenar o arquivo em um blob interno e devolverá um id para que seja utilizado na criação de um link para assinatura.
\nEsta chamada é utilizada para a criação de um token e link, que será enviado ao cliente final para a coleta de dados, como selfie e foto do documento e assinatura de documentos, nas telas externas da T-Shield.
\nApós a configuração das características do token no portal da T-Shield, será possível gerar um token único, no qual possibilitará o vínculo do token ao usuário em seu sistema.
\nO resultado da análise será fornecido através do webhook onde forneceremos o número do token para a identificação de seu usuário final.
\n