Integration Guide
Integrate with Guardline to manage KYC and KYB applicants.
Welcome to Guardline
Guardline provides tools for creating and managing KYC (person) and KYB (organization) applicants. This documentation covers the available integration methods so you can get up and running quickly.
Integration Modes
Guardline supports two integration modes depending on your needs:
Onboarding Web UI
A hosted onboarding experience powered by Guardline. You create a session and redirect your end users to a Guardline-managed flow that handles the entire onboarding UX.
- Configure onboarding templates in Platform.
- Create sessions via API to get a redirect URL.
- Users complete onboarding steps in Guardline's hosted web.
Best for: fast go-live with hosted UI and built-in flow orchestration.
Guardline API
A direct backend integration where your system talks to Guardline's API to create and manage applicants programmatically.
- Full control over the UX and lifecycle.
- Create, update, and complete
people(KYC) andorganizations(KYB). - Schema-validated payloads per process type and country.
Best for: full backend control and custom UX.
Onboarding Web UI
Hosted KYC/KYB onboarding flows — create sessions and redirect users.
Guardline API
Learn how to create and manage applicants via the Guardline API.
Platform UI
Configure, monitor, and manage Guardline service using the GUI.
Which mode should I choose?
| Criteria | Onboarding Web UI | Guardline API |
|---|---|---|
| UX ownership | Guardline-managed | Your application |
| Integration effort | Low (redirect-based) | Medium (API calls) |
| Customization | Template-based | Full control |
| Best for | Quick onboarding | Custom workflows |
You can combine both modes: use Onboarding for user acquisition and Guardline API for custom back-office operations.