OFAC - Lista de Sanções

O que é#

Na consulta OFAC - Lista de Sanções, você consulta indivíduos, grupos, entidades e países que são objeto de sanções econômicas e financeiras dos EUA.

Sobre a requisição#

Método: POST
Endereço: https://api.plexi.com.br/api/maestro/ofac/lista-sancoes

Parâmetros do header#

Nome	Tipo	Obrigatório?	Descrição
Authorization	String	Sim	Chave de API gerada no cadastro no Plexi, prefixada com `Bearer`
Callback	String	Não	URL para onde o resultado da requisição será enviado via HTTP POST.

Parâmetros do body#

Nome	Tipo	Obrigatório?	Descrição
nome	string	Sim	Nome a ser pesquisado.

Retornos possíveis da requisição#

Status	Significado	Descrição	Informações retornadas
201	Created	Solicitação criada	Campo requestId, com o ID da requisição criada.
422	Unprocessable Entity	A solicitação contém erro	Em quais campos houve erro.

Exemplos de retornos#

Status 201

JSON

{
  "requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}

Status 422

JSON

{
  "message": "The given data was invalid.",
  "errors": {
    "nome": [
      "O campo nome é obrigatório."
    ]
  }
}

Resultados da pesquisa (retornados no callback ou fazendo requisição à API de respostas)#

Valores possíveis do campo status

Status	Significado
negativo	NÃO foram encontrados registros com o nome pesquisado
positivo	Foram encontrados registros com o nome pesquisado

Resposta com status positivo

JSON

{
  "status": "positivo",
  "registros": [
    {
      "nome": "EXAMPLE BUSINESS",
      "url": "https://sanctionssearch.ofac.treas.gov/Details.aspx?id=00000000",
      "endereco": "No. 123, Sample Street; New York",
      "tipo": "Entity",
      "programas": [
        "BURMA-EO14014"
      ],
      "lista": "SDN",
      "score": "100"
    }
  ],
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

Resposta com status negativo

JSON

{
  "status": "negativo",
  "registros": [],
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}