API Party (4.0.0)

Download OpenAPI specification:Download

TMF API Reference : TMF 632 - Party

Release : 19.0

The party API provides standardized mechanism for party management such as creation, update, retrieval, deletion and notification of events. Party can be an individual or an organization that has any kind of relation with the enterprise. Party is created to record individual or organization information before the assignment of any role. For example, within the context of a split billing mechanism, Party API allows creation of the individual or organization that will play the role of 3 rd payer for a given offer and, then, allows consultation or update of his information.

Resources

  • Organization
  • Individual
  • Hub

Party API performs the following operations :

  • Retrieve an organization or an individual
  • Retrieve a collection of organizations or individuals according to given criteria
  • Create a new organization or a new individual
  • Update an existing organization or an existing individual
  • Delete an existing organization or an existing individual
  • Notify events on organizatin or individual

Authentication

OAuth2

Security Scheme Type OAuth2
implicit OAuth Flow
Authorization URL: https://auth.bss.totogi.com/oauth2/authorize
Scopes:
  • openid -

    openid