Fayda API

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.

To facilitate a smooth integration and onboarding experience, we invite you to use our self-service Partner Portal to register your account and onboard your organization. The Partner Portal is available at partner.fayda.et and provides a guided onboarding process with step-by-step instructions to help you complete and submit your onboarding request efficiently.

Partners Portal

Once your submission is received, our team will review the information and supporting documents provided. You will be notified of the status of your onboarding request throughout the review process. The portal also serves as a centralized platform where you can:

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 to support your technical teams throughout implementation

Should you have any questions, require technical assistance, or encounter any issues during onboarding or integration, please contact our support team at api_support@id.et. Our team will be happy to assist you and respond as promptly as possible.

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)

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.