Registros
Esta sección de la API aún está en desarrollo, por lo que puede sufrir cambios considerables. Esta página está en desarrollo.
Obtener registros
POST https://www.pepdata.com/api/get_questionnaires
Endpoint para obtener registros de transacciones y clientes.
Headers
Authorization*
string
key [API_KEY]
Request Body
id
string
Id de registro o transacción
id_custom
string
Id personalizable de registro o transacción
search_term
string
Término de búsqueda: Buscar en las columnas name, vatin e id_custom
page
integer
Página de registros o transacciones Default: 1
type
String
Tipo de registros
Default: customer
Valores aceptados:
customer
transaction
relationship
{
"data": {
"items": [
{
"id": "7dd49ce1-9385-0cd1-7835-828393771ea0",
"name": "individual",
"vatin": null,
"value": "{\"entity_proof\":{\"type\":\"\",\"identification_metadata\":{\"document_number\":\"\",\"document_validity\":\"\",\"is_document_perpetual\":\"\",\"document_issuing_entity\":\"\",\"document_issuing_date\":\"\",\"document_issuing_location\":\"\"},\"documentUpload\":{\"files\":[],\"type\":null,\"source\":null,\"extraData\":null,\"is_trustworthy\":null}},\"personal_data\":{\"name\":\"individual\",\"vatin\":null,\"email\":\"\",\"birth_date\":\"\",\"nationalities\":[],\"birth_place\":\"\",\"documentUpload\":{\"files\":[]}},\"address_data\":{\"type\":null,\"country\":null,\"cep\":\"\",\"address_line_1\":\"\",\"address_line_2\":\"\",\"city\":\"\",\"district\":\"\",\"documentUpload\":{\"files\":[],\"type\":null,\"source\":null,\"extraData\":null,\"is_trustworthy\":null}},\"occupation_data\":{\"type\":null,\"profession\":\"\",\"employer\":\"\",\"eni\":{\"commercial_name\":\"\",\"is_same_address\":null,\"address\":{\"country\":null,\"cep\":\"\",\"address_line_1\":\"\",\"address_line_2\":\"\",\"city\":\"\",\"district\":\"\"},\"cae\":\"\"},\"documentUpload\":{\"files\":[],\"type\":null,\"source\":null,\"extraData\":null,\"is_trustworthy\":null}},\"data_verification\":{\"type\":null,\"client_email\":\"\",\"documentUpload\":{\"files\":[],\"type\":null,\"source\":null,\"extraData\":null,\"is_trustworthy\":null},\"invite_sent\":false},\"adverse_media_data\":{\"adverse_media\":[]},\"suspicion_data\":{\"is_suspect\":null,\"reason\":\"\"},\"questionnaire_id\":\"7dd49ce1-9385-0cd1-7835-828393771ea0\",\"name\":\"individual\"}",
"type": "individual",
"main_entity_subtype": "regular",
"relations": null,
"added_by": "cd9f4a64-ab25-4efb-bf31-323ee2280095",
"added_at": 1693489958769,
"submitted_at": null,
"submitted_by": null,
"approval_state": null,
"approval_change_reason": null,
"risk": 0,
"risk_change_reason": null,
"saved_at": 1693491414116,
"assigned_to": null,
"id_invited_user": null,
"locked_by": null,
"locked_at": null,
"invited_submission_by": null,
"invited_submission_at": null,
"data_treatment_accepted_at": null,
"needs_attention": "[{\"reason\":\"onboarding:quick_registration.needs_attention.risk_configurations_changed\",\"needs_attention_date\":\"2025-06-26\",\"old_risk_category_key\":\"medium\",\"new_risk_category_key\":\"low\"}]",
"id_organization": "6cc1b6c1-33a9-4095-a4a4-aaca0db8d647",
"id_custom": null,
"invited_at": null,
"invited_by_organization_name": null,
"language": null,
"organization_id_country": "PT",
"id_iperson": "ID1",
"type": "customer",
"id_questionnaire_data": "4ba763f9-6675-949b-482c-35c689991d65"
"risk_category: "low"
}
],
"page": 1,
"max_results_per_page": 10,
"count": 1,
"total": 1
},
"version": "0.1",
"timestamp": 1648132877766
}Leyenda
id: id de registro
name: nombre del registro
vatin: NIF/CIF de registro
value: información de registro
entity_type: tipo de entidad (individual, colectivo o transaccion)
main_entity_subtype: subtipo de entidad (representante, titular real, etc...)
relations: relaciones asociadas al registro.
added_by: id del usuario que agregó el registro
added_at: fecha en que se agregó el registro, en milisegundos desde el 1 de enero de 1970 00:00:00 UTC
submitted_at: fecha en que se envió el registro, en milisegundos desde el 1 de enero de 1970 a las 00:00:00 UTC
submitted_by: id del usuario que envió el registro
approval_state: estado de aprobación del registro (0 - en espera de decisión, 1 - aprobado, -1 - rechazado)
approval_change_reason: justificación para cambiar el estado de aprobación
risk: valor de riesgo del registro
risk_change_reason: justificación del cambio de categoría de riesgo
saved_at: fecha en que se guardó el registro por última vez, en milisegundos desde el 1 de enero de 1970 a las 00:00:00 UTC
assigned_to: id del responsable del registro
id_invited_user: id del usuario invitado al completar el registro
locked_by: id del usuario que tiene el registro abierto
lock_at: fecha en que se abrió el registro por última vez, en milisegundos desde el 1 de enero de 1970 a las 00:00:00 UTC
invited_submission_by: id del usuario invitado que aceptó la invitación a rellenar
invited_submission_at: fecha en la que se aceptó la invitación de finalización, en forma de número de milisegundos desde el 1 de enero de 1970 00:00:00 UTC
data_treatment_accepted_at: fecha en la que se aceptaron las condiciones de tratamiento de datos del usuario invitado, en forma de número de milisegundos desde el 1 de enero de 1970 00:00:00 UTC
needs_attention: array de objetos con información sobre el motivo de cada una de las alertas.
id_organization: id de la organización que creó el registro
id_custom: id personalizable ingresado por el usuario
invited_at: fecha en que se envió la invitación a llenar, expresada en milisegundos desde el 1 de enero de 1970 00:00:00 UTC
invited_by_organization_name: nombre de la organización que envió la invitación a rellenar
language: idioma en el que se envió la invitación a completar
organization_id_country: país de la organización que creó el registro en formato ISO 3166-1 alpha-2
id_iperson: id de la persona identificable correspondiente. nulo si no hubo ninguna coincidencia.
type: tipo de registro.
id_questionnaire_data: id del registro donde se almacena la información del cuestionario.
risk_category: categoría en la que caie el valor del riesgo.
Agregando un registro
POST https://www.pepdata.com/api/add_questionnaire
Endpoint para agregar un registro de clientes y transacciones.
Headers
Authorization*
string
key [API_KEY]
Request Body
name*
string
Nombre del registro o transacción
vatin
string
NIF/CIF de registro
id_custom
string
id personalizable de registro
type*
string
Tipo de registro
Valores aceptados:
individual (registro de persona física)
organization (registro de persona jurídica)
transaction (Transacción)
questionnaire_data
Dependiendo de cada tipo de registro, se necesitan diferentes objetos:
indivudal
{
"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",
"cep":"1234-567",
"address_line_1":"Rua X",
"address_line_2":"nº123", "city":"Lisboa",
"district":"Lisboa"
},
"suspicion_data": {
"is_suspect": false,
"reason": "Test"
},
}
**Valores aceptados:
residence
fiscal_residence
headquarters
organization
{
"company_data": {
"brand_name": "Brand Name",
"object": "test",
"caes": ["01111"],
"country": "Portugal",
"foundation_date": "2005-02-01",
"countries_operations": ["Portugal"]
},
"entity_proof": {
"national_headquarters": true
},
"beneficiary_data": {
"codigo_rcbe": "123456"
},
"address_data": {
"country":"Portugal", "cep":"1234-567", "address_line_1":"Rua X", "address_line_2":"nº 123", "city":"Lisboa", "district":"Lisboa"
},
"suspicion_data": {
"is_suspect": false,
"reason": "Test"
},
}
transaction
{
"buyer": {
"acquisition_purpose": "test purpose",
},
"basic_information": {
"sell_type": "good",
"description": "test description",
"observations": "test observations"
},
"suspicion_data": {
"is_suspect": false,
"reason": "Test"
},
}
{
"version": 0.1,
"timestamp": 1660060397561,
"data": {
"id": "aa199264-c62e-3763-e3a5-68127b070720",
"risk": 0,
"risk_category": "low"
}
}Leyenda
id: Id del registro o transacción creada.
risk: valor de riesgo del registro/transación creado/a.
risk_category: categoria en la que se inserta el valor de riesgo del registro/transación creado/a.
Edición de un registro
POST https://www.pepdata.com/api/edit_questionnaire
Endpoint para editar un registro de clientes y transacciones.
Headers
Authorization*
string
key [API_KEY]
Request Body
id*
string
id del registro o transacción
questionnaire_data
json
Solo puede editar el valor que necesita:
Compruebe add_questionnaire (questionnaire_data) para ver qué propiedades se aceptan.
{
"version": 0.1,
"timestamp": 1660061942863,
"data": {
"risk": 0,
"risk_category": "low"
}
}Leyenda
risk: valor de riesgo del registro/transación editado/a.
risk_category: categoria en la que se inserta el valor de riesgo del registro/transación editado/a.
Eliminación de un registro
POST https://www.pepdata.com/api/delete_questionnaire
Endpoint para eliminar un registro de clientes o transacciones.
Headers
Authorization*
string
key [API_KEY]
Request Body
id*
string
id del registro o transacción
{
"version": 0.1,
"timestamp": 1695892485159,
"data": {
"message": "El registro fue eliminado con éxito."
}
}Importante: Puede obtener un error al eliminar un registro si tiene dependencias con otros registros.
Anular el envío de un registro
POST https://www.pepdata.com/api/unsubmit_questionnaire
Endpoint para cancelar el envío de un registro de cliente o transacción.
Headers
Authorization*
string
key [API_KEY]
Request Body
id
string
id del registro o transacción
{
"version": 0.1,
"timestamp": 1695893220141,
"data": {
"risk": 0,
"risk_category": "low"
}
}Cancelar el envío recalculará el riesgo de registro. Si tiene una categoría de riesgo configurada manualmente, se perderá.
Leyenda
risk: riesgo recalculado de alta de clientes u operaciones.
risk_category: categoria en la que se inserta el valor de riesgo recalculado de alta de clientes u operaciones.
Enviar una invitación para completar el registro
POST https://www.pepdata.com/api/send_questionnaire_invite
Endpoint para enviar una invitación para completar un registro de cliente o transacción.
Headers
Authorization*
string
key [API_KEY]
Request Body
id*
string
Id del registro o transacción
client_email*
string
Correo del cliente invitado
language
string
Idioma en el que debe enviarse la invitación
Predeterminado: pt-PT
Valores aceptados:
pt-PT (portugués)
en (inglés)
es (español)
{
"version": 0.1,
"timestamp": 1695997097315,
"data": {
"message": "Invitación enviada a {{client_email}}."
}
}Cancelar una invitación para completar el registro
POST https://www.pepdata.com/api/cancel_questionnaire_invite
Endpoint para cancelar la invitación para completar un registro de cliente o transacción.
Headers
Authorization*
string
key [API_KEY]
Request Body
id*
string
Id del registro o transacción
client_email*
string
Correo del cliente invitado
{
"version": 0.1,
"timestamp": 1695997713238,
"data": {
"message": "La invitación de {{client_email}} fue cancelada."
}
}Asignar un usuario a un registro
POST https://www.pepdata.com/api/assign_user_to_questionnaire
Endpoint para asignar un usuario a un registro de cliente o transacción.
Headers
Authorization *
string
key [API_KEY]
Request Body
id*
string
Id del registro o transacción
id_user*
string
Id de usuario
{
"version": 0.1,
"timestamp": 1695999232282,
"data": {
"message": "Responsable modificado a {{user_name}}."
}
}Asignar departamentos a un registro
POST https://www.pepdata.com/api/assign_departments_to_questionnaire
Endpoint para asignar departamentos a un cliente o registro de transacciones.
Headers
Authorization*
string
key [API_KEY]
Request Body
id
string
Id del registro o transacción
departments*
json
Array de departamentos Ejemplo: ["Financiero"]
{
"version": 0.1,
"timestamp": 1696001921643,
"data": {
"message": "Departamentos asignados con éxito."
}
}Editar el estado de aprobación de un registro
POST https://www.pepdata.com/api/edit_questionnaire_approval_state
Endpoint para editar el estado de aprobación de un cliente o registro de transacción.
Headers
Authorization*
string
key [API_KEY]
Request Body
id*
string
id del regristro o transacción
approval_state*
string
Estado de aprobación
Valores aceptados: -1 (Rechazado) 0 (Indeciso) 1 (aprobado)
approval_change_reason*
string
Justificación para cambiar el estado de aprobación
{
"version": 0.1,
"timestamp": 1696002523053,
"data": {
"message": "Estado de aprobación cambiado con éxito."
}
}Revertir el riesgo de un registro
POST https://www.pepdata.com/api/revert_questionnaire_risk
Endpoint para revertir el riesgo actual de un cliente o registro de transacciones.
Headers
Authorization*
string
key [API_KEY]
Request Body
id*
string
id del registro o transacción
{
"version": 0.1,
"timestamp": 1696238603806,
"data": {
"risk": 0,
"risk_category": "low"
}
}Leyenda
risk: riesgo de alta de clientes u operaciones.
risk_category: categoria en la que se inserta el valor de riesgo de alta de clientes u operaciones.
Restablecer el estado "Necesita atención" de un registro
POST https://www.pepdata.com/api/reset_questionnaire_needs_attention
Endpoint para restablecer el estado "Necesita atención" de un registro de cliente o transacción.
Headers
Authorization*
string
key [API_KEY]
Request Body
id
string
Id del registro o transacción
{
"version": 0.1,
"timestamp": 1696239199674,
"data": {
"message": "El estado 'Necesita atención' se ha restablecido correctamente."
}
}Entregar los registros
POST https://www.pepdata.com/api/submit_questionnaires
Endpoint que entrega automáticamente todos los registros no enviados.*
*Esta operación está limitada a 8000 registros a la vez.
Headers
Authorization*
string
key [API_KEY]
Request Body
type*
string
Tipo de los registros a entregar
Valores aceptados:
customers transactions
{
"version": 0.1,
"timestamp": 1695983552463,
"data": {
"time_to_conclusion": 1
}
}Leyenda
time_to_conclusion: tiempo estimado en segundos para que se complete la operación.
Last updated
Was this helpful?