Registos

Esta secção da API ainda está em desenvolvimento, pelo que poderá sofrer alterações consideráveis. Esta página encontra-se em desenvolvimento.

Obter registos

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

Endpoint para obter os registos de clientes e transações.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id	string	Id do registo ou transação
id_custom	string	Id personalizável do registo ou transação
search_term	string	Termo de pesquisa: Pesquisa sobre as colunas name, vatin e id_custom
page	integer	Página dos registos ou transações \ Default: 1
type*	string	Tipo de registos Valores aceites: customer supplier employee transaction relationship
status	string	Estado do registo Valores aceites: rejected to_decide approved incomplete needs_attention

200: OK Registos obtidos com sucesso.

{
    "data": {
        "items": [
            {
                "id": "7dd49ce1-9385-0cd1-7835-828393771ea0",
                "name": "individual",
                "name_normalized": "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\"}",
                "entity_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,
                "manual_risk": null,
                "risk_change_reason": null,
                "saved_at": 1693491414116,
                "assigned_to": null,
                "is_disabled": false,
                "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,qu
                "organization_id_country": "PT",
                "id_iperson": "ID1",
                "id_iorganization": null,
                "determined_at": null,
                "adverse_media_searched_at": null,
                "judicial_processes_searched_at": null,
                "forensics_searched_at": null,
                "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
}

Legenda

• id: id do registo.

• name: nome do registo.

• name_normalized: nome normalizado do registo.

• vatin: NIF/NIPC do registo.

• value: informação do registo.

• entity_type: tipo de entidade (individual, coletiva ou transação).

• main_entity_subtype: subtipo da entidade (representante, beneficiário, etc..).

• relations: relações associadas ao registo.

• added_by: id do utilizador que adicionou o registo.

• added_at: data a que o registo foi adicionado, sob a forma de número de milissegundos desde 1 de Janeiro de 1970 00:00:00 UTC.

• submitted_at: data a que o registo foi submetido, sob a forma de número de milissegundos desde 1 de Janeiro de 1970 00:00:00 UTC.

• submitted_by: id do utilizador que submeteu o registo.

• approval_state: estado de aprovação do registo (0 - aguarda decisão, 1 - aprovado, -1 - rejeitado).

• approval_change_reason: justificação para alteração do estado de aprovação.

• risk: valor do risco do registo.

• manual_risk: valor do risco associado manualmente.

• risk_change_reason: justificação para alteração de categoria de risco.

• saved_at: data a que o registo foi gravado pela última vez, sob a forma de número de milissegundos desde 1 de Janeiro de 1970 00:00:00 UTC.

• assigned_to: id do responsável do registo.

• is_disabled: registo inativo.

• id_invited_user: id do utilizador convidado ao preenchimento do registo.

• locked_by: id do utilizador que tem o registo aberto.

• locked_at: data a que o registo foi aberto pela última vez, sob a forma de número de milissegundos desde 1 de Janeiro de 1970 00:00:00 UTC.

• invited_submission_by: id do utilizador convidado que aceitou o convite ao preenchimento.

• invited_submission_at: data a que o convite ao preenchimento foi aceite, sob a forma de número de milissegundos desde 1 de Janeiro de 1970 00:00:00 UTC.

• data_treatment_accepted_at: data a que o foram aceites as codições de tratamento dos dados do utilizador convidado, sob a forma de número de milissegundos desde 1 de Janeiro de 1970 00:00:00 UTC.

• needs_attention: array de objetos com informação sobre o motivo de cada um dos alertas.

• id_organization: id da organização que criou o registo.

• id_custom: id personalizável inserido pelo utilizador.

• invited_at: data a que o convite ao preenchimento foi enviado, sob a forma de número de milissegundos desde 1 de Janeiro de 1970 00:00:00 UTC.

• invited_by_organization_name: nome da organização que enviou o convite ao preenchimento.

• language: língua em que foi enviado o convite ao preenchimento.

• organization_id_country: país da organização que criou o registo em formato ISO 3166-1 alpha-2.

• id_iperson: id da pessoa identificável correspondente. null caso não tenha existido correspondência.

• id_iorganization: id da organização identificável correspondente. null caso não tenha existido correspondência.

• determined_at: data a que o registo foi determinado, sob a forma de número de milissegundos desde 1 de Janeiro de 1970 00:00:00 UTC.

• adverse_media_searched_at: data a que a última pesquisa de adverse media foi realizada, sob a forma de número de milissegundos desde 1 de Janeiro de 1970 00:00:00 UTC.

• judicial_processes_searched_at: data a que a última pesquisa de processos judiciais foi realizada, sob a forma de número de milissegundos desde 1 de Janeiro de 1970 00:00:00 UTC.

• forensics_searched_at: data a que a última pesquisa de informação forense foi realizada, sob a forma de número de milissegundos desde 1 de Janeiro de 1970 00:00:00 UTC.

• type: tipo de registo,

• id_questionnaire_data: id do registo onde está guardada a informação do questionário.

• risk_category: categoria em que se insere o valor do risco.

Adição de um registo

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

Endpoint para adicionar um registo de clientes e transações.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
name*	string	Nome do registo ou transação
vatin	string	NIF/NIPC do registo
id_custom	string	Id personalizável do registo
questionnaire_type	string	Tipo de registo Default: customer Valores aceites: customer supplier employee transaction relationship
type*	string	Tipo de entidade Valores aceites: individual (Registo de pessoa individual) organization ( Registo de pessoa coletiva) transaction (Transação)
questionnaire_data	json	Consoante cada tipo de registo, são necessários objetos diferentes: individual { "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 aceites: residence fiscal_residence headquarters organization { "company_data": { "alternative_names": ["Alternative Name 1"], "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" }, }

200: OK Registo ou transação criado/a.

{
    "version": 0.1,
    "timestamp": 1660060397561,
    "data": {
        "id": "aa199264-c62e-3763-e3a5-68127b070720",
        "risk": 0,
        "risk_category": "low"
    }
}

409: Conflict Já existe um registo com o mesmo nif/nipc ou ID personalizado.

409: Conflict (Transação) Já existe um registo com o mesmo ID personalizado.

400: Bad Request NIF/NIPC inválido

Legenda

• id: Id do registo ou transação criado/a.

• risk: valor do risco do registo/transação criado/a.

• risk_category: categoria em que se insere o valor do risco do registo/transação criado/a.

Edição de um registo

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

Endpoint para editar um registo de clientes e transações.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id*	string	Id do registo ou transação
questionnaire_data	json	Poderá só editar o valor que necessita: Verifique add_questionnaire (questionnaire_data) para saber quais as propriedades que são aceites.

200: OK Registo de clientes ou transações editado/a.

{
    "version": 0.1,
    "timestamp": 1660061942863,
    "data": {
        "risk": 0,
        "risk_category": "low"
    }
}

400: Bad Request Registo de cliente ou transação não encontrado

Legenda

• risk: valor do risco do registo/transação editado/a.

• risk_category: categoria em que se insere o valor do risco do registo/transação editado/a.

Eliminação de registos

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

Endpoint para apagar registos de clientes ou transações.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
ids*	array	Ids dos registos a eliminar

200: OK O registo de clientes ou transações foi apagado com sucesso.

{
    "version": 0.1,
    "timestamp": 1695892485159,
    "data": {
        "message": "Registo(s) eliminado(s) com sucesso."
    }
}

400: Bad Request Registo de cliente ou transação não encontrado.

Importante: Poderá obter um erro ao eliminar um registo caso este tenha dependências com outros registos.

Cancelar a submissão de um registo

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

Endpoint para cancelar a submissão de um registo de clientes ou transações.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id*	string	Id do registo ou transação

200: OK Submissão do registo de clientes ou transações cancelada foi cancelada com sucesso.

{
    "version": 0.1,
    "timestamp": 1695893220141,
    "data": {
        "risk": 0,
        "risk_category": "low"
    }
}

400: Bad Request Registo de cliente ou transação não encontrado.

Cancelar a submissão irá recalcular o risco do registo. Se tiver uma categoria de risco configurada manualmente, a mesma será perdida.

Legenda

• risk: valor do risco do registo de clientes/transações.

• risk_category: categoria em que se insere o valor do risco do registo de clientes/transações.

Enviar um convite de preenchimento do registo

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

Endpoint para enviar convite de preenchimento de um registo de clientes ou transações.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id*	string	Id do registo ou transação
client_email*	string	E-mail do cliente convidado
language	string	Língua em que deve ser enviado o convite Default: pt-PT Valores aceites: pt-PT (Português) en (Inglês) es (Espanhol)

200: OK Convite enviado com sucesso.

{
    "version": 0.1,
    "timestamp": 1695997097315,
    "data": {
        "message": "Convite enviado para {{client_email}}."
    }
}

400: Bad Request Registo de cliente ou transação não encontrado.

Cancelar um convite de preenchimento do registo

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

Endpoint para cancelar o convite de preenchimento de um registo de clientes ou transações.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id*	string	Id do registo ou transação
client_email*	string	E-mail do cliente convidado

200: OK Convite cancelado com sucesso.

{
    "version": 0.1,
    "timestamp": 1695997713238,
    "data": {
        "message": "Convite de {{client_email}} foi cancelado."
    }
}

400: Bad Request Registo de cliente ou transação não encontrado.

Atribuir um utilizador a um registo

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

Endpoint para atribuir um utilizador a um registo de clientes ou transações.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id*	string	Id do registo ou transação
id_user*	string	Id do utilizador

200: OK O utilizador foi atribuído ao registo de clientes ou transações com sucesso.

{
    "version": 0.1,
    "timestamp": 1695999232282,
    "data": {
        "message": "Responsável modificado para {{user_name}}."
    }
}

400: Bad Request Registo de cliente ou transação não encontrado.

Atribuir departamentos a um registo

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

Endpoint para atribuir departamentos a um registo de clientes ou transações.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id*	string	Id do registo ou transação
departments*	json	Array de departamentos Exemplo: ["Financeiro"]

200: OK Os departamentos foram atribuídos ao registo de clientes ou transações com sucesso.

{
    "version": 0.1,
    "timestamp": 1696001921643,
    "data": {
        "message": "Departamentos atribuídos com sucesso."
    }
}

400: Bad Request Departamentos inválidos

Editar o estado de aprovação de um registo

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

Endpoint para editar o estado de aprovação de um registo de clientes ou transações.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id*	string	Id do registo ou transação
approval_state*	string	Estado de aprovação Valores aceites: -1 (Rejeitado) 0 (Por decidir) 1 (Aprovado)
approval_change_reason*	string	Justificação para alteração do estado de aprovação

200: OK Estado de aprovação do registo de clientes ou transações foi alterado com sucesso.

{
    "version": 0.1,
    "timestamp": 1696002523053,
    "data": {
        "message": "Estado de aprovação editado com sucesso."
    }
}

400: Bad Request Registo de cliente ou transação não encontrado.

Editar o estado de um registo (Activo/Inactivo)

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

Endpoint para alterar o estado (ativo/inativo) de um registo ou transação.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id*	string	Id do registo ou transação
disabled*	boolean	Estado do registo ou transação Valores aceites: true registo inativo false registo ativo

200: OK A alteração do estado do registo foi alterada com sucesso.

{
    "version": 0.1,
    "timestamp": 1696238603806,
    "data": {
        "is_disabled": false
    }
}

400: Bad Request Registo de cliente ou transação não encontrado.

Legenda

• is_disabled: estado do registo ou transação.

Reverter o risco de um registo

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

Endpoint para reverter o risco atual de um registo de clientes ou transações.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id*	string	Id do registo ou transação

200: OK O risco do registo de clientes ou transações foi revertido com sucesso.

{
    "version": 0.1,
    "timestamp": 1696238603806,
    "data": {
        "risk": 0,
        "risk_category": "low"
    }
}

400: Bad Request Registo de cliente ou transação não encontrado.

Legenda

• risk: risco calculado do registo de clientes ou transações.

• risk_category: categoria em que se insere o valor do risco do registo de clientes/transações.

Redefinir o estado

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

Endpoint para redefinir o estado "Precisam de atenção" de um registo de clientes ou transações.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id*	string	Id do registo ou transação

200: OK Estado

{
    "version": 0.1,
    "timestamp": 1696239199674,
    "data": {
        "message": "Estado 'Needs attention' redefinido com sucesso."
    }
}

400: Bad Request Registo de cliente ou transação não encontrado.

Submeter os registos

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

Endpoint que submete automaticamente todos os registos não submetidos.*

*Esta operação está limitada a 8000 registos de cada vez.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
type*	string	Tipo dos registos a submeter Valores aceites: customers transactions

200: OK Os registos foram submetidos com sucesso.

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

400: Bad Request O tipo de registos não é válido.

Legenda

• time_to_conclusion: tempo estimado em segundos para a conclusão da operação.

Exportar o relatório de risco

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

Endpoint para obter o relatório de risco de um registo em formato pdf.

Headers

Name	Type	Description
Authorization*	string	key [API_KEY]

Request Body

Name	Type	Description
id*	string	Id do registo ou transação

Response

200: OK Report gerado com sucesso

174KB

PEPData - Relatório de Avaliação de risco.pdf

PDF

Open

Exemplo de relatório de avaliação de risco

400: Bad Request Registo não encontrado