API_Proposal_Tenure_Vodafone.md

May 16, 2024 ยท View on GitHub

FieldDescription
API family nameTenure
API family ownerVodafone
API summaryEstablishes a level of trust against the mobile ID by verifying the length of tenure for a mobile user who is bound to a mobile number with their current mobile operator; tenure means the period of time a MSISDN has been associated with a specific user with their current CSP. API checks whether the lifetime tenure of a given MSISDN is longer than an input date and indicates the type of mobile contract.

[Use Case]: Enterprises can use Tenure API to gauge and establish a level of trust (or Trust Score) with a mobile user who is associated with a specific mobile number, based on how long they have been associated with that number.
Technical viabilityThe data for this API comes from backend systems/sources (i.e. CRM).
Commercial viabilityTo Establish level of trust (or Trust Score) against a mobile ID (MSISDN). The Tenure API will return a True or False answer as to whether the customer's tenure with an operator has been longstanding.

[Example]: Customer submits MSISDN to understand if the mobile number has been registered to a CSP for longer than a specific date.

* Sample Request: {"tenure_before_date":{"value": "2019-01-15"}}
* API Response: True/False - if tenure is longer than specified date + billing segment (PAYG/PAYM/Business)
* Sample Response: "tenure_before_date_check": true, "billing_segment": "PAYM"
YAML code available?YES
Validated in lab/productive environments?YES
Validated with real customers?YES - TMT Analysis
Validated with operators?YES - Telefonica, Hutchinson Group
Supporters in API Backlog Working GroupTelefonica, Deutsche Telekom, Orange, KDDI