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
Authorization*
string
key [API_KEY]
Request Body
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
Default: customer
Valores aceites:
customer
transaction
relationship
Legenda
id: id do registo.
name: nome 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.
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.
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: booleano que descreve se o registo precisa de atenção.
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.
id_iperson: id da pessoa identificável correspondente. null caso não tenha existido correspondência.
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
Authorization*
string
key [API_KEY]
Request Body
name*
string
Nome do registo ou transação
vatin
string
NIF/NIPC do registo
id_custom
string
Id personalizável do registo
type*
string
Tipo do registo
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": {
"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"
},
}
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
Authorization*
string
key [API_KEY]
Request Body
id*
string
Id do registo ou transação
questionnaire_data
json
Poderá só editar o valor que necessita:
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 um registo
POST https://www.pepdata.com/api/delete_questionnaire
Endpoint para apagar um registo de clientes ou transações.
Headers
Authorization*
string
key [API_KEY]
Request Body
id*
string
Id do registo ou transação
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
Authorization*
string
key [API_KEY]
Request Body
id*
string
Id do registo ou transação
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
Authorization*
string
key [API_KEY]
Request Body
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)
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
Authorization*
string
key [API_KEY]
Request Body
id*
string
Id do registo ou transação
client_email*
string
E-mail do cliente convidado
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
Authorization*
string
key [API_KEY]
Request Body
id*
string
Id do registo ou transação
id_user*
string
Id do utilizador
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
Authorization*
string
key [API_KEY]
Request Body
id*
string
Id do registo ou transação
departments*
json
Array de departamentos
Exemplo:
["Financeiro"]
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
Authorization*
string
key [API_KEY]
Request Body
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
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
Authorization*
string
key [API_KEY]
Request Body
id*
string
Id do registo ou transação
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
Authorization*
string
key [API_KEY]
Request Body
id*
string
Id do registo ou transação
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
Authorization*
string
key [API_KEY]
Request Body
type*
string
Tipo dos registos a submeter
Valores aceites:
customers transactions
Legenda
time_to_conclusion: tempo estimado em segundos para a conclusão da operação.
Last updated
Was this helpful?