The MSISDN Verify matching API delivers the result of comparison (true/false) of a MSISDN provided by your application and the one detected by the Orange Network.
It is based on GSMA specification IDY.54 - Mobile Connect Verified MSISDN Definition and Technical Requirements
Table of Contents
API Reference
Please find in the API Reference Tab the swagger for the Number verify match API
Authentication prerequisite
Our MSISDN Verify API requires a 3-legged authentication with our OpenID Connect platform. Please follow the method described here, with mc_vm_match scope, in order to get an access token that will be granted to get the MSISDN comparison result.
base-url
https://api.orange.com/msisdnverify/match/fr/v1
Retrieve MSISDN comparison result
You need a valid access token to invoke the MSISDN Verify matching API. This access token must be provided in the HTTP Authorization header:
curl --request POST \
--url https://api.orange.com/msisdnverify/match/fr/v1/msisdn_verify \
--header 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--data ' {
"mc_claims" : {
"device_msisdn": "+336........"
}
}
'
Note that delivered MSISDN has to be in international format E.164 (+33...).
If the transaction succeeds
If the comparison is successful
{
"device_msisdn_verified": true
}
If the comparison is unsuccessful
{
"device_msisdn_verified": false
}
If the transaction fails
In case of error, the endpoint returns an error response (JSON format) with the following information:
- error: single ASCII error code
- error_description: Human-readable ASCII text providing additional information, used to assist the developer in understanding the error that occurred.
| Error case | Error code | Error description |
|---|---|---|
| Access token is missing | 400 | REQUIRED authorization header is missing. |
| No device msisdn information detected by network | 400 | Network authentication failure |
| Content-Type different to "application/json" | 400 | Unexpected content-type |
| Malformed json | 400 | Malformed JSON |
| mc_claims parameter does not exist | 400 | REQUIRED parameter mc_claims is missing. |
| mc_claims parameter exists but the REQUIRED parameter device_msisdn is missing | 400 | REQUIRED parameter device_msisdn is missing. |
| device_msisdn is not compliant to E.164 format | 400 | REQUIRED parameter device_msisdn is not E.164 compliant. |
As examples:
{
"error": "invalid_request",
"error_description": "Authorization header is missing"
}
{
"error": "invalid_request",
"error_description": "Missing or unknown token in Authorization header"
}
We will always be there to support you if needed.