TM Forum Open API

Digital Identity Management API

Manage customers' digital identities and credentials

The Digital Identity Management API is designed to ensure secure authentication and identity verification for various entities, including customers, employees, partners, and system resources.

  • Identity lifecycle
  • Credential management
  • Account linking

What you can do with this API

Ready to test? Jump to the sample call and the API reference, where you can try every endpoint. Start testing
Read the full API overview

The Digital Identity Management API is designed to ensure secure authentication and identity verification for various entities, including customers, employees, partners, and system resources. It plays a crucial role in managing digital identities, enforcing access control, and safeguarding sensitive data from unauthorized access.

 

Key Capabilities

1. User Authentication & Verification

  • Provides multi-factor authentication (MFA) to enhance security.
  • Supports biometric authentication, password-based login, and token-based verification.
  • Ensures secure identity validation for seamless access control.

2. Role-Based Access Control (RBAC)

  • Defines user roles and permissions to prevent unauthorized data access.
  • Ensures that employees, customers, and partners can access only their designated resources.
  • Supports privilege escalation and restrictions based on organizational policies.

3. Federated Identity Management

  • Enables single sign-on (SSO) across multiple applications and platforms.
  • Supports identity federation, allowing users to authenticate using credentials from external identity providers.
  • Helps integrate authentication systems across cloud and on-premises environments.

4. Identity Lifecycle Management

  • Manages creation, modification, suspension, and deletion of digital identities.
  • Automates identity provisioning for new users and deprovisioning for departed employees or partners.
  • Ensures compliance with identity governance policies.

5. Fraud Detection & Security Monitoring

  • Implements AI-powered fraud detection mechanisms to identify suspicious activities.
  • Provides real-time monitoring and alerts for unauthorized access attempts.
  • Enables logging and auditing for security incident tracking and compliance.

6. Integration with Business Systems

  • Works seamlessly with CRM, ERP, and third-party security platforms.
  • Supports API-driven authentication for web applications, mobile apps, and IoT devices.
  • Ensures businesses maintain a secure and unified identity management strategy.
 

Use Cases of Digital Identity Management API

  1. Secure Customer Authentication – Protects customer accounts by enforcing multi-factor authentication.
  2. Employee Access Control – Grants employees access to internal resources based on predefined roles.
  3. Partner & Vendor Identity Management – Ensures secure authentication for third-party partners accessing enterprise platforms.
  4. Single Sign-On (SSO) Enablement – Simplifies login processes across multiple applications.
  5. Fraud Prevention & Account Security – Detects unauthorized logins and prevents identity theft.
  6. Compliance with Security Regulations – Helps businesses meet standards like GDPR, HIPAA, and ISO 27001.
 

The Digital Identity Management API is essential for protecting user identities, managing secure access, and preventing security breaches in digital ecosystems.

Questions about the Digital Identity Management API

What can I do with the Digital Identity Management API?

The Digital Identity Management API is designed to ensure secure authentication and identity verification for various entities, including customers, employees, partners, and system resources.

  • List or find DigitalIdentity objects (GET /digitalIdentity)
  • Creates a DigitalIdentity (POST /digitalIdentity)
  • Retrieves a DigitalIdentity by ID (GET /digitalIdentity/{id})
  • Deletes a DigitalIdentity (DELETE /digitalIdentity/{id})
  • Updates partially a DigitalIdentity (PATCH /digitalIdentity/{id})
  • Register a listener (POST /hub)
  • Unregister a listener (DELETE /hub/{id})
  • Client listener for entity DigitalIdentityCreateEvent (POST /listener/digitalIdentityCreateEvent)
  • Client listener for entity DigitalIdentityStateChangeEvent (POST /listener/digitalIdentityStateChangeEvent)
  • Client listener for entity DigitalIdentityDeleteEvent (POST /listener/digitalIdentityDeleteEvent)
  • Client listener for entity DigitalIdentityAttributeValueChangeEvent (POST /listener/digitalIdentityAttributeValueChangeEvent)
Which inputs does each call to the Digital Identity Management API need?
  • GET /digitalIdentity/{id}: requires id, msisdn
  • DELETE /digitalIdentity/{id}: requires id
  • PATCH /digitalIdentity/{id}: requires id
  • DELETE /hub/{id}: requires id

Every call also needs Authorization: Bearer <access_token>. The API reference on this page shows each field's type and an example request.

Which errors can the Digital Identity Management API return?
  • 400: Bad Request
  • 401: Unauthorized
  • 403: Forbidden
  • 404: Not Found
  • 405: Method Not allowed
  • 409: Conflict
  • 500: Internal Server Error

On 401, request a new access token and retry.

Where is the Digital Identity Management API available?

Digital Identity Management is available in Algeria, Kuwait, Maldives, Oman, Palestine and Tunisia.

Which standard does the Digital Identity Management API follow?

It follows the TM Forum Open API standard used across the telecom industry. See our TM Forum certification page.

Related APIs

Sample call

From the published OpenAPI specification. Replace the placeholders with your app's credentials and real values.

Call the API

curl -X GET https://api.ooredoo.com/tmf-api/digitalIdentityManagement/v1/digitalIdentity \
  -H "Authorization: Bearer $ACCESS_TOKEN"

API reference

Try any endpoint in the sandbox