Pesquisa

Pesquisa de pessoa identificável

POST https://www.pepdata.com/api/search_iperson

Endpoint para pesquisar uma pessoa identificável.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
name*	string	Nome da pessoa a pesquisar
birth_date	string	Data de nascimento da validação. \ Formato: yyyy-mm-dd \ Default: null

200: OK Pesquisa realizada com sucesso.

{
    "data": {
        "items": [
            {
              "id": "0bdeb685-8d0b-41ec-a3ff-996188fe2b22",
              "name": "João Pedro Silva",
              "birth_date": null,
              "death_date": null,
              "id_country": "PT",
              "score": 95,
              "country": "Portugal"
            },
            {
              "id": "d7c48e2d-8699-4064-b94c-d6e2106fdf85",
              "name": "João Pedro Pereira",
              "birth_date": "1933-05-25",
              "death_date": null,
              "id_country": "PT",
              "score": 76,
              "country": "Portugal"
            }
        ]
    },
    "version": "0.1",
    "timestamp": 1588599744111
}

400: Bad Request Nome inválido

{
    "message": {
        "version": 0.1,
        "timestamp": 1697029877505,
        "message": "O nome é inválido. Só são permitidos nomes:  • Com apenas caracteres latinos, apóstrofes, espaços, pontos ou hífenes;"
    }
}

Legenda

• id: id da pessoa identificável.

• name: nome da pessoa identificável.

• birth_date: data de nascimento da pessoa identificável.

• death_date: data de morte da pessoa identificável.

• id_country: país primário da pessoa identificável, no formato ISO 3166-1 alpha-2.

• source: fonte da lista de sanções, caso exista: EU, OFAC, HMTreasury ou UN.

• score: grau de semelhança.
• country: país primário da pessoa identificável.

De forma a obter melhores resultados, recomenda-se que leia a documentação referente à área de pesquisa.

Pesquisa de organizações sancionadas

POST https://www.pepdata.com/api/search_organization

Endpoint para pesquisar uma organização sancionada.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
name*	string	Nome da organização a pesquisar

200: OK Pesquisa realizada com sucesso.

{
    "data": {
        "items": [
            {
                "id": "894e61ca-0264-0ed2-542c-d5aa53ef407c",
                "name": "Fekete Szeptember",
                "score": 100
            }
        ]
    },
    "version": "0.1",
    "timestamp": 1588599744111
}

400: Bad Request Nome não introduzido

{
    "message": {
        "version": 0.1,
        "timestamp": 1697030330542,
        "message": "Por favor introduza o nome a pesquisar."
    }
}

Legenda

• id: id da organização sancionada.

• name: nome da organização sancionada.

• score: grau de semelhança.

Este endpoint executa uma pesquisa nas organizações presentes nas seguintes listas de sanções internacionais:

• United Nations Security Council Consolidated List

• EU Financial Sanctions Database

• OFAC Specially Designated Nationals and Blocked Persons List

• HM Treasury Financial Sanctions Targets

Importante: de momento, o nome da organização deverá coincidir com o nome presente na lista de sanções para que sejam devolvidos resultados.

Obtenção de relatório de pesquisa de entidades

POST https://www.pepdata.com/api/get_entities_search_report

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
name*	string	Nome da entidade a pesquisar

Response

200: OK Report gerado com sucesso

115KB

PEPData - Relatório de Pesquisa de Entidades - António Silva.pdf

pdf

Exemplo de relatório de pesquisa de entidades

400: Nome não introduzido

{
    "message": {
        "version": 0.1,
        "timestamp": 1697030777756,
        "message": "Por favor insira um nome."
    }
}