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 building

The path, and who does each step

You do thisOoredoo does this, and emails you

  1. You Browse the APIs No account needed
  2. You Register Email and server IPs
  3. Ooredoo Account approved IPs whitelisted, email sent
  4. You Create an app Add the APIs you need
  5. You Get keys and call OAuth 2.0 token

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

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 register

GSMA CAMARA

SIM Swap, Number Verification and OTP follow CAMARA, part of the GSMA Open Gateway initiative.

Our CAMARA certification → GSMA Open Gateway map

Need help?

Answers to common questions, or write to the team.

Read the FAQs → Contact us og_api@ooredoo.com