Get Started in Simple Steps
Get started
From browsing to your first API call
Browse every API and its documentation without an account. Register when you're ready to create an app and get your keys.
Register to get API keys and start buildingAlready registered? Sign in
The path, and who does each step
You do thisOoredoo does this, and emails you
Your first call
Example with the SIM Swap API, from its published OpenAPI specification. Use the client ID and secret of your app.
1. Get an access token
curl -X POST https://api.ooredoo.com/oauth/v4/token \
-H "client_id: $CLIENT_ID" \
-H "client_secret: $CLIENT_SECRET" \
-d "grant_type=client_credentials" \
-d "scope=urn:camarasimswap"
2. Call the API
curl -X POST https://api.ooredoo.com/sim-swap/v4/check \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"phoneNumber": "+974XXXXXXXX", "maxAge": 240}'
Every API page lists its operations, required inputs, response fields and errors.
APIs
- Account Management Manage customer, billing and settlement accounts TM Forum
- CAMARA Number Verification Verify phone numbers without SMS codes CAMARA
- CAMARA OTP Send and check one-time passcodes by SMS CAMARA
- Communication Management Send messages to customers on the Ooredoo network TM Forum
- Customer Details Management Look up customer details for a mobile number TM Forum
- Customer Management Create, find and update customer records TM Forum
- DCB One-Time Let customers pay with their mobile account TM Forum
- DCB Recurring Bill subscriptions to the mobile account TM Forum
- Digital Identity Management Manage customers' digital identities and credentials TM Forum
- DMP Management Reach and charge customers from your data platform
- Number Recycling Know when a phone number has a new owner CAMARA
- Open Gateway Onboarding and Ordering Onboard partners and order API access programmatically TM Forum
- Prepay Balance Management Manage prepaid balances in real time TM Forum
- Product Catalog Management Browse the operator's products, offers and prices TM Forum
- Product Inventory Management See which products and services a customer has TM Forum
- Product Ordering Management Place and track product orders TM Forum
- SIM Swap Stop SIM-swap fraud before it happens CAMARA
Standards and help
TM Forum Open APIs
Billing, balance, customer and communication APIs follow the TM Forum Open API standard.
Our TM Forum certification → TM Forum certifications registerGSMA CAMARA
SIM Swap, Number Verification and OTP follow CAMARA, part of the GSMA Open Gateway initiative.
Our CAMARA certification → GSMA Open Gateway mapNeed help?
Answers to common questions, or write to the team.
Read the FAQs → Contact us og_api@ooredoo.com
