Welcome to Fayda Digital ID SSO API
Our API makes it simple for developers to connect with our platform and seamlessly integrate our services into their applications. Designed for reliability and scalability, it supports both small applications and large-scale projects, ensuring robust performance at any level. With strong security protocols, Your data remains secure throughout every stage.
We also provide modern authentication and identity management solutions, including OAuth 2.0 and OpenID Connect (OIDC). These industry-standard protocols ensure secure access to resources and make it easier for users to authenticate safely. Whether you're starting with basic integration or implementing advanced identity solutions like Fayda eSignet, We're here to support you every step of the way.
Getting Started
To begin integrating our Api, start by reviewing our documentation. It covers all the essential steps, including authentication, available endpoints, and usage examples.
Read API Documentation (Online)Offline Authentication
You can get your Fayda verified without the need for network connectivity, simply by either using the QR code (we also call the QR FaydaEncode) on your Fayda Credential (id.et/credentials).We are also working on a Digital Credential Wallet called FaydaPass, to serve as a credential repository for citizens and multiple use-cases, not only limited to Fayda Credentials.These offline channels are quick, real-time and better for privacy.
Simplified authentication at your convenience.
Download ManualOnline Authentication
Online use cases leverage advanced digital solutions. Veri Fayda 1.0 and 2.0 enable seamless eKYC with features like one-time passwords (OTP), facial recognition via selfies, and fingerprint scans, ensuring robust and secure digital identity verification.
Verifayda 2.0 Guidelinee-KYC Service
Service providers can perform e-KYC by requesting the customer’s Fayda Alias Number (FAN) or Fayda Identification Number (FIN) on our secure portal. Customers will receive a verification code (OTP) for added security, giving consent for the service to be provided. Service providers can effortlessly retrieve the customer's eKYC data after successful consent.
Going one step further
Beyond e-KYC we are now working towards securely linking our Fadya customer’s credentials with their extended digitally stored records with essential services such as banks, telecom, medical records, and more… establishing a trusted connection between Fayda holders and service providers enabling seamless and secure authentication for future transactions. This ensures Fayda becomes a reliable and trusted means of identification, enhancing the convenience, efficiency, and security of digitized service interactions.
Download ManualPartner Portal
To facilitate a smooth integration and onboarding experience, register your organization through our self-service Partner Portal at partner.fayda.et. The portal provides guided step-by-step instructions to complete and submit your onboarding request.
Open Partner PortalPortal capabilities
- Manage your organization's profile and onboarding information
- Manage your Organization Validation (OV) certificates
- Access and manage integration credentials
- Read technical documentation, API specifications, and integration guides
- Track onboarding and integration progress
- Access end-to-end integration documentation within the portal
Authentication and Identity Management
Our Api uses modern, secure methods for authentication and identity management to ensure your application's safety and reliability.
OAuth 2.0
OAuth 2.0 is an industry-standard protocol designed for secure, delegated access to web resources. It allows applications to access user data on another system without requiring the user to share their password directly. Instead, OAuth 2.0 issues tokens after users authenticate, which the application can then use to make requests on behalf of the user. To use OAuth 2.0, developers must register their applications to receive client credentials, then implement the token exchange process. This includes obtaining an authorization code, exchanging it for an access token, and then using that token to access protected resources. By using OAuth 2.0, applications can securely interact with a user’s account while minimizing the risk of exposing sensitive credentials.
OpenID Protocol
OpenID is a decentralized authentication protocol that allows users to use a single set of credentials across multiple sites. Through OpenID, users can log in to various services without needing a separate username and password for each one. Instead, they authenticate through a trusted OpenID provider, which then verifies their identity to the requesting application. To implement OpenID, developers need to redirect users to the OpenID provider for authentication, then handle the provider’s response to confirm the user’s identity. This process simplifies account management for users and enhances security for applications by outsourcing authentication to a secure, specialized provider.
OIDC with Fayda eSignet
OpenID Connect (OIDC) is an identity layer built on top of the OAuth 2.0 protocol, providing a way to verify user identity in addition to handling access authorization. When integrated with Fayda eSignet, OIDC enables secure, streamlined user authentication and access management tailored specifically for Ethiopian users. Fayda eSignet serves as the OpenID provider, managing user identity verification and authorization in compliance with local standards. By using OIDC with Fayda eSignet, applications can authenticate users with a high degree of trust, ensuring data security while facilitating easy, centralized access to services across platforms in the Ethiopian digital ecosystem.
OIDC Flow
Resources for Developers
| Resource | Description | Link |
|---|---|---|
| Quick Start Guide | A step-by-step walkthrough to get your Api integration up and running quickly. | Quick Start |
| Api Reference | Detailed information on each endpoint, parameters, and expected responses. | Reference |
| Code Samples | Explore examples to see how each endpoint functions in real scenarios. | GitHub |
Reference
Implementations for VeriFayda 2.0 via eSignet can be found in our GitHub page:
Have Questions?
Our support team is here to help! If you have any questions or need assistance, please reach out to our support email api_support@id.et.
