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
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: booleano que describe si el registro necesita atención
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"
},
}
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:
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
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
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)
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
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
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"]
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
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
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
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
Leyenda
time_to_conclusion: tiempo estimado en segundos para que se complete la operación.
Last updated
Was this helpful?