Validações
Obter validações
POST https://www.pepdata.com/api/get_validations
Endpoint para obter validações.
Headers
Authorization*
string
key [API_KEY]
Request Body
page
number
Página das validações
Default: 1
source
string
Origem das validações
Default: all
Valores possíveis:
all
upload
manual
status
string
Estado das validações
Default: all
Valores possíveis:
all
complete
complete_identified,
complete_not_identified
needs_attention
incomplete
id
string
Id da validação
id_custom
string
Id personalizável da validação
sort_by
string
Propriedade usada para a ordenação das validações Valores possíveis:
added_at
determined_at
name
sort_dir
string
Ordenação descendente ou ascendente das validações Valores possíveis:
desc
asc
{
"version": 0.1,
"timestamp": 1688640113263,
"data": {
"count": 2,
"total": 2,
"page": 1,
"max_results_per_page": 50,
"items": [
{
"id": "0984f9f1-1895-dc5b-6530-9075825225aa",
"vatin": "628579388",
"source": "Automatic",
"name": "António Jorge Melo Lourenço Neco Rodrigues Fernandes",
"birth_date": "1931-07-19",
"id_country_nationality": "PT",
"id_country_residence": null,
"decision": null,
"id_iperson": 9bbf3184-8ced-4095-9cad-7e4dc664c9ee,
"iperson_classifications": [
"PEP",
"Familiar",
"Associado
],
"relations": [
{
"name": "António Silva",
"vatin": null,
"id_iperson": "5e809bc7-927e-3dc3-0ff8-ab9022843a5a",
"id_iorganization": null,
"relationship_type": "representative",
"id_relationship_info": "d0a4effc-576e-a4a2-f32e-9e594d7144ba"
}
],
"added_by": "cd9f4a64-ab25-4efb-bf31-323ee2280095",
"added_at": 1688639245750,
"determined_at": null,
"determined_by": null,
"identifiable_country": null,
"id_organization": "6cc1b6c1-33a9-4095-a4a4-aaca0db8d647",
"id_custom": null,
"entity_type": "individual",
"id_iorganization": null,
"adverse_media_searched_at": null,
"judicial_processes_searched_at": null,
"alerts": [],
"country_nationality": "Portugal"
},
{
"id": "a58dd84e-7e89-9904-5acf-2b1fbfcc8a31",
"vatin": "595596160",
"source": "Automatic",
"name": "Maria Edite Nieto",
"birth_date": null,
"id_country_nationality": "PT",
"id_country_residence": null,
"decision": null,
"id_iperson": null,
"iperson_classifications": null,
"relations": null,
"added_by": "cd9f4a64-ab25-4efb-bf31-323ee2280095",
"added_at": 1688639245750,
"determined_at": null,
"determined_by": null,
"identifiable_country": null,
"id_organization": "6cc1b6c1-33a9-4095-a4a4-aaca0db8d647",
"id_custom": null,
"entity_type": "individual",
"id_iorganization": null,
"adverse_media_searched_at": null,
"judicial_processes_searched_at": null,
"alerts": [
{
"id": "1d71c856-8dde-4815-9dce-1683e176a6f1",
"added_at": 1689244974065,
"resolved_by": null,
"resolved_at": null,
"reasons": [
"Há um novo resultado que pode corresponder a esta validação: Maria Edite Neto"
]
}
],
"country_nationality": "Portugal"
},
]
}
}Legenda
id: id da validação.
vatin: NIF da validação.
source: origem da validação.
name: nome da validação.
birth_date: data de nascimento da validação.
id_country_nationality: código do país da nacionalidade, no formato ISO 3166-1 alpha-2.
id_country_residence: código do país de residência, no formato ISO 3166-1 alpha-2.
decision: booleano que descreve se existiu correspondência com uma pessoa identificável.
id_iperson: id da pessoa identificável correspondente. null caso não tenha existido correspondência.
iperson_classifications: lista de classificações da pessoa identificável, possíveis valores:
Associado
Familiar
Titular de Outros Cargos
PEP
Sancionado (EU)
Sancionado (HM Treasury)
Sancionado (OFAC)
Sancionado (UN)
relations: lista de relações associadas à validação. Contém as seguintes propriedades:
name: nome da relação.
vatin: NIF da relação.
id_iperson: id da pessoa identificável associada à relação.
id_iorganization: id da organização identificável associada à relação.
relationship_type: tipo da relação. Valores possíveis:
representative
manager
beneficiary
beneficial_owner
id_relationship_info: id da relação.
added_by: id do utilizador que adicionou a validação.
added_at: data a que a validação foi adicionada, sob a forma de número de milissegundos desde 1 de Janeiro de 1970 00:00:00 UTC.
determined_at: data a que a validação foi determinada, sob a forma de número de milissegundos desde 1 de Janeiro de 1970 00:00:00 UTC.
determined_by: id do utilizador que determinou a validação.
identifiable_country: booleano que descreve se o país da validação se encontra sancionado.
id_organization: id da organização que criou a validação.
id_custom: id personalizável inserido pelo utilizador.
entity_type: tipo da validação, podendo ser: "individual" ou "organization".
id_iorganization: id da organização identificável correspondente. null caso não tenha existido correspondência.
adverse_media_searched_at: data da última procura de notícias adversas associadas ao nome da validação.
judicial_processes_searched_at: data da última procura de processos judiciais associados ao nome da validação.
alerts: alertas relacionados com a validação e que ainda estejam por resolver.
country_nationality: país de nacionalidade.
Exportar validações
POST https://www.pepdata.com/api/export_validations
Headers
Authorization*
string
key [API_KEY]
Request Body
from*
int
Data de início do filtro, sob a forma de número de milissegundos desde 1 de Janeiro de 1970 00:00:00 UTC
until*
int
Data de fim do filtro, sob a forma de número de milissegundos desde 1 de Janeiro de 1970 00:00:00 UTC
status
string
Estado das validações
Default: all
Valores possíveis:
all
complete
complete_identified,
complete_not_identified
needs_attention
incomplete
format
string
Formato do ficheiro exportado Default: xlsx Valores possíveis:
xlsx
csv
export_by
string
Exportar validações por data de adição ou data de determinação. Default: added_at Valores possíveis:
added_at
determined_at
timezone
string
Fuso horário dos timestamps utilizados nos filtros Default: Europe/Lisbon
Response
Obter alertas das validações
POST https://www.pepdata.com/api/get_alerts
Headers
Authorization*
string
key [API_KEY]
Request Body
id_validation
string
Id da validação
ids_validations
string array
Array de ids de validações
status
string
Estado dos alertas
Default: unresolved
Valores possíveis:
all
resolved
unresolved
from
int
Data de início do filtro, sob a forma de número de milissegundos desde 1 de Janeiro de 1970 00:00:00 UTC
until
int
Data de fim do filtro, sob a forma de número de milissegundos desde 1 de Janeiro de 1970 00:00:00 UTC
include_comments
boolean
Parâmetro para solicitar informação sobre os comentários associados aos alertas.
Default: false
Valores possíveis:
true
false
page
number
Página dos alertas.
Default: 1
Legenda
id: id do alerta.
id_validation: id da validação.
name: nome da pessoa identificável.
birth_date: data de nascimento da pessoa identificável.
id_country_nationality: código do país da nacionalidade, no formato ISO 3166-1 alpha-2.
added_at: data a que o alerta foi criado, sob a forma de número de milissegundos desde 1 de Janeiro de 1970 00:00:00 UTC.
resolved_at: data a que o alerta foi resolvido, sob a forma de número de milissegundos desde 1 de Janeiro de 1970 00:00:00 UTC.
resolved_by: utilizador que resolveu o alerta.
status: estado do alerta.
reason: razão da criação do alerta.
country_nationality: país de nacionalidade.
comments: comentários associados ao alerta.
id: id do comentário.
comment: comentário.
Adicionar validação
POST https://www.pepdata.com/api/add_validation
Endpoint para adicionar uma validação.
Headers
Authorization*
string
key [API_KEY]
Request Body
name*
string
Nome da validação
birth_date
string
Data de nascimento da validação.
Parâmetro usado apenas em validações de pessoas. Formato: yyyy-mm-dd Default: null
ignore_duplicates
boolean
Instrução para ignorar a verificação de duplicados.
Formato: 0/1
Default: 0
country_nationality
string
País de nacionalidade da validação.
Parâmetro usado apenas em validações de pessoas. Formato: Nome do país (ver nota abaixo) Default: null
country_residence
string
País de residência da validação.
Parâmetro usado apenas em validações de pessoas.
Formato: Nome do país (ver nota abaixo) Default: null
country
String
País da validação.
Parâmetro usado apenas em validações de organizações.
Formato: Nome do país (ver nota abaixo)
Default: null
vatin
string
NIF da validação
Default: null
id_custom
string
Id personalizável da validação
Default: null
type
string
Tipo de entidade, podendo ser: "individual" ou "organization"
Default: "individual"
Legenda
id: id da validação criada.
Analisar validação
POST https://www.pepdata.com/api/analyze_validation
Endpoint para consultar os resultados obtidos da análise de uma validação.
Headers
Authorization*
string
key [API_KEY]
Request Body
id
string
Id da validação
include_iperson_details
boolean
Incluir informação acerca das classificações, ocupações e relações das pessoas identificáveis. Formato: true/false
Default: false
Legenda
id: id da pessoa identificável.
name: nome da pessoa identificável.
birth_date: data de nascimento da pessoa identificável.
score: grau de semelhança.
classifications: classificações da pessoa identificável.
occupations: lista de ocupações da pessoa identificável:
organization: organização da ocupação.
organ: orgão da ocupação.
position: posição na ocupação.
source: link da fonte que relaciona a pessoa identificável à ocupação.
start_date: data de início da ocupação.
end_date: data de fim da ocupação.
comments: notas relevantes sobre a ocupação.
relationships: lista de relações da pessoa identificável
relationship_type: tipo de relação.
relationship_to: nome do familiar da pessoa identificável.
source: link da fonte com informação sobre a relação.
end_date: data de fim da relação.
comments: notas relevantes sobre a relação.
Determinação de validação
POST https://www.pepdata.com/api/determine_validation
Endpoint para determinar uma validação.
Headers
Authorization*
string
key [API_KEY]
Request Body
id
string
Id da validação
id_entity
string
Id da pessoa ou organização identificável correspondente.
Apagar validação
POST https://www.pepdata.com/api/delete_validation
Endpoint para apagar uma validação.
Headers
Authorization*
string
key [API_KEY]
Request Body
id
string
Id da validação
Aplicação das regras
POST https://www.pepdata.com/api/apply_rules
Endpoint para aplicação das regras de validação.
Headers
Authorization*
string
key [API_KEY]
Legenda
time_to_conclusion: tempo estimado em segundos para a conclusão da operação.
A leitura da documentação relativa à aplicação das regras de validação é fortemente recomendada, uma vez que a aplicação sem a sua correta compreensão poderá provocar alterações indesejadas.
Obter comentários
POST https://www.pepdata.com/api/get_comments
Endpoint para obter comentários.
Headers
Authorization*
string
key [API_KEY]
Request Body
page
number
Página dos comentários.
Default: 1
type
string
Tipo de comentários.
Valores possíveis:
determination
alert
judicial_process
adverse_media
id_validation
string
Id da validação associada aos comentários.
Legenda
id: id do comentário.
comment: comentário.
added_at: data em que o comentário foi adicionado, sob a forma de número de milissegundos desde 1 de Janeiro de 1970 00:00:00 UTC.
added_by: utilizador que adicionou o comentário.
id_validation: id da validação associada ao comentário.
id_iperson: id da pessoa identificável correspondente, caso o tipo do comentário seja "determination".
id_validation_alert: id do alerta de validação correspondente, caso o tipo do comentário seja "alert".
id_validation_judicial_process: id do processo judicial associado correspondente, caso o tipo de comentário seja "judicial_process".
id_validation_adverse_media: id da notícia adversa associada correspondente, caso o tipo de comentário seja "adverse_media".
id_added_by: id do utilizador que adicionou o comentário.
Adicionar um comentário
POST https://www.pepdata.com/api/add_comment
Endpoint para adicionar um comentário.
Headers
Authorization*
string
key [API_KEY]
Request Body
id_validation*
string
Id da validação
id_iperson
string
Id da pessoa identificável correspondente. Este parâmetro é obrigatório caso o comentário a adicionar seja referente à identificação de uma validação.
comment*
string
Comentário
id_validation_alert
string
Id do alerta de validação correspondente. Este parâmetro é obrigatório caso o comentário a adicionar seja referente a um alerta de validação.
id_validation_judicial_process
string
Id do processo judicial associado correspondente. Este parâmetro é obrigatório caso o comentário a adicionar seja referente a um processo judicial.
id_validation_adverse_media
string
Id da notícia adversa associada correspondente. Este parâmetro é obrigatório caso o comentário a adicionar seja referente a uma notícia adversa.
Legenda
id: id do comentário adicionado.
Editar um comentário
POST https://www.pepdata.com/api/edit_comment
Endpoint para editar um comentário.
Headers
Authorization*
string
key [API_KEY]
Request Body
id*
string
Id do comentário a editar
comment*
string
Comentário
Apagar um comentário
POST https://www.pepdata.com/api/delete_comment
Endpoint para apagar um comentário.
Headers
Authorization*
string
key [API_KEY]
Request Body
id*
string
Id do comentário a apagar
Obter relações de uma validação
POST https://www.pepdata.com/api/get_validation_relationships
Endpoint para obter relações de uma validação.
Headers
Authorization*
string
key [API_KEY]
Request Body
id_validation*
string
Id da validação
page
number
Página das relações.
Default: 1
Legenda
id: identificador da tabela de informações de relações.
id_relationship: id da relação.
relationship_type: tipo da relação
relationship_to: nome da validação para a qual se criou a relação.
id_relationship_to: id da validação para a qual se criou a relação.
id_relationship_from: id da validação a partir da qual se criou a relação.
added_by: utilizador responsável pela criação da relação.
added_at: data em que a relação foi adicionada, sob a forma de número de milissegundos desde 1 de Janeiro de 1970 00:00:00 UTC.
Adicionar uma relação a uma validação.
POST https://www.pepdata.com/api/add_validation_relationship
Endpoint para adicionar uma relação a uma validação.
Headers
Authorization*
string
key [API_KEY]
Request Body
organization_vat_number*
string
NIF da validação a partir da qual se vai criar a relação. Tem de ser obrigatoriamente uma validação de organização.
vat_number*
string
NIF da validação para a qual se vai criar a relação. Tem de ser obrigatoriamente uma validação de pessoa caso o tipo de relação seja representative, manager ou beneficial_owner.
position_in_organization*
string
Tipo de relação.
Valores possíveis: representative, manager, owner, beneficial_owner
Legenda
id: id da nova relação.
Editar uma relação de validação
POST https://www.pepdata.com/api/edit_validation_relationship
Endpoint para editar uma relação de validação
Headers
Authorization*
string
key [API_KEY]
Request Body
id_relationship_info*
string
identificador da tabela de informações das relações associado à relação a editar.
position_in_organization*
string
Tipo de relação.
Valores possíveis:
representative
manager
owner
beneficial_owner
Apagar uma relação de validação
POST https://www.pepdata.com/api/delete_validation_relationship
Endpoint para apagar uma relação de validação
Headers
Authorization*
string
key [API_KEY]
Request Body
id_relationship_info*
string
identificador da tabela de informações das relações associado à relação a editar.
Exportar o relatório da validação
POST https://www.pepdata.com/api/export_validation_pdf
Endpoint para obter o relatório de uma validação em formato pdf.
Headers
Authorization*
string
key [API_KEY]
Request Body
id*
string
Id da validação
timezone
string
Fuso horário em que serão apresentadas as horas e datas do relatório
Exemplos de valores possíveis:
Europe/Lisbon
America/Los_Angeles
Europe/Madrid
Last updated
Was this helpful?