TMF629 v4 Customer Management API

The Customer Management API (TMF629) provides a standardised mechanism for customer and customer account management, such as creation, update, retrieval and deletion of customers. Using this API you can perform the following operations on the customer account.

  • Retrieve the list of customer accounts from the system
  • Get the customer account details based on conditions or id parameter
  • Create a customer account
  • Update an existing customer account
  • Delete an existing customer account

The Customer Management API is certified by TM Forum.

Certification

  • The CommsCloud license must be enabled to invoke the TMF629 API.

TMF629 API uses the following URL format: {https://MyDomainLoginUrl}/services/data/{{version}}/connect/comms/customermanagement/v4/customer.

To access and use the TMF629 API:

  1. Read and accept the terms and conditions of usage. See Accept Terms and Enable Access.
  2. Authorize and use a connected app and an OAuth 2.0 authorization flow. See Authorize Access.
  3. Trigger the API call. Refer the above section for sample URL.
  4. Use the TMF629 API endpoints. See TMF629 API Endpoints.