TM Forum Open API

Customer Details Management API

Look up customer details for a mobile number

The CustomerDetailsManagement API is a powerful tool designed to handle customer information efficiently.

  • Onboarding
  • Customer service
  • Account checks

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 CustomerDetailsManagement API is a powerful tool designed to handle customer information efficiently. It provides a structured way to store, update, retrieve, and manage customer data across various business applications. This API ensures seamless integration with CRM systems, e-commerce platforms, financial services, and more, helping businesses maintain accurate and accessible customer records.

 

Key Features

  • Customer Data Storage: Securely stores customer details such as contact information, address, purchase history, and preferences.
  • Real-time Updates: Ensures data accuracy by allowing instant modifications to customer profiles.
  • Advanced Search & Filtering: Enables businesses to find specific customer records using criteria such as name, location, and purchase behavior.
  • Authentication & Security: Implements role-based access control and encryption to safeguard customer data.
  • Integration Flexibility: Works seamlessly with various business applications, including CRM systems, payment gateways, and analytics tools.
  • Activity Tracking: Maintains logs of customer interactions, enabling businesses to analyze behavior and improve engagement strategies.
 

Uses

  • E-commerce Platforms: Manage customer profiles, order history, and personalized recommendations.
  • Banking & Financial Services: Store and update customer credentials for secure transactions.
  • Healthcare Systems: Maintain patient records while ensuring compliance with privacy regulations.
  • Retail & Customer Support: Track customer inquiries and preferences to improve service.
  • Marketing & Personalization: Analyze customer behavior to create targeted advertising and promotions.
 

Benefits

  • Improved Customer Experience: Provides businesses with accurate and up-to-date customer data, allowing for better service and personalized interactions.
  • Operational Efficiency: Reduces manual data entry and errors by automating customer information management.
  • Security & Compliance: Ensures sensitive customer data remains protected and complies with industry standards and regulations.
  • Enhanced Decision-Making: Supports data-driven strategies by offering insights into customer trends and purchasing habits.
  • Scalability & Flexibility: Adapts to business growth, handling increasing volumes of customer data without performance issues.

Questions about the Customer Details Management API

What can I do with the Customer Details Management API?

The CustomerDetailsManagement API is a powerful tool designed to handle customer information efficiently.

  • Look up customer details for a number (GET /customerDetails/{msisdn})
Which inputs does each call to the Customer Details Management API need?
  • GET /customerDetails/{msisdn}: requires msisdn; headers transactionId, countryCode

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

What does the Customer Details Management API return?
  • GET /customerDetails/{msisdn} returns HTTP 200 with @type, eligibility, status

Responses are JSON.

How do I authenticate with the Customer Details Management API?
  1. Call POST https://api.ooredoo.com/tmf-api/oauth/v4/token with client_id, client_secret in the headers. Send grant_type in the body. Use the client ID and secret of your app.
  2. The response contains access_token, token_type, expires_in, consented_on, created_At, expired_At.
  3. Send Authorization: Bearer <access_token> on each call until the token expires, then request a new one.
Which errors can the Customer Details Management API return?
  • 400: Bad Request
  • 401: Unauthorized
  • 403: Forbidden
  • 404: Not Found
  • 405: Method Not Allowed
  • 412: PreCondition Failed
  • 500: Internal Server Error
  • 501: Not Implemented
  • 503: Service Unavailable

On 401, request a new access token and retry.

Where is the Customer Details Management API available?

Customer Details Management is available in Algeria, Palestine, Kuwait, Maldives, Qatar, Tunisia, Oman and Iraq.

Which standard does the Customer Details 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.

1. Get an access token

curl -X POST https://api.ooredoo.com/tmf-api/oauth/v4/token \
  -H "client_id: $CLIENT_ID" \
  -H "client_secret: $CLIENT_SECRET" \
  -d "grant_type=client_credentials"

2. Call the API

curl -X GET https://api.ooredoo.com/tmf-api/customerDetailsManagement/v4/customerDetails/<msisdn> \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "transactionId: <transactionId>" \
  -H "countryCode: <countryCode>"

API reference

Try any endpoint in the sandbox