Validaciones

Obtener validaciones

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

Endpoint para obtener validaciones.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
page	number	Página de validaciones Default: 1
source	string	Origen de las validaciones Default: all Valores posibles: all upload manual
status	string	Estado de validación Predeterminado: incomplete Valores posibles: all complete complete_identified complete_not_identified needs_attention incomplete
id	string	Id de la validación
id_custom	string	Id personalizable de la validación
sort_by	string	Propiedad utilizada para la ordenación de las validaciones Valores posibles: added_at determined_at name
sort_dir	string	Ordenación descendente o ascendente de las validaciones Valores posibles: desc asc

200 Validaciones obtenidas con éxito.

{
    "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": null,
                "iperson_classifications": [
                    "PRP",
                    "Familiar",
                    "Asociado
                ],
                "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"
                    }
                ],
                "iperson_classifications": 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": [],
                "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": [
                            "Hay un nuevo resultado que podría coincidir con esta validación: María García"
                        ]
                    }
                ],
                "country_nationality": "Portugal"
            },
        ]
    }
}

Leyenda

• id: id de validación.

• vatin: nif de la validación.

• source: origen de la validación.

• name: nombre de validación.

• birth_date: fecha de nacimiento de la validación.

• id_country_nationality: país de nacionalidad de la validación, en el formato ISO 3166-1 alpha-2.

• id_country_residence: país de residencia de la validación, en el formato ISO 3166-1 alpha-2.

• decision: booleano que describe si ha habido una coincidencia con una persona identificable.

• id_iperson: id de la persona identificable correspondiente. null si no se ha encontrado ninguna coincidencia.

• iperson_classifications: lista de clasificaciones de la persona identificable, posibles valores:

  • Asociado

  • Familiar

  • Titular de Otros Cargos

  • PRP

  • Sancionado (EU)

  • Sancionado (HM Treasury)

  • Sancionado (OFAC)

  • Sancionado (UN)

• relations: lista de relaciones asociadas con la validación. Contiene las siguientes propriedades:

  • name: nombre de la relación.

  • vatin: nif de la relación.

  • id_iperson: id de la persona identificable asociada con la relación.

  • id_iorganization: id de la organización identificable asociada con la relación.

  • relationship_type: tipo de relación. Valores posibles:

    • representative

    • manager

    • beneficary

    • beneficial_owner

  • id_relationship_info: id de la relación.

• iperson_classifications: lista de clasificaciones de personas identificables.

• added_by: id del usuario que ha agregado la validación, como el número de milisegundos desde el 1 de enero de 1970 00:00:00 UTC.

• added_at: la fecha a la que se agregó la validación, como el número de milisegundos desde el 1 de enero de 1970 00:00:00 UTC.

• determined_at: la fecha en la que se determinó la validación, como el número de milisegundos desde el 1 de enero de 1970 00:00:00 UTC.

• determined_by: id del usuario que ha determinado la validación.

• identifiable_country: booleano que describe si el país de validación está sancionado.

• id_organization: id de la organización que creó la validación.

• id_custom: identificación personalizable ingresada por el usuario.

• entity_type: tipo de validación, que puede ser: "individual" u "organization".

• id_iorganization: identificación de la organización identificable correspondiente. null si no hubo ninguna coincidencia.

• adverse_media_searched_at: fecha de la última búsqueda de noticias adversas asociadas al nombre de la validación.

• judicial_processes_searched_at: fecha de la última búsqueda de procesos judiciales asociados al nombre de la validación.

• alerts: alertas relacionadas con la validación y que aún están sin resolver.

• country_nationality: país de nacionalidad.

Exportar Validaciones

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

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Body

Name	Type	Description
from*	int	Fecha de inicio del filtro, com número de milisegundos desde el 1 de enero de 1970 00:00:00 UTC
until*	int	Fecha de finalización del filtro, com número de milisegundos desde el 1 de enero de 1970 00:00:00 UTC
status	string	Estado de las validaciones Predeterminado: all Valores posibles: all complete complete_identified, complete_not_identified needs_attention incomplete
format	string	Formato del archivo exportado Predeterminado: xlsx Valores posibles: xlsx csv
export_by	string	Exportar validaciones por fecha de adición o fecha de determinación. Predeterminado: added_at Valores posibles: added_at determined_at
timezone	string	Zona horaria de fechas utilizadas en los filtros Predeterminado: Europe/Lisbon

Response

200: OK Archivo exportado con éxito

9KB

validaciones de 01-07-2024 a 29-07-2024.xlsx

Ejemplo de archivo de exportación de validaciones

400: Bad Request Campos obligatorios vacíos

{
   "message": {
        "version": 0.1,
        "timestamp": 1722266342583,
        "message": "El campo 'from' no puede estar vacío."
    }
}

400: Bad Request Opciones inválidas

{
   "message": {
        "version": 0.1,
        "timestamp": 1722266342583,
        "message": "La opción del campo 'status' no es válida."
    }
}

Agregar validación

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

Endpoint para agregar una validación.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
ignore_duplicates	boolean	Instrucción para omitir el control por duplicado. Formato: 0/1 Default: 0
name*	string	Nombre de validación
birth_date	string	Fecha de nacimiento de la validación. Parámetro solo utilizado en validaciones de personas. Formato: yyyy-mm-dd Default: null
country_nationality	string	País de nacionalidad de la validación. Parámetro solo utilizado en validaciones de personas. Formato: Nombre del país (véase la nota más abajo) Default: null
vatin	string	Nif de la validación Default: null
id_custom	string	id personalizable de la validación Default: null
country_residence	string	País de residencia de la validación. Parámetro solo utilizado en validaciones de personas. Formato: Nombre del país (véase la nota más abajo) Default: null
type	string	Tipo de entidad, que puede ser: "individual" u "organization". Default: "individual"
country	String	País de la validación. Parámetro solo utilizado en validaciones de organizaciones. Formato: Nombre del país (véase la nota más abajo) Default: null

200 Validación añadida con éxito.

{
    "data": {
        "id": "926b7dab-a3af-986f-2137-872adb95260f"
    },
    "version": "0.1",
    "timestamp": 1588599744111
}

409: Conflict La validación a agregar ya está en la base de datos.

{
    "message": "Esta validação parece já existir na base de dados"
    "version": 0.1,
    "timestamp": 1696943296957
}

400: Bad Request Nombre inválido

{
    "message": {
        "version": 0.1,
        "timestamp": 1697017001540,
        "message": "El nombre no es válido. Solo se permiten nombres:  • Solo con caracteres latinos, apóstrofes, espacios, puntos o guiones;"
    }
}

Leyenda

• id: id de la validación creada.

country_nationality, country_residence e country

Hay múltiples formas diferentes de escribir el nombre de cada país. La aplicación PEPData es capaz de identificar todas las denominaciones de los países presentes en la Lista de Estados, territorios y monedas de la Unión Europea. Sin embargo, para garantizar una mayor robustez, recomendamos utilizar el formato ISO 3166-1 alpha-2, siempre que sea posible.

Obtener alertas

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

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id_validation	string	Id de la validación
ids_validations	string array	Array de ids de validaciónes
status	string	Estado de alertas Predeterminado: unresolved Valores posibles: all resolved unresolved
from	int	Fecha de inicio del filtro, com número de milisegundos desde el 1 de enero de 1970 00:00:00 UTC
until	int	Fecha de finalización del filtro, com número de milisegundos desde el 1 de enero de 1970 00:00:00 UTC
include_comments	boolean	Parámetro para solicitar información sobre comentarios asociados a los alertas. Predeterminado: false Valores posibles: true false
page	number	Pagina de los alertas. Predeterminado: 1

200: OK Alertas de validación obtenidas con éxito

{
    "version": 0.1,
    "timestamp": 1693318084192,
    "data": {
        "items": [
            {
                "id": "53fef9d4-e3d4-ed03-5e79-38ba066050f7",
                "id_validation": "3462600c-8b9a-6384-c321-4587104ce0f1",
                "name": "José Codinha Manso",
                "birth_date": null,
                "id_country_nationality": "JP",
                "added_at": 1687873995707,
                "resolved_at": null,
                "resolved_by": null,
                "status": "unresolved",
                "reason": "Podem ter sido encontradas novas adverse media relativas a esta pessoa.",
                "country_nationality": "Japan",
                "comments": [
                    {
                        "id": "ff959c5f-8dbb-130c-f904-b0b02359d113",
                        "comment": "Comentario 1"
                    },
                    {
                        "id": "2b0c4c70-6730-9056-b3c2-bb8dc21125d3",
                        "comment": "Comentario 2"
                    }
                ]
            }
        ],
        "count": 1,
        "total": 1,
        "page": 1,
        "max_results_per_page": 50
    }
}

400: Bad Request estado de alertas inválido

{
    "message": {
        "version": 0.1,
        "timestamp": 1588599744111,
        "message": "El campo 'estado' no es válido."
    }
}

Leyenda

• id: id de la alerta.

• id_validation: id de validación.

• name: nombre de la persona idenficiable.

• birth_date: fecah de nacimiento de la persona identificable.

• id_country_nationality: código del país de la nacionalidad, en formato ISO 3166-1 alpha-2.

• added_at: fecha en que se creó la alerta, expressada en milisegundos desde el 1 de enero de 1970 a las 1970 00:00:00 UTC.

• resolved_at: fecha en que se resolvió la alerta, expressada en milisegundos desde el 1 de enero de 1970 a las 1970 00:00:00 UTC.

• resolved_by: usuario que resolvió la alerta.

• status: estado de la alerta.

• reason: motivo para crear la alerta.

• country_nationality: país de nacionalidad.

• comments: comentarios asociados con la alerta.

  • id: id de lo comentario.

  • comment: comentario.

Analizar la validación

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

Endpoint para consultar los resultados obtenidos del análisis de una validación.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id	string	Id de la validación

200 Resultados del análisis de validación obtenidos con éxito.

{
    "data": {
        "items": [
            {
              "id": "0bdeb685-8d0b-41ec-a3ff-996188fe2b22",
              "name": "João Pedro Silva",
              "birth_date": null,
              "score": 95
              "classifications": [
                    "PEP"
                ],
                "occupations": [
                    {
                        "organization": "Governo da República Portuguesa",
                        "organ": "Ministério dos Negócios Estrangeiros",
                        "position": "Ministro",
                        "source": "https://test-link.com",
                        "start_date": null,
                        "end_date": null,
                        "comments": null
                    }
                ],
                "relationships": []
            },
            {
              "id": "BFFD688C-4618-048D-9C14-8887B1BDA173",
              "name": "João Pedro Pereira",
              "birth_date": "1933-05-25",
              "score": 76,
              "classifications": [
                    "PEP",
                    "Familiar"
                ],
                "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
                    }
                ]
            }
        ],
        "count": 2
    },
    "version": "0.1",
    "timestamp": 1588599744111
}

400: Bad Request Validación no encontrada

{
    "message": {
        "version": 0.1,
        "timestamp": 1697017565826,
        "message": "No se encontró la validación"
    }
}

Leyenda

• id: identificación de la persona identificable.

• name: nombre de la persona identificable.

• birth_date: fecha de nacimiento de la persona identificable.

• score: grado de similitud.

• classifications: clasificaciones de la persona identificable.

• occupations: lista de ocupaciones de la persona identificable:

  • organization: organización de la ocupación.

  • organ: organismo de la ocupación.

  • position: posición de la ocupación.

  • source: link de la fuente que relaciona a la persona identificable con lá ocupación.

  • start_date: fecha de inicio de la ocupación.

  • end_date: fecha de finalización de la ocupación.

  • comments: notas relevantes sobre la ocupación.

• relationships: lista de relaciones de la persona identificable:

  • relationship_type: tipo de relación.

  • relationship_to: nombre del familiar de la person identificable.

  • source: link de la fuente con información sobre la relación.

  • end_date: fecha de finalización de la relación.

  • comments: notas relevantes sobre la relación.

Determinación de la validación

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

Endpoint para determinar una validación.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id	string	Id de validación
id_entity	string	Id de la persona u organización identificable correspondiente.

200 La validación ha sido determinada con éxito.

{
    "version": 0.1,
    "timestamp": 1695805850051,
    "data": {
        "message": "La validación ha sido determinada con éxito."
    }
}

400: Bad Request Validación no encontrada

{
    "message": {
        "version": 0.1,
        "timestamp": 1697017565826,
        "message": "No se encontró la validación"
    }
}

Eliminar la validación

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

Endpoint para eliminar una validación.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id	string	Id de validación

200 La validación ha sido eliminada con éxito.

{
    "version": 0.1,
    "timestamp": 1695806667520,
    "data": {
        "message": "La validación ha sido eliminada con éxito."
    }
}

400: Bad Request Validación no encontrada

{
    "message": {
        "version": 0.1,
        "timestamp": 1697017565826,
        "message": "No se encontró la validación"
    }
}

Aplicación de las reglas

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

Endpoint para la aplicación de las reglas de validación.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

200: OK Las reglas han empezado a aplicarse.

{
    "version": 0.1,
    "timestamp": 1695827026005,
    "data": {
        "time_to_conclusion": 1
    }
}

200: OK No hay validaciones elegibles para aplicar las reglas.

{
    "version": 0.1,
    "timestamp": 1695827026005,
    "data": {
        "message": "No hay validaciones elegibles para aplicar las reglas."
    }
}

400: Bad Request Las reglas ya se están aplicando.

{
    "message": {
        "version": 0.1,
        "timestamp": 1695984451235,
        "message": "Esta operación ya está en marcha. Por favor, espere hasta que se complete."
    }
}

Leyenda

• time_to_conclusion: tiempo estimado en segundos para que se complete la operación.

Se recomienda fuertemente leer la documentación sobre la aplicación de las reglas de validación, ya que aplicarlas sin una comprensión adecuada puede conducir a cambios no deseados.

A aplicación de la regla puede tardar varios minutos en completarse, dependiendo del número de validaciones incompletas existentes.

Obtener comentários

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

Endpoint para obtener comentarios.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
page	number	Pagina de los comentarios. Predeterminado: 1
type	string	Tipo de comentarios. Valores posibles: determination alert judicial_process adverse_media
id_validation	string	Id de la validación asociada a los comentarios.

200: OK Comentarios obtenidos con éxito.

{
    "version": 0.1,
    "timestamp": 1697728294225,
    "data": {
        "count": 2,
        "total": 2,
        "items": [
            {
                "id": "ff959c5f-8dbb-130c-f904-b0b02359d113",
                "comment": "Comentario 1",
                "added_at": 1697704218743,
                "added_by": "António Jesus",
                "id_validation": "a086cf5f-99ad-12d6-7a80-3d9a47a638d0",
                "id_iperson": null,
                "id_validation_alert": "e9b629b3-0566-c119-1de3-a86d8436205d",
                "id_validation_judicial_process": null,
                "id_validation_adverse_media": null,
                "id_added_by": "cd9f4a64-ab25-4efb-bf31-323ee2280095"
            },
            {
                "id": "12cdbdba-685d-73d5-fc35-017ecb17c166",
                "comment": "Comentario 2",
                "added_at": 1697704304926,
                "added_by": "António Jesus",
                "id_validation": "6f95d22f-9751-3d02-0784-0c6288c79c66",
                "id_iperson": "91a1d1c0-bfd0-6e4b-3574-08c40bc9e577",
                "id_validation_alert": null,
                "id_validation_judicial_process": null,
                "id_validation_adverse_media": null,
                "id_added_by": "cd9f4a64-ab25-4efb-bf31-323ee2280095"
            }
        ],
        "page": 1,
        "max_results_per_page": 50
    }
}

400: Bad Request Tipo de comentarios no válido.

{
    "message": {
        "version": 0.1,
        "timestamp": 1697728633346,
        "message": "El tipo de comentario no es valido."
    }
}

Leyenda

• id: id de lo comentario.

• comment: comentario.

• added_at: fecha en que se añadió el comentario, expressada en milisegundos desde el 1 de enero de 1970 a las 1970 00:00:00 UTC.

• added_by: usuario que agregó el comentario.

• id_validation: id de la validación asociado con el comentario.

• id_iperson: id de la persona identificable correspondiente, si el tipo de comentario es "determination".

• id_validation_alert: id de la alerta de validación correspondiente, si el tipo de comentario es "alert".

• id_validation_judicial_process: id del proceso judicial correspondiente, si el tipo de comentario es "judicial_process".

• id_validation_adverse_media: id de la noticia adversa correspondiente, si el tipo de comentario es "adverse_media".

• id_added_by: id del usuario que agregó el comentario.

Añadir un comentario

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

Endpoint para anãdir un comentario.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id_validation*	string	Id de la validación
id_iperson	string	Id de la persona identificable correspondiente. Este parámetro es obligatorio si el comentario a agregar se refiere a la identificación de una validación.
comment*	string	Comentario
id_validation_alert	string	Id de lo alerta de validación correspondiente. Este parámetro es obligatorio si el comentario a agregar se refiere a una alerta de validación.
id_validation_judicial_process	string	Id de lo proceso judiciale correspondiente. Este parámetro es obligatorio si el comentario a agregar se refiere a un proceso judicial.
id_validation_adverse_media	string	Id de la noticia adversa correspondiente. Este parámetro es obligatorio si el comentario a agregar se refiere a una noticia adversa.

200: OK Comentario agregado con éxito.

{
    "version": 0.1,
    "timestamp": 1697730099564,
    "data": {
        "id": "ac33a772-a869-1c36-8569-5cba9cd0542d"
    }
}

400: Bad Request Validación no encontrada.

{
    "message": {
        "version": 0.1,
        "timestamp": 1697730211531,
        "message": "No se encontró la validación."
    }
}

Leyenda

• id: id de lo comentario agregado.

Editar un comentario

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

Endpoint para editar un comentario.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id*	string	Id de lo comentario a editar
comment*	string	Comentario

200: OK Comentario editado con éxito.

{
    "version": 0.1,
    "timestamp": 1697730574961,
    "data": {
        "message": "Comentário editado correctamente."
    }
}

400: Bad Request Id de comentario no valido.

{
    "message": {
        "version": 0.1,
        "timestamp": 1697730622187,
        "message": "No se encontró lo comentario."
    }
}

Eliminar un comentário

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

Endpoint para eliminar un comentario.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id*	string	Id de lo comentario a eliminar

200: OK Comentario eliminado con éxito.

{
    "version": 0.1,
    "timestamp": 1697730574961,
    "data": {
        "message": "Comentario eliminado con éxito."
    }
}

400: Bad Request Id de comentario no valido.

{
    "message": {
        "version": 0.1,
        "timestamp": 1697730622187,
        "message": "No se encontró lo comentario."
    }
}

Obtener relaciones de una validación

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

Endpoint para obtener relaciones de una validación.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id_validation*	string	Id de la validación
page	number	Pagina de las relaciones. Predeterminado: 1

200: OK Relaciones obtenidas con éxito

{
    "version": 0.1,
    "timestamp": 1697795044035,
    "data": {
        "items": [
            {
                "id": "7f0c97de-6c71-1461-4d9b-da65b4670824",
                "id_relationship": "a86a80bf-0d90-cdfe-1869-726b898cc426",
                "relationship_type": "representative",
                "relationship_to": "António João Soares",
                "id_relationship_to": "df3250ff-382f-c9aa-346e-ef76dd3d333f",
                "id_relationship_from": "6474d5fc-205a-f750-2dd6-24c5d87a5ee5",
                "added_by": "Carlos Araujo",
                "added_at": 1697795029624
            },
            {
                "id": "3b402dbb-ccef-c773-7fac-3225ce7f0e25",
                "id_relationship": "7c5d3c73-b61c-44ae-6d0a-234e1ea2145b",
                "relationship_type": "manager",
                "relationship_to": "José Manuel Silva",
                "id_relationship_to": "3b981423-e1eb-f30f-b4ff-d72b8f34c43a",
                "id_relationship_from": "6474d5fc-205a-f750-2dd6-24c5d87a5ee5",
                "added_by": "Carlos Araujo",
                "added_at": 1697795038487
            }
        ],
        "count": 2,
        "total": 2,
        "page": 1,
        "max_results_per_page": 50
    }
}

400: Bad Request Validación no encontrada.

{
    "message": {
        "version": 0.1,
        "timestamp": 1697795069776,
        "message": "No se encontró la validación."
    }
}

Legenda

• id: identificador de la tabla de información de relaciones.

• id_relationship: id de la relación.

• relationship_type: tipo de la relación.

• relationship_to: nombre de la validación para la cual se creó la relación.

• id_relationship_to: id de la validación para la cual se creó la relación.

• id_relationship_from: id de la validación a partir de la cual se creó la relación.

• added_by: usuario responsable de crear la relación.

• added_at: fecha en que se añadió la relación, expressada en milisegundos desde el 1 de enero de 1970 a las 1970 00:00:00 UTC.

Agregar una relación a una validación

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

Endpoint para agregar una relación a una validación.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
organization_vat_number*	string	NIF de la validación a partir de la cual se creará la relación. Es necesariamente una validación de organización.
vat_number*	string	NIF de la validación para la cual se creará la relación. Es necesariamente una validación de persona si el tipo de relación es representative, manager o beneficial_owner.
position_in_organization*	string	Tipo de la relación. Valores posibles: representative manager owner beneficial_owner

200: OK Relación agregada con éxito.

{
    "version": 0.1,
    "timestamp": 1697798272664,
    "data": {
        "id": "8e6c7899-7c13-33d1-0538-50faf20f123e"
    }
}

400: Bad Request Tipo de relación no válido.

{
    "message": {
        "version": 0.1,
        "timestamp": 1697798319930,
        "message": "El tipo de relación no es válido."
    }
}

Leyenda

• id: id de la nueva relación.

Editar una relación de validación

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

Endpoint para editar una relación de validación.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id_relationship_info*	string	identificador de la tabla de información de relaciones asociado con la relación a editar.
position_in_organization*	string	Tipo de la relación. Valores posibles: representative manager owner beneficial_owner

200: OK Relación editada con éxito.

{
    "version": 0.1,
    "timestamp": 1697798682365,
    "data": {
        "message": "Relación editada con éxito."
    }
}

400: Bad Request Tipo de relación no válido.

{
    "message": {
        "version": 0.1,
        "timestamp": 1697798319930,
        "message": "El tipo de relación no es válido."
    }
}

Eliminar una relación de validación

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

Endpoint para eliminar una relación de validación.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id_relationship_info*	string	identificador de la tabla de información de relaciones asociado con la relación a eliminar.

200: OK Relación eliminada con éxito.

{
    "version": 0.1,
    "timestamp": 1697798682365,
    "data": {
        "message": "Relación eliminada con éxito."
    }
}

400: Bad Request Identificador de la tabla de información de relaciones no válido.

{
    "message": {
        "version": 0.1,
        "timestamp": 1697798319930,
        "message": "Lo identificador de la tabla de información de relaciones no es válido."
    }
}