{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"9fca7409-b3a8-411c-8c4c-a71a61347973","name":"T-Shield Tecnologia","description":"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\n[contato@tshield.com.br](https://mailto:contato@tshield.com.br)\n\n## Painel de Controle\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.\n\nPara ter acesso ao Painel de Controle entre em contato com um consultor da T-Shield Tecnologia.\n\n## Autenticação\n\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\n\\* Login  \n\\* Senha  \n\\* Empresa\n\nAo 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](https://jwt.io/)\n\n## Tipo de Análise (_Client Validation_)\n\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\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.\n\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.\n\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.\n\n## Modelos de Análises\n\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.\n\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.\n\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.\n\n### Pré-Definido\n\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.\n\nSegue abaixo um exemplo de como realizar a criação de um link através do modelo da análise pré-definido:\n\n``` json\n{\n  \"client_validation_id\": 1234\n}\n\n ```\n\n### Dinâmico\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.\n\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.\n\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:\n\n| **Parâmetros** | **Comparações** |\n| --- | --- |\n| Id | Contém em uma lista de Ids |\n| Id | Não contém em uma lista de Ids |\n| Soma de valores | Igual à... |\n| Soma de valores | É maior do que... |\n| Soma de valores | É menor do que... |\n| Quantidade de itens | É igual à... |\n| Quantidade de itens | É maior do que... |\n| Quantidade de itens | É menor do que... |\n| Soma de valores por Id | É igual à... |\n| Soma de valores por Id | É maior que... |\n| Soma de valores por Id | É menor que... |\n| Comparar Texto | É igual à... |\n| Comparar Texto | É diferente de... |\n| Comparar Texto | Contém... |\n\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.\n\nPara o caso da escolha do parâmetro \"_Comparar Texto_\" os campos \"_id_\" e \"_value_\" serão do tipo string.\n\nSegue abaixo um exemplo de criar um link com o modelo de análise dinâmico:\n\n``` json\n{\n  \"parameter_list\": [\n    {\n      \"id\": 1234,\n      \"value\": 1400\n    }\n  ]\n}\n\n ```\n\n## API\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| **API** | **URL** | **Descrição** |\n| --- | --- | --- |\n| Login | \\[POST\\] api/login | Chamada para realizar a autenticação na API. |\n| Criar Link | \\[POST\\] api/query/external/token | Chamada para criar o token e o link para coleta das imagens. |\n| Criar Análise - Pessoa Física | \\[POST\\] api/query | Chamada para criar uma nova análise para pessoas físicas. |\n| Criar Análise - Pessoa Jurídica | \\[POST\\] api/query/company | Chamada para criar uma nova análise para pessoas jurídicas. |\n| Face Id - Transacional | \\[POST\\] api/consultas/face-id | Chamada para validação transacional de identidade |\n| Antifraude Web | \\[POST\\] api/consultas/antifraude-web | Chamada é utilizada para realizar a análise antifraude web, de maneira transacional. |\n| Detalhes da Análise | \\[GET\\] api/query/number/{number} | Chamada para buscar os detalhes de uma análise. |\n| Detalhes da Análise por CPF | \\[GET\\] api/query/cpf/{cpf} | Chamada para buscar os detalhes da ultima análise realizada para um CPF específico. |\n| Criar Quiz | \\[POST\\] api/quiz | Chamada para a criação do Quiz e recebimento do questionário. |\n| Resultado Quiz | \\[POST\\] api/quiz/result | Chamada para envio de respostas e obter o resultado do Quiz. |\n| Liveness 3D | \\[POST\\] api/token/liveness | Chamada para criar um link de liveness 3D |\n| Liveness 3D - Detalhes | \\[GET\\] api/token/{{queryNumber}}/facetec-session-id | Chamada utilizada para obter o resultado da liveness 3D |\n\n> Para aplicações desenvolvidas em Java é necessário realizar a configuração considerando o encoding _**UTF-8**_. \n  \n\n## Webhook\n\nOs 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.\n\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:\n\n| **Campo** | **Descrição** |\n| --- | --- |\n| id | Número sequencial de identificação da análise |\n| number | Número de identificação da Análise |\n| token | Número de identificação do token gerado ao enviar o link |\n| create_date | Data de criação da análise |\n| cpf | Número de CPF da pessoa objeto da análise |\n| clientvalidation | Descrição do tipo de análise realizada |\n| score | Pontuação atingida como resultado da análise |\n| id_check | Objeto com status e score do Id Check |\n| credit | Objeto com status e score dos serviços selecionados do grupo de crédito |\n| risk | Objeto com status e score dos serviços selecionados do grupo de risco |\n| kyc | Objeto com status e score dos serviços selecionados do grupo de KYC (Know Your Customer) |\n| status | Status de uma análise, segundo a configuração realizada por tipo de análise |\n\nSegue abaixo exemplos de retorno do webhook:\n\n``` json\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\n ```\n\nAcesse o site [webhook.site](https://webhook.site/) para realizar os teste de recebimento do webhook.\n\n## Status\n\nAbaixo estão os possíveis status de processamento da análise:\n\n| **ID** | **Status** | **Descrição** |\n| --- | --- | --- |\n| 1 | Pendente | Análise esta aguardando para ser processada. |\n| 2 | Processando | Análise em processamento |\n| 3 | Concluído | Análise foi processada, porém não existe nenhum produdo com Score selecionado. Ex. e-KYC. |\n| 4 | Erro | Ocorreu um erro ao realizar um processamento em um ou mais produtos. |\n| 9 | Aprovado | Análise aprovada segundo configuração do score. |\n| 10 | Reprovado | Análise reprovada segundo configuração do score. |\n| 14 | Aguardando Aprovação Manual | Análise precisa ser avaliada manualmente. |\n| 15 | Aguardando Face Id | Análise esta pendende de validação de face no Face Id. |\n| 19 | Documento ou Selfie inválida | Não foi possível realizar a análise pois a imagem do documento e/ou selfie é inválida. É necessário realizar uma nova análise com novas imagens. |\n\n# Produtos\n\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:\n\n- Id Check\n    \n- Análise de Crédito\n    \n- Análise de Risco\n    \n- KYC (Know Your Customer)\n    \n- Device ID\n    \n- Assinatura de Contratos\n    \n\n# Id Check\n\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.\n\nA validação de identidade é dividida nas seguintes partes:\n\n\\* Face Id  \n\\* Prova de Vida  \n\\* Documento  \n\\* Dados de Contato\n\nCom 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.\n\n| **Score** | **Descrição** |\n| --- | --- |\n| 0 a 35 | Face restrita ou com suspeita de fraude |\n| 40 | Selfie ou Documento Inválidos |\n| 41 a 69 | Face não conhecida ou novo cadastro |\n| 70 à 100 | Validação de identidade confirmada |\n\n# Análise de Risco\n\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.\n\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.\n\n# Análise de Crédito\n\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.\n\n| **Fontes** | **Descrição** |\n| --- | --- |\n| Boa Vista | Consulta no bureau da Boa Vista, verificando protestos unificados, débitos e ocorrências de débitos, talão de cheques sustados e score. |\n| Dívida Ativa SP | Consulta dados de débitos de pessoas físicas e jurídicas junto à Fazenda Pública, através do número da Certidão da Dívida Ativa (CDA), CNPJ, CPF, Inscrição Estadual ou Renavam. |\n| Quod | Consulta no bureau da Quod, verificando flag negativado, detalhes da negativação, score e renda presumida. |\n| DBJUS | Consulta em processos nos tribunais de justiça estaduais, federais e trabalhistas. |\n| SPC | Consulta no bureau da SPC, verificando inadimplência, alerta de documentos perdidos, crédito concedido e dívidas judiciais. |\n| Protestos IEPTB | Consulta a existencia e os dados de Protestos de pessoas físicas e jurídicas no Instituto de Estudos de Protesto de Titulos do Brasil (IEPTB). |\n| SERASA | Consulta no bureau da SERASA, verificando pendências internas, pendências financeiras, protestos nacionais e estaduais, cheques sem fundo no BACEN, alerta de documentos roubados, cheques sem fundo no varejo e registro de consultas. |\n\n# KYC (Know Your Costumer)\n\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.\n\n| **Fontes** | **Descrição** |\n| --- | --- |\n| Antecedentes Criminais / MG | Emite Atestado de Antecedentes no portal da Polícia Civil de Minas Gerais. Este serviço funciona com Carteiras de Identidade (RG) emitidas em Minas Gerais. |\n| Antecedentes Criminais / DPF | Consulta e emite a Certidão de Antecedentes Criminais que informa a existência ou não de registros criminais nos sistemas informatizados pelo Departamento de Polícia Federal (DPF). |\n| Antecedentes Criminais / SP | Emite Atestado de Antecedentes no Instituto de Identificação Ricardo Gumbleton Daunt (IIRGD), órgão da Secretaria da Segurança Pública de São Paulo. Este serviço funciona com Carteiras de Identidade (RG) emitidas em São Paulo. |\n| Análise Unitfour | Consulta informações de contato, como e-mail, endereço e telefone, informado se os dados fornecidos estão vinculados com o CPF fornecido na análise. |\n| Cadastro de empregador de trabalho escravo | Consulta se um CPF ou CNPJ está presente no cadastro de empregadores que tenham submetido trabalhadores a condições análogas à de escravo, organizada pela SIT (Secretaria de Inspeção do Trabalho). Esta é uma consulta offline baseada em uma lista publicada pela SIT de tempos em tempos. |\n| ICIJ / Offshore Leaks Database | Retorna os resultados da pesquisa no banco de dados de empresas internacionais, possivelmente suspeitas de fraudes, organizado pela International Consortium of Investigative Journalists. |\n| OFAC / Sanções | Pesquisa indivíduos e entidades presentes na lista de sanções da OFAC (Office of Foreign Assets Control traduzido para o português como \"Agência de Controles de Ativos\"). |\n| PEP Bacen | Consulta dos agentes públicos que desempenham ou tenham desempenhado, nos últimos cinco anos, no Brasil ou em países, territórios e dependências estrangeiros, cargos, empregos ou funções públicas relevantes, assim como seus representantes, familiares e outras pessoas de seu relacionamento próximo. |\n| Sanções ONU | Pesquisa indivíduos e entidades presentes na lista de sanções do conselho de segurança da Organização das Nações Unidas. |\n| DBJUS | Consulta em processos nos tribunais de justiça estaduais, federais e trabalhistas. |\n| Municípios com faixa de fronteira | Verifica se o endereço fornecido consta na lista de cidades que fazem fronteira com outros países. |\n| Receita Federal | Consulta na receita federal, verificando o status do cadastro de pessoa física, óbito e dados pessoais. |\n| Dívidas Trabalhistas (TST) | Consulta empresas falidas no Tribunal Superior do Trabalho (TST) |\n| Mandados de Prisão | Consulta mandados de prisão que possuem situação \"Aguardando Cumprimento\" e que ainda estão vigentes, no Banco Nacional de Mandados de Prisão do Conselho Nacional de Justiça através do CPF informado. |\n| Validação de E-mail | Valida se o e-mail informado esta ativo, pode receber mensagens e se está vinculado a alguma rede social, como Facebook, Google, Instagram e etc. |\n| Validação de Telefone | Valida se o telefone informado é válido, e se esta registrado a alguma rede social, como Facebook, Instagram, Whatsapp e etc. |\n\n# Device Id\n\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.  \nPara os clientes que fazem a captura das informações, disponibilizamos um arquivo javascript que poderá ser incorporado em sua aplicação web:\n\n[https://portal.tshield.com.br/assets/vendor/deviceid/deviceid.prod.min.js](https://portal.tshield.com.br/assets/vendor/deviceid/deviceid.prod.min.js)\n\nAdicione os seguinte código:\n\n``` html\n<comment class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;> Device Id                                  -->\n<script src=\"js/deviceid.prod.min.js\" type=\"text/javascript\"></script>\n<script>\n    DeviceID.send('ABc7DEdssf', '98765432100');\n</script>\n\n ```\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.\n\nOs parametros a serem enviados são:\n\n- Token de acesso fornecido pela T-Shield Tecnologia\n    \n- Número do CPF do usuário do sistema para vincular o dispositivo\n    \n\n# Assinatura de Contratos\n\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.\n\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.\n\nPara tanto, temos os seguintes fluxo:\n\n- Contrato Pessoa Física\n    \n- Contrato Pessoa Jurídica\n    \n\n## Fluxo Contrato Pessoa Física\n\nPara realizar a assinatura do contrato de pessoa física, devemos seguir os seguintes passos:\n\n1. Configurar o contrato no painel de controle da T-Shield\n    \n2. Realizar a chamada de API para [Criar Link](https://documenter.getpostman.com/view/1143068/UVeJKQeT#22a7996b-26b9-4756-a23c-a9a3ee4aaf54)\n    \n3. Enviar link criado para o cliente final\n    \n4. Configurar o recebimento da análise via Webhook\n    \n5. Realizar a chamada da API para buscar PDF do contrato assinado\n    \n\n## Fluxo Contrato Pessoa Jurídica\n\nPara realizar a assinatura do contrato de pessoa jurídica, devemos seguir os seguintes passos:\n\n1. Configurar o contrato no painel de controle da T-Shield\n    \n2. Realizar a chamada de API para [Criar Análise - Pessoa Jurídica](https://documenter.getpostman.com/view/1143068/UVeJKQeT#8219ba33-7e93-4e41-9492-96b7d40293cb)\n    \n3. Realizar a chamada de API para criar um novo link [Criar Link](https://documenter.getpostman.com/view/1143068/UVeJKQeT#22a7996b-26b9-4756-a23c-a9a3ee4aaf54)\n    \n4. Enviar o link para o cliente final\n    \n5. Configurar o recebimento da análise via Webhook\n    \n6. Realizar a chamada da API para buscar PDF do contrato assinado\n    \n\n## Fluxo Contrato PDF\n\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.\n\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](#)\n\nPara realizar a assinatura do contrato com o arquivo PDF, devemos seguir os seguintes passos:\n\n1. Enviar o arquivo PDF via base64 (opcional) [Contrato - Enviar PDF](https://documenter.getpostman.com/view/1143068/UVeJKQeT#2fa6df7f-9755-4497-b964-8a68ab7914c2)\n    \n2. Realizar a chamada de API para criar um novo link com o arquivo [Contrato - Criar Link com PDF](https://documenter.getpostman.com/view/1143068/UVeJKQeT#4f89b3d4-62e5-422f-af79-20913ea7e61a)\n    \n3. Enviar o link para o cliente final\n    \n4. Configurar o recebimento da análise via Webhook\n    \n5. Realizar a chamada da API para buscar PDF do contrato assinado\n    \n\n# EndPoints\n\nA seguir estão os métodos disponíveis para integração com a T-Shield:","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1143068","team":3085133,"collectionId":"9fca7409-b3a8-411c-8c4c-a71a61347973","publishedId":"UVeJKQeT","public":true,"publicUrl":"https://documenter-api.postman.tech/view/1143068/UVeJKQeT","privateUrl":"https://go.postman.co/documentation/1143068-9fca7409-b3a8-411c-8c4c-a71a61347973","customColor":{"top-bar":"377dff","right-sidebar":"303030","highlight":"377dff"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"377dff","right-sidebar":"303030","highlight":"377dff"}}]}},"version":"8.10.1","publishDate":"2026-02-11T12:38:44.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/8d9149980017fbfaf3cc760caa3589097e8487588315822729d6a3974f84a093","favicon":"https://res.cloudinary.com/postman/image/upload/v1644273114/team/wakotusmmtghfs7kh65b.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/UVeJKQeT"}