The SimSwap API provides the customer the ability to obtain information on any recent SIM pairing change related to the User's mobile account.

HTTPS requests to the REST API are protected with CIBA 3-Legged OAuth.

In short, the API Invoker (e.g. Application Backend or Aggregator) before to request SIM swap check, needs to request a Three-Legged Access Token from Orange Authorization Server. The process follows the OpenID Connect Client-Initiated Backchannel Authentication (CIBA) flow.

Step 1: request the back channel authorization from the Application Backend

To authenticate the end-user and obtain her/his consent a GET request must be sent to the bc-authorize endpoint from the Application Backend. This request must provide required parameters.

curl -X POST "https://api.orange.com/es/openapi/oauth/v2/bc-authorize"
-H 'Authorization: Basic encode64(clien_id:client_secret)'
-H 'Content-type:application/x-www-form-urlencoded'
-d 'scope=dpv%3AFraudPreventionAndDetection%23sim-swap&login_hint=tel%3A%2B346xxxxxxxx'

        
        Copied 
      

Once the end-user provided her/his consent, the Orange authorization server will send back to the client application an authorization req_id.

200 {"auth_req_id":"69957d77-fea4-4a4c-8cd2-b29f22e61307","interval":2,"expires_in":120}

        
        Copied 
      

Step 2: Request the OAuth access token

Once the client application got the authorization code, it has to get the access token protecting the resources. In order to retrieve it, the client application triggers a POST request to the token endpoint.

curl -X POST "https://api.orange.com/es/openapi/oauth/v2/token"
-H "Authorization: Basic {your application Basic header}" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=urn%3Aopenid%3Aparams%3Agrant-type%3Aciba&auth_req_id=69957d77-fea4-4a4c-8cd2-b29f22e61307"

        
        Copied 
      

If the transaction succeeds, in the POST response, the acccess_token is provided.

200 {"access_token":"*****","token_type":"Bearer","expires_in":"119"}

        
        Copied 
      

Step 3: Access protected resources using OAuth access token

In order to call our API, the access_token is mandatory.

Specific documentation about number Verification resources is provided below.

Go up

Base URL

The Base URL is the first part of the full invocation URL, just before the resource paths defined in the API reference.

The Base URL is comprised of the scheme ('https'), the authority (i.e. the Fully Qualified Domain Name) and the API base path.

Whenever you request this API and encounter a 404 (Not Found) HTTP status code, please check first that the Base URL is correct.

The Base URL for this API is: https://api.orange.comcamara/oes/sim-swap/v0

The documentation below assumes that, whenever you make requests on this API, you are prepending the Base URL to the resource paths defined for this API.

Resources

This API has two resources which have their own parameters.

/retrieve-date (POST)

This service returns the timestamp of the most recent SIM card change, capturing the latest alteration between a specific mobile phone number and its corresponding SIM card unique identifier (IMSI).

Request

As an example:

curl 
  --request POST \
  --header 'Authorization: Bearer *****' \
  --header 'Content-type:application/json' \
  --data '{"phoneNumber": "+34654654654"}'
  'https://api.orange.com/camara/oes/sim-swap/v0/retrieve-date' 

        
        Copied 
      

Response

a/ If the transaction succeeds

On success, the SimSwap API returns a 200 OK HTTP status code with JSON data including the 'latestSimChange' property with information about SIM swap change.

As an example:

HTTP/1.1 200 OK

{
  "latestSimChange": "2023-09-05T13:57:55.707Z"
}

        
        Copied 
      

b/ If the transaction fails

Please visit the common error responses section in this page.

/check (POST)

Checks if SIM swap has been performed during a past period.

Request

As an example:

curl 
  --request POST \
  --header 'Authorization: Bearer *****' \
  --header 'Content-type:application/json' \
  --data '{"phoneNumber": "+34654654654","maxAge": 240}'
  'https://api.orange.com/camara/oes/sim-swap/v0/check' 

        
        Copied 
      

Response

a/ If the transaction succeeds

On success, the SimSwap API returns a 200 OK HTTP status code with JSON data including the 'swapped' property indicating if SIM swap has been performed during the period.

As an example:

HTTP/1.1 200 OK
X-Orange-Trace-Id: 428fe874f806e88e243f73c730103279531ed1e1

{
  "swapped": true
}

        
        Copied 
      

b/ If the transaction fails

Please visit the common error responses section in this page.

Common error responses

In case of error, the SimSwap API returns an error response (JSON format) with the following information:

This is compliant with CAMARA Project specifications, which can be read here. Below is a list of possible error responses.

Problem with the client request:

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "status": 400,
  "code": "INVALID_ARGUMENT",
  "message": "Client specified an invalid argument, request body or query param"
}

        
        Copied 
      

Authentication problem with the client request:

HTTP/1.1 401 Unauthorized
Content-Type: application/json

{
  "status": 401,
  "code": "UNAUTHENTICATED",
  "message": "Request not authenticated due to missing, invalid, or expired credentials"
}

        
        Copied 
      

Client is authenticated correctly but does not have sufficient permissions:

HTTP/1.1 403 Forbidden
Content-Type: application/json

{
  "status": 403,
  "code": "PERMISSION_DENIED",
  "message": "Client does not have sufficient permissions to perform this action"
}

        
        Copied 
      

Resource not found (it can be an error in the pathsuffix of the URL, or an unknown phone number):

HTTP/1.1 404 Not Found
Content-Type: application/json

{
  "status": 404,
  "code": "NOT_FOUND",
  "message": "The specified resource is not found."
}

        
        Copied 
      

The URL of the request is right but it has been made with a method (HTTP verb) not allowed:

HTTP/1.1 405 Method Not Allowed
Content-Type: application/json

{
  "status": 405,
  "code": "METHOD_NOT_ALLOWED",
  "message": "The requested method is not allowed/supported on the target resource."
}

        
        Copied 
      

There is another request created for the same MSISDN:

HTTP/1.1 409 Conflict
Content-Type: application/json

{
  "status": 409,
  "code": "CONFLICT",
  "message": "Another request is created for the same MSISDN"
}

        
        Copied 
      

Exceeded requests per hour/minute limit:

HTTP/1.1 429 Too Many Requests
Content-Type: application/json

{
  "status": 429,
  "code": "TOO_MANY_REQUESTS",
  "message": "Either out of resource quota or reaching rate limiting."
}

        
        Copied 
      

Generic internal server error (also used by default if the error doesn't fit any of the ones detailed in this section):

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
  "status": 500,
  "code": "INTERNAL",
  "message": "Server error"
}

        
        Copied 
      

Service temporarily unavailable or host not reached:

HTTP/1.1 503 Service Unavailable
Content-Type: application/json

{
  "status": 503,
  "code": "UNAVAILABLE",
  "message": "Service unavailable"
}

        
        Copied 
      

Request time limit exceeded:

HTTP/1.1 504 Gateway Timeout
Content-Type: application/json

{
  "status": 504,
  "code": "TIMEOUT",
  "message": "Request timeout exceeded. Try later"
}

        
        Copied 
      

Go up

History of document

Go up