Examples of use

There are two distinct ways to use PEPData's API. This page will try to describe both modes and present their advantages and disadvantages so that you can decide in an informed way which one is best suited to your needs.

Search

Corresponds to the most basic usage example. To go this route, you just need to use the identifiable person search endpoint.

This endpoint accepts a name and date of birth as inputs and returns search results that most closely match the search terms. In order to obtain better results, it is recommended that you read the documentation related to the search area.

Upon receiving the results, you can process them internally in order to decide whether the searched person corresponds to an identifiable person contained in the PEPData database.

Advantages

• Quite easy and simple solution to implement .

• Suitable in case you need to validate people in real time.

Disadvantages

• It does not allow you to create a "customer portfolio" in PEPData's application, which allows you to receive future alerts in the event of a change in status as an identifiable person.

• It forces you to create internal criteria to interpret searches and your decision is not saved in PEPData's application.

• You can only search one person at a time.

• Does not allow validating sanctioned countries.

Validations

Corresponds to the most advanced usage example. To go this route, you need to use several validation endpoints. As an example, the following workflow is proposed:

1. Add each person to validate via the /add_validation endpoint. This accepts the person's name, date of birth and country, thus creating a validation.

2. When necessary, apply the desired validation rules through the /apply_rules endpoint. These will allow the determination of all validations that fit the rules you defined.

3. Validations that remain incomplete are more difficult to determine and likely require human attention. It is therefore recommended that they are determined manually in PEPData's application. However, you can do this via the API, using the /determine_validation endpoint.

Advantages

• It allows you to create a "customer portfolio" in PEPData's application, which allows you to receive future alerts in the event of a change in status as an identifiable person.

• All your decisions are registered in the PEPData application and can be exported for future use.

• It can determine hundreds of thousands of validations at a time.

• Allows you to validate sanctioned countries.

Disadvantages

• More complex solution to implement.

• Not suitable in case you need to search people in real time.

Registers and obtaining the risk

Registering your customers and transactions allows you to record all the information necessary to comply with the law, also obtaining a risk score associated with each record. To do this, you need to use at least two registers endpoints. For example:

1. Add the customer or transaction via the /add_questionnaire endpoint. This endpoint accepts several properties sent in a questionnaire_data object, allowing you to populate a large part of the fields available right at the time of creating the record. This function will return the id of the created customer or transaction.
2. Afterwards, you can get information about the record using the get_questionnaires function, iterating through the existing pages or specifying the id of the record you just created. This function returns complete information, including risk, regarding your customers or transactions.

If the risk value is consulted immediately after insertion, its value will only include the analysis of the fields just inserted via the API. There are also other fields that, at the moment, can only be edited through the application. If you have any particular needs, do not hesitate to speak to us.