Overview

Guardline API

The API lets you create and manage people (KYC) and organizations (KYB) directly from your backend

In Guardline, unless otherwise specified, processes are executed asynchronously. This means that the result of a process is not obtained directly when calling the REST endpoint, but through a webhook. During the onboarding process, you must provide the URL with its respective configuration where the process results will be sent. In general, it is recommended to expose a POST type endpoint for this purpose.

A process is initiated by creating an entity of type Applicant that represents your client. An Applicant is identified with a UUID. The entity also contains your client's information (both provided by you and obtained by Guardline) and the results of the various processes it has undergone. Upon successfully creating the Applicant, you will receive the identification UUID as a response, which can be used in subsequent API calls. For one-shot API calls, after this response, the execution of the requested process will be automatically triggered (validating the rules corresponding to your default model), and the result will be sent to you via the previously mentioned callback.

Base Paths

https://api.guardline.io/v1/

Applicant Lifecycle

Every applicant follows this lifecycle:

1. Create — Send applicant data with a processType and optional country (jurisdiction for schema validation and model execution).
2. Update — Patch additional data as needed (documents, addresses, etc.).
3. Complete — Mark the applicant as ready for review/processing.
4. (If/when needed) Create new version - Override latest information and start over from step 1.

You cannot start a process until the subject applicant is in COMPLETED status. For audit reasons, we require the data to be immutable from the moment the process starts to run on. This means that once the applicant reaches to a COMPLETED status, you cannot alter the data.

To execute new processes with updated information, you must create a "new version" of the applicant and reinitiate the lifecycle. To achieve this, follow these steps:

1. Retrieve the current data using the GET endpoint.
2. Modify or append the necessary information.
3. Execute a PUT method using the existing applicant id. This will "overwrite" the data you see while keeping the original version for audit purposes.

Please note that the endpoints will always return the most recent version available.

Note: Maintaining the same ID is crucial for tracking the historical progression of an applicant across multiple versions.

Available Endpoints

Applicant entity supports a CRUD-like interface. There are also endpoints to fulfill one or more of the onboarding steps by using Guardline's onboarding UI. These endpoints depend on the applicant type, since the onboarding workflow varies between people and organizations.

Process Types

When creating an applicant, you must specify a processType that determines the validation rules and required fields:

API Reference