Overview

PEPData's API can be used to carry out searches and operations related with validations, beneficial owners and users of the platform.

This documentation is technical and programmer-oriented. If you just want to read about the application, you can do so in the corresponding section.

Authentication

Authentication through PEPData's API v0.1 can only be performed via an authentication key.

Each user can view and change their authentication key on their profile page. A key can be changed but the new one will invalidate the old one. There is, therefore, only one active key at any given time, per user.

The active key must be used in the Headers section of the HTTP request. Exemplifying:

curl -H "Authorization: key [API_KEY]" https://www.pepdata.com/api/[endpoint_url]

Your authentication key has the same privileges as your user. It is therefore essential that you keep it safe. Do not share your key with third parties: be especially careful not to send it by email or place it in a code repository.

Structure

All communication with the API must be carried out through JSON objects. All the responses are encoded in UTF-8.

In case of success, the API will send the following response structure:

{
    "data": {...},
    "version": "API version",
    "timestamp": X
}

Label

• data: object that contains the requested information.

• version: current API version.

• timestamp: represents when the server response was made, in the form of the number of milliseconds since January 1, 1970 00:00:00 UTC.

Dates

The dates that appear in the properties mentioned hereinafter follow the following formats:

• Properties with the suffix "_at" or the timestamp name represent unix millisecond timestamps (milliseconds since January 1, 1970 00:00:00 UTC)

• Properties suffixed with "_date" represent calendar dates in ISO 8601 YYYY-MM-DD format.

Pagination

Some endpoints return multiple results, being able to do so in a paginated way. In this case, the formatting of the data parameter object will be as follows:

{
    "items": [
        ...
    ],
    "page": X,
    "max_results_per_page": Y,
    "total": Z
}

Label

• items: the items corresponding to the requested information.

• page: number of the page to which the items belong.

• max_results_per_page: maximum number of results per page.

• total: the number of existing results.

Errors

PEPData uses conventional HTTP response codes to indicate the success or failure of each API request.

As a general rule:

• Codes in the 2xx range indicate success.

• Codes in the 4xx range indicate incorrect or incomplete use of parameters (examples: a mandatory parameter was omitted, the endpoint does not exist, the authentication token is not valid).

• Codes in the 5xx range indicate an error on the PEPData servers.

PEPData returns the error message in the following format:

{
    "message": "Error message",
    "version": "API version",
    "timestamp": X 
}

Special cases: Errors 401, 403, 404 and 500 must be processed as such and the response must be ignored.

Configuration for Postman

If you want to do a quick test on the PEPData API endpoints, we have created a configuration for Postman that contains some basic examples.

27KB

PEPData - Public API.postman_collection.json

PEPData's API Configuration

Once the configuration is imported into Postman, you will need to set the API_KEY variable in the Authorization tab.

FAQs

How can I find my key for API access?

The key to access via the API is available in your profile. Just generate it by pressing the button, and copy it to establish the connection you want.

Besides the API, what other types of access are there?

PEPData has three types of access. You can access the application through our website, via an API connection or by downloading a list. This last access is normally user per clients with a greater number of data.