Listas Restritivas

Este endpoint verifica se o nome de uma pessoa se encontra em uma ou mais listas restritivas.

Request

GET /restricted-lists/?name={name}&list={list}

Parâmetros

Parâmetro	Descrição	Obrigatório
name	Nome da pessoa consultada	Sim
list	Lista desejada (ver opções abaixo)	Sim

Opções de listas (list):

• auxilioemergencial
• bacen
• candidatoseleitorais
• ceis
• cepim
• cnep
• cvm
• diariooficial
• europeias
• leniencia
• ofacsdn
• onu
• pep
• todas
• trabalhoescravo
• uk

DANGER

Caso seja utilizado o parâmetro todas, a busca será realizada em todas as listas e o valor tarifado será correspondente a somatória de cada consulta individual. Dessa forma, certifique-se que este é o parâmetro ideal para o seu cenário.

Response

Campo	Descrição	Tipo
id	ID único da requisição	String
version	Versão da API	String
data	Objeto com o resultado da busca	Object
data.found	Nome encontrado na lista buscada?	Boolean
data.lists	Lista com os nomes das listas buscadas	String[]
data.files	Lista com os arquivos respectivos das listas	String[]
metadata	Objeto com os metadatas da requisição	Object
metadata.timeSpent	Tempo da requisição	Number

Exemplo Request

GET /restricted-lists?name=Joao da Silva&list=ofacsdn

Exemplos JSON

Veja um exemplo em JSON da resposta.

Status Code: 200

{
  "id": "13cfec7c-b238-4820-a4d1-5173e4c1418e",
  "version": "v1",
  "data": {
    "found": false,
    "lists": [
      "OFACSDN"
    ],
    "files": [
      "20210802_sdn.xml"
    ]
  },
  "metadata": {
    "timeSpent": 10000
  }
}