TMF931 Onboarding and Ordering

Enables Channel Partners and Marketplace providers to efficiently manage service onboarding and order execution

TMF
Service Management

Introduction

The TMF 931 Onboarding and Ordering API enables Channel Partners and Marketplace providers to efficiently manage service onboarding and order execution through a flexible, operate-first interface.

Subscribe to the API

Due to the nature of the TMF 931 Onboarding and Ordering API, subscription cannot be completed through a self-service process like other APIs available on Orange Developer. Instead, please contact the Orange Developer team by using the "Contact us" button at the top of this page. When reaching out, kindly specify the reason for your request and how you intend to use this API. Our team will then guide you through the necessary steps to gain access.

API Authentication

HTTPS requests to the REST API are protected with 2-Legged OAuth. To learn more about how Orange Developer handles authentication, please refer to our documentation.

In short, you will use your Orange Developer Authorization header as authorization_header for the Basic authentication with Orange Developer.

curl -X POST \
-H "Authorization: {{ authorization_header }}" \
-d "grant_type=client_credentials" \
https://api.orange.com/oauth/v3/token

In response, you will get an access_token.

{
       "token_type": "Bearer",
       "access_token": "66AeYJF8eJQ...2SjkFg9LB1LePC",
       "expires_in": 3600
}

API Description

See the TMF 931 Onboarding and Ordering API documentation

Data Required for TMF931 API Integration

GDPR Note

Some data properties used in Onboarding API operations become mandatory if the provisioned API Products implies end-users of Telecom Services based on the European Union.

Application Owner

Required data

DescriptionFieldComment
Name of the legal representative for the companyApplicationOwner.nameMandatory
Name of the companyApplicationOwner.engagedParty.nameMandatory
Name that the company trades underApplicationOwner.engagedParty.tradingNameMandatory
Tax number of the companyApplicationOwner.engagedParty.taxNumberMandatory
Type of organization. W3C types of organizations catalogueApplicationOwner.engagedParty.organizationTypeMandatory
Company legal identifierApplicationOwner.engagedParty.organizationIdentification.identificationIdOptional
Authority which has issued the identifierApplicationOwner.engagedParty.organizationIdentification.issuingAuthorityOptional
Type of identification information used to identify the companyApplicationOwner.engagedParty.organizationIdentification.identificationTypeOptional
The legal address of the companyApplicationOwner.engagedParty.registeredGeographicAddressMandatory
Company contact informationApplicationOwner.engagedParty.contactMediumMandatory

Additional required data for GDPR

DescriptionFieldComment
Contact information for the exercise of data protection rightsApplicationOwner.engagedParty.privacyManager or ApplicationOwner.engagedParty.dataProtectionOfficerMandatory - must be in one or another of the 2 fields
Contact information for the company DPO/PrivacyApplicationOwner.engagedParty.privacyManager or ApplicationOwner.engagedParty.dataProtectionOfficerMandatory - must be in one or another of the 2 fields
Legal representative of the companyApplicationOwner.engagedParty.legalRepresentativeMandatory
Data of the company’s representative in the UE (if available)ApplicationOwner.engagedParty.localRepresentativeOptional
Company privacy urlApplicationOwner.engagedParty.privacyPolicyURLProviding a company privacy url is mandatory but could be passed here or in Application.privacyPolicyURL

Application

Required data

DescriptionFieldComment
Application nameApplication.nameMandatory
Application commercial nameApplication.commercialNameMandatory
Application descriptionApplication descriptionMandatory
Category of the application (like finance, mapsAndNavigation, productivity, socialNetworkingAndCommunications, etc..)Application.categoryMandatory
Jwks uri if neededApplication.jwksUri(Technical requirement from CAMARA API) Needed for CIBA flow
Redirect uri if neededApplication.redirectUrl(Technical requirement from CAMARA API) Needed for Authorization Code flow

Additional required data for GDPR

DescriptionFieldComment
Link to application privacy PolicyApplication.privacyPolicyURLProviding a privacyPolicyURL is mandatory but could be provided in this attribute or in ApplicationOwner.engagedParty.privacyPolicyURL
Request Contact to provide users with the ability to delete or modify their own data.Application.privacyRightsRequestContactMandatory

ApiProductOrder

Required data

DescriptionFieldComment
Id of the product to subscribe (provided by Orange)ApiProductOrderItemAdd.productOffering.idMandatory

Additional required data for GDPR

DescriptionFieldComment
Explicit Terms and Conditions acceptance for the ProductApiProductOrderItemAdd.approvedProductOfferingTermOrConditionMandatory
Explain the reason justifying the purposeApiProductOrderItemAdd.approvedProductOfferingTermOrCondition.purposeReasonMandatory
Legal Basis based on W3C Data Privacy Vocabulary v2 (enum) (legitimate interest, explicit consent, etc…)ApiProductOrderItemAdd.approvedProductOfferingTermOrCondition.applicationLegalBasisForInputDataMandatory
Country or countries to which the data will be storedApiProductOrderItemAdd.approvedProductOfferingTermOrCondition.process.dataExportStorageCountry.countryCodeMandatory
Country or countries to which the data will transitApiProductOrderItemAdd.approvedProductOfferingTermOrCondition.process.dataExportTransitCountry.countryCodeMandatory
Screenshots of Application UXApiProductOrderItemAdd.approvedProductOfferingTermOrCondition.userConsentScreenshotMandatory
Processing operations of the “Processing” catalog of the DPV WC3 (enum) (ex: store, use, analyse, match, etc…)ApiProductOrderItemAdd.approvedProductOfferingTermOrCondition.process.processingOperationMandatory
Processing context derived from the "Context of processing" catalogue of the DPV WC3 v2 standard (enum) (ex: AlgorithmicLogic, DecisionMaking, EvaluationScoring, ConditionalAutomation, etc.)ApiProductOrderItemAdd.approvedProductOfferingTermOrCondition.process.context.processingContextMandatory
Duration of treatment derived from the “Duration and frequency” catalogue of the DPV WC3 v2 standard (enum) (Ex: endlessDuration, FixedOccurrencesDuration, TemporalDuration, etc…)ApiProductOrderItemAdd.approvedProductOfferingTermOrCondition.process.durationMandatory
Frequency of treatment derived from the “Duration and frequency” catalogue of the DPV WC3 v2 standard (enum) (Ex: ContinuousFrequency, OftenFrequency, SingularFrequency, SporadicFrequency)ApiProductOrderItemAdd.approvedProductOfferingTermOrCondition.process.frequencyMandatory