Compliance
Adição de um individuo
POST https://www.pepdata.com/api/compliance/add_individual
Endpoint para adicionar um indivíduo a uma secção de compliance.
Headers
Authorization*
string
key [API_KEY]
Request Body
name*
string
Nome próprio
vatin
string
NIF/NIPC
id_custom
string
Id personalizável
section
string
Secção onde o indivíduo irá ser adicionado.
Valores aceites:
customers
suppliers Default: customers
data
json
{
"personal_data": {
"email": "[email protected]",
"birth_date": "2010-10-10",
"nationalities": ["Portugal"],
"birth_place": "Portugal"
},
"entity_proof": {
"identification_metadata": {
"document_number": 123456789,
"is_document_perpetual": false,
"document_validity": "2023-05-20",
"document_issuing_entity": "Test",
"document_issuing_date": "2013-05-20",
"document_issuing_location": "Test"
}
},
"address_data": {
"type": "residence"**,
"country":"Portugal",
"postal_code":"1234-567",
"address_line_1":"Rua X",
"address_line_2":"nº123",
"city":"Lisboa",
"district":"Lisboa"
},
"suspicion_data": {
"is_suspect": false,
"reason": "Test"
},
}
**Valores aceites:
residence
fiscal_residence
headquarters
adverse_info_data_sources
array
Especificação das fontes de dados a pesquisar.
Valores aceites:
forensic
adverse_media
judicial_processes
{
"version": 0.1,
"timestamp": 1660060397561,
"data": {
"id_validation": "aa199264-c62e-3763-e3a5-68127b070720",
"id_questionnaire": "89da8ec5-d4d8-48ff-915f-e1e9a6715c4a",
"risk": 0,
"risk_category": "low",
"validation_status": "complete",
"iperson": {
"id": "0347e7ec-200f-4b6a-937c-96c66275e92c",
"name": "João Pedro Pereira",
"birth_date": "1933-05-25",
"score": 76,
"classifications": [
"pep",
"family_member",
"associate",
],
"occupations": [
{
"organization": "Governo da República Portuguesa",
"organ": "Ministério dos Negócios Estrangeiros",
"position": "Ministro",
"source": "https://test-link.com",
"start_date": "2005-01-01",
"end_date": "2030-01-01",
"comments": null
}
],
"relationships": [
{
"relationship_type": "son",
"relationship_to": "Flávio Alberto Roldão",
"source": "https://test-link.com",
"end_date": null,
"comments": null
},
{
"relationship_type": "spouse",
"relationship_to": "Albertina Hermínia da Corte",
"source": "https://test-link.com",
"end_date": null,
"comments": null
}
]
}
}
}Legenda
id_validation: Id da validação associada ao indivíduo criado.
id_questionnaire: Id do questionário associado ao indivíduo criado.
risk: valor do risco do questionário associado ao indivíduo criado.
risk_category: categoria em que se insere o valor do risco.
validation_status: estado da validação, podendo esta ser:
complete: Caso a aplicação tenha conseguido realizar a associação de maneira automática.
incomplete: Caso contrário.
iperson: pessoa identificável associada ao indivíduo adicionado, caso a aplicação tenha conseguido realizar a associação de maneira automática.
Adição de uma organização
POST https://www.pepdata.com/api/compliance/add_organization
Endpoint para adicionar uma organização a uma secção de compliance.
Headers
Authorization*
string
key [API_KEY]
Request Body
name*
string
Nome oficial
vatin
string
NIF/NIPC
id_custom
string
Id personalizável
section
string
Secção onde a organização irá ser adicionada.
Valores aceites:
customers
suppliers Default: customers
data
json
{
"company_data": {
"brand_name: "Brand Name",
"object": "test",
"nace_codes": ["01111"],
"country": "Portugal",
"foundation_date": "2005-02-01",
"countries_operations": ["Portugal"]
},
"entity_proof": {
"national_headquarters": true
},
"beneficiary_data": {
"rcbe_code": "123456"
},
"address_data": {
"country":"Portugal",
"postal_code":"1234-567",
"address_line_1":"Rua X",
"address_line_2":"nº 123",
"city":"Lisboa",
"district":"Lisboa"
},
"suspicion_data": {
"is_suspect": false,
"reason": "Test"
},
}
adverse_info_data_sources
array
Especificação das fontes de dados a pesquisar.
Valores aceites:
forensic
adverse_media
judicial_processes
{
"version": 0.1,
"timestamp": 1660060397561,
"data": {
"id_validation": "aa199264-c62e-3763-e3a5-68127b070720",
"id_questionnaire": "89da8ec5-d4d8-48ff-915f-e1e9a6715c4a",
"risk": 0,
"risk_category": "low",
"classifications": ["sanctioned_eu", "sanctioned_ofac"]
}
}Legenda
id_validation: Id da validação associada à organização criada.
id_questionnaire: Id do questionário associado à organização criada.
risk: valor do risco do questionário associado à organização criada.
risk_category: categoria em que se insere o valor do risco.
classifications: classificações associadas à organização adicionada, caso a aplicação tenha conseguido realizar a associação de maneira automática.
Last updated
Was this helpful?