Developer Portal

Build with GhanaPass

Integrate national identity verification into your applications with our REST API and OAuth 2.0 SSO.

API Endpoints

Open Swagger UI

Authentication

POST/api/auth/register
Register a new user with Ghana Card
POST/api/auth/login
Login and receive JWT tokens
POST/api/auth/refresh
Refresh access token
POST/api/auth/logout
Invalidate session

Identity Verification

POST/api/verify/identity
Verify identity using Ghana Card number
POST/api/verify/face
Facial recognition with liveness detection

SIM Verification

POST/api/sim/verify
Verify SIM ownership against Ghana Card registration

Digital Signatures

POST/api/documents/upload
Upload a PDF document
POST/api/documents/sign
Digitally sign a document with PIN
GET/api/documents
List user documents
GET/api/documents/:id/verify
Verify document signature integrity

OAuth 2.0 / OpenID Connect

GET/api/oauth/authorize
Authorization endpoint — start SSO flow
POST/api/oauth/token
Exchange authorization code for tokens
GET/api/oauth/userinfo
OpenID Connect userinfo endpoint