Open APIs

Dear All,

Need your quick input/guidance on using correct TMF API for SIM's registration. It's regarding pre-provisioning or registration of SIM's inventory at core network i.e IMS network HSS, AOTA etc. so before handing over to subscriber we do need to pre-provision or register respective IMSI , ICCID etc. range on network along with its authentication key and all so which TMF API can be used . Is it TMF664 or TMF702 etc. ?

Because later when actual customer or subscriber we reserve respective MSISDN and associate its ICCID,IMSI to activate service, plan offers etc. via PCRF, HSS then we will be using TMF 641-640 for respective activation of MSISDN, IMSI, ICCID at HSS, PCRF for policy and profile definition.

Kindly guide if will before when we get IMSI ranges and all from SIM's vendor and all with specific network specification and we need to get those registered on HSS, OTA etc. as a pre-requisite with its various authentication and network profile keys which TMF API can be best suited. If its TMF 664 how it can be used as I am unable to map MSISDN, ICCID, IMSI etc. ranges with resource function and its registration parameters with given operations like heal, scale, migrate or for activation of resource.

Thanks !!!

------------------------------
Mahesh Choudhari
BT Group plc
------------------------------

Hi Mahesh

If you are talking about pre-provisioning of an individual SIM, presumably TMF702 would be the correct API, Resource Activation. TMF664 is specifically for resource functions, and I don't think a SIM is that. But maybe @Vance Shipley could weigh in here.

There is no concrete model in the TMF Open API for SIM resource and its friends, so all the items that you mention would be characteristics on the SIM resource. It will be your responsibility to populate the characteristic values based on what you get from your SIM manufacturer and of course the specific needs of your network equipment.

If you need to do bulk pre-provisioning, you'll have to set up a process that invokes the TMF702 POST one by one for each item in the bulk. Or use some bulk load that doesn't involve TMF Open APIs.

Hope it helps

------------------------------
Jonathan Goldberg
Amdocs Management Limited
Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
------------------------------

Thanks @Jonathan Goldbergfor your quick response and inputs. Even we were thinking of 702 could be most suitable. Just one query can we use and execute this API directly between source and destination we need to generate some 641-service order or 652 resource order and against that logically we can map RFS to execute 702 API. Just thinking from modelling of API and SID accordingly for resource/ service etc. so that subsequently when customer /subscriber order comes for actual service plan activation in HSS, PCRF etc. then against 641 we can use 640 and also will have respective service inventory associated against earlier created resource inventory against 702.

------------------------------
Mahesh Choudhari
BT Group plc
------------------------------

Original Message:
Sent: May 23, 2024 09:33
From: Jonathan Goldberg
Subject: Best TMF API for Pre-provisioning of registration of SIM's

Hi Mahesh

If you are talking about pre-provisioning of an individual SIM, presumably TMF702 would be the correct API, Resource Activation. TMF664 is specifically for resource functions, and I don't think a SIM is that. But maybe @Vance Shipley could weigh in here.

There is no concrete model in the TMF Open API for SIM resource and its friends, so all the items that you mention would be characteristics on the SIM resource. It will be your responsibility to populate the characteristic values based on what you get from your SIM manufacturer and of course the specific needs of your network equipment.

If you need to do bulk pre-provisioning, you'll have to set up a process that invokes the TMF702 POST one by one for each item in the bulk. Or use some bulk load that doesn't involve TMF Open APIs.

Hope it helps

------------------------------
Jonathan Goldberg
Amdocs Management Limited
Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
------------------------------

Have a look at the proposals in 

TMFS008 Use Case: Service and Resource Order Management for Postpaid Mobile Subscribers v3.2.0 – TM Forum

Note this member only document at the moment.

It describes the modelling as per Vance description below and show the sequence chart for ordering and provisioning including which API's to use.

------------------------------
Dave Milham
TM Forum, Chief Architect
------------------------------

Original Message:
Sent: May 24, 2024 00:45
From: Mahesh Choudhari
Subject: Best TMF API for Pre-provisioning of registration of SIM's

Thanks @Jonathan Goldbergfor your quick response and inputs. Even we were thinking of 702 could be most suitable. Just one query can we use and execute this API directly between source and destination we need to generate some 641-service order or 652 resource order and against that logically we can map RFS to execute 702 API. Just thinking from modelling of API and SID accordingly for resource/ service etc. so that subsequently when customer /subscriber order comes for actual service plan activation in HSS, PCRF etc. then against 641 we can use 640 and also will have respective service inventory associated against earlier created resource inventory against 702.

------------------------------
Mahesh Choudhari
BT Group plc
------------------------------


Original Message:
Sent: May 23, 2024 09:33
From: Jonathan Goldberg
Subject: Best TMF API for Pre-provisioning of registration of SIM's

Hi Mahesh

If you are talking about pre-provisioning of an individual SIM, presumably TMF702 would be the correct API, Resource Activation. TMF664 is specifically for resource functions, and I don't think a SIM is that. But maybe @Vance Shipley could weigh in here.

There is no concrete model in the TMF Open API for SIM resource and its friends, so all the items that you mention would be characteristics on the SIM resource. It will be your responsibility to populate the characteristic values based on what you get from your SIM manufacturer and of course the specific needs of your network equipment.

If you need to do bulk pre-provisioning, you'll have to set up a process that invokes the TMF702 POST one by one for each item in the bulk. Or use some bulk load that doesn't involve TMF Open APIs.

Hope it helps

------------------------------
Jonathan Goldberg
Amdocs Management Limited
Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.

The big picture would be that a universal integrated circuit card (UICC) based SIM is a Physical Resource while an eSIM is a Logical Resource. In both cases they contain one or more Logical Resources representing applications, chiefly USIM but possibly ISIM and others.

If you are managing the SIM/eSIM distribution channels you would want to represent those Physical/Logical Resources as their own managed entities.

A USIM or ISIM would most accurately be represented as a instance of Installed Software (TMF730) as it is technically an application running on an embedded computer (UICC) which exposes an API via Resource Functions (e.g. AKA Challenge). I am not however going to suggest that you do that.  Those are all subclasses of Logical Resource and you may just manage the USIM application as one Logical Resource.

So with that said you may use TMF702 for activation of a (U)SIM if the system producing the API is intended to handle activation through interaction with HSS, etc..

------------------------------
Vance Shipley
SigScale
------------------------------

For pre-provisioning SIMs (IMSI, ICCID, etc.) in the core network, TMF664 is the right API to use. It handles resource management, including registration and authentication keys. The challenge you're facing with mapping MSISDN, ICCID, IMSI could be related to how your resource functions are set up. You may need to ensure these are properly defined for your system to link them with the correct operations. TMF641/640 will be used later for activation and policy management. Let me know if you need further details!

------------------------------
Muhammad Hussain
TO BE VERIFIED
------------------------------

​For pre-provisioning SIM cards (IMSI, ICCID, etc.) in the core network, the TMF664 Resource Function Activation and Configuration API is the recommended choice. This API supports the provisioning and lifecycle management of resource functions, which can include SIM-related resources. 

Once the SIM is pre-provisioned, subsequent activation and policy management can be handled using the TMF641/640 APIs. These APIs are designed for service activation and policy management, aligning with the activation of services associated with the SIM. ​

For more insights and discussions on SIM registration and related topics, you might find the TM Forum's community discussions helpful.

------------------------------
jay Sheraz
TO BE VERIFIED
------------------------------

Use TMF702 (Resource Pool Management) for pre-provisioning SIM data like IMSI, ICCID, and keys into HSS/OTA. TMF664 is more for lifecycle operations (heal, scale, etc.) and may not suit this use case directly.

------------------------------
jase phon
TO BE VERIFIED
------------------------------

A suitable API for the initial pre-provisioning of SIM inventory (IMSI, ICCID, authentication keys) into the core network is TMF702 (Resource Activation and Configuration).

This API is designed for activating logical resources like a SIM profile on network elements (HSS, OTA). The TMF664 API is generally used for broader lifecycle management operations (heal, scale, migrate) of resource functions and may not directly map the specific registration parameters required.

The subsequent plan to use TMF641/640 for customer-facing service activation and policy definition on HSS/PCRF is correct.

For end-users, successful service activation also depends on correct device configuration. A common issue faced is a tm sim card no signal error, often resolvable with specific device troubleshooting steps. A detailed guide can be found here: Fix TM SIM No Signal Instantly 2025.

This clarification should help map the correct API to the pre-provisioning requirement.

------------------------------
Norman Porter
TO BE VERIFIED
------------------------------

Original Message:
Sent: Aug 07, 2025 13:56
From: jase phon
Subject: Best TMF API for Pre-provisioning of registration of SIM's

Use TMF702 (Resource Pool Management) for pre-provisioning SIM data like IMSI, ICCID, and keys into HSS/OTA. TMF664 is more for lifecycle operations (heal, scale, etc.) and may not suit this use case directly.

------------------------------
jase phon
TO BE VERIFIED
------------------------------