Live & Production-Ready

The Developer Gateway to
IPPIS Rwanda

A secure, RESTful API that gives partner applications access to user profiles, employment records, qualifications, disabilities, publications, and more — all from one endpoint.

▶  Try Live APIs 📄  Read the Docs
BASE URL https://api.ippis.rw/api

Everything your app needs

Built for government partner systems that integrate with Rwanda's public-sector HR platform.

👤

User Profiles

Retrieve complete employee identity data including NID verification, residence, and employment status.

🎓

Qualifications & Education

Access academic history, degree levels, schools, graduation years, and uploaded certificates.

💼

Work Experience

Query employment history across public and private institutions, with verified document references.

Disabilities & Inclusion

Retrieve declared disabilities and levels in compliance with Rwanda's inclusion policy requirements.

📄

Publications

List and manage an employee's published works, linked to type catalogs and document URLs.

👥

Referees

Create, update, and retrieve professional referees with duplicate-detection built in.

🔏

Bearer-Token Auth

All endpoints are protected by partner client credentials and scoped bearer tokens.

📋

OpenAPI 3 Docs

Full Swagger UI and ReDoc documentation generated from the live API spec — always up to date.

Key Endpoints

All routes are prefixed with /api/profile unless noted.

👤 Identity

GET/user/identityFull user profile with employment & personal data
GET/user/statusProfile completion status flags
GET/user/residenceResidence address hierarchy

🎓 Education & Qualifications

GET/user/educationsList all education records
POST/user/educationsAdd or update an education record
DEL/user/educations/:idRemove an education record

💼 Experience & Languages

GET/user/experiencesEmployment history list
POST/user/experiencesAdd or update work experience
GET/user/languagesLanguage proficiency records
POST/user/languagesAdd or update a language entry

📦 Shared Lookups — /api/share

GET/degreesDegree catalog
GET/countriesCountry list
GET/disabilitiesDisability catalog
GET/languagesLanguage catalog

Up and running in minutes

Four steps from zero to your first successful API response.

Request Credentials

Contact the IPPIS team to receive your client ID and client secret for your partner system.

Obtain a Token

POST to /api/auth/token with your credentials to receive a scoped bearer token.

Call Endpoints

Include Authorization: Bearer <token> and your x-client-id header on every request.

Explore & Integrate

Use Swagger UI to test all endpoints live, then integrate the responses into your application.

Ready to build with IPPIS?

Open the interactive documentation and start making real API calls right now.

Open Swagger UI  ↗
🔒

VPN Required

The SDK package registry is hosted on the internal network.
Please connect to the IPPIS VPN before proceeding.