openapi: 3.0.1 info: title: Open Gateway Operate API Onboarding and Ordering description: > **TMF931 - API Ordering, Developer & Application Onboarding and Management** This Operate API specification covers the onboarding operations between Channel Partners and Operators as described by GSMA. It offers a consolidation of multiple TM Forum based APIs into a single specification (a component suite). This API specification proposes : - Application Owner (Developer) Management (acceptance, onboarding, lifecycle management) - Application Management (acceptance, onboarding, lifecycle management) - Service API Management (ordering, retrieving) This API is a composite DCS (Domain Context Specialization) of the following TMF Open APIs for Open Gateway context - TMF622 Product Ordering Management v5.0 - TMF637 Product Inventory Management v5.0 - TMF669 Party Role Management v5.0 - TMF639 Resource Inventory v5.0 Copyright © TM Forum 2025. All Rights Reserved version: 5.2.1 x-generation-tooling-version: v8.5.15 x-generation-data-model-version: unknown x-generation-date: '2025-12-11T09:49:01.463Z' x-api-id: TMF931 license: name: Apache License 2.0 url: 'https://www.apache.org/licenses/LICENSE-2.0' servers: - url: '{apiRoot}/openGatewayOperateAPIOnboardingAndOrdering/v5/' variables: apiRoot: default: 'https://serverRoot/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5' enum: - 'https://serverRoot/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5' tags: - name: apiProductOrder description: Operations for ApiProductOrder Resource - name: apiProduct description: Operations for ApiProduct Resource - name: application description: Operations for Application Resource - name: applicationOwner description: Operations for ApplicationOwner Resource - name: monitor description: Operations for Monitor Resource - name: notification listener description: Notifications for Resource Lifecycle and event notifications - name: events subscription description: Endpoints to register and terminate an Event Listener paths: /apiProduct: get: tags: - apiProduct summary: List or find ApiProduct objects description: List or find ApiProduct objects operationId: listApiProduct parameters: - $ref: '#/components/parameters/Fields' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Before' - $ref: '#/components/parameters/After' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Filter' responses: '200': $ref: '#/components/responses/200ApiProductArray' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' '/apiProduct/{id}': get: tags: - apiProduct summary: Retrieves a ApiProduct by ID description: >- This operation retrieves a ApiProduct entity. Attribute selection enabled for all first level attributes. operationId: retrieveApiProduct parameters: - $ref: '#/components/parameters/Id' - $ref: '#/components/parameters/Fields' responses: '200': $ref: '#/components/responses/200ApiProduct_Get' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' /apiProductOrder: get: tags: - apiProductOrder summary: List or find ApiProductOrder objects description: List or find ApiProductOrder objects operationId: listApiProductOrder parameters: - $ref: '#/components/parameters/Fields' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Before' - $ref: '#/components/parameters/After' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Filter' responses: '200': $ref: '#/components/responses/200ApiProductOrderArray' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' post: tags: - apiProductOrder summary: Creates a ApiProductOrder description: This operation creates a ApiProductOrder entity. operationId: createApiProductOrder parameters: - $ref: '#/components/parameters/Fields' requestBody: $ref: '#/components/requestBodies/ApiProductOrder_FVO' responses: '201': $ref: '#/components/responses/201ApiProductOrder' '202': description: Accepted '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '409': $ref: '#/components/responses/409' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' '/apiProductOrder/{id}': get: tags: - apiProductOrder summary: Retrieves a ApiProductOrder by ID description: >- This operation retrieves a ApiProductOrder entity. Attribute selection enabled for all first level attributes. operationId: retrieveApiProductOrder parameters: - $ref: '#/components/parameters/Id' - $ref: '#/components/parameters/Fields' responses: '200': $ref: '#/components/responses/200ApiProductOrder_Get' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' /application: post: tags: - application summary: Creates a Application description: This operation creates a Application entity. operationId: createApplication parameters: - $ref: '#/components/parameters/Fields' requestBody: $ref: '#/components/requestBodies/Application_FVO' responses: '201': $ref: '#/components/responses/201Application' '202': description: Accepted '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '409': $ref: '#/components/responses/409' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' get: tags: - application summary: List or find Application objects description: List or find Application objects operationId: listApplication parameters: - $ref: '#/components/parameters/Fields' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Before' - $ref: '#/components/parameters/After' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Filter' responses: '200': $ref: '#/components/responses/200ApplicationArray' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' '/application/{id}': get: tags: - application summary: Retrieves a Application by ID description: >- This operation retrieves a Application entity. Attribute selection enabled for all first level attributes. operationId: retrieveApplication parameters: - $ref: '#/components/parameters/Id' - $ref: '#/components/parameters/Fields' responses: '200': $ref: '#/components/responses/200Application_Get' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' patch: tags: - application summary: Updates partially a Application description: This operation updates partially a Application entity. operationId: patchApplication parameters: - $ref: '#/components/parameters/Id' - $ref: '#/components/parameters/Fields' requestBody: $ref: '#/components/requestBodies/Application_MVO' responses: '200': $ref: '#/components/responses/200Application_Patch' '202': description: Accepted '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '409': $ref: '#/components/responses/409' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' /applicationOwner: post: tags: - applicationOwner summary: Creates a ApplicationOwner description: This operation creates a ApplicationOwner entity. operationId: createApplicationOwner parameters: - $ref: '#/components/parameters/Fields' requestBody: $ref: '#/components/requestBodies/ApplicationOwner_FVO' responses: '201': $ref: '#/components/responses/201ApplicationOwner' '202': description: Accepted '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '409': $ref: '#/components/responses/409' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' get: tags: - applicationOwner summary: List or find ApplicationOwner objects description: List or find ApplicationOwner objects operationId: listApplicationOwner parameters: - $ref: '#/components/parameters/Fields' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Before' - $ref: '#/components/parameters/After' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Filter' responses: '200': $ref: '#/components/responses/200ApplicationOwnerArray' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' '/applicationOwner/{id}': get: tags: - applicationOwner summary: Retrieves a ApplicationOwner by ID description: >- This operation retrieves a ApplicationOwner entity. Attribute selection enabled for all first level attributes. operationId: retrieveApplicationOwner parameters: - $ref: '#/components/parameters/Id' - $ref: '#/components/parameters/Fields' responses: '200': $ref: '#/components/responses/200ApplicationOwner_Get' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' patch: tags: - applicationOwner summary: Updates partially a ApplicationOwner description: This operation updates partially a ApplicationOwner entity. operationId: patchApplicationOwner parameters: - $ref: '#/components/parameters/Id' - $ref: '#/components/parameters/Fields' requestBody: $ref: '#/components/requestBodies/ApplicationOwner_MVO' responses: '200': $ref: '#/components/responses/200ApplicationOwner_Patch' '202': description: Accepted '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '409': $ref: '#/components/responses/409' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' /hub: post: operationId: createHub summary: Create a subscription (hub) to receive Events description: Sets the communication endpoint to receive Events. tags: - events subscription requestBody: $ref: '#/components/requestBodies/Hub_FVO' responses: '201': $ref: '#/components/responses/Hub' default: $ref: '#/components/responses/Error' '/hub/{id}': get: operationId: hubGet summary: Retrieve a subscription (hub) description: This operation retrieves the subscription to receive Events. tags: - events subscription parameters: - $ref: '#/components/parameters/Id' responses: '200': $ref: '#/components/responses/Hub' default: $ref: '#/components/responses/Error' delete: operationId: hubDelete summary: Remove a subscription (hub) to receive Events description: This operation removes the subscription to receive Events. tags: - events subscription parameters: - $ref: '#/components/parameters/Id' responses: '204': description: Deleted default: $ref: '#/components/responses/Error' /listener/apiProductOrderAttributeValueChangeEvent: post: tags: - notification listener summary: Client listener for entity ApiProductOrderAttributeValueChangeEvent description: >- Example of a client listener for receiving the notification ApiProductOrderAttributeValueChangeEvent operationId: apiProductOrderAttributeValueChangeEvent requestBody: $ref: '#/components/requestBodies/ApiProductOrderAttributeValueChangeEvent' responses: '204': description: Notified default: $ref: '#/components/responses/Error' /listener/apiProductOrderCreateEvent: post: tags: - notification listener summary: Client listener for entity ApiProductOrderCreateEvent description: Example of a client listener for receiving the notification ApiProductOrderCreateEvent operationId: apiProductOrderCreateEvent requestBody: $ref: '#/components/requestBodies/ApiProductOrderCreateEvent' responses: '204': description: Notified default: $ref: '#/components/responses/Error' /listener/apiProductOrderStateChangeEvent: post: tags: - notification listener summary: Client listener for entity ApiProductOrderStateChangeEvent description: Example of a client listener for receiving the notification ApiProductOrderStateChangeEvent operationId: apiProductOrderStateChangeEvent requestBody: $ref: '#/components/requestBodies/ApiProductOrderStateChangeEvent' responses: '204': description: Notified default: $ref: '#/components/responses/Error' /listener/applicationApprovalStatusChangeEvent: post: tags: - notification listener summary: Client listener for entity ApplicationApprovalStatusChangeEvent description: >- Example of a client listener for receiving the notification ApplicationApprovalStatusChangeEvent operationId: applicationApprovalStatusChangeEvent requestBody: $ref: '#/components/requestBodies/ApplicationApprovalStatusChangeEvent' responses: '204': description: Notified default: $ref: '#/components/responses/Error' /listener/applicationAttributeValueChangeEvent: post: tags: - notification listener summary: Client listener for entity ApplicationAttributeValueChangeEvent description: >- Example of a client listener for receiving the notification ApplicationAttributeValueChangeEvent operationId: applicationAttributeValueChangeEvent requestBody: $ref: '#/components/requestBodies/ApplicationAttributeValueChangeEvent' responses: '204': description: Notified default: $ref: '#/components/responses/Error' /listener/applicationCreateEvent: post: tags: - notification listener summary: Client listener for entity ApplicationCreateEvent description: Example of a client listener for receiving the notification ApplicationCreateEvent operationId: applicationCreateEvent requestBody: $ref: '#/components/requestBodies/ApplicationCreateEvent' responses: '204': description: Notified default: $ref: '#/components/responses/Error' /listener/applicationOwnerApprovalStatusChangeEvent: post: tags: - notification listener summary: Client listener for entity ApplicationOwnerApprovalStatusChangeEvent description: >- Example of a client listener for receiving the notification ApplicationOwnerApprovalStatusChangeEvent operationId: applicationOwnerApprovalStatusChangeEvent requestBody: $ref: '#/components/requestBodies/ApplicationOwnerApprovalStatusChangeEvent' responses: '204': description: Notified default: $ref: '#/components/responses/Error' /listener/applicationOwnerAttributeValueChangeEvent: post: tags: - notification listener summary: Client listener for entity ApplicationOwnerAttributeValueChangeEvent description: >- Example of a client listener for receiving the notification ApplicationOwnerAttributeValueChangeEvent operationId: applicationOwnerAttributeValueChangeEvent requestBody: $ref: '#/components/requestBodies/ApplicationOwnerAttributeValueChangeEvent' responses: '204': description: Notified default: $ref: '#/components/responses/Error' /listener/applicationOwnerCreateEvent: post: tags: - notification listener summary: Client listener for entity ApplicationOwnerCreateEvent description: Example of a client listener for receiving the notification ApplicationOwnerCreateEvent operationId: applicationOwnerCreateEvent requestBody: $ref: '#/components/requestBodies/ApplicationOwnerCreateEvent' responses: '204': description: Notified default: $ref: '#/components/responses/Error' /listener/monitorStateChangeEvent: post: tags: - notification listener summary: Client listener for entity MonitorStateChangeEvent description: Example of a client listener for receiving the notification MonitorStateChangeEvent operationId: monitorStateChangeEvent requestBody: $ref: '#/components/requestBodies/MonitorStateChangeEvent' responses: '204': description: Notified default: $ref: '#/components/responses/Error' /monitor: get: tags: - monitor summary: List or find Monitor objects description: List or find Monitor objects operationId: listMonitor parameters: - $ref: '#/components/parameters/Fields' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Before' - $ref: '#/components/parameters/After' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Filter' responses: '200': $ref: '#/components/responses/200MonitorArray' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' '/monitor/{id}': get: tags: - monitor summary: Retrieves a Monitor by ID description: >- This operation retrieves a Monitor entity. Attribute selection enabled for all first level attributes. operationId: retrieveMonitor parameters: - $ref: '#/components/parameters/Id' - $ref: '#/components/parameters/Fields' responses: '200': $ref: '#/components/responses/200Monitor_Get' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' components: schemas: Addressable: type: object description: Base schema for addressable entities properties: href: type: string description: Hyperlink reference id: type: string description: unique identifier AgreementItemRef: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: It's a Agreement item that has been executed previously. properties: agreementName: type: string description: Name of the related entity. agreementHref: type: string description: Reference of the related entity. '@referredType': type: string description: The actual type of the target instance when needed for disambiguation. agreementId: type: string description: Unique identifier of a related entity. agreementItemId: type: string description: Id of an item of a Agreement discriminator: propertyName: '@type' mapping: AgreementItemRef: '#/components/schemas/AgreementItemRef' AgreementRef: type: object description: >- Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications. allOf: - $ref: '#/components/schemas/EntityRef' discriminator: propertyName: '@type' mapping: AgreementRef: '#/components/schemas/AgreementRef' ApiAuthorization: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: Describes who has been authorized to sign the API ProductOfferingTermOrCondition. properties: name: type: string description: Name of the required authorization approver: $ref: '#/components/schemas/RelatedPartyRefOrPartyRoleRef' discriminator: propertyName: '@type' mapping: ApiAuthorization: '#/components/schemas/ApiAuthorization' ApiAuthorization_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: Describes who has been authorized to sign the API ProductOfferingTermOrCondition. properties: name: type: string description: Name of the required authorization approver: $ref: '#/components/schemas/RelatedPartyRefOrPartyRoleRef_FVO' required: - approver discriminator: propertyName: '@type' mapping: ApiAuthorization: '#/components/schemas/ApiAuthorization_FVO' ApiConsumerPermission: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: An ApiConsumerPermission allows an Application to consume an API. properties: managedAssetGroup: $ref: '#/components/schemas/ApiListAssetGroup' discriminator: propertyName: '@type' mapping: ApiConsumerPermission: '#/components/schemas/ApiConsumerPermission' ApiDigitalIdentity: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- ApiDigitalIdentity is a class that allow to describe a digital identity for an individual or a resource or a specific party role. One of these three MUST be provided. If an individual is provided, this identity will be for all her/his partyRole. To avoid confusion it is recommended in this case to not provide partyRoleIdentified. DEPRECATED in the POST and PATCH, this attribute can't be valued by the API consumer in this context. properties: clientId: type: string description: >- OAuth2 Client ID: A public identifier for apps. Even though it is public, it is best that it is not guessable by third parties, so many implementations use something like a 32-character hex string. DEPRECATED in the POST and the PATCH, this attribute can't be valued by the API consumer in this context. redirectUrl: type: array deprecated: true items: type: string description: >- DEPRECATED : moved to Application schema. After a user successfully authorizes an application, the authorization server will redirect the user back to the application. jwksUri: deprecated: true type: string description: >- DEPRECATED : moved to Application schema. JSON Web Key (JWK) is a data structure that represents a cryptographic key validFor: $ref: '#/components/schemas/TimePeriod' status: type: string description: >- Used to indicate the current lifecycle status of this digital identity (unknown, active, suspended, archived). credential: type: array description: >- A list of credential/authentification method that are used for this digital identity. items: $ref: '#/components/schemas/OAuth2ClientCredential' discriminator: propertyName: '@type' mapping: ApiDigitalIdentity: '#/components/schemas/ApiDigitalIdentity' ApiDigitalIdentity_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- ApiDigitalIdentity is a class that allow to describe a digital identity for an individual or a resource or a specific party role. One of these three MUST be provided. If an individual is provided, this identity will be for all her/his partyRole. To avoid confusion it is recommended in this case to not provide partyRoleIdentified. DEPRECATED in the POST and PATCH, this attribute can't be valued by the API consumer in this context. properties: clientId: type: string description: >- OAuth2 Client ID: A public identifier for apps. Even though it is public, it is best that it is not guessable by third parties, so many implementations use something like a 32-character hex string. DEPRECATED in the POST and the PATCH, this attribute can't be valued by the API consumer in this context. redirectUrl: type: array deprecated: true items: type: string description: >- DEPRECATED : moved to Application schema. After a user successfully authorizes an application, the authorization server will redirect the user back to the application. jwksUri: deprecated: true type: string description: >- DEPRECATED : moved to Application schema. JSON Web Key (JWK) is a data structure that represents a cryptographic key discriminator: propertyName: '@type' mapping: ApiDigitalIdentity: '#/components/schemas/ApiDigitalIdentity_FVO' ApiDigitalIdentity_MVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- ApiDigitalIdentity is a class that allow to describe a digital identity for an individual or a resource or a specific party role. One of these three MUST be provided. If an individual is provided, this identity will be for all her/his partyRole. To avoid confusion it is recommended in this case to not provide partyRoleIdentified. DEPRECATED in the POST and PATCH, this attribute can't be valued by the API consumer in this context. properties: clientId: type: string description: >- OAuth2 Client ID: A public identifier for apps. Even though it is public, it is best that it is not guessable by third parties, so many implementations use something like a 32-character hex string. DEPRECATED in the POST and the PATCH, this attribute can't be valued by the API consumer in this context. redirectUrl: type: array deprecated: true items: type: string description: >- DEPRECATED : moved to Application schema. After a user successfully authorizes an application, the authorization server will redirect the user back to the application. jwksUri: deprecated: true type: string description: >- DEPRECATED : moved to Application schema. JSON Web Key (JWK) is a data structure that represents a cryptographic key discriminator: propertyName: '@type' mapping: ApiDigitalIdentity: '#/components/schemas/ApiDigitalIdentity_MVO' ApiGrantInformation: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- ApiGrantInformation is a structured set of information regarding the grant of access to an API product, detailing its purpose, scope, grant type, and legal basis for usage. properties: purpose: $ref: '#/components/schemas/DpvPurposeType' scope: type: array items: type: string description: >- One or several scopes of the API, as stated in the API that has been purchased. Examples: "sim-swap:retrieve-date" grantType: type: array items: type: string description: >- One or several grantType of the API, as stated in the API that has been purchased. Examples: "authorization_code" "client_credentials" "urn:ietf:params:oauth:grant-type:token-exchange" "urn:ietf:params:oauth:grant-type:jwt-bearer" "urn:ietf:params:oauth:grant-type:saml2-bearer" "urn:ietf:params:oauth:grant-type:device_code" "urn:openid:params:grant-type:ciba" legalBasis: $ref: '#/components/schemas/DpvLegalBasisType' discriminator: propertyName: '@type' mapping: ApiGrantInformation: '#/components/schemas/ApiGrantInformation' ApiListAssetGroup: allOf: - $ref: '#/components/schemas/AssetGroup' - type: object description: Defines a group of API assets to which access can be controlled properties: apiProduct: type: array items: $ref: '#/components/schemas/ProductRef' description: The list of products for which permissions are given. ApiPermissionSet: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- The PermissionSet is a set of Permissions granted to a user (party, party role or resource). The set may be granted explicitly by an authorized user or may be acquired implicitly due to the role that the user is playing. properties: creationDate: type: string format: date-time description: Date when the PermissionSet was created and assigned to a user description: type: string description: Text describing the permission set validFor: $ref: '#/components/schemas/TimePeriod' permission: $ref: '#/components/schemas/ApiConsumerPermission' discriminator: propertyName: '@type' mapping: ApiPermissionSet: '#/components/schemas/ApiPermissionSet' ApiPermissionSet_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- The PermissionSet is a set of Permissions granted to a user (party, party role or resource). The set may be granted explicitly by an authorized user or may be acquired implicitly due to the role that the user is playing. properties: creationDate: type: string format: date-time description: Date when the PermissionSet was created and assigned to a user description: type: string description: Text describing the permission set validFor: $ref: '#/components/schemas/TimePeriod' permission: $ref: '#/components/schemas/ApiConsumerPermission' required: - creationDate - permission discriminator: propertyName: '@type' mapping: ApiPermissionSet: '#/components/schemas/ApiPermissionSet_FVO' ApiProduct: allOf: - $ref: '#/components/schemas/Entity' - type: object description: >- ApiProduct is a specialization of a Product being an instance of an atomic ProductOffering or a ProductSpecification that is realized by an API (the Service). properties: name: type: string description: Name of the product. It could be the same as the name of the product offering description: type: string description: >- Is the description of the product. It could be same description than Product Offering one. productOffering: $ref: '#/components/schemas/ProductOfferingRef' productSpecification: $ref: '#/components/schemas/ProductSpecificationRef' productRelationship: type: array description: Collection of product relationships items: $ref: '#/components/schemas/OpenGatewayProductRelationship' apiName: type: string description: Standardized name of the API. apiVersionDetails: type: array items: $ref: '#/components/schemas/ApiVersionDetails' description: A set of ApiProduct characteristics grouped together by API major version. purpose: $ref: '#/components/schemas/DpvPurposeType' countryCode: type: array items: $ref: '#/components/schemas/ISO31661Alpha2StandardIdentifier' description: One or several countries where API is operated. productOrderItem: type: array items: $ref: '#/components/schemas/RelatedOrderItem' description: A reference to the Product Order items that involved this Product. approvedProductOfferingTermOrCondition: type: array items: $ref: '#/components/schemas/ProductOfferingTermOrCondition' description: Approved Terms or Conditions of the ProductOffering. status: $ref: '#/components/schemas/ProductStatusType' creationDate: type: string format: date-time description: Date and time when the product was created startDate: type: string format: date-time description: Is the date from which the product starts orderDate: type: string format: date-time description: Is the date when the product was ordered terminationDate: type: string format: date-time description: Is the date when the product was terminated channelPartner: $ref: '#/components/schemas/PartyRoleRef' agreementItem: type: array items: $ref: '#/components/schemas/AgreementItemRef' description: Collection of agreement items that involves this Product. discriminator: propertyName: '@type' mapping: ApiProduct: '#/components/schemas/ApiProduct' ApiProductDeviceLocationVerification: '#/components/schemas/ApiProductDeviceLocationVerification' ApiProductLocationVerificationAntifraud: '#/components/schemas/ApiProductLocationVerificationAntifraud' UsageVolumeProductLocationVerification: '#/components/schemas/UsageVolumeProductLocationVerification' ApiProduct_RES: type: object description: Response object for ApiProduct allOf: - $ref: '#/components/schemas/ApiProduct' required: - id - href discriminator: propertyName: '@type' mapping: ApiProduct: '#/components/schemas/ApiProduct' ApiProductDeviceLocationVerification: '#/components/schemas/ApiProductDeviceLocationVerification' ApiProductLocationVerificationAntifraud: '#/components/schemas/ApiProductLocationVerificationAntifraud' UsageVolumeProductLocationVerification: '#/components/schemas/UsageVolumeProductLocationVerification' ApiProductActionAdd: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- An ApiProductActionAdd is a specialization of a ProductAction, for GSMA Open GW context for action to add a product. properties: purpose: $ref: '#/components/schemas/DpvPurposeType' countryCode: type: array items: $ref: '#/components/schemas/ISO31661Alpha2StandardIdentifier' description: >- One or several countries where API is operated. Must be chosen from possible values described in the API ProductSpecification. targetApplication: $ref: '#/components/schemas/ApplicationRef' discriminator: propertyName: '@type' mapping: ApiProductActionAdd: '#/components/schemas/ApiProductActionAdd' ApiProductActionAddDeviceLocationVerification: '#/components/schemas/ApiProductActionAddDeviceLocationVerification' ApiProductActionAddDeviceLocationVerificationBundled: '#/components/schemas/ApiProductActionAddDeviceLocationVerificationBundled' ApiProductActionAdd_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- An ApiProductActionAdd is a specialization of a ProductAction, for GSMA Open GW context for action to add a product. properties: purpose: $ref: '#/components/schemas/DpvPurposeType' countryCode: type: array items: $ref: '#/components/schemas/ISO31661Alpha2StandardIdentifier_FVO' description: >- One or several countries where API is operated. Must be chosen from possible values described in the API ProductSpecification. targetApplication: $ref: '#/components/schemas/ApplicationRef' required: - targetApplication discriminator: propertyName: '@type' mapping: ApiProductActionAdd: '#/components/schemas/ApiProductActionAdd_FVO' ApiProductActionAddDeviceLocationVerification: '#/components/schemas/ApiProductActionAddDeviceLocationVerification_FVO' ApiProductActionAddDeviceLocationVerificationBundled: '#/components/schemas/ApiProductActionAddDeviceLocationVerificationBundled_FVO' ApiProductActionAddDeviceLocationVerification: allOf: - $ref: '#/components/schemas/ApiProductActionAdd' - type: object description: >- An ApiProductActionAddDeviceLocationVerification is a specialization of a ApiProductActionAdd. It's an example, not a schema to be implemented as is in production. properties: bestAccuracy: type: integer ApiProductActionAddDeviceLocationVerification_FVO: allOf: - $ref: '#/components/schemas/ApiProductActionAdd_FVO' - type: object description: >- An ApiProductActionAddDeviceLocationVerification is a specialization of a ApiProductActionAdd. It's an example, not a schema to be implemented as is in production. properties: bestAccuracy: type: integer required: - bestAccuracy ApiProductActionAddDeviceLocationVerificationBundled: allOf: - $ref: '#/components/schemas/ApiProductActionAdd' - type: object description: >- An ApiProductActionAddDeviceLocationVerificationBundled is a specialization of a ApiProductActionAdd. It's an example, not a schema to be implemented as is in production. properties: bestAccuracy: type: integer ApiProductActionAddDeviceLocationVerificationBundled_FVO: allOf: - $ref: '#/components/schemas/ApiProductActionAdd_FVO' - type: object description: >- An ApiProductActionAddDeviceLocationVerificationBundled is a specialization of a ApiProductActionAdd. It's an example, not a schema to be implemented as is in production. properties: bestAccuracy: type: integer required: - bestAccuracy ApiProductActionModify: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- An ApiProductActionModify is a specialization of a ProductAction, for GSMA Open GW context for action to modify a product. The values in the schema shall override the values in the Product; it means if the purpose values were [A,B] then if in the modify productAction the purpose values are [A,C] it means the purpose B will be removed and purpose C will be added. properties: purpose: $ref: '#/components/schemas/DpvPurposeType' countryCode: type: array items: $ref: '#/components/schemas/ISO31661Alpha2StandardIdentifier' description: >- One or several countries where is operated. Must be chosen from possible values described in the API ProductSpecification. targetApplication: $ref: '#/components/schemas/ApplicationRef' discriminator: propertyName: '@type' mapping: ApiProductActionModify: '#/components/schemas/ApiProductActionModify' ApiProductActionModifyDeviceLocationVerification: '#/components/schemas/ApiProductActionModifyDeviceLocationVerification' ApiProductActionModify_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- An ApiProductActionModify is a specialization of a ProductAction, for GSMA Open GW context for action to modify a product. The values in the schema shall override the values in the Product; it means if the purpose values were [A,B] then if in the modify productAction the purpose values are [A,C] it means the purpose B will be removed and purpose C will be added. properties: purpose: $ref: '#/components/schemas/DpvPurposeType' countryCode: type: array items: $ref: '#/components/schemas/ISO31661Alpha2StandardIdentifier_FVO' description: >- One or several countries where is operated. Must be chosen from possible values described in the API ProductSpecification. targetApplication: $ref: '#/components/schemas/ApplicationRef' discriminator: propertyName: '@type' mapping: ApiProductActionModify: '#/components/schemas/ApiProductActionModify_FVO' ApiProductActionModifyDeviceLocationVerification: '#/components/schemas/ApiProductActionModifyDeviceLocationVerification_FVO' ApiProductActionModifyDeviceLocationVerification: allOf: - $ref: '#/components/schemas/ApiProductActionModify' - type: object description: >- An ApiProductActionModifyDeviceLocationVerification is a specialization of a ApiProductActionModify. It's an example, not a schema to be implemented as is in production. properties: bestAccuracy: type: integer ApiProductActionModifyDeviceLocationVerification_FVO: allOf: - $ref: '#/components/schemas/ApiProductActionModify_FVO' - type: object description: >- An ApiProductActionModifyDeviceLocationVerification is a specialization of a ApiProductActionModify. It's an example, not a schema to be implemented as is in production. properties: bestAccuracy: type: integer ApiProductDeviceLocationVerification: allOf: - $ref: '#/components/schemas/ApiProduct' - type: object description: >- An ApiProductDeviceLocationVerification is a specialization of a ApiProduct. It's an example, not a schema to be implemented as is in production. properties: bestAccuracy: description: The best accuracy is the wished accuracy of the location in the response. type: integer minimum: 10 maximum: 1000 ApiProductLocationVerificationAntifraud: allOf: - $ref: '#/components/schemas/ApiProduct' - type: object description: >- An ApiProductLocationVerificationAntifraud is a specialization of a ApiProduct. It's an example, not a schema to be implemented as is in production. properties: bestAccuracy: description: The best accuracy is the wished accuracy of the location in the response. type: integer minimum: 10 maximum: 1000 ApiProductOrder: allOf: - $ref: '#/components/schemas/Entity' - type: object description: >- An ApiProductOrder is a specialization of a ProductOrder, which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa. properties: description: type: string description: Description of the product order externalId: type: array items: $ref: '#/components/schemas/ExternalIdentifier' description: >- Can be used to pass the internal identifier of the order in the Channel Partner system. productOrderItem: type: array items: $ref: '#/components/schemas/DCSProductOrderItem' minItems: 1 description: >- An identified part of the order. A product order is decomposed into one or more order items. agreement: type: array description: A reference to an agreement defined in the context of the product order items: $ref: '#/components/schemas/AgreementRef' channelPartner: $ref: '#/components/schemas/PartyRoleRef' state: $ref: '#/components/schemas/ProductOrderStateType' stateReason: type: string description: >- A string providing an explanation on the value of the state lifecycle. For instance if the state is rejected, stateReason will provide the reason for rejection. creationDate: type: string format: date-time description: Date and time when the ProductOrder was created expectedCompletionDate: type: string format: date-time description: Expected delivery date amended by the provider completionDate: type: string format: date-time description: Date when the ProductOrder was completed discriminator: propertyName: '@type' mapping: ApiProductOrder: '#/components/schemas/ApiProductOrder' ApiProductOrder_FVO: allOf: - $ref: '#/components/schemas/Entity' - type: object description: >- An ApiProductOrder is a specialization of a ProductOrder, which can be used to place an order between a customer and a service provider or between a service provider and a partner and vice versa. properties: description: type: string description: Description of the product order externalId: type: array items: $ref: '#/components/schemas/ExternalIdentifier_FVO' description: >- Can be used to pass the internal identifier of the order in the Channel Partner system. productOrderItem: type: array items: $ref: '#/components/schemas/DCSProductOrderItem_FVO' minItems: 1 description: >- An identified part of the order. A product order is decomposed into one or more order items. agreement: type: array description: A reference to an agreement defined in the context of the product order items: $ref: '#/components/schemas/AgreementRef' required: - productOrderItem discriminator: propertyName: '@type' mapping: ApiProductOrder: '#/components/schemas/ApiProductOrder_FVO' ApiProductOrder_RES: type: object description: Response object for ApiProductOrder allOf: - $ref: '#/components/schemas/ApiProductOrder' required: - id - href discriminator: propertyName: '@type' mapping: ApiProductOrder: '#/components/schemas/ApiProductOrder' ApiProductOrderAttributeValueChangeEvent: allOf: - $ref: '#/components/schemas/Event' - type: object description: ApiProductOrderAttributeValueChangeEvent generic structure properties: event: $ref: '#/components/schemas/ApiProductOrderAttributeValueChangeEventPayload' discriminator: propertyName: '@type' mapping: ApiProductOrderAttributeValueChangeEvent: '#/components/schemas/ApiProductOrderAttributeValueChangeEvent' ApiProductOrderAttributeValueChangeEventPayload: type: object description: ApiProductOrderAttributeValueChangeEventPayload properties: productOrder: $ref: '#/components/schemas/ApiProductOrder' ApiProductOrderCreateEvent: allOf: - $ref: '#/components/schemas/Event' - type: object description: ApiProductOrderCreateEvent generic structure properties: event: $ref: '#/components/schemas/ApiProductOrderCreateEventPayload' discriminator: propertyName: '@type' mapping: ApiProductOrderCreateEvent: '#/components/schemas/ApiProductOrderCreateEvent' ApiProductOrderCreateEventPayload: type: object description: ApiProductOrderCreateEventPayload properties: productOrder: $ref: '#/components/schemas/ApiProductOrder' ApiProductOrderItemAdd: allOf: - $ref: '#/components/schemas/DCSProductOrderItem' - type: object description: >- An ApiProductOrderItemAdd is a specialization of a ProductOrderItem, for action to add a product. An identified part of the order. A product order is decomposed into one or more order items. properties: id: type: string description: >- Identifier of the ProductOrder item (generally it is a sequence number 01, 02, 03, ...) productOffering: $ref: '#/components/schemas/ProductOfferingRef' productAction: $ref: '#/components/schemas/ApiProductActionAdd' approvedProductOfferingTermOrCondition: type: array items: $ref: '#/components/schemas/ProductOfferingTermOrCondition' description: List of approved ProductOfferingTermOrCondition by the ApplicationOwner. state: $ref: '#/components/schemas/ProductOrderItemStateType' stateReason: type: string description: >- A string providing an explanation on the value of the state lifecycle. For instance if the state is rejected, stateReason will provide the reason for rejection. product: $ref: '#/components/schemas/ProductRef' externalIdentifier: $ref: '#/components/schemas/ExternalIdentifier' productOrderItemRelationship: type: array description: Collection of order items relationships in the Open Gateway context. items: $ref: '#/components/schemas/OpenGatewayOrderItemRelationship' ApiProductOrderItemAdd_FVO: allOf: - $ref: '#/components/schemas/DCSProductOrderItem_FVO' - type: object description: >- An ApiProductOrderItemAdd is a specialization of a ProductOrderItem, for action to add a product. An identified part of the order. A product order is decomposed into one or more order items. properties: id: type: string description: >- Identifier of the ProductOrder item (generally it is a sequence number 01, 02, 03, ...) productOffering: $ref: '#/components/schemas/ProductOfferingRef' productAction: $ref: '#/components/schemas/ApiProductActionAdd_FVO' approvedProductOfferingTermOrCondition: type: array items: $ref: '#/components/schemas/ProductOfferingTermOrCondition_FVO' description: List of approved ProductOfferingTermOrCondition by the ApplicationOwner. stateReason: type: string description: >- A string providing an explanation on the value of the state lifecycle. For instance if the state is rejected, stateReason will provide the reason for rejection. externalIdentifier: $ref: '#/components/schemas/ExternalIdentifier_FVO' productOrderItemRelationship: type: array description: Collection of order items relationships in the Open Gateway context. items: $ref: '#/components/schemas/OpenGatewayOrderItemRelationship_FVO' required: - id - productOffering - approvedProductOfferingTermOrCondition - productAction ApiProductOrderItemModify: allOf: - $ref: '#/components/schemas/DCSProductOrderItem' - type: object description: >- An ApiProductOrderItemModify is a specialization of a ProductOrderItem, for action to add a product. An identified part of the order. A product order is decomposed into one or more order items. properties: id: type: string description: >- Identifier of the ProductOrder item (generally it is a sequence number 01, 02, 03, ...) productAction: $ref: '#/components/schemas/ApiProductActionModify' approvedProductOfferingTermOrCondition: type: array items: $ref: '#/components/schemas/ProductOfferingTermOrCondition' description: List of approved ProductOfferingTermOrCondition by the ApplicationOwner. state: $ref: '#/components/schemas/ProductOrderItemStateType' stateReason: type: string description: >- A string providing an explanation on the value of the state lifecycle. For instance if the state is rejected, stateReason will provide the reason for rejection. product: $ref: '#/components/schemas/ProductRef' productOrderItemRelationship: type: array description: Collection of order items relationships in the Open Gateway context. items: $ref: '#/components/schemas/OpenGatewayOrderItemRelationship' ApiProductOrderItemModify_FVO: allOf: - $ref: '#/components/schemas/DCSProductOrderItem_FVO' - type: object description: >- An ApiProductOrderItemModify is a specialization of a ProductOrderItem, for action to add a product. An identified part of the order. A product order is decomposed into one or more order items. properties: id: type: string description: >- Identifier of the ProductOrder item (generally it is a sequence number 01, 02, 03, ...) productAction: $ref: '#/components/schemas/ApiProductActionModify_FVO' approvedProductOfferingTermOrCondition: type: array items: $ref: '#/components/schemas/ProductOfferingTermOrCondition_FVO' description: List of approved ProductOfferingTermOrCondition by the ApplicationOwner. stateReason: type: string description: >- A string providing an explanation on the value of the state lifecycle. For instance if the state is rejected, stateReason will provide the reason for rejection. product: $ref: '#/components/schemas/ProductRef' productOrderItemRelationship: type: array description: Collection of order items relationships in the Open Gateway context. items: $ref: '#/components/schemas/OpenGatewayOrderItemRelationship_FVO' required: - id - product - targetApplication - approvedProductOfferingTermOrCondition ApiProductOrderStateChangeEvent: allOf: - $ref: '#/components/schemas/Event' - type: object description: ApiProductOrderStateChangeEvent generic structure properties: event: $ref: '#/components/schemas/ApiProductOrderStateChangeEventPayload' discriminator: propertyName: '@type' mapping: ApiProductOrderStateChangeEvent: '#/components/schemas/ApiProductOrderStateChangeEvent' ApiProductOrderStateChangeEventPayload: type: object description: ApiProductOrderStateChangeEventPayload properties: productOrder: $ref: '#/components/schemas/ApiProductOrder' ApiVersionDetails: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: A set of ApiProduct characteristics grouped together by API major version. properties: apiMajorVersion: type: integer description: Major version of the API standard specification. basePath: type: string description: Base path of the API. countryCode: $ref: '#/components/schemas/ISO31661Alpha2StandardIdentifier' apiGrantInformation: type: array items: $ref: '#/components/schemas/ApiGrantInformation' description: >- Collection of API grant information that describe the Product. ApiGrantInformation is a structured set of information regarding the grant of access to an API product, detailing its purpose, scope, grant type, and legal basis for usage. discriminator: propertyName: '@type' mapping: ApiVersionDetails: '#/components/schemas/ApiVersionDetails' Application: allOf: - $ref: '#/components/schemas/LogicalResource' - type: object description: >- Application is a logical resource that can consume API products. It's a specialization of a LogicalResource in the Open Gateway context. properties: commercialName: type: string description: Exact name of the Application as marketed (and known by the end-user). logoUrl: type: string description: Url to retrieve the Application official logo. privacyPolicyURL: type: string description: 'Url to Application privacy policy, if applicable.' redirectUrl: type: array items: type: string description: >- After a user successfully authorizes an application, the authorization server will redirect the user back to the application. jwksUri: type: string description: >- Uri pointing to a JSON Web Key (JWK) : data structure that represents a cryptographic key category: $ref: '#/components/schemas/ApplicationCategoryType' approvalStatus: $ref: '#/components/schemas/ApprovalStatusType' approvalStatusReason: type: string description: >- The reason why the approval state changed. DEPRECATED in the PATCH (bug to be fixed on next major version). applicationOwner: $ref: '#/components/schemas/PartyRoleRef' privacyRightsRequestContact: type: array items: $ref: '#/components/schemas/ContactMedium' description: >- Contact information for the exercise of data protection rights to which the End Users can address. Must be only EmailContactMedium or WebFormContactMedium for this context. channelPartner: $ref: '#/components/schemas/PartyRoleRef' digitalIdentity: $ref: '#/components/schemas/ApiDigitalIdentity' apiConsumerRole: type: array items: $ref: '#/components/schemas/LogicalResourceRole' description: 'Each GSMA Service-API plays a role, and has specific permissions for use' creationDate: type: string format: date-time description: Date and time when the Application was created Application_FVO: allOf: - $ref: '#/components/schemas/LogicalResource_FVO' - type: object description: >- Application is a logical resource that can consume API products. It's a specialization of a LogicalResource in the Open Gateway context. properties: commercialName: type: string description: Exact name of the Application as marketed (and known by the end-user). logoUrl: type: string description: Url to retrieve the Application official logo. privacyPolicyURL: type: string description: 'Url to Application privacy policy, if applicable.' redirectUrl: type: array items: type: string description: >- After a user successfully authorizes an application, the authorization server will redirect the user back to the application. jwksUri: type: string description: >- Uri pointing to a JSON Web Key (JWK) : data structure that represents a cryptographic key category: $ref: '#/components/schemas/ApplicationCategoryType' applicationOwner: $ref: '#/components/schemas/PartyRoleRef' privacyRightsRequestContact: type: array items: $ref: '#/components/schemas/ContactMedium_FVO' description: >- Contact information for the exercise of data protection rights to which the End Users can address. Must be only EmailContactMedium or WebFormContactMedium for this context. digitalIdentity: $ref: '#/components/schemas/ApiDigitalIdentity_FVO' required: - commercialName - applicationOwner - description Application_MVO: allOf: - $ref: '#/components/schemas/LogicalResource_MVO' - type: object description: >- Application is a logical resource that can consume API products. It's a specialization of a LogicalResource in the Open Gateway context. properties: commercialName: type: string description: Exact name of the Application as marketed (and known by the end-user). logoUrl: type: string description: Url to retrieve the Application official logo. privacyPolicyURL: type: string description: 'Url to Application privacy policy, if applicable.' redirectUrl: type: array items: type: string description: >- After a user successfully authorizes an application, the authorization server will redirect the user back to the application. jwksUri: type: string description: >- Uri pointing to a JSON Web Key (JWK) : data structure that represents a cryptographic key category: $ref: '#/components/schemas/ApplicationCategoryType' approvalStatusReason: type: string description: >- The reason why the approval state changed. DEPRECATED in the PATCH (bug to be fixed on next major version). privacyRightsRequestContact: type: array items: $ref: '#/components/schemas/ContactMedium' description: >- Contact information for the exercise of data protection rights to which the End Users can address. Must be only EmailContactMedium or WebFormContactMedium for this context. digitalIdentity: $ref: '#/components/schemas/ApiDigitalIdentity_MVO' Application_RES: type: object description: Response object for Application allOf: - $ref: '#/components/schemas/Application' required: - id - href ApplicationApprovalStatusChangeEvent: allOf: - $ref: '#/components/schemas/Event' - type: object description: ApplicationApprovalStatusChangeEvent generic structure properties: event: $ref: '#/components/schemas/ApplicationApprovalStatusChangeEventPayload' discriminator: propertyName: '@type' mapping: ApplicationApprovalStatusChangeEvent: '#/components/schemas/ApplicationApprovalStatusChangeEvent' ApplicationApprovalStatusChangeEventPayload: type: object description: ApplicationApprovalStatusChangeEventPayload properties: application: $ref: '#/components/schemas/Application' ApplicationAttributeValueChangeEvent: allOf: - $ref: '#/components/schemas/Event' - type: object description: ApplicationAttributeValueChangeEvent generic structure properties: event: $ref: '#/components/schemas/ApplicationAttributeValueChangeEventPayload' discriminator: propertyName: '@type' mapping: ApplicationAttributeValueChangeEvent: '#/components/schemas/ApplicationAttributeValueChangeEvent' ApplicationAttributeValueChangeEventPayload: type: object description: ApplicationAttributeValueChangeEventPayload properties: application: $ref: '#/components/schemas/Application' ApplicationCategoryType: enum: - agriculture - artAndDesign - autoAndVehicle - beauty - booksAndReference - business - construction - defense - developerTools - education - engineering - eventsAndEntertainment - finance - foodAndDrink - games - healthAndFitness - healthcare - information - kids - librariesAndDemo - lifestyle - manufacturing - mapsAndNavigation - media - medical - mining - musicAndAudio - newsAndMagazines - organizations - other - photoAndVideo - productivity - publicService - realEstate - shopping - socialNetworkingAndCommunications - sports - tourism - utilities - trading - transportation - travelAndLocal - water - weather type: string description: >- Valid values for the category of the Application. Please refer to main Application stores in order to retrieve a more precise definition of the categories. ApplicationCreateEvent: allOf: - $ref: '#/components/schemas/Event' - type: object description: ApplicationCreateEvent generic structure properties: event: $ref: '#/components/schemas/ApplicationCreateEventPayload' discriminator: propertyName: '@type' mapping: ApplicationCreateEvent: '#/components/schemas/ApplicationCreateEvent' ApplicationCreateEventPayload: type: object description: ApplicationCreateEventPayload properties: application: $ref: '#/components/schemas/Application' ApplicationOwner: allOf: - $ref: '#/components/schemas/Entity' - type: object description: >- Application Owner represents the role played by the organization that owns an Application that can consume API products. It's a specialization of a PartyRole in the Open Gateway context. properties: name: type: string description: >- A word, term, or phrase by which the ApplicationOwner is known and distinguished from other PartyRoles. It's the name of the ApplicationOwner unique entity. description: type: string description: A description of the ApplicationOwner. engagedParty: $ref: '#/components/schemas/ApplicationOwnerOrganization' channelPartner: $ref: '#/components/schemas/PartyRoleRef' approvalStatus: $ref: '#/components/schemas/ApprovalStatusType' approvalStatusReason: type: string description: The reason why the approval status changed. status: $ref: '#/components/schemas/ApplicationOwnerStatusType' statusReason: type: string description: >- A string providing an explanation on the value of the Status lifecycle. For instance if the Status is Rejected, statusReason will provide the reason for rejection. validFor: $ref: '#/components/schemas/TimePeriod' creationDate: type: string format: date-time description: Date and time when the ApplicationOwner was created discriminator: propertyName: '@type' mapping: ApplicationOwner: '#/components/schemas/ApplicationOwner' ApplicationOwner_FVO: allOf: - $ref: '#/components/schemas/Entity' - type: object description: >- Application Owner represents the role played by the organization that owns an Application that can consume API products. It's a specialization of a PartyRole in the Open Gateway context. properties: name: type: string description: >- A word, term, or phrase by which the ApplicationOwner is known and distinguished from other PartyRoles. It's the name of the ApplicationOwner unique entity. description: type: string description: A description of the ApplicationOwner. engagedParty: $ref: '#/components/schemas/ApplicationOwnerOrganization_FVO' required: - engagedParty - name - description discriminator: propertyName: '@type' mapping: ApplicationOwner: '#/components/schemas/ApplicationOwner_FVO' ApplicationOwner_MVO: allOf: - $ref: '#/components/schemas/Entity' - type: object description: >- Application Owner represents the role played by the organization that owns an Application that can consume API products. It's a specialization of a PartyRole in the Open Gateway context. properties: name: type: string description: >- A word, term, or phrase by which the ApplicationOwner is known and distinguished from other PartyRoles. It's the name of the ApplicationOwner unique entity. description: type: string description: A description of the ApplicationOwner. engagedParty: $ref: '#/components/schemas/ApplicationOwnerOrganization' status: $ref: '#/components/schemas/ApplicationOwnerStatusType' statusReason: type: string description: >- A string providing an explanation on the value of the Status lifecycle. For instance if the Status is Rejected, statusReason will provide the reason for rejection. discriminator: propertyName: '@type' mapping: ApplicationOwner: '#/components/schemas/ApplicationOwner_MVO' ApplicationOwner_RES: type: object description: Response object for ApplicationOwner allOf: - $ref: '#/components/schemas/ApplicationOwner' required: - id - href discriminator: propertyName: '@type' mapping: ApplicationOwner: '#/components/schemas/ApplicationOwner' ApplicationOwnerApprovalStatusChangeEvent: allOf: - $ref: '#/components/schemas/Event' - type: object description: ApplicationOwnerApprovalStatusChangeEvent generic structure properties: event: $ref: '#/components/schemas/ApplicationOwnerApprovalStatusChangeEventPayload' discriminator: propertyName: '@type' mapping: ApplicationOwnerApprovalStatusChangeEvent: '#/components/schemas/ApplicationOwnerApprovalStatusChangeEvent' ApplicationOwnerApprovalStatusChangeEventPayload: type: object description: ApplicationOwnerApprovalStatusChangeEventPayload properties: applicationOwner: $ref: '#/components/schemas/ApplicationOwner' ApplicationOwnerAttributeValueChangeEvent: allOf: - $ref: '#/components/schemas/Event' - type: object description: ApplicationOwnerAttributeValueChangeEvent generic structure properties: event: $ref: '#/components/schemas/ApplicationOwnerAttributeValueChangeEventPayload' discriminator: propertyName: '@type' mapping: ApplicationOwnerAttributeValueChangeEvent: '#/components/schemas/ApplicationOwnerAttributeValueChangeEvent' ApplicationOwnerAttributeValueChangeEventPayload: type: object description: ApplicationOwnerAttributeValueChangeEventPayload properties: applicationOwner: $ref: '#/components/schemas/ApplicationOwner' ApplicationOwnerCreateEvent: allOf: - $ref: '#/components/schemas/Event' - type: object description: ApplicationOwnerCreateEvent generic structure properties: event: $ref: '#/components/schemas/ApplicationOwnerCreateEventPayload' discriminator: propertyName: '@type' mapping: ApplicationOwnerCreateEvent: '#/components/schemas/ApplicationOwnerCreateEvent' ApplicationOwnerCreateEventPayload: type: object description: ApplicationOwnerCreateEventPayload properties: applicationOwner: $ref: '#/components/schemas/ApplicationOwner' ApplicationOwnerOrganization: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- Application Organization represents a group of people identified by shared interests or purpose. Examples include business, department and enterprise. Because of the complex nature of many businesses, both organizations and organization units are represented by the same data. It's a specialization of Party in the Open Gateway context. properties: name: type: string description: Organization name (department name for example) nameType: type: string description: 'Type of the name : Co, Inc, Ltd, etc.' tradingName: type: string description: Name that the organization (unit) trades under organizationType: $ref: '#/components/schemas/DpvOrganizationType' organizationIdentification: type: array items: $ref: '#/components/schemas/OrganizationIdentification' description: >- List of official identifiers given to the organization, for example company number in the registry of companies isLegalEntity: type: boolean description: >- If value is true, the organization is a legal entity known by a national referential. externalReference: type: array items: $ref: '#/components/schemas/ExternalIdentifier' description: >- List of identifiers of the Party in an external system, for example when party information is imported from a commerce system contactMedium: type: array items: $ref: '#/components/schemas/ContactMedium' description: 'List of means for contacting the party, e.g. mobile phone, email address' legalRepresentative: $ref: '#/components/schemas/ApplicationOwnerRelatedIndividual' localRepresentative: type: array items: $ref: '#/components/schemas/ApplicationOwnerRelatedLocalRepresentative' description: Represents a Party representing the Organization within a geographic localization. dataProtectionOfficer: $ref: '#/components/schemas/ApplicationOwnerPartyOrPartyRole' privacyManager: $ref: '#/components/schemas/ApplicationOwnerPartyOrPartyRole' registeredGeographicAddress: $ref: '#/components/schemas/LightGeographicAddress' taxNumber: type: string description: Tax number of the Organization in the country privacyPolicyURL: type: string description: Url to privacy policy. discriminator: propertyName: '@type' mapping: ApplicationOwnerOrganization: '#/components/schemas/ApplicationOwnerOrganization' ApplicationOwnerOrganization_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- Application Organization represents a group of people identified by shared interests or purpose. Examples include business, department and enterprise. Because of the complex nature of many businesses, both organizations and organization units are represented by the same data. It's a specialization of Party in the Open Gateway context. properties: name: type: string description: Organization name (department name for example) nameType: type: string description: 'Type of the name : Co, Inc, Ltd, etc.' tradingName: type: string description: Name that the organization (unit) trades under organizationType: $ref: '#/components/schemas/DpvOrganizationType' organizationIdentification: type: array items: $ref: '#/components/schemas/OrganizationIdentification_FVO' description: >- List of official identifiers given to the organization, for example company number in the registry of companies isLegalEntity: type: boolean description: >- If value is true, the organization is a legal entity known by a national referential. externalReference: type: array items: $ref: '#/components/schemas/ExternalIdentifier_FVO' description: >- List of identifiers of the Party in an external system, for example when party information is imported from a commerce system contactMedium: type: array items: $ref: '#/components/schemas/ContactMedium_FVO' description: 'List of means for contacting the party, e.g. mobile phone, email address' legalRepresentative: $ref: '#/components/schemas/ApplicationOwnerRelatedIndividual_FVO' localRepresentative: type: array items: $ref: '#/components/schemas/ApplicationOwnerRelatedLocalRepresentative_FVO' description: Represents a Party representing the Organization within a geographic localization. dataProtectionOfficer: $ref: '#/components/schemas/ApplicationOwnerPartyOrPartyRole_FVO' privacyManager: $ref: '#/components/schemas/ApplicationOwnerPartyOrPartyRole_FVO' registeredGeographicAddress: $ref: '#/components/schemas/LightGeographicAddress_FVO' taxNumber: type: string description: Tax number of the Organization in the country privacyPolicyURL: type: string description: Url to privacy policy. required: - contactMedium - name - organizationIdentification - registeredGeographicAddress - taxNumber - tradingName discriminator: propertyName: '@type' mapping: ApplicationOwnerOrganization: '#/components/schemas/ApplicationOwnerOrganization_FVO' ApplicationOwnerPartyOrPartyRole: type: object description: >- Schema that permits to identify an Individual or an Organisation in the Open Gateway context. oneOf: - $ref: '#/components/schemas/ApplicationOwnerRelatedIndividual' - $ref: '#/components/schemas/ApplicationOwnerRelatedOrganization' discriminator: propertyName: '@type' mapping: ApplicationOwnerRelatedIndividual: '#/components/schemas/ApplicationOwnerRelatedIndividual' ApplicationOwnerRelatedOrganization: '#/components/schemas/ApplicationOwnerRelatedOrganization' ApplicationOwnerPartyOrPartyRole_FVO: type: object description: >- Schema that permits to identify an Individual or an Organisation in the Open Gateway context. oneOf: - $ref: '#/components/schemas/ApplicationOwnerRelatedIndividual_FVO' - $ref: '#/components/schemas/ApplicationOwnerRelatedOrganization_FVO' discriminator: propertyName: '@type' mapping: ApplicationOwnerRelatedIndividual: '#/components/schemas/ApplicationOwnerRelatedIndividual_FVO' ApplicationOwnerRelatedOrganization: '#/components/schemas/ApplicationOwnerRelatedOrganization_FVO' ApplicationOwnerRelatedIndividual: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- ApplicationOwnerRelatedIndividual represents an Individual that has a role within the ApplicationOwner, in the Open Gateway context. Typically an employee of the company. properties: familyName: type: string description: >- Contains the non-chosen or inherited name. Also known as last name in the Western context givenName: type: string description: First name of the individual contactMedium: type: array items: $ref: '#/components/schemas/ContactMedium' description: 'List of means for contacting the party, e.g. mobile phone, email address' discriminator: propertyName: '@type' mapping: ApplicationOwnerRelatedIndividual: '#/components/schemas/ApplicationOwnerRelatedIndividual' ApplicationOwnerRelatedIndividual_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- ApplicationOwnerRelatedIndividual represents an Individual that has a role within the ApplicationOwner, in the Open Gateway context. Typically an employee of the company. properties: familyName: type: string description: >- Contains the non-chosen or inherited name. Also known as last name in the Western context givenName: type: string description: First name of the individual contactMedium: type: array items: $ref: '#/components/schemas/ContactMedium_FVO' description: 'List of means for contacting the party, e.g. mobile phone, email address' required: - familyName - givenName - contactMedium discriminator: propertyName: '@type' mapping: ApplicationOwnerRelatedIndividual: '#/components/schemas/ApplicationOwnerRelatedIndividual_FVO' ApplicationOwnerRelatedLocalRepresentative: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- ApplicationOwnerRelatedLocalRepresentative represents a Party representing the Organization within a geographic localization. properties: countryCode: $ref: '#/components/schemas/ISO31661Alpha2StandardIdentifier' representative: $ref: '#/components/schemas/ApplicationOwnerRelatedIndividual' discriminator: propertyName: '@type' mapping: ApplicationOwnerRelatedLocalRepresentative: '#/components/schemas/ApplicationOwnerRelatedLocalRepresentative' ApplicationOwnerRelatedLocalRepresentative_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- ApplicationOwnerRelatedLocalRepresentative represents a Party representing the Organization within a geographic localization. properties: countryCode: $ref: '#/components/schemas/ISO31661Alpha2StandardIdentifier_FVO' representative: $ref: '#/components/schemas/ApplicationOwnerRelatedIndividual_FVO' required: - representative - countryCode discriminator: propertyName: '@type' mapping: ApplicationOwnerRelatedLocalRepresentative: '#/components/schemas/ApplicationOwnerRelatedLocalRepresentative_FVO' ApplicationOwnerRelatedOrganization: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- ApplicationOwnerRelatedOrganization represents an Organization that has a role within the ApplicationOwner, in the Open Gateway context. Typically a department inside the company. properties: name: type: string description: Organization name (department name for example) contactMedium: type: array items: $ref: '#/components/schemas/ContactMedium' description: 'List of means for contacting the party, e.g. mobile phone, email address' organizationType: $ref: '#/components/schemas/DpvOrganizationType' discriminator: propertyName: '@type' mapping: ApplicationOwnerRelatedOrganization: '#/components/schemas/ApplicationOwnerRelatedOrganization' ApplicationOwnerRelatedOrganization_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- ApplicationOwnerRelatedOrganization represents an Organization that has a role within the ApplicationOwner, in the Open Gateway context. Typically a department inside the company. properties: name: type: string description: Organization name (department name for example) contactMedium: type: array items: $ref: '#/components/schemas/ContactMedium_FVO' description: 'List of means for contacting the party, e.g. mobile phone, email address' organizationType: $ref: '#/components/schemas/DpvOrganizationType' required: - name - contactMedium discriminator: propertyName: '@type' mapping: ApplicationOwnerRelatedOrganization: '#/components/schemas/ApplicationOwnerRelatedOrganization_FVO' ApplicationOwnerStatusType: enum: - active - inactive type: string description: >- Used to track the lifecycle status of the ApplicationOwner in Channel Partner IT. So this attribute is allowed to be contributed by the Channel Partner and patchable. ApplicationRef: type: object description: Reference to an Application. allOf: - $ref: '#/components/schemas/EntityRef' discriminator: propertyName: '@type' mapping: ApplicationRef: '#/components/schemas/ApplicationRef' ApprovalStatusType: enum: - pendingApproval - approved - rejected type: string description: Valid values for an ApprovalStatus in the context of an approval process. AssetGroup: type: object description: >- Defines a group of assets (entities) to which access can be controlled. Specific subclasses allow definition in various ways (list of entities, queries, ownership by customer, etc.). AssetGroup is not a managed entity, its concrete subclasses are always included by value in their containing entities. allOf: - $ref: '#/components/schemas/Extensible' discriminator: propertyName: '@type' mapping: ApiListAssetGroup: '#/components/schemas/ApiListAssetGroup' AssetGroup: '#/components/schemas/AssetGroup' Attachment: allOf: - $ref: '#/components/schemas/Entity' - type: object description: >- Complements the description of an element (for instance a product) through video, pictures... properties: name: type: string description: The name of the attachment description: type: string description: A narrative text describing the content of the attachment example: Photograph of the Product url: type: string description: 'Uniform Resource Locator, is a web page address (a subset of URI)' example: 'https://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f' content: type: string format: base64 description: 'The actual contents of the attachment object, if embedded, encoded as base64' size: $ref: '#/components/schemas/Quantity' validFor: $ref: '#/components/schemas/TimePeriod' attachmentType: type: string description: >- a business characterization of the purpose of the attachment, for example logo, instructionManual, contractCopy mimeType: type: string description: a technical characterization of the attachment content format using IETF Mime Types discriminator: propertyName: '@type' mapping: Attachment: '#/components/schemas/Attachment' Attachment_FVO: allOf: - $ref: '#/components/schemas/Entity' - type: object description: >- Complements the description of an element (for instance a product) through video, pictures... properties: name: type: string description: The name of the attachment description: type: string description: A narrative text describing the content of the attachment example: Photograph of the Product url: type: string description: 'Uniform Resource Locator, is a web page address (a subset of URI)' example: 'https://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f' content: type: string format: base64 description: 'The actual contents of the attachment object, if embedded, encoded as base64' size: $ref: '#/components/schemas/Quantity' validFor: $ref: '#/components/schemas/TimePeriod' attachmentType: type: string description: >- a business characterization of the purpose of the attachment, for example logo, instructionManual, contractCopy mimeType: type: string description: a technical characterization of the attachment content format using IETF Mime Types required: - attachmentType - mimeType discriminator: propertyName: '@type' mapping: Attachment: '#/components/schemas/Attachment_FVO' AttachmentRef: allOf: - $ref: '#/components/schemas/EntityRef' - type: object description: >- Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures properties: description: type: string description: A narrative text describing the content of the attachment url: description: Link to the attachment media/content type: string discriminator: propertyName: '@type' mapping: AttachmentRef: '#/components/schemas/AttachmentRef' AttachmentRefOrValue: type: object description: >- The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself oneOf: - $ref: '#/components/schemas/Attachment' - $ref: '#/components/schemas/AttachmentRef' discriminator: propertyName: '@type' mapping: Attachment: '#/components/schemas/Attachment' AttachmentRef: '#/components/schemas/AttachmentRef' AttachmentRefOrValue_FVO: type: object description: >- The polymorphic attributes @type, @schemaLocation & @referredType are related to the Attachment entity and not the AttachmentRefOrValue class itself oneOf: - $ref: '#/components/schemas/Attachment_FVO' - $ref: '#/components/schemas/AttachmentRef' discriminator: propertyName: '@type' mapping: Attachment: '#/components/schemas/Attachment_FVO' AttachmentRef: '#/components/schemas/AttachmentRef' BaseEvent: allOf: - $ref: '#/components/schemas/Entity' - type: object description: Base event with common attributes. properties: event: type: object description: The event linked to the involved resource object eventId: type: string description: The identifier of the notification. eventTime: type: string format: date-time description: Time of the event occurrence. eventType: type: string description: The type of the notification. correlationId: type: string description: The correlation id for this event. domain: type: string description: The domain of the event. title: type: string description: The title of the event. description: type: string description: An explanatory of the event. priority: type: string description: A priority. timeOcurred: type: string format: date-time description: The time the event occurred. discriminator: propertyName: '@type' mapping: BaseEvent: '#/components/schemas/BaseEvent' Characteristic: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- Describes a given characteristic of an object or entity through a name/value pair. This is an abstract base class, the actual value is in one of the strongly-typed subclasses : StringCharacteristic, ObjectCharacteristic, FloatCharacteristic, BooleanCharacteristic, NumberCharacteristic, IntegerCharacteristic, StringArrayCharacteristic, ObjectArrayCharacteristic, BooleanArrayCharacteristic, NumberArrayCharacteristic, IntegerArrayCharacteristic... properties: id: type: string description: Unique identifier of the characteristic name: type: string description: Name of the characteristic valueType: type: string description: Data type of the value of the characteristic characteristicRelationship: type: array description: Collection of characteristic relationships items: $ref: '#/components/schemas/CharacteristicRelationship' discriminator: propertyName: '@type' mapping: Characteristic: '#/components/schemas/Characteristic' CharacteristicRelationship: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: Another Characteristic that is related to the current Characteristic; properties: id: type: string description: Unique identifier of the characteristic relationshipType: type: string description: The type of relationship discriminator: propertyName: '@type' mapping: CharacteristicRelationship: '#/components/schemas/CharacteristicRelationship' ContactMedium: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- Indicates the contact medium that could be used to contact the party. This is an abstract base class, the actual value is in one of the strongly-typed subclasses : EmailContactMedium, FaxContactMedium, PhoneContactMedium, GeographicAddressContactMedium, SocialMediaContactMedium... properties: id: type: string description: Identifier for this contact medium. preferred: type: boolean description: 'If true, indicates that is the preferred contact medium' contactType: type: string description: >- Type of the contact medium to qualify it like pro email / personal email. This is not used to define the contact medium used. validFor: $ref: '#/components/schemas/TimePeriod' discriminator: propertyName: '@type' mapping: ContactMedium: '#/components/schemas/ContactMedium' EmailContactMedium: '#/components/schemas/EmailContactMedium' FaxContactMedium: '#/components/schemas/FaxContactMedium' GeographicAddressContactMedium: '#/components/schemas/GeographicAddressContactMedium' PhoneContactMedium: '#/components/schemas/PhoneContactMedium' SocialContactMedium: '#/components/schemas/SocialContactMedium' WebFormContactMedium: '#/components/schemas/WebFormContactMedium' ContactMedium_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- Indicates the contact medium that could be used to contact the party. This is an abstract base class, the actual value is in one of the strongly-typed subclasses : EmailContactMedium, FaxContactMedium, PhoneContactMedium, GeographicAddressContactMedium, SocialMediaContactMedium... properties: id: type: string description: Identifier for this contact medium. preferred: type: boolean description: 'If true, indicates that is the preferred contact medium' contactType: type: string description: >- Type of the contact medium to qualify it like pro email / personal email. This is not used to define the contact medium used. validFor: $ref: '#/components/schemas/TimePeriod' discriminator: propertyName: '@type' mapping: ContactMedium: '#/components/schemas/ContactMedium_FVO' EmailContactMedium: '#/components/schemas/EmailContactMedium' FaxContactMedium: '#/components/schemas/FaxContactMedium' GeographicAddressContactMedium: '#/components/schemas/GeographicAddressContactMedium' PhoneContactMedium: '#/components/schemas/PhoneContactMedium' SocialContactMedium: '#/components/schemas/SocialContactMedium' WebFormContactMedium: '#/components/schemas/WebFormContactMedium_FVO' DataExportCountry: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- This schema permits to declare the countries and context where some data has been stored or has transited. properties: countryCode: $ref: '#/components/schemas/ISO31661Alpha2StandardIdentifier' commercialActivity: type: boolean description: Flag to indicate if commercial activity applies to these data management. commercialOrganizationName: type: string description: Organization who is managing the data. dataPrivacyFrameworkURL: type: string description: URL to the organization or governmental data privacy framework if applies. discriminator: propertyName: '@type' mapping: DataExportCountry: '#/components/schemas/DataExportCountry' DataExportCountry_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- This schema permits to declare the countries and context where some data has been stored or has transited. properties: countryCode: $ref: '#/components/schemas/ISO31661Alpha2StandardIdentifier_FVO' commercialActivity: type: boolean description: Flag to indicate if commercial activity applies to these data management. commercialOrganizationName: type: string description: Organization who is managing the data. dataPrivacyFrameworkURL: type: string description: URL to the organization or governmental data privacy framework if applies. discriminator: propertyName: '@type' mapping: DataExportCountry: '#/components/schemas/DataExportCountry_FVO' DCSProductOrderItem: type: object description: An identified part of the order. A product order is decomposed into one or more order items. allOf: - $ref: '#/components/schemas/GCProductOrderItem' discriminator: propertyName: '@type' mapping: ApiProductOrderItemAdd: '#/components/schemas/ApiProductOrderItemAdd' ApiProductOrderItemModify: '#/components/schemas/ApiProductOrderItemModify' ProductOrderItemDelete: '#/components/schemas/ProductOrderItemDelete' DCSProductOrderItem_FVO: type: object description: An identified part of the order. A product order is decomposed into one or more order items. allOf: - $ref: '#/components/schemas/GCProductOrderItem' discriminator: propertyName: '@type' mapping: ApiProductOrderItemAdd: '#/components/schemas/ApiProductOrderItemAdd_FVO' ApiProductOrderItemModify: '#/components/schemas/ApiProductOrderItemModify_FVO' ProductOrderItemDelete: '#/components/schemas/ProductOrderItemDelete_FVO' DpvContext: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: Describes all the context and conditions within which processing takes place properties: processingContext: type: array items: $ref: '#/components/schemas/DpvProcessingContextType' description: context classes of the data processing of the API. duration: $ref: '#/components/schemas/DpvDurationType' frequency: $ref: '#/components/schemas/DpvFrequencyType' discriminator: propertyName: '@type' mapping: DpvContext: '#/components/schemas/DpvContext' DpvDurationType: enum: - 'dpv:EndlessDuration' - 'dpv:FixedOccurrencesDuration' - 'dpv:IndeterminateDuration' - 'dpv:TemporalDuration' - 'dpv:UntilEventDuration' - 'dpv:UntilTimeDuration' type: string description: >- Valid values for the data processing duration based on W3C Data Privacy Vocabulary v2 https://w3c.github.io/dpv/2.0/dpv/ DpvFrequencyType: enum: - 'dpv:ContinuousFrequency' - 'dpv:OftenFrequency' - 'dpv:SingularFrequency' - 'dpv:SporadicFrequency' type: string description: >- Valid values for the data processing frequency based on W3C Data Privacy Vocabulary v2 https://w3c.github.io/dpv/2.0/dpv/ DpvLegalBasisType: enum: - 'dpv:Consent' - 'dpv:Contract' - 'dpv:ContractPerformance' - 'dpv:DataTransferLegalBasis' - 'dpv:EnterIntoContract' - 'dpv:LegalBasis' - 'dpv:LegalObligation' - 'dpv:LegitimateInterest' - 'dpv:LegitimateInterestOfController' - 'dpv:LegitimateInterestOfDataSubject' - 'dpv:LegitimateInterestOfThirdParty' - 'dpv:OfficialAuthorityOfController' - 'dpv:PublicInterest' - 'dpv:VitalInterest' - 'dpv:VitalInterestOfDataSubject' - 'dpv:VitalInterestOfNaturalPerson' - 'dpv:InformedConsent' - 'dpv:DataControllerContract' - 'dpv:ImpliedConsent' - 'dpv:DataSubjectContract' - 'dpv:ExplicitlyExpressedConsent' - 'dpv:UninformedConsent' - 'dpv:DataProcessorContract' - 'dpv:ExpressedConsent' - 'dpv:ThirdPartyContract' type: string description: >- Valid values for Legal Basis based on W3C Data Privacy Vocabulary v2 https://w3c.github.io/dpv/2.0/dpv/ DpvOrganizationType: enum: - 'dpv:AcademicScientificOrganisation' - 'dpv:ForProfitOrganisation' - 'dpv:GovernmentalOrganisation' - 'dpv:IndustryConsortium' - 'dpv:InternationalOrganisation' - 'dpv:NonGovernmentalOrganisation' - 'dpv:NonProfitOrganisation' - 'dpv:OrganisationalUnit' type: string description: >- Valid values for a type of organization based on W3C Data Privacy Vocabulary v2 https://w3c.github.io/dpv/2.0/dpv. DpvProcess: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: Describes all the operations or 'processing' performed on data properties: processingOperation: type: array items: $ref: '#/components/schemas/DpvProcessingOperationType' description: operations of the data processing of the API. context: $ref: '#/components/schemas/DpvContext' dataExportTransitCountry: type: array description: Field to contain all the traceability of the data until the last storage site. items: $ref: '#/components/schemas/DataExportCountry' dataExportStorageCountry: type: array description: Field to contain all the information related the last data storage site. items: $ref: '#/components/schemas/DataExportCountry' discriminator: propertyName: '@type' mapping: DpvProcess: '#/components/schemas/DpvProcess' DpvProcess_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: Describes all the operations or 'processing' performed on data properties: processingOperation: type: array items: $ref: '#/components/schemas/DpvProcessingOperationType' description: operations of the data processing of the API. context: $ref: '#/components/schemas/DpvContext' dataExportTransitCountry: type: array description: Field to contain all the traceability of the data until the last storage site. items: $ref: '#/components/schemas/DataExportCountry_FVO' dataExportStorageCountry: type: array description: Field to contain all the information related the last data storage site. items: $ref: '#/components/schemas/DataExportCountry_FVO' discriminator: propertyName: '@type' mapping: DpvProcess: '#/components/schemas/DpvProcess_FVO' DpvProcessingContextType: enum: - 'dpv:AlgorithmicLogic' - 'dpv:AssistiveAutomation' - 'dpv:AutomatedDecisionMaking' - 'dpv:AutomatedScoringOfIndividuals' - 'dpv:AutomationLevel' - 'dpv:Autonomous' - 'dpv:CannotChallengeProcess' - 'dpv:CannotChallengeProcessInput' - 'dpv:CannotChallengeProcessOutput' - 'dpv:CannotCorrectProcess' - 'dpv:CannotCorrectProcessInput' - 'dpv:CannotCorrectProcessOutput' - 'dpv:CannotObjectToProcess' - 'dpv:CannotOptInToProcess' - 'dpv:CannotOptOutFromProcess' - 'dpv:CannotReverseProcessEffects' - 'dpv:CannotReverseProcessInput' - 'dpv:CannotReverseProcessOutput' - 'dpv:CannotWithdrawFromProcess' - 'dpv:ChallengingProcess' - 'dpv:ChallengingProcessInput' - 'dpv:ChallengingProcessOutput' - 'dpv:ConditionalAutomation' - 'dpv:ConsentControl' - 'dpv:CorrectingProcess' - 'dpv:CorrectingProcessInput' - 'dpv:CorrectingProcessOutput' - 'dpv:CompletelyManualProcessing' - 'dpv:DataControllerDataSource' - 'dpv:DataPublishedByDataSubject' - 'dpv:DataSource' - 'dpv:DataSubject' - 'dpv:DataSubjectDataSource' - 'dpv:DataSubjectScale' - 'dpv:DataVolume' - 'dpv:DecisionMaking' - 'dpv:EntityActiveInvolvement' - 'dpv:EntityInvolvement' - 'dpv:EntityNonInvolvement' - 'dpv:EntityNonPermissiveInvolvement' - 'dpv:EntityPassiveInvolvement' - 'dpv:EntityPermissiveInvolvement' - 'dpv:EvaluationOfIndividuals' - 'dpv:EvaluationScoring' - 'dpv:FullAutomation' - 'dpv:GeographicCoverage' - 'dpv:GlobalScale' - 'dpv:HighAutomation' - 'dpv:HugeDataVolume' - 'dpv:HugeScaleOfDataSubjects' - 'dpv:HumanInvolved' - 'dpv:HumanInvolvement' - 'dpv:HumanInvolvementForControl' - 'dpv:HumanInvolvementForDecision' - 'dpv:HumanInvolvementForInput' - 'dpv:HumanInvolvementForIntervention' - 'dpv:HumanInvolvementForOversight' - 'dpv:HumanInvolvementForVerification' - 'dpv:HumanNotInvolved' - 'dpv:InnovativeUseOfExistingTechnology' - 'dpv:InnovativeUseOfNewTechnologies' - 'dpv:InnovativeUseOfTechnology' - 'dpv:LargeDataVolume' - 'dpv:LargeScaleOfDataSubjects' - 'dpv:LargeScaleProcessing' - 'dpv:LocalEnvironmentScale' - 'dpv:LocalityScale' - 'dpv:MediumDataVolume' - 'dpv:MediumScaleOfDataSubjects' - 'dpv:MediumScaleProcessing' - 'dpv:MultiNationalScale' - 'dpv:NationalScale' - 'dpv:NearlyGlobalScale' - 'dpv:NonPublicDataSource' - 'dpv:NotAutomated' - 'dpv:ObjectingToProcess' - 'dpv:ObtainConsent' - 'dpv:OptingInToProcess' - 'dpv:OptingOutFromProcess' - 'dpv:PartialAutomation' - 'dpv:ProcessingCondition' - 'dpv:ProcessingDuration' - 'dpv:ProcessingLocation' - 'dpv:ProcessingScale' - 'dpv:ProvideConsent' - 'dpv:PublicDataSource' - 'dpv:ReaffirmConsent' - 'dpv:RegionalScale' - 'dpv:ReversingProcessEffects' - 'dpv:ReversingProcessInput' - 'dpv:ReversingProcessOutput' - 'dpv:Scale' - 'dpv:ScoringOfIndividuals' - 'dpv:SingularDataVolume' - 'dpv:SingularScaleOfDataSubjects' - 'dpv:SmallDataVolume' - 'dpv:SmallScaleOfDataSubjects' - 'dpv:SmallScaleProcessing' - 'dpv:SporadicDataVolume' - 'dpv:SporadicScaleOfDataSubjects' - 'dpv:StorageCondition' - 'dpv:StorageDeletion' - 'dpv:StorageDuration' - 'dpv:StorageLocation' - 'dpv:StorageRestoration' - 'dpv:SystematicMonitoring' - 'dpv:ThirdPartyDataSource' - 'dpv:WithdrawConsent' - 'dpv:WithdrawingFromProcess' type: string description: >- Valid values for the data processing context classes based on W3C Data Privacy Vocabulary v2 https://w3c.github.io/dpv/2.0/dpv/ DpvProcessingOperationType: enum: - 'dpv:Access' - 'dpv:Acquire' - 'dpv:Adapt' - 'dpv:Aggregate' - 'dpv:Align' - 'dpv:Alter' - 'dpv:Analyse' - 'dpv:Anonymise' - 'dpv:Assess' - 'dpv:Collect' - 'dpv:Combine' - 'dpv:Consult' - 'dpv:Copy' - 'dpv:CrossBorderTransfer' - 'dpv:Delete' - 'dpv:Derive' - 'dpv:Destruct' - 'dpv:Disclose' - 'dpv:DiscloseByTransmission' - 'dpv:Display' - 'dpv:Disseminate' - 'dpv:Download' - 'dpv:Erase' - 'dpv:Export' - 'dpv:Filter' - 'dpv:Format' - 'dpv:Generate' - 'dpv:Infer' - 'dpv:MakeAvailable' - 'dpv:Match' - 'dpv:Modify' - 'dpv:Monitor' - 'dpv:Move' - 'dpv:Observe' - 'dpv:Obtain' - 'dpv:Organise' - 'dpv:Profiling' - 'dpv:Pseudonymise' - 'dpv:Query' - 'dpv:Record' - 'dpv:Reformat' - 'dpv:Remove' - 'dpv:Restrict' - 'dpv:Retrieve' - 'dpv:Screen' - 'dpv:Share' - 'dpv:Store' - 'dpv:Structure' - 'dpv:Transfer' - 'dpv:Transform' - 'dpv:Transmit' - 'dpv:Use' type: string description: >- Valid values for the data processing operation based on W3C Data Privacy Vocabulary v2 https://w3c.github.io/dpv/2.0/dpv/. DpvPurposeType: enum: - 'dpv:AcademicResearch' - 'dpv:AccountManagement' - 'dpv:Advertising' - 'dpv:AgeVerification' - 'dpv:CombatClimateChange' - 'dpv:CommercialPurpose' - 'dpv:CommercialResearch' - 'dpv:CommunicationForCustomerCare' - 'dpv:CommunicationManagement' - 'dpv:CounterMoneyLaundering' - 'dpv:Counterterrorism' - 'dpv:CreditChecking' - 'dpv:CustomerCare' - 'dpv:CustomerClaimsManagement' - 'dpv:CustomerManagement' - 'dpv:CustomerOrderManagement' - 'dpv:CustomerRelationshipManagement' - 'dpv:CustomerSolvencyMonitoring' - 'dpv:DataAltruism' - 'dpv:DeliveryOfGoods' - 'dpv:DirectMarketing' - 'dpv:DisputeManagement' - 'dpv:EnforceAccessControl' - 'dpv:EnforceSecurity' - 'dpv:EstablishContractualAgreement' - 'dpv:FraudPreventionAndDetection' - 'dpv:FulfilmentOfContractualObligation' - 'dpv:FulfilmentOfObligation' - 'dpv:HumanResourceManagement' - 'dpv:IdentityAuthentication' - 'dpv:IdentityVerification' - 'dpv:ImproveExistingProductsAndServices' - 'dpv:ImproveHealthcare' - 'dpv:ImproveInternalCRMProcesses' - 'dpv:ImprovePublicServices' - 'dpv:ImproveTransportMobility' - 'dpv:IncreaseServiceRobustness' - 'dpv:InternalResourceOptimisation' - 'dpv:LegalCompliance' - 'dpv:MaintainCreditCheckingDatabase' - 'dpv:MaintainCreditRatingDatabase' - 'dpv:MaintainFraudDatabase' - 'dpv:Marketing' - 'dpv:MemberPartnerManagement' - 'dpv:MisusePreventionAndDetection' - 'dpv:NonCommercialPurpose' - 'dpv:NonCommercialResearch' - 'dpv:OptimisationForConsumer' - 'dpv:OptimisationForController' - 'dpv:OptimiseUserInterface' - 'dpv:OrganisationComplianceManagement' - 'dpv:OrganisationGovernance' - 'dpv:OrganisationRiskManagement' - 'dpv:PaymentManagement' - 'dpv:Personalisation' - 'dpv:PersonalisedAdvertising' - 'dpv:PersonalisedBenefits' - 'dpv:PersonnelHiring' - 'dpv:PersonnelManagement' - 'dpv:PersonnelPayment' - 'dpv:ProtectionOfIPR' - 'dpv:ProtectionOfNationalSecurity' - 'dpv:ProtectionOfPublicSecurity' - 'dpv:ProvideEventRecommendations' - 'dpv:ProvideOfficialStatistics' - 'dpv:ProvidePersonalisedRecommendations' - 'dpv:ProvideProductRecommendations' - 'dpv:PublicBenefit' - 'dpv:PublicPolicyMaking' - 'dpv:PublicRelations' - 'dpv:RecordManagement' - 'dpv:RepairImpairments' - 'dpv:RequestedServiceProvision' - 'dpv:ResearchAndDevelopment' - 'dpv:RightsFulfillment' - 'dpv:ScientificResearch' - 'dpv:SearchFunctionalities' - 'dpv:SellDataToThirdParties' - 'dpv:SellInsightsFromData' - 'dpv:SellProducts' - 'dpv:SellProductsToDataSubject' - 'dpv:ServiceOptimisation' - 'dpv:ServicePersonalisation' - 'dpv:ServiceProvision' - 'dpv:ServiceRegistration' - 'dpv:ServiceUsageAnalytics' - 'dpv:SocialMediaMarketing' - 'dpv:TargetedAdvertising' - 'dpv:TechnicalServiceProvision' - 'dpv:UserInterfacePersonalisation' - 'dpv:VendorManagement' - 'dpv:VendorPayment' - 'dpv:VendorRecordsManagement' - 'dpv:VendorSelectionAssessment' - 'dpv:Verification' type: string description: >- Valid values for the purpose based on W3C Data Privacy Vocabulary v2 https://w3c.github.io/dpv/2.0/dpv/ Duration: type: object description: A time interval in a given unit of time in Open Gateway context. properties: amount: type: integer description: 'Time interval (number of seconds, minutes, hours, etc.)' units: type: string description: 'Unit of time (seconds, minutes, hours, etc.)' enum: - day - week - month - year EmailContactMedium: allOf: - $ref: '#/components/schemas/ContactMedium' - type: object description: >- Describes an email that could be used to contact a party (an individual or an organization) properties: emailAddress: type: string description: Full email address in standard format Entity: type: object description: Base entity schema for use in TMForum Open-APIs. Property. allOf: - $ref: '#/components/schemas/Extensible' - $ref: '#/components/schemas/Addressable' EntityRef: allOf: - $ref: '#/components/schemas/Extensible' - $ref: '#/components/schemas/Addressable' - type: object description: Entity reference schema to be use for all entityRef class. properties: id: type: string description: The identifier of the referred entity. href: type: string description: The URI of the referred entity. name: type: string description: Name of the referred entity. '@referredType': type: string description: The actual type of the target instance when needed for disambiguation. required: - id Event: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: event with common attributes. properties: href: type: string description: Hyperlink reference id: type: string description: unique identifier correlationId: type: string description: The correlation id for this event. domain: type: string description: The domain of the event. title: type: string description: The title of the event. description: type: string description: An explanation of the event. priority: type: string description: A priority. timeOccurred: type: string format: date-time description: The time the event occurred. source: $ref: '#/components/schemas/EntityRef' reportingSystem: $ref: '#/components/schemas/EntityRef' relatedParty: type: array description: Collection of related parties items: $ref: '#/components/schemas/RelatedPartyRefOrPartyRoleRef' analyticCharacteristic: type: array description: Collection of analytic characteristics items: $ref: '#/components/schemas/Characteristic' eventId: type: string description: The identifier of the notification. eventTime: type: string format: date-time description: Time of the event occurrence. eventType: type: string description: The type of the notification. event: description: The event linked to the involved resource object type: object Extensible: type: object description: >- Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type properties: '@type': type: string description: 'When sub-classing, this defines the sub-class Extensible name' '@baseType': type: string description: 'When sub-classing, this defines the super-class' '@schemaLocation': type: string description: A URI to a JSON-Schema file that defines additional attributes and relationships required: - '@type' ExternalIdentifier: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- An identification of an entity that is owned by or originates in a software system different from the current system, for example a ProductOrder handed off from a commerce platform into an order handling system. The structure identifies the system itself, the nature of the entity within the system (e.g. class name) and the unique ID of the entity within the system. It is anticipated that multiple external IDs can be held for a single entity, e.g. if the entity passed through multiple systems on the way to the current system. In this case the consumer is expected to sequence the IDs in the array in reverse order of provenance, i.e. most recent system first in the list. properties: owner: type: string description: Name of the external system that owns the entity. example: MagentoCommerce externalIdentifierType: type: string description: >- Type of the identification, typically would be the type of the entity within the external system example: ProductOrder id: type: string description: identification of the entity within the external system. discriminator: propertyName: '@type' mapping: ExternalIdentifier: '#/components/schemas/ExternalIdentifier' ExternalIdentifier_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- An identification of an entity that is owned by or originates in a software system different from the current system, for example a ProductOrder handed off from a commerce platform into an order handling system. The structure identifies the system itself, the nature of the entity within the system (e.g. class name) and the unique ID of the entity within the system. It is anticipated that multiple external IDs can be held for a single entity, e.g. if the entity passed through multiple systems on the way to the current system. In this case the consumer is expected to sequence the IDs in the array in reverse order of provenance, i.e. most recent system first in the list. properties: owner: type: string description: Name of the external system that owns the entity. example: MagentoCommerce externalIdentifierType: type: string description: >- Type of the identification, typically would be the type of the entity within the external system example: ProductOrder id: type: string description: identification of the entity within the external system. required: - id discriminator: propertyName: '@type' mapping: ExternalIdentifier: '#/components/schemas/ExternalIdentifier_FVO' FaxContactMedium: allOf: - $ref: '#/components/schemas/ContactMedium' - type: object description: Describes a fax that could be used to contact a party (an individual or an organization) properties: faxNumber: type: string description: The fax number of the contact GCProductOrderItem: type: object description: >- General Context ProductOrderItem that can be used as a Domain Specialization Order Item or as a non-specialised OrderItem. allOf: - $ref: '#/components/schemas/Extensible' discriminator: propertyName: '@type' mapping: DCSProductOrderItem: '#/components/schemas/DCSProductOrderItem' GCProductOrderItem: '#/components/schemas/GCProductOrderItem' GeographicAddressContactMedium: allOf: - $ref: '#/components/schemas/ContactMedium' - type: object description: >- Describes a geographical address that could be used to contact a party (an individual or an organization) properties: city: type: string description: The city country: type: string description: The country postCode: type: string description: Postcode stateOrProvince: type: string description: State or province street1: type: string description: Describes the street street2: type: string description: Complementary street description geographicAddress: $ref: '#/components/schemas/GeographicAddressRef' GeographicAddressRef: type: object description: Reference to a Geographic Address. allOf: - $ref: '#/components/schemas/EntityRef' discriminator: propertyName: '@type' mapping: GeographicAddressRef: '#/components/schemas/GeographicAddressRef' HeaderItem: type: object description: An item typically included in a request or response properties: name: description: 'The name of the header item, e.g. locale' type: string value: description: 'The value of the header item, e.g. en-us' type: string ISO31661Alpha2StandardIdentifier: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- The corresponding identification of the resource in different standard, regulatory definitions. The standard specification identifier (e.g., ISO 3166-1 Alpha-2) and the corresponding value (e.g., BE) relevant to a particular resource. properties: value: type: string description: The value of the resource in the ISO 3166-1 Alpha 2 standard pattern: '[A-Z]{2}' example: GB discriminator: propertyName: '@type' mapping: ISO31661Alpha2StandardIdentifier: '#/components/schemas/ISO31661Alpha2StandardIdentifier' ISO31661Alpha2StandardIdentifier_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- The corresponding identification of the resource in different standard, regulatory definitions. The standard specification identifier (e.g., ISO 3166-1 Alpha-2) and the corresponding value (e.g., BE) relevant to a particular resource. properties: value: type: string description: The value of the resource in the ISO 3166-1 Alpha 2 standard pattern: '[A-Z]{2}' example: GB required: - value discriminator: propertyName: '@type' mapping: ISO31661Alpha2StandardIdentifier: '#/components/schemas/ISO31661Alpha2StandardIdentifier_FVO' ItemActionType: enum: - add - modify - delete - noChange type: string description: action to be performed on the entity managed by the item LightGeographicAddress: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- Structured textual way of describing how to find a Property in an urban area (country properties are often defined differently). Note : Address corresponds to SID UrbanPropertyAddress properties: streetNr: type: string description: Number identifying a specific property on a public street. streetName: type: string description: Name of the street locality: type: string description: >- An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature, or a suburb, a bounded locality within a city, town or shire principally of urban character city: type: string description: City that the address is in stateOrProvince: type: string description: the State or Province that the address is in countryCode: $ref: '#/components/schemas/ISO31661Alpha2StandardIdentifier' postcode: type: string description: >- descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode) geographicSubAddress: $ref: '#/components/schemas/LightGeographicSubAddress' discriminator: propertyName: '@type' mapping: LightGeographicAddress: '#/components/schemas/LightGeographicAddress' LightGeographicAddress_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- Structured textual way of describing how to find a Property in an urban area (country properties are often defined differently). Note : Address corresponds to SID UrbanPropertyAddress properties: streetNr: type: string description: Number identifying a specific property on a public street. streetName: type: string description: Name of the street locality: type: string description: >- An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature, or a suburb, a bounded locality within a city, town or shire principally of urban character city: type: string description: City that the address is in stateOrProvince: type: string description: the State or Province that the address is in countryCode: $ref: '#/components/schemas/ISO31661Alpha2StandardIdentifier_FVO' postcode: type: string description: >- descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also know as zipcode) geographicSubAddress: $ref: '#/components/schemas/LightGeographicSubAddress' required: - city - countryCode discriminator: propertyName: '@type' mapping: LightGeographicAddress: '#/components/schemas/LightGeographicAddress_FVO' LightGeographicSubAddress: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- Representation of a GeographicSubAddress. It is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building. properties: buildingName: type: string description: allows for buildings that have well-known names levelNumber: type: string description: 'used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2' levelType: type: string description: describes level types within a building privateStreetName: type: string description: >- private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office. privateStreetNumber: type: string description: private streets numbers internal to a private street discriminator: propertyName: '@type' mapping: LightGeographicSubAddress: '#/components/schemas/LightGeographicSubAddress' LogicalResource: allOf: - $ref: '#/components/schemas/Entity' - type: object description: >- Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses) in the inventory. properties: description: type: string description: free-text description of the resource name: type: string description: the name of the resource operationalState: $ref: '#/components/schemas/ResourceOperationalStateType' resourceVersion: type: string description: A field that identifies the specific version of an instance of a resource. externalIdentifier: type: array description: >- An identification of this resource that is owned by or originates in a software system different from the current system. The structure identifies the system itself, the nature of the resource within the system and the unique ID of the resource within the system. It is anticipated that multiple external IDs can be held for a single resource, e.g. if the resource passed through multiple systems on the way to the current system. items: $ref: '#/components/schemas/ExternalIdentifier' discriminator: propertyName: '@type' mapping: Application: '#/components/schemas/Application' LogicalResource: '#/components/schemas/LogicalResource' LogicalResource_FVO: allOf: - $ref: '#/components/schemas/Entity' - type: object description: >- Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses) in the inventory. properties: description: type: string description: free-text description of the resource name: type: string description: the name of the resource resourceVersion: type: string description: A field that identifies the specific version of an instance of a resource. externalIdentifier: type: array description: >- An identification of this resource that is owned by or originates in a software system different from the current system. The structure identifies the system itself, the nature of the resource within the system and the unique ID of the resource within the system. It is anticipated that multiple external IDs can be held for a single resource, e.g. if the resource passed through multiple systems on the way to the current system. items: $ref: '#/components/schemas/ExternalIdentifier_FVO' required: - name discriminator: propertyName: '@type' mapping: Application: '#/components/schemas/Application_FVO' LogicalResource: '#/components/schemas/LogicalResource_FVO' LogicalResource_MVO: allOf: - $ref: '#/components/schemas/Entity' - type: object description: >- Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses) in the inventory. properties: description: type: string description: free-text description of the resource name: type: string description: the name of the resource operationalState: $ref: '#/components/schemas/ResourceOperationalStateType' resourceVersion: type: string description: A field that identifies the specific version of an instance of a resource. externalIdentifier: type: array description: >- An identification of this resource that is owned by or originates in a software system different from the current system. The structure identifies the system itself, the nature of the resource within the system and the unique ID of the resource within the system. It is anticipated that multiple external IDs can be held for a single resource, e.g. if the resource passed through multiple systems on the way to the current system. items: $ref: '#/components/schemas/ExternalIdentifier' discriminator: propertyName: '@type' mapping: Application: '#/components/schemas/Application_MVO' LogicalResource: '#/components/schemas/LogicalResource_MVO' LogicalResourceRole: type: object description: A logical Resource Role is a role given to a logical resource in a given context. properties: grantedPermissionSet: description: >- The PermissionSet is a set of Permissions granted to a user (party, party role, resource or resource role). The set may be granted explicitly by an authorized user or may be acquired implicitly due to the role that the user is playing. type: array items: $ref: '#/components/schemas/ApiPermissionSet' Monitor: allOf: - $ref: '#/components/schemas/Entity' - type: object description: Monitoring of resources properties: request: $ref: '#/components/schemas/Request' response: $ref: '#/components/schemas/Response' sourceHref: type: string description: The monitored resource href state: type: string description: 'The Monitor state of the resource. inProgress, inError, completed' discriminator: propertyName: '@type' mapping: Monitor: '#/components/schemas/Monitor' Monitor_RES: type: object description: Response object for Monitor allOf: - $ref: '#/components/schemas/Monitor' required: - id - href discriminator: propertyName: '@type' mapping: Monitor: '#/components/schemas/Monitor' MonitorStateChangeEvent: allOf: - $ref: '#/components/schemas/Event' - type: object description: MonitorStateChangeEvent generic structure properties: event: $ref: '#/components/schemas/MonitorStateChangeEventPayload' discriminator: propertyName: '@type' mapping: MonitorStateChangeEvent: '#/components/schemas/MonitorStateChangeEvent' MonitorStateChangeEventPayload: type: object description: MonitorStateChangeEventPayload generic structure properties: monitor: $ref: '#/components/schemas/Monitor' OAuth2ClientCredential: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- OAuth2ClientCredential describes the registration attributes in an OAuth registration process properties: clientSecret: type: string description: Secret that permits the Application to authenticate with OAuth2 method. state: type: string description: >- Used to indicate the current lifecycle state of this credential (like active, inactive, expired). validFor: $ref: '#/components/schemas/TimePeriod' discriminator: propertyName: '@type' mapping: OAuth2ClientCredential: '#/components/schemas/OAuth2ClientCredential' OpenGatewayOrderItemRelationship: allOf: - $ref: '#/components/schemas/OrderItemRelationship' - type: object description: >- Used to describe relationship between Order item in the Open Gateway context. These relationship could have an impact on pricing and conditions properties: relationshipType: type: string description: >- Relationship type in the Open Gateway context. bundles is used when the id in the OrderItemRelationship is the id of a ProductOffering bundled into the productOffering referred in the orderItem. requires is used when the id in the OrderItemRelationship is the id of a ProductOffering required by the productOffering referred in the orderItem. enum: - bundles - requires OpenGatewayOrderItemRelationship_FVO: allOf: - $ref: '#/components/schemas/OrderItemRelationship_FVO' - type: object description: >- Used to describe relationship between Order item in the Open Gateway context. These relationship could have an impact on pricing and conditions properties: relationshipType: type: string description: >- Relationship type in the Open Gateway context. bundles is used when the id in the OrderItemRelationship is the id of a ProductOffering bundled into the productOffering referred in the orderItem. requires is used when the id in the OrderItemRelationship is the id of a ProductOffering required by the productOffering referred in the orderItem. enum: - bundles - requires OpenGatewayProductRelationship: allOf: - $ref: '#/components/schemas/ProductRelationship' - type: object description: Used to describe relationship between product in the Open Gateway context. properties: relationshipType: type: string description: >- Relationship in the Open Gateway context. bundles is used when the id in the productRelationship is the id of a product bundled into the main product. appliesOn is used when the id in the productRelationship is the id of a product to which the main product applies on (like a usage volume product applies on an API product). enum: - bundles - appliesOn OrderItemRelationship: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- Used to describe relationship between Order item. These relationship could have an impact on pricing and conditions properties: id: type: string description: Id of the related Order item (must be in the same Order) relationshipType: type: string description: 'Relationship type as relies on, bundles, etc...' discriminator: propertyName: '@type' mapping: OpenGatewayOrderItemRelationship: '#/components/schemas/OpenGatewayOrderItemRelationship' OrderItemRelationship: '#/components/schemas/OrderItemRelationship' OrderItemRelationship_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- Used to describe relationship between Order item. These relationship could have an impact on pricing and conditions properties: id: type: string description: Id of the related Order item (must be in the same Order) relationshipType: type: string description: 'Relationship type as relies on, bundles, etc...' required: - id - relationshipType discriminator: propertyName: '@type' mapping: OpenGatewayOrderItemRelationship: '#/components/schemas/OpenGatewayOrderItemRelationship_FVO' OrderItemRelationship: '#/components/schemas/OrderItemRelationship_FVO' OrganizationIdentification: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: Represents our registration of information used as proof of identity by an organization properties: identificationId: type: string description: Identifier issuingAuthority: type: string description: Authority which has issued the identifier (chamber of commerce...) issuingDate: type: string format: date-time description: Date at which the identifier was issued identificationType: type: string description: >- Type of identification information used to identify the company in a country or internationally validFor: $ref: '#/components/schemas/TimePeriod' attachment: $ref: '#/components/schemas/AttachmentRefOrValue' discriminator: propertyName: '@type' mapping: OrganizationIdentification: '#/components/schemas/OrganizationIdentification' OrganizationIdentification_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: Represents our registration of information used as proof of identity by an organization properties: identificationId: type: string description: Identifier issuingAuthority: type: string description: Authority which has issued the identifier (chamber of commerce...) issuingDate: type: string format: date-time description: Date at which the identifier was issued identificationType: type: string description: >- Type of identification information used to identify the company in a country or internationally validFor: $ref: '#/components/schemas/TimePeriod' attachment: $ref: '#/components/schemas/AttachmentRefOrValue_FVO' required: - identificationId discriminator: propertyName: '@type' mapping: OrganizationIdentification: '#/components/schemas/OrganizationIdentification_FVO' PartyRef: type: object description: A Party reference allOf: - $ref: '#/components/schemas/EntityRef' discriminator: propertyName: '@type' mapping: PartyRef: '#/components/schemas/PartyRef' PartyRefOrPartyRoleRef: type: object description: '' oneOf: - $ref: '#/components/schemas/PartyRef' - $ref: '#/components/schemas/PartyRoleRef' discriminator: propertyName: '@type' mapping: PartyRef: '#/components/schemas/PartyRef' PartyRoleRef: '#/components/schemas/PartyRoleRef' PartyRoleRef: allOf: - $ref: '#/components/schemas/EntityRef' - type: object description: >- Party role reference. A party role represents the part played by a party in a given context. properties: partyId: type: string description: The identifier of the engaged party that is linked to the PartyRole object. partyName: type: string description: The name of the engaged party that is linked to the PartyRole object. discriminator: propertyName: '@type' mapping: PartyRoleRef: '#/components/schemas/PartyRoleRef' PhoneContactMedium: allOf: - $ref: '#/components/schemas/ContactMedium' - type: object description: >- Describes a phone number that could be used to contact a party (an individual or an organization) properties: phoneNumber: type: string description: The phone number of the contact ProductOfferingRef: allOf: - $ref: '#/components/schemas/EntityRef' - type: object description: >- ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information. properties: version: type: string description: Version of the product offering discriminator: propertyName: '@type' mapping: ProductOfferingRef: '#/components/schemas/ProductOfferingRef' ProductOfferingTermOrCondition: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: Approved Terms or Conditions of the ProductOffering. properties: id: type: string description: Identifier of the ProductOfferingTermOrCondition. name: type: string description: Identifier of the ProductOfferingTermOrCondition. productOfferingTermOrConditionSpecRef: $ref: '#/components/schemas/ProductOfferingTermOrConditionSpecRef' productOfferingTermOrConditionApproval: $ref: '#/components/schemas/ProductOfferingTermOrConditionApproval' product: $ref: '#/components/schemas/ProductRef' applicationLegalBasisForInputData: $ref: '#/components/schemas/DpvLegalBasisType' process: type: array items: $ref: '#/components/schemas/DpvProcess' description: Lists all the operations or 'processing' performed on data by the data consumer. purposeReason: type: string description: >- Explain the reason justifying the purpose, indicating specifically which is the reason why the API is employed as part of the application's use case. userConsentScreenshot: $ref: '#/components/schemas/SimpleAttachment' discriminator: propertyName: '@type' mapping: ProductOfferingTermOrCondition: '#/components/schemas/ProductOfferingTermOrCondition' ProductOfferingTermOrCondition_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: Approved Terms or Conditions of the ProductOffering. properties: id: type: string description: Identifier of the ProductOfferingTermOrCondition. name: type: string description: Identifier of the ProductOfferingTermOrCondition. productOfferingTermOrConditionSpecRef: $ref: '#/components/schemas/ProductOfferingTermOrConditionSpecRef' productOfferingTermOrConditionApproval: $ref: '#/components/schemas/ProductOfferingTermOrConditionApproval_FVO' product: $ref: '#/components/schemas/ProductRef' applicationLegalBasisForInputData: $ref: '#/components/schemas/DpvLegalBasisType' process: type: array items: $ref: '#/components/schemas/DpvProcess_FVO' description: Lists all the operations or 'processing' performed on data by the data consumer. purposeReason: type: string description: >- Explain the reason justifying the purpose, indicating specifically which is the reason why the API is employed as part of the application's use case. userConsentScreenshot: $ref: '#/components/schemas/SimpleAttachment' required: - productOfferingTermOrConditionSpecRef discriminator: propertyName: '@type' mapping: ProductOfferingTermOrCondition: '#/components/schemas/ProductOfferingTermOrCondition_FVO' ProductOfferingTermOrConditionApproval: type: object description: >- Approval entity for the ProductOfferingTermOrCondition. Exists when Terms or Conditions are approved. properties: approvalDate: type: string format: date-time description: Date of the approval. authorization: type: array items: $ref: '#/components/schemas/ApiAuthorization' deprecated: true description: DEPRECATED not possible yet to have the ID of the individual that made the approval. ProductOfferingTermOrConditionApproval_FVO: type: object description: >- Approval entity for the ProductOfferingTermOrCondition. Exists when Terms or Conditions are approved. properties: approvalDate: type: string format: date-time description: Date of the approval. authorization: type: array items: $ref: '#/components/schemas/ApiAuthorization_FVO' deprecated: true description: DEPRECATED not possible yet to have the ID of the individual that made the approval. required: - approvalDate ProductOfferingTermOrConditionSpecRef: allOf: - $ref: '#/components/schemas/EntityRef' - type: object description: Reference to the ProductOfferingTermOrCondition specification. properties: version: type: string description: Version of the ProductOfferingTermOrCondition specification. discriminator: propertyName: '@type' mapping: ProductOfferingTermOrConditionSpecRef: '#/components/schemas/ProductOfferingTermOrConditionSpecRef' ProductOrderItemDelete: allOf: - $ref: '#/components/schemas/DCSProductOrderItem' - type: object description: >- A ProductOrderItemDelete is a specialization of a ProductOrderItem, for action to delete a product. An identified part of the order. A product order is decomposed into one or more order items. properties: id: type: string description: >- Identifier of the ProductOrder item (generally it is a sequence number 01, 02, 03, ...) product: $ref: '#/components/schemas/ProductRef' state: $ref: '#/components/schemas/ProductOrderItemStateType' stateReason: type: string description: >- A string providing an explanation on the value of the state lifecycle. For instance if the state is rejected, stateReason will provide the reason for rejection. productOrderItemRelationship: type: array description: Collection of order items relationships in the Open Gateway context. items: $ref: '#/components/schemas/OpenGatewayOrderItemRelationship' ProductOrderItemDelete_FVO: allOf: - $ref: '#/components/schemas/DCSProductOrderItem_FVO' - type: object description: >- A ProductOrderItemDelete is a specialization of a ProductOrderItem, for action to delete a product. An identified part of the order. A product order is decomposed into one or more order items. properties: id: type: string description: >- Identifier of the ProductOrder item (generally it is a sequence number 01, 02, 03, ...) product: $ref: '#/components/schemas/ProductRef' stateReason: type: string description: >- A string providing an explanation on the value of the state lifecycle. For instance if the state is rejected, stateReason will provide the reason for rejection. productOrderItemRelationship: type: array description: Collection of order items relationships in the Open Gateway context. items: $ref: '#/components/schemas/OpenGatewayOrderItemRelationship_FVO' required: - id - product ProductOrderItemStateType: enum: - acknowledged - rejected - pending - held - inProgress - cancelled - completed - failed - partial - assessingCancellation - pendingCancellation type: string description: Possible values for the state of the product order item ProductOrderStateType: enum: - acknowledged - rejected - pending - held - inProgress - cancelled - completed - failed - partial - assessingCancellation - pendingCancellation - draft - inProgress.accepted type: string description: Possible values for the state of the order ProductRef: type: object description: A Product reference allOf: - $ref: '#/components/schemas/EntityRef' discriminator: propertyName: '@type' mapping: ProductRef: '#/components/schemas/ProductRef' ProductRelationship: allOf: - $ref: '#/components/schemas/Extensible' - $ref: '#/components/schemas/EntityRef' - type: object description: Used to describe relationship between product. properties: id: type: string description: Id of the related product relationshipType: type: string description: 'Relationship type as relies on, bundles, etc...' discriminator: propertyName: '@type' mapping: OpenGatewayProductRelationship: '#/components/schemas/OpenGatewayProductRelationship' ProductRelationship: '#/components/schemas/ProductRelationship' ProductSpecificationRef: allOf: - $ref: '#/components/schemas/EntityRef' - type: object description: >- ProductSpecification reference. A product Specification represents entities that are orderable from the provider of the catalog. properties: version: type: string description: Version of the product specification targetProductSchema: $ref: '#/components/schemas/TargetProductSchema' discriminator: propertyName: '@type' mapping: ProductSpecificationRef: '#/components/schemas/ProductSpecificationRef' ProductStatusType: enum: - created - pendingActive - cancelled - active - pendingTerminate - terminated - suspended - 'aborted ' type: string description: Possible values for the status of the product Quantity: type: object description: An amount in a given unit properties: amount: type: number format: float default: 1 description: Numeric value in a given unit units: type: string description: Unit RelatedOrderItem: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: It's a Order item that has been executed previously. properties: orderItemAction: $ref: '#/components/schemas/ItemActionType' orderHref: type: string description: Reference of the related entity. '@referredType': type: string description: The actual type of the target instance when needed for disambiguation. role: deprecated: true type: string description: Role played by the order orderId: type: string description: Unique identifier of a related Order. orderItemId: type: string description: Id of an item of a product order discriminator: propertyName: '@type' mapping: RelatedOrderItem: '#/components/schemas/RelatedOrderItem' RelatedPartyRefOrPartyRoleRef: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- RelatedParty reference. A related party defines party or party role or its reference, linked to a specific entity properties: role: description: >- Role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user' type: string partyOrPartyRole: $ref: '#/components/schemas/PartyRefOrPartyRoleRef' discriminator: propertyName: '@type' mapping: RelatedPartyRefOrPartyRoleRef: '#/components/schemas/RelatedPartyRefOrPartyRoleRef' RelatedPartyRefOrPartyRoleRef_FVO: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- RelatedParty reference. A related party defines party or party role or its reference, linked to a specific entity properties: role: description: >- Role played by the related party or party role in the context of the specific entity it is linked to. Such as 'initiator', 'customer', 'salesAgent', 'user' type: string partyOrPartyRole: $ref: '#/components/schemas/PartyRefOrPartyRoleRef' required: - role discriminator: propertyName: '@type' mapping: RelatedPartyRefOrPartyRoleRef: '#/components/schemas/RelatedPartyRefOrPartyRoleRef_FVO' Request: type: object description: A response to a request properties: method: description: 'The protocol of the request, e.g. http' type: string to: description: 'The target of the request, e.g. a URL for an HTTP request' type: string body: description: >- The body of the request. For example for an HTTP request might contain content of a form . type: object header: type: array description: >- Items included in the header of the request. For example for an HTTP request might contain requested locale, basic authentication. items: $ref: '#/components/schemas/HeaderItem' title: header ResourceOperationalStateType: enum: - enable - disable type: string description: >- ResourceOperationalStateType enumerations; values defined by ITU X.731: 'disable': The resource is totally inoperable and unable to provide service to the user(s); 'enable': The resource is partially or fully operable and available for use. Response: type: object description: A response to a request properties: statusCode: description: >- The status of the response. For example for an HTTP response would be codes such as 200, 400, etc. type: string body: description: The body of the response. type: object header: description: >- Items included in the header of the response. For example for an HTTP response might contain negotiated locale. type: array items: $ref: '#/components/schemas/HeaderItem' title: header SimpleAttachment: allOf: - $ref: '#/components/schemas/Extensible' - type: object description: >- Complements the description of an element (for instance a product) through video, pictures... properties: content: type: string format: base64 description: 'The actual contents of the attachment object, if embedded, encoded as base64' mimeType: type: string enum: - application/pdf description: a technical characterization of the attachment content format using IETF Mime Types url: type: string description: 'Uniform Resource Locator, is a web page address (a subset of URI)' discriminator: propertyName: '@type' mapping: SimpleAttachment: '#/components/schemas/SimpleAttachment' SocialContactMedium: allOf: - $ref: '#/components/schemas/ContactMedium' - type: object description: >- Describes a social media identifier that could be used to contact a party (an individual or an organization) properties: socialNetworkId: type: string description: Identifier as a member of a social network TargetProductSchema: type: object description: >- The reference object to the schema and type of target product which is described by product specification properties: '@type': type: string description: Class type of the target product '@schemaLocation': type: string format: uri description: This field provides a link to the schema describing the target product TimePeriod: type: object description: 'A period of time, either as a deadline (endDateTime only) a startDateTime only, or both' properties: startDateTime: description: 'Start of the time period, using IETC-RFC-3339 format' type: string format: date-time example: '1985-04-12T23:20:50.52Z' endDateTime: description: 'End of the time period, using IETC-RFC-3339 format' type: string format: date-time example: '1985-04-12T23:20:50.52Z' UsageVolume: type: object description: Usage Volume for Open Gateway context. properties: volumeUnit: type: string description: >- unit of the volume. If the schema is specialized with an enum, the values must be taken from this list : apiCall, apiNotification. volumeInitialAmount: type: integer description: Initial amount of volumeUnit when corresponding Service Balance is created. UsageVolumeProductLocationVerification: allOf: - $ref: '#/components/schemas/ApiProduct' - type: object description: >- A UsageVolumeProductLocationVerification is a specialization of a ApiProduct. It's an example, not a schema to be implemented as is in production. properties: usageVolume: $ref: '#/components/schemas/UsageVolume' isBlocked: type: boolean description: >- If true means that the usage of the service can be blocked when a specific value of the Service Balance is reached, for instance when its remaining usage value is 0. isRecurring: type: boolean description: If true means that a new Service Balance will be created after each validity period. validityDuration: $ref: '#/components/schemas/Duration' WebFormContactMedium: allOf: - $ref: '#/components/schemas/ContactMedium' - type: object description: >- Describes an URL of a web form that could be used to contact a party (an individual or an organization) properties: url: type: string description: Url of the web form. WebFormContactMedium_FVO: allOf: - $ref: '#/components/schemas/ContactMedium_FVO' - type: object description: >- Describes an URL of a web form that could be used to contact a party (an individual or an organization) properties: url: type: string description: Url of the web form. required: - url Error: discriminator: propertyName: '@type' mapping: Error: '#/components/schemas/Error' allOf: - $ref: '#/components/schemas/Extensible' - type: object required: - code - reason properties: code: type: string description: 'Application relevant detail, defined in the API or a common list.' reason: type: string description: Explanation of the reason for the error which can be shown to a client user. message: type: string description: >- More details and corrective actions related to the error which can be shown to a client user. status: type: string description: HTTP Error code extension referenceError: type: string description: URI of documentation describing the error. description: 'Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)' Hub_FVO: type: object description: >- Sets the communication endpoint address the service instance must use to deliver notification information required: - callback allOf: - $ref: '#/components/schemas/Extensible' - properties: callback: type: string description: The callback being registered. query: type: string description: additional data to be passed Hub: type: object description: >- Sets the communication endpoint address the service instance must use to deliver notification information allOf: - $ref: '#/components/schemas/Entity' - properties: id: type: string description: Id of the listener callback: type: string description: The callback being registered. query: type: string description: additional data to be passed required: - callback JsonPatch: type: object description: A JSONPatch document as defined by RFC 6902 required: - op - path properties: op: type: string description: The operation to be performed enum: - add - remove - replace - move - copy - test path: type: string description: A JSON-Pointer value: description: The value to be used within the operations. from: type: string description: A string containing a JSON Pointer value. JsonPatchOperations: description: JSONPatch Operations document as defined by RFC 6902 type: array items: $ref: '#/components/schemas/JsonPatch' parameters: Id: name: id required: true schema: type: string in: path description: Identifier of the Resource Fields: name: fields in: query description: Comma-separated properties to be provided in response schema: type: string Offset: name: offset in: query description: Requested index for start of resources to be provided in response schema: type: integer Limit: name: limit in: query description: Requested number of resources to be provided in response schema: type: integer Before: name: before in: query description: An opaque string value representing the page results before the cursor value schema: type: string After: name: after in: query description: An opaque string value representing the page results after the cursor value schema: type: string Sort: name: sort in: query description: >- The default direction is Ascending order, the use of the modifier in front of the sort field name, “-“, changes the sort order direction. schema: type: string Filter: name: filter in: query description: Filter a collection using JSONPath schema: type: string example: 'attachment[?(@size==300)]' requestBodies: ApiProductOrder_FVO: description: The ApiProductOrder to be created content: application/json: schema: $ref: '#/components/schemas/ApiProductOrder_FVO' examples: Create_an_API_Product_Order_for_ordering_subscribe_a_new_ProductOffering: $ref: >- #/components/examples/Create_an_API_Product_Order_for_ordering_subscribe_a_new_ProductOffering_request Create_an_API_Product_Order_for_ordering_unsubscribe_the_removal_of_an_existing_Product: $ref: >- #/components/examples/Create_an_API_Product_Order_for_ordering_unsubscribe_the_removal_of_an_existing_Product_request Create_an_API_Product_Order_for_ordering_subscribe_a_new_ProductOffering_bundle: $ref: >- #/components/examples/Create_an_API_Product_Order_for_ordering_subscribe_a_new_ProductOffering_bundle_request required: true ApiProductOrderCreateEvent: description: ApiProductOrder create Event payload content: application/json: schema: $ref: '#/components/schemas/ApiProductOrderCreateEvent' examples: ApiProductOrderCreateEvent: $ref: '#/components/examples/ApiProductOrderCreateEvent_request' required: true ApiProductOrderStateChangeEvent: description: ApiProductOrder stateChange Event payload content: application/json: schema: $ref: '#/components/schemas/ApiProductOrderStateChangeEvent' examples: ApiProductOrderStateChangeEvent: $ref: '#/components/examples/ApiProductOrderStateChangeEvent_request' required: true ApiProductOrderAttributeValueChangeEvent: description: ApiProductOrder attributeValueChange Event payload content: application/json: schema: $ref: '#/components/schemas/ApiProductOrderAttributeValueChangeEvent' examples: ApiProductOrderAttributeValueChangeEvent: $ref: '#/components/examples/ApiProductOrderAttributeValueChangeEvent_request' required: true Application_FVO: description: The Application to be created content: application/json: schema: $ref: '#/components/schemas/Application_FVO' examples: Create_an_Application: $ref: '#/components/examples/Create_an_Application_request' required: true Application_MVO: description: The Application to be patched content: application/json: schema: $ref: '#/components/schemas/Application_MVO' examples: Update_an_Application_with_json_content_type: $ref: '#/components/examples/Update_an_Application_with_json_content_type_request' application/merge-patch+json: schema: $ref: '#/components/schemas/Application_MVO' examples: Update_an_Application_with_merge-patch_json_content_type: $ref: >- #/components/examples/Update_an_Application_with_merge-patch_json_content_type_request application/json-patch+json: schema: $ref: '#/components/schemas/JsonPatchOperations' examples: Update_an_Application_with_json-patch_json_content_type: $ref: >- #/components/examples/Update_an_Application_with_json-patch_json_content_type_request application/json-patch-query+json: schema: $ref: '#/components/schemas/JsonPatchOperations' examples: Update_an_Application_with_json-patch-query_json_content_type: $ref: >- #/components/examples/Update_an_Application_with_json-patch-query_json_content_type_request required: true ApplicationCreateEvent: description: Application create Event payload content: application/json: schema: $ref: '#/components/schemas/ApplicationCreateEvent' examples: ApplicationCreateEvent: $ref: '#/components/examples/ApplicationCreateEvent_request' required: true ApplicationApprovalStatusChangeEvent: description: Application approvalStatusChange Event payload content: application/json: schema: $ref: '#/components/schemas/ApplicationApprovalStatusChangeEvent' examples: ApplicationApprovalStatusChangeEvent: $ref: '#/components/examples/ApplicationApprovalStatusChangeEvent_request' required: true ApplicationAttributeValueChangeEvent: description: Application attributeValueChange Event payload content: application/json: schema: $ref: '#/components/schemas/ApplicationAttributeValueChangeEvent' examples: ApplicationAttributeValueChangeEvent: $ref: '#/components/examples/ApplicationAttributeValueChangeEvent_request' required: true ApplicationOwner_FVO: description: The ApplicationOwner to be created content: application/json: schema: $ref: '#/components/schemas/ApplicationOwner_FVO' examples: Create_an_ApplicationOwner: $ref: '#/components/examples/Create_an_ApplicationOwner_request' required: true ApplicationOwner_MVO: description: The ApplicationOwner to be patched content: application/json: schema: $ref: '#/components/schemas/ApplicationOwner_MVO' examples: Update_an_ApplicationOwner_with_json_content_type: $ref: '#/components/examples/Update_an_ApplicationOwner_with_json_content_type_request' application/merge-patch+json: schema: $ref: '#/components/schemas/ApplicationOwner_MVO' examples: Update_an_ApplicationOwner_with_merge-patch_json_content_type: $ref: >- #/components/examples/Update_an_ApplicationOwner_with_merge-patch_json_content_type_request application/json-patch+json: schema: $ref: '#/components/schemas/JsonPatchOperations' examples: Update_an_ApplicationOwner_with_json-patch_json_content_type: $ref: >- #/components/examples/Update_an_ApplicationOwner_with_json-patch_json_content_type_request application/json-patch-query+json: schema: $ref: '#/components/schemas/JsonPatchOperations' examples: Update_an_ApplicationOwner_with_json-patch-query_json_content_type: $ref: >- #/components/examples/Update_an_ApplicationOwner_with_json-patch-query_json_content_type_request required: true ApplicationOwnerCreateEvent: description: ApplicationOwner create Event payload content: application/json: schema: $ref: '#/components/schemas/ApplicationOwnerCreateEvent' examples: ApplicationOwnerCreateEvent: $ref: '#/components/examples/ApplicationOwnerCreateEvent_request' required: true ApplicationOwnerApprovalStatusChangeEvent: description: ApplicationOwner approvalStatusChange Event payload content: application/json: schema: $ref: '#/components/schemas/ApplicationOwnerApprovalStatusChangeEvent' examples: ApplicationOwnerApprovalStatusChangeEvent: $ref: '#/components/examples/ApplicationOwnerApprovalStatusChangeEvent_request' required: true ApplicationOwnerAttributeValueChangeEvent: description: ApplicationOwner attributeValueChange Event payload content: application/json: schema: $ref: '#/components/schemas/ApplicationOwnerAttributeValueChangeEvent' examples: ApplicationOwnerAttributeValueChangeEvent: $ref: '#/components/examples/ApplicationOwnerAttributeValueChangeEvent_request' required: true MonitorStateChangeEvent: description: Monitor stateChange Event payload content: application/json: schema: $ref: '#/components/schemas/MonitorStateChangeEvent' examples: MonitorStateChangeEvent: $ref: '#/components/examples/MonitorStateChangeEvent_request' required: true Hub_FVO: description: Data containing the callback endpoint to deliver the information content: application/json: schema: $ref: '#/components/schemas/Hub_FVO' examples: Basic Hub Example Request: value: '@type': Hub callback: 'https://host/tmf-api/specificAPIName/v5/listener/specificEventListener' query: data required: true responses: '200': description: OK '202': description: Accepted '204': description: Deleted '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Bad Request Error value: '@type': Error code: ERR400 reason: Bad Request message: >- The server could not understand the request due to invalid syntax. Please correct the syntax and try again. referenceError: 'https://host/errors' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Unauthorized Error value: '@type': Error code: ERR401 reason: Unauthorized message: >- You are not authorized to access the requested resource. Please provide the correct credentials. referenceError: 'https://host/errors' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Forbidden Error value: '@type': Error code: ERR403 reason: Forbidden message: >- You don't have the permission to access the requested resource. It is either read-protected or not readable by the server. referenceError: 'https://host/errors' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Not Found Error value: '@type': Error code: ERR404 reason: Not Found message: The requested URL was not found on the server. referenceError: 'https://host/errors' '405': description: Method Not allowed content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Method Not allowed Error value: '@type': Error code: ERR405 reason: Method Not allowed message: The method is not allowed for the requested URL. referenceError: 'https://host/errors' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Conflict Error value: '@type': Error code: ERR409 reason: Conflict message: >- The request could not be completed due to a conflict with the current state of the target resource. referenceError: 'https://host/errors' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Internal Server Error example value: '@type': Error code: ERR500 reason: Internal Server Error message: The server encountered an internal error. Please contact the system administrator. referenceError: 'https://host/errors' '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Not Implemented Error value: '@type': Error code: ERR501 reason: The requested operation is not implemented message: >- The requested operation is not implemented. Please contact the system administrator. referenceError: 'https://host/errors' '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Service Unavailable Error value: '@type': Error code: ERR503 reason: Service Unavailable message: The service is currently unavailable. Please try again later. referenceError: 'https://host/errors' 200ApiProductOrderArray: description: Success headers: X-Total-Count: $ref: '#/components/headers/X-Total-Count' X-Result-Count: $ref: '#/components/headers/X-Result-Count' content: application/json: schema: type: array items: $ref: '#/components/schemas/ApiProductOrder_RES' examples: Retrieve_a_list_of_API_Product_Order: $ref: '#/components/examples/Retrieve_a_list_of_API_Product_Order_response' Retrieve_a_list_of_API_Product_Order_with_field_selection_and_filter: $ref: >- #/components/examples/Retrieve_a_list_of_API_Product_Order_with_field_selection_and_filter_response 200ApiProductOrder_Get: description: Success content: application/json: schema: $ref: '#/components/schemas/ApiProductOrder_RES' examples: Retrieve_an_API_Product_Order_with_add_action_from_its_identifier: $ref: >- #/components/examples/Retrieve_an_API_Product_Order_with_add_action_from_its_identifier_response Retrieve_an_API_Product_Order_with_delete_action_from_its_identifier: $ref: >- #/components/examples/Retrieve_an_API_Product_Order_with_delete_action_from_its_identifier_response Retrieve_an_API_Product_Order_with_add_action_for_a_bundle_ProductOffering_from_its_identifier: $ref: >- #/components/examples/Retrieve_an_API_Product_Order_with_add_action_for_a_bundle_ProductOffering_from_its_identifier_response 201ApiProductOrder: description: Created content: application/json: schema: $ref: '#/components/schemas/ApiProductOrder_RES' examples: Create_an_API_Product_Order_for_ordering_subscribe_a_new_ProductOffering: $ref: >- #/components/examples/Create_an_API_Product_Order_for_ordering_subscribe_a_new_ProductOffering_response Create_an_API_Product_Order_for_ordering_unsubscribe_the_removal_of_an_existing_Product: $ref: >- #/components/examples/Create_an_API_Product_Order_for_ordering_unsubscribe_the_removal_of_an_existing_Product_response Create_an_API_Product_Order_for_ordering_subscribe_a_new_ProductOffering_bundle: $ref: >- #/components/examples/Create_an_API_Product_Order_for_ordering_subscribe_a_new_ProductOffering_bundle_response 200ApiProductArray: description: Success headers: X-Total-Count: $ref: '#/components/headers/X-Total-Count' X-Result-Count: $ref: '#/components/headers/X-Result-Count' content: application/json: schema: type: array items: $ref: '#/components/schemas/ApiProduct_RES' examples: Retrieve_a_list_of_API_Product: $ref: '#/components/examples/Retrieve_a_list_of_API_Product_response' Retrieve_a_list_of_API_Product_with_field_selection_and_filter: $ref: >- #/components/examples/Retrieve_a_list_of_API_Product_with_field_selection_and_filter_response 200ApiProduct_Get: description: Success content: application/json: schema: $ref: '#/components/schemas/ApiProduct_RES' examples: Retrieve_an_API_Product_location_verification_standalone: $ref: >- #/components/examples/Retrieve_an_API_Product_location_verification_standalone_response Retrieve_an_API_Product_location_verification_bundle: $ref: '#/components/examples/Retrieve_an_API_Product_location_verification_bundle_response' Retrieve_an_API_Product_location_verification_API_bundled: $ref: >- #/components/examples/Retrieve_an_API_Product_location_verification_API_bundled_response Retrieve_an_API_Product_location_verification_usage_volume_bundled: $ref: >- #/components/examples/Retrieve_an_API_Product_location_verification_usage_volume_bundled_response 200ApplicationArray: description: Success headers: X-Total-Count: $ref: '#/components/headers/X-Total-Count' X-Result-Count: $ref: '#/components/headers/X-Result-Count' content: application/json: schema: type: array items: $ref: '#/components/schemas/Application_RES' examples: Retrieve_a_list_of_Application: $ref: '#/components/examples/Retrieve_a_list_of_Application_response' Retrieve_a_list_of_Application_with_field_selection_and_filter: $ref: >- #/components/examples/Retrieve_a_list_of_Application_with_field_selection_and_filter_response 200Application_Get: description: Success content: application/json: schema: $ref: '#/components/schemas/Application_RES' examples: Retrieve_an_Application_from_its_identifier: $ref: '#/components/examples/Retrieve_an_Application_from_its_identifier_response' Retrieve_an_Application_with_permissions_from_its_identifier: $ref: >- #/components/examples/Retrieve_an_Application_with_permissions_from_its_identifier_response Retrieve_an_Application_without_digital_identity_from_its_identifier: $ref: >- #/components/examples/Retrieve_an_Application_without_digital_identity_from_its_identifier_response 200Application_Patch: description: Success content: application/json: schema: $ref: '#/components/schemas/Application_RES' examples: Update_an_Application_with_json_content_type: $ref: '#/components/examples/Update_an_Application_with_json_content_type_response' Update_an_Application_with_merge-patch_json_content_type: $ref: >- #/components/examples/Update_an_Application_with_merge-patch_json_content_type_response Update_an_Application_with_json-patch_json_content_type: $ref: >- #/components/examples/Update_an_Application_with_json-patch_json_content_type_response Update_an_Application_with_json-patch-query_json_content_type: $ref: >- #/components/examples/Update_an_Application_with_json-patch-query_json_content_type_response 201Application: description: Created content: application/json: schema: $ref: '#/components/schemas/Application_RES' examples: Create_an_Application: $ref: '#/components/examples/Create_an_Application_response' 200ApplicationOwnerArray: description: Success headers: X-Total-Count: $ref: '#/components/headers/X-Total-Count' X-Result-Count: $ref: '#/components/headers/X-Result-Count' content: application/json: schema: type: array items: $ref: '#/components/schemas/ApplicationOwner_RES' examples: Retrieve_a_list_of_ApplicationOwner: $ref: '#/components/examples/Retrieve_a_list_of_ApplicationOwner_response' Retrieve_a_list_of_ApplicationOwner_with_field_selection_and_filter: $ref: >- #/components/examples/Retrieve_a_list_of_ApplicationOwner_with_field_selection_and_filter_response 200ApplicationOwner_Get: description: Success content: application/json: schema: $ref: '#/components/schemas/ApplicationOwner_RES' examples: Retrieve_an_ApplicationOwner_from_its_identifier: $ref: '#/components/examples/Retrieve_an_ApplicationOwner_from_its_identifier_response' 200ApplicationOwner_Patch: description: Success content: application/json: schema: $ref: '#/components/schemas/ApplicationOwner_RES' examples: Update_an_ApplicationOwner_with_json_content_type: $ref: '#/components/examples/Update_an_ApplicationOwner_with_json_content_type_response' Update_an_ApplicationOwner_with_merge-patch_json_content_type: $ref: >- #/components/examples/Update_an_ApplicationOwner_with_merge-patch_json_content_type_response Update_an_ApplicationOwner_with_json-patch_json_content_type: $ref: >- #/components/examples/Update_an_ApplicationOwner_with_json-patch_json_content_type_response Update_an_ApplicationOwner_with_json-patch-query_json_content_type: $ref: >- #/components/examples/Update_an_ApplicationOwner_with_json-patch-query_json_content_type_response 201ApplicationOwner: description: Created content: application/json: schema: $ref: '#/components/schemas/ApplicationOwner_RES' examples: Create_an_ApplicationOwner: $ref: '#/components/examples/Create_an_ApplicationOwner_response' 200MonitorArray: description: Success headers: X-Total-Count: $ref: '#/components/headers/X-Total-Count' X-Result-Count: $ref: '#/components/headers/X-Result-Count' content: application/json: schema: type: array items: $ref: '#/components/schemas/Monitor_RES' examples: Retrieve_a_list_of_Monitor: $ref: '#/components/examples/Retrieve_a_list_of_Monitor_response' Retrieve_a_list_of_Monitor_with_field_selection_and_filter: $ref: >- #/components/examples/Retrieve_a_list_of_Monitor_with_field_selection_and_filter_response 200Monitor_Get: description: Success content: application/json: schema: $ref: '#/components/schemas/Monitor_RES' examples: Retrieve_a_Monitor_from_its_identifier: $ref: '#/components/examples/Retrieve_a_Monitor_from_its_identifier_response' Error: description: Error content: application/json: schema: $ref: '#/components/schemas/Error' examples: basic: summary: Error example value: '@type': Error code: ERR001 reason: Missing information message: Please provide the additional example information referenceError: 'https://host/errors' Hub: description: Notified content: application/json: schema: $ref: '#/components/schemas/Hub' examples: basic: summary: Hub example value: '@type': Hub callback: 'https://host/tmf-api/specificAPIName/v5/listener/specificEventListener' headers: X-Total-Count: description: Total number of items matching criteria schema: type: integer X-Result-Count: description: Actual number of items returned in the response body schema: type: integer securitySchemes: {} examples: Retrieve_an_API_Product_Order_with_add_action_from_its_identifier_response: value: '@type': ApiProductOrder id: 86387671-0997-461b-99c7-d624ffb0640c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/86387671-0997-461b-99c7-d624ffb0640c state: completed creationDate: '2025-02-02T12:00:00.00Z' completionDate: '2025-02-02T12:01:00.00Z' externalId: - '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerCustomerOrder id: order_2232342 owner: ChannelPartner description: Camara API order for an Application Owner productOrderItem: - '@type': ApiProductOrderItemAdd '@baseType': DCSProductOrderItem '@schemaLocation': 'https://mycsp.com/tmf-api/schema/Customer/ApiProductOrderItemAdd.schema.json' id: '1' state: completed productOffering: '@type': ProductOfferingRef id: 2d4ef4d3-08ce-441d-ac76-133b6dad0ccb '@referredType': OpenGatewayProductOffering product: '@type': ProductRef id: 8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb '@referredType': ApiProduct productAction: '@type': ApiProductActionAddDeviceLocationVerification '@baseType': ApiProductAction '@schemaLocation': >- https://mycsp.com/tmf-api/schema/Customer/ApiProductActionAddDeviceLocationVerification_example.schema.json purpose: 'dpv:FraudPreventionAndDetection' bestAccuracy: 500 targetApplication: '@type': ApplicationRef id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c '@referredType': Application externalIdentifier: '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerProduct id: device_location_1234 owner: ChannelPartner approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: 2d4ef4d3-08ce-441d-ac76-133b6dad0ccb_terms_1 '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-10-20T00:00:00.000Z' applicationLegalBasisForInputData: 'dpv:Consent' process: - '@type': DpvProcess processingOperation: - 'dpv:Assess' context: '@type': DpvContext processingContext: - 'dpv:AutomatedDecisionMaking' - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:FixedOccurrencesDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' - '@type': DpvProcess processingOperation: - 'dpv:Profiling' context: '@type': DpvContext processingContext: - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:EndlessDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' dataExportStorageCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' userConsentScreenshot: '@type': SimpleAttachment content: JVBERi...JSVFT0Y= mimeType: application/pdf channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: API Order representation. Retrieve_an_API_Product_Order_with_delete_action_from_its_identifier_response: value: '@type': ApiProductOrder id: d86065be-f2fd-490b-bb6a-dca24cc7f65a href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/d86065be-f2fd-490b-bb6a-dca24cc7f65a state: completed creationDate: '2025-03-02T12:00:00.00Z' completionDate: '2025-03-02T12:01:00.00Z' externalId: - '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerCustomerOrder id: order_2232342 owner: ChannelPartner description: Camara API Unsubscription for an Application Owner productOrderItem: - '@type': ProductOrderItemDelete '@baseType': DCSProductOrderItem id: '1' state: completed product: '@type': ProductRef id: 8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb '@referredType': ApiProduct channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: API Order representation. Retrieve_an_API_Product_Order_with_add_action_for_a_bundle_ProductOffering_from_its_identifier_response: value: '@type': ApiProductOrder id: c5c005c5-34f9-4e7d-99df-8a30da246f8b href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/c5c005c5-34f9-4e7d-99df-8a30da246f8b state: completed creationDate: '2025-01-01T10:00:00.00Z' completionDate: '2025-01-01T10:01:00.00Z' externalId: - '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerCustomerOrder id: order_6453 owner: ChannelPartner productOrderItem: - '@type': ApiProductOrderItemAdd '@baseType': DCSProductOrderItem state: completed id: '1' productOffering: '@type': ProductOfferingRef id: 5e9b10e5-d707-4a16-89d1-687c7f0bf81a '@referredType': OpenGatewayProductOffering product: '@type': ProductRef href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/33944716-d86f-4122-827b-307d74e6ca50 id: 33944716-d86f-4122-827b-307d74e6ca50 '@referredType': ApiProduct productAction: '@type': ApiProductActionAdd targetApplication: '@type': ApplicationRef id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c '@referredType': Application externalIdentifier: '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerProduct id: device_location_bundle_0987 owner: ChannelPartner approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: 5e9b10e5-d707-4a16-89d1-687c7f0bf81a_terms_1 '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' productOrderItemRelationship: - '@type': OpenGatewayOrderItemRelationship id: '2' relationshipType: bundles - '@type': OpenGatewayOrderItemRelationship id: '3' relationshipType: bundles - '@type': ApiProductOrderItemAdd '@baseType': DCSProductOrderItem state: completed id: '2' productOffering: '@type': ProductOfferingRef id: ab7792f8-6628-4c4b-a557-699adc26d4ce '@referredType': OpenGatewayProductOffering product: '@type': ProductRef href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/3be31371-2755-43f7-a6f6-380234910b9b id: 3be31371-2755-43f7-a6f6-380234910b9b '@referredType': ApiProduct productAction: '@type': ApiProductActionAddDeviceLocationVerificationBundled '@baseType': ApiProductActionAdd '@schemaLocation': >- https://mycsp.com/tmf-api/schema/Customer/ApiProductActionAddDeviceLocationVerificationBundled.schema.json purpose: 'dpv:FraudPreventionAndDetection' bestAccuracy: 500 targetApplication: '@type': ApplicationRef id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c '@referredType': Application externalIdentifier: '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerProduct id: device_location_bundle_0987 owner: ChannelPartner approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: ab7792f8-6628-4c4b-a557-699adc26d4ce_terms_1 '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' applicationLegalBasisForInputData: 'dpv:Consent' process: - '@type': DpvProcess processingOperation: - 'dpv:Assess' context: '@type': DpvContext processingContext: - 'dpv:AutomatedDecisionMaking' - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:FixedOccurrencesDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' - '@type': DpvProcess processingOperation: - 'dpv:Profiling' context: '@type': DpvContext processingContext: - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:EndlessDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' dataExportStorageCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' userConsentScreenshot: '@type': SimpleAttachment content: JVBERi...JSVFT0Y= mimeType: application/pdf - '@type': ApiProductOrderItemAdd '@baseType': DCSProductOrderItem state: completed id: '3' productOffering: '@type': ProductOfferingRef id: 0a2782b7-81a7-4af9-9e4f-d51bc690ec2d '@referredType': OpenGatewayProductOffering product: '@type': ProductRef href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/fea0c794-d62d-40bb-a9a4-934336194dca id: fea0c794-d62d-40bb-a9a4-934336194dca '@referredType': ApiProduct productAction: '@type': ApiProductActionAdd targetApplication: '@type': ApplicationRef id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c '@referredType': Application externalIdentifier: '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerProduct id: device_location_bundle_0987 owner: ChannelPartner approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: 0a2782b7-81a7-4af9-9e4f-d51bc690ec2d_terms_1 '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' productOrderItemRelationship: - '@type': OpenGatewayOrderItemRelationship id: '2' relationshipType: requires channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: API Order representation. Retrieve_a_list_of_API_Product_Order_response: value: - '@type': ApiProductOrder id: 86387671-0997-461b-99c7-d624ffb0640c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/86387671-0997-461b-99c7-d624ffb0640c state: completed creationDate: '2025-02-02T12:00:00.00Z' completionDate: '2025-02-02T12:01:00.00Z' externalId: - '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerCustomerOrder id: order_2232342 owner: ChannelPartner description: Camara API order for an Application Owner productOrderItem: - '@type': ApiProductOrderItemAdd '@baseType': DCSProductOrderItem id: '1' state: completed productOffering: '@type': ProductOfferingRef id: 2d4ef4d3-08ce-441d-ac76-133b6dad0ccb '@referredType': OpenGatewayProductOffering product: '@type': ProductRef id: 8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb '@referredType': ApiProduct productAction: '@type': ApiProductActionAddDeviceLocationVerification '@baseType': ApiProductAction '@schemaLocation': >- https://mycsp.com/tmf-api/schema/Customer/ApiProductActionAddDeviceLocationVerification_example.schema.json purpose: 'dpv:FraudPreventionAndDetection' bestAccuracy: 500 targetApplication: '@type': ApplicationRef id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c '@referredType': Application externalIdentifier: '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerProduct id: device_location_1234 owner: ChannelPartner approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: 2d4ef4d3-08ce-441d-ac76-133b6dad0ccb_terms_1 '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' applicationLegalBasisForInputData: 'dpv:Consent' process: - '@type': DpvProcess processingOperation: - 'dpv:Assess' context: '@type': DpvContext processingContext: - 'dpv:AutomatedDecisionMaking' - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:FixedOccurrencesDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' - '@type': DpvProcess processingOperation: - 'dpv:Profiling' context: '@type': DpvContext processingContext: - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:EndlessDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' dataExportStorageCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' userConsentScreenshot: '@type': SimpleAttachment content: JVBERi...JSVFT0Y= mimeType: application/pdf channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole - '@type': ApiProductOrder id: d86065be-f2fd-490b-bb6a-dca24cc7f65a href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/d86065be-f2fd-490b-bb6a-dca24cc7f65a state: completed creationDate: '2025-03-02T12:00:00.00Z' completionDate: '2025-03-02T12:01:00.00Z' externalId: - '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerCustomerOrder id: order_2232342 owner: ChannelPartner description: Camara API Unsubscription for an Application Owner productOrderItem: - '@type': ProductOrderItemDelete '@baseType': DCSProductOrderItem '@schemaLocation': 'https://mycsp.com/tmf-api/schema/Customer/ApiProductOrderItemDelete.schema.json' id: '1' state: completed product: '@type': ProductRef id: 8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb '@referredType': ApiProduct channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole - '@type': ApiProductOrder id: c5c005c5-34f9-4e7d-99df-8a30da246f8b href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/c5c005c5-34f9-4e7d-99df-8a30da246f8b state: completed creationDate: '2025-01-01T10:00:00.00Z' completionDate: '2025-01-01T10:01:00.00Z' externalId: - '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerCustomerOrder id: order_6453 owner: ChannelPartner productOrderItem: - '@type': ApiProductOrderItemAdd '@baseType': DCSProductOrderItem state: completed id: '1' productOffering: '@type': ProductOfferingRef id: 5e9b10e5-d707-4a16-89d1-687c7f0bf81a '@referredType': OpenGatewayProductOffering product: '@type': ProductRef href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/33944716-d86f-4122-827b-307d74e6ca50 id: 33944716-d86f-4122-827b-307d74e6ca50 '@referredType': ApiProduct productAction: '@type': ApiProductActionAdd targetApplication: '@type': ApplicationRef id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c '@referredType': Application externalIdentifier: '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerProduct id: device_location_bundle_0987 owner: ChannelPartner approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: 5e9b10e5-d707-4a16-89d1-687c7f0bf81a_terms_1 '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' productOrderItemRelationship: - '@type': OpenGatewayOrderItemRelationship id: '2' relationshipType: bundles - '@type': OpenGatewayOrderItemRelationship id: '3' relationshipType: bundles - '@type': ApiProductOrderItemAdd '@baseType': DCSProductOrderItem state: completed id: '2' productOffering: '@type': ProductOfferingRef id: ab7792f8-6628-4c4b-a557-699adc26d4ce '@referredType': OpenGatewayProductOffering product: '@type': ProductRef href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/3be31371-2755-43f7-a6f6-380234910b9b id: 3be31371-2755-43f7-a6f6-380234910b9b '@referredType': ApiProduct productAction: '@type': ApiProductActionAddDeviceLocationVerificationBundled '@baseType': ApiProductActionAdd '@schemaLocation': >- https://mycsp.com/tmf-api/schema/Customer/ApiProductActionAddDeviceLocationVerificationBundled.schema.json purpose: 'dpv:FraudPreventionAndDetection' bestAccuracy: 500 targetApplication: '@type': ApplicationRef id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c '@referredType': Application externalIdentifier: '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerProduct id: device_location_bundle_0987 owner: ChannelPartner approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: ab7792f8-6628-4c4b-a557-699adc26d4ce_terms_1 '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' applicationLegalBasisForInputData: 'dpv:Consent' process: - '@type': DpvProcess processingOperation: - 'dpv:Assess' context: '@type': DpvContext processingContext: - 'dpv:AutomatedDecisionMaking' - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:FixedOccurrencesDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' - '@type': DpvProcess processingOperation: - 'dpv:Profiling' context: '@type': DpvContext processingContext: - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:EndlessDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' dataExportStorageCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' userConsentScreenshot: '@type': SimpleAttachment content: JVBERi...JSVFT0Y= mimeType: application/pdf - '@type': ApiProductOrderItemAdd '@baseType': DCSProductOrderItem state: completed id: '3' productOffering: '@type': ProductOfferingRef id: 0a2782b7-81a7-4af9-9e4f-d51bc690ec2d '@referredType': OpenGatewayProductOffering product: '@type': ProductRef href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/fea0c794-d62d-40bb-a9a4-934336194dca id: fea0c794-d62d-40bb-a9a4-934336194dca '@referredType': ApiProduct productAction: '@type': ApiProductActionAdd targetApplication: '@type': ApplicationRef id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c '@referredType': Application externalIdentifier: '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerProduct id: device_location_bundle_0987 owner: ChannelPartner approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: 0a2782b7-81a7-4af9-9e4f-d51bc690ec2d_terms_1 '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: A collection of API Order representation Retrieve_a_list_of_API_Product_Order_with_field_selection_and_filter_response: value: - '@type': ApiProductOrder id: 86387671-0997-461b-99c7-d624ffb0640c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/86387671-0997-461b-99c7-d624ffb0640c state: completed - '@type': ApiProductOrder id: d86065be-f2fd-490b-bb6a-dca24cc7f65a href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/d86065be-f2fd-490b-bb6a-dca24cc7f65a state: completed - '@type': ApiProductOrder id: c5c005c5-34f9-4e7d-99df-8a30da246f8b href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/c5c005c5-34f9-4e7d-99df-8a30da246f8b state: completed description: A collection of API Product Order with field selection and filter Retrieve_an_API_Product_location_verification_standalone_response: value: '@type': ApiProductDeviceLocationVerification '@baseType': ApiProduct '@schemaLocation': 'https://mycsp.com/tmf-api/schema/Product/ApiProductDeviceLocationVerification.schema.json' id: 8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb name: device_location_verification description: Open Gateway Device Location Verify creationDate: '2025-02-02T12:02:00.00Z' startDate: '2025-02-02T12:00:03.00Z' status: active productOffering: '@type': ProductOfferingRef id: 2d4ef4d3-08ce-441d-ac76-133b6dad0ccb name: Location Verification Antifraud CAMARA API Standalone '@referredType': OpenGatewayProductOffering productOrderItem: - '@type': RelatedOrderItem orderId: 86387671-0997-461b-99c7-d624ffb0640c orderHref: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/86387671-0997-461b-99c7-d624ffb0640c orderItemId: '1' orderItemAction: add productSpecification: '@type': ProductSpecificationRef id: 4b6591ef-5ede-4885-9543-0c5e9070ade9 href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIProductCatalog/v5/productSpecification/4b6591ef-5ede-4885-9543-0c5e9070ade9 name: Location Verification Antifraud CAMARA API version: 1.0.0 '@referredType': ApiProductSpecification apiName: location-verification apiVersionDetails: - '@type': ApiVersionDetails apiMajorVersion: 0 basePath: location-verification apiGrantInformation: - '@type': ApiGrantInformation purpose: 'dpv:FraudPreventionAndDetection' scope: - 'location-verification:verify' grantType: - 'urn:openid:params:grant-type:ciba' - authorization_code legalBasis: 'dpv:Consent' - '@type': ApiGrantInformation scope: - 'location-verification:read' grantType: - client_credentials purpose: 'dpv:FraudPreventionAndDetection' bestAccuracy: 500 approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: 2d4ef4d3-08ce-441d-ac76-133b6dad0ccb_terms_1 name: device_location_verification_terms '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' applicationLegalBasisForInputData: 'dpv:Consent' process: - '@type': DpvProcess processingOperation: - 'dpv:Assess' context: '@type': DpvContext processingContext: - 'dpv:AutomatedDecisionMaking' - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:FixedOccurrencesDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' - '@type': DpvProcess processingOperation: - 'dpv:Profiling' context: '@type': DpvContext processingContext: - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:EndlessDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' dataExportStorageCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' userConsentScreenshot: '@type': SimpleAttachment content: JVBERi...JSVFT0Y= mimeType: application/pdf channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: API Order representation. Retrieve_an_API_Product_location_verification_bundle_response: value: '@type': ApiProduct id: 33944716-d86f-4122-827b-307d74e6ca50 href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/33944716-d86f-4122-827b-307d74e6ca50 creationDate: '2025-01-01T10:02:00.00Z' startDate: '2025-01-01T10:03:00.00Z' status: active productOffering: '@type': ProductOfferingRef href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIProductCatalog/v5/productOffering/5e9b10e5-d707-4a16-89d1-687c7f0bf81a id: 5e9b10e5-d707-4a16-89d1-687c7f0bf81a name: Open Gateway Location Verification bundle offer '@referredType': OpenGatewayProductOffering productOrderItem: - '@type': RelatedOrderItem orderId: c5c005c5-34f9-4e7d-99df-8a30da246f8b orderHref: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/c5c005c5-34f9-4e7d-99df-8a30da246f8b orderItemId: '1' orderItemAction: add productRelationship: - '@type': OpenGatewayProductRelationship id: 3be31371-2755-43f7-a6f6-380234910b9b relationshipType: bundles - '@type': OpenGatewayProductRelationship id: fea0c794-d62d-40bb-a9a4-934336194dca relationshipType: bundles apiName: '' approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: 5e9b10e5-d707-4a16-89d1-687c7f0bf81a_terms_1 '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: API Order representation. Retrieve_an_API_Product_location_verification_API_bundled_response: value: '@type': ApiProductLocationVerificationAntifraud '@baseType': ApiProduct '@schemaLocation': >- https://mycsp.com/tmf-api/schemas/Tmf/Product/DCS/GSMAOperateAPI/LocationVerificationAntifraudStandalone.schema.json#/definitions/LocationVerificationAntifraudStandalone id: 3be31371-2755-43f7-a6f6-380234910b9b href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/3be31371-2755-43f7-a6f6-380234910b9b creationDate: '2025-01-01T10:02:00.00Z' startDate: '2025-01-01T10:03:00.00Z' status: active productOffering: '@type': ProductOfferingRef id: ab7792f8-6628-4c4b-a557-699adc26d4ce href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIProductCatalog/v5/productOffering/ab7792f8-6628-4c4b-a557-699adc26d4ce name: Location Verification Antifraud CAMARA API Bundled '@referredType': OpenGatewayProductOffering productOrderItem: - '@type': RelatedOrderItem orderId: c5c005c5-34f9-4e7d-99df-8a30da246f8b orderHref: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/c5c005c5-34f9-4e7d-99df-8a30da246f8b orderItemId: '2' orderItemAction: add productSpecification: '@type': ProductSpecificationRef id: 4b6591ef-5ede-4885-9543-0c5e9070ade9 href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIProductCatalog/v5/productSpecification/4b6591ef-5ede-4885-9543-0c5e9070ade9 name: Location Verification Antifraud CAMARA API version: 1.0.0 '@referredType': ApiProductSpecification apiName: location-verification apiVersionDetails: - '@type': ApiVersionDetails apiMajorVersion: 0 basePath: location-verification apiGrantInformation: - '@type': ApiGrantInformation purpose: 'dpv:FraudPreventionAndDetection' scope: - 'location-verification:verify' grantType: - 'urn:openid:params:grant-type:ciba' - authorization_code legalBasis: 'dpv:Consent' - '@type': ApiGrantInformation scope: - 'location-verification:read' grantType: - client_credentials purpose: 'dpv:FraudPreventionAndDetection' bestAccuracy: 500 approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: ab7792f8-6628-4c4b-a557-699adc26d4ce_terms_1 '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' applicationLegalBasisForInputData: 'dpv:Consent' process: - '@type': DpvProcess processingOperation: - 'dpv:Assess' context: '@type': DpvContext processingContext: - 'dpv:AutomatedDecisionMaking' - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:FixedOccurrencesDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' - '@type': DpvProcess processingOperation: - 'dpv:Profiling' context: '@type': DpvContext processingContext: - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:EndlessDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' dataExportStorageCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' userConsentScreenshot: '@type': SimpleAttachment content: JVBERi...JSVFT0Y= mimeType: application/pdf channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: API Order representation. Retrieve_an_API_Product_location_verification_usage_volume_bundled_response: value: '@type': UsageVolumeProductLocationVerification '@baseType': ApiProduct id: fea0c794-d62d-40bb-a9a4-934336194dca href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/fea0c794-d62d-40bb-a9a4-934336194dca creationDate: '2025-01-01T10:02:00.00Z' startDate: '2025-01-01T10:03:00.00Z' status: active productOffering: '@type': ProductOfferingRef id: 0a2782b7-81a7-4af9-9e4f-d51bc690ec2d href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIProductCatalog/v5/productOffering/0a2782b7-81a7-4af9-9e4f-d51bc690ec2d name: Location Verification Verify Usage Volume Recurring Bundled '@referredType': OpenGatewayProductOffering productOrderItem: - '@type': RelatedOrderItem orderId: c5c005c5-34f9-4e7d-99df-8a30da246f8b orderHref: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/c5c005c5-34f9-4e7d-99df-8a30da246f8b orderItemId: '3' orderItemAction: add productSpecification: '@type': ProductSpecificationRef id: a7b90fdb-00f7-498b-944e-88115d00626b href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIProductCatalog/v5/productSpecification/a7b90fdb-00f7-498b-944e-88115d00626b name: Location Verification Verify Usage Volume Recurring version: 1.0.0 '@referredType': UsageVolumeProductSpecification productRelationship: - '@type': OpenGatewayProductRelationship id: 3be31371-2755-43f7-a6f6-380234910b9b relationshipType: appliesOn apiName: '' usageVolume: volumeUnit: apiCall volumeInitialAmount: 10000 isBlocked: false isRecurring: true validityDuration: amount: 1 units: month approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: 0a2782b7-81a7-4af9-9e4f-d51bc690ec2d_terms_1 '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: API Order representation. Retrieve_a_list_of_API_Product_response: value: - '@type': ApiProductDeviceLocationVerification '@baseType': ApiProduct '@schemaLocation': >- https://mycsp.com/tmf-api/schema/Product/ApiProductDeviceLocationVerification.schema.json id: 8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb name: device_location_verification description: Open Gateway Device Location Verify creationDate: '2025-02-02T12:02:00.00Z' startDate: '2025-02-02T12:00:03.00Z' status: active productOffering: '@type': ProductOfferingRef id: 2d4ef4d3-08ce-441d-ac76-133b6dad0ccb name: Location Verification Antifraud CAMARA API Standalone '@referredType': OpenGatewayProductOffering productOrderItem: - '@type': RelatedOrderItem orderId: 86387671-0997-461b-99c7-d624ffb0640c orderHref: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/86387671-0997-461b-99c7-d624ffb0640c orderItemId: '1' orderItemAction: add productSpecification: '@type': ProductSpecificationRef id: 4b6591ef-5ede-4885-9543-0c5e9070ade9 '@referredType': ApiProductSpecification apiName: location-verification apiVersionDetails: - '@type': ApiVersionDetails apiMajorVersion: 0 basePath: location-verification apiGrantInformation: - '@type': ApiGrantInformation purpose: 'dpv:FraudPreventionAndDetection' scope: - 'location-verification:verify' grantType: - 'urn:openid:params:grant-type:ciba' - authorization_code legalBasis: 'dpv:Consent' - '@type': ApiGrantInformation scope: - 'location-verification:read' grantType: - client_credentials purpose: 'dpv:FraudPreventionAndDetection' bestAccuracy: 500 approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: 2d4ef4d3-08ce-441d-ac76-133b6dad0ccb_terms_1 name: device_location_verification_terms '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' applicationLegalBasisForInputData: 'dpv:Consent' process: - '@type': DpvProcess processingOperation: - 'dpv:Assess' context: '@type': DpvContext processingContext: - 'dpv:AutomatedDecisionMaking' - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:FixedOccurrencesDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' - '@type': DpvProcess processingOperation: - 'dpv:Profiling' context: '@type': DpvContext processingContext: - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:EndlessDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' dataExportStorageCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' userConsentScreenshot: '@type': SimpleAttachment content: JVBERi...JSVFT0Y= mimeType: application/pdf channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole - '@type': ApiProduct id: 33944716-d86f-4122-827b-307d74e6ca50 href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/33944716-d86f-4122-827b-307d74e6ca50 creationDate: '2025-01-01T10:02:00.00Z' startDate: '2025-01-01T10:03:00.00Z' status: active productOffering: '@type': ProductOfferingRef href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIProductCatalog/v5/productOffering/5e9b10e5-d707-4a16-89d1-687c7f0bf81a id: 5e9b10e5-d707-4a16-89d1-687c7f0bf81a name: Open Gateway Location Verification bundle offer '@referredType': OpenGatewayProductOffering productOrderItem: - '@type': RelatedOrderItem orderId: c5c005c5-34f9-4e7d-99df-8a30da246f8b orderHref: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/c5c005c5-34f9-4e7d-99df-8a30da246f8b orderItemId: '1' orderItemAction: add productRelationship: - '@type': OpenGatewayProductRelationship id: 3be31371-2755-43f7-a6f6-380234910b9b relationshipType: bundles - '@type': OpenGatewayProductRelationship id: fea0c794-d62d-40bb-a9a4-934336194dca relationshipType: bundles apiName: '' approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: 5e9b10e5-d707-4a16-89d1-687c7f0bf81a_terms_1 '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole - '@type': ApiProductLocationVerificationAntifraud '@baseType': ApiProduct '@schemaLocation': >- https://mycsp.com/tmf-api/schemas/Tmf/Product/DCS/GSMAOperateAPI/LocationVerificationAntifraudStandalone.schema.json#/definitions/LocationVerificationAntifraudStandalone id: 3be31371-2755-43f7-a6f6-380234910b9b href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/3be31371-2755-43f7-a6f6-380234910b9b creationDate: '2025-01-01T10:02:00.00Z' startDate: '2025-01-01T10:03:00.00Z' status: active productOffering: '@type': ProductOfferingRef id: ab7792f8-6628-4c4b-a557-699adc26d4ce href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIProductCatalog/v5/productOffering/ab7792f8-6628-4c4b-a557-699adc26d4ce name: Location Verification Antifraud CAMARA API Bundled '@referredType': OpenGatewayProductOffering productOrderItem: - '@type': RelatedOrderItem orderId: c5c005c5-34f9-4e7d-99df-8a30da246f8b orderHref: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/c5c005c5-34f9-4e7d-99df-8a30da246f8b orderItemId: '2' orderItemAction: add productSpecification: '@type': ProductSpecificationRef id: 4b6591ef-5ede-4885-9543-0c5e9070ade9 href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIProductCatalog/v5/productSpecification/4b6591ef-5ede-4885-9543-0c5e9070ade9 name: Location Verification Antifraud CAMARA API version: 1.0.0 '@referredType': ApiProductSpecification apiName: location-verification apiVersionDetails: - '@type': ApiVersionDetails apiMajorVersion: 0 basePath: location-verification apiGrantInformation: - '@type': ApiGrantInformation purpose: 'dpv:FraudPreventionAndDetection' scope: - 'location-verification:verify' grantType: - 'urn:openid:params:grant-type:ciba' - authorization_code legalBasis: 'dpv:Consent' - '@type': ApiGrantInformation scope: - 'location-verification:read' grantType: - client_credentials purpose: 'dpv:FraudPreventionAndDetection' bestAccuracy: 500 approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: ab7792f8-6628-4c4b-a557-699adc26d4ce_terms_1 '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' applicationLegalBasisForInputData: 'dpv:Consent' process: - '@type': DpvProcess processingOperation: - 'dpv:Assess' context: '@type': DpvContext processingContext: - 'dpv:AutomatedDecisionMaking' - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:FixedOccurrencesDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' - '@type': DpvProcess processingOperation: - 'dpv:Profiling' context: '@type': DpvContext processingContext: - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:EndlessDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' dataExportStorageCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' userConsentScreenshot: '@type': SimpleAttachment content: JVBERi...JSVFT0Y= mimeType: application/pdf channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole - '@type': UsageVolumeProductLocationVerification '@baseType': ApiProduct id: fea0c794-d62d-40bb-a9a4-934336194dca href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/fea0c794-d62d-40bb-a9a4-934336194dca creationDate: '2025-01-01T10:02:00.00Z' startDate: '2025-01-01T10:03:00.00Z' status: active productOffering: '@type': ProductOfferingRef id: 0a2782b7-81a7-4af9-9e4f-d51bc690ec2d href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIProductCatalog/v5/productOffering/0a2782b7-81a7-4af9-9e4f-d51bc690ec2d name: Location Verification Verify Usage Volume Recurring Bundled '@referredType': OpenGatewayProductOffering productOrderItem: - '@type': RelatedOrderItem orderId: c5c005c5-34f9-4e7d-99df-8a30da246f8b orderHref: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/c5c005c5-34f9-4e7d-99df-8a30da246f8b orderItemId: '3' orderItemAction: add productSpecification: '@type': ProductSpecificationRef id: a7b90fdb-00f7-498b-944e-88115d00626b href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIProductCatalog/v5/productSpecification/a7b90fdb-00f7-498b-944e-88115d00626b name: Location Verification Verify Usage Volume Recurring version: 1.0.0 '@referredType': UsageVolumeProductSpecification productRelationship: - '@type': OpenGatewayProductRelationship id: 3be31371-2755-43f7-a6f6-380234910b9b relationshipType: appliesOn apiName: '' usageVolume: volumeUnit: apiCall volumeInitialAmount: 10000 isBlocked: false isRecurring: true validityDuration: amount: 1 units: month approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: 0a2782b7-81a7-4af9-9e4f-d51bc690ec2d_terms_1 '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: A collection of API representation Retrieve_a_list_of_API_Product_with_field_selection_and_filter_response: value: - '@type': ApiProductDeviceLocationVerification id: 8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb status: active - '@type': ApiProduct id: 33944716-d86f-4122-827b-307d74e6ca50 href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/33944716-d86f-4122-827b-307d74e6ca50 status: active - '@type': ApiProductLocationVerificationAntifraud id: 3be31371-2755-43f7-a6f6-380234910b9b href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/3be31371-2755-43f7-a6f6-380234910b9b status: active - '@type': UsageVolumeProductLocationVerification id: fea0c794-d62d-40bb-a9a4-934336194dca href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/fea0c794-d62d-40bb-a9a4-934336194dca status: active description: A collection of API Product with field selection and filter Retrieve_an_Application_from_its_identifier_response: value: '@type': Application '@baseType': LogicalResource id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c name: Evolve Quest creationDate: '2024-12-02T14:00:00.00Z' commercialName: Evolve Quest logoUrl: 'https://channelpartner.com/opengateway/application/evolvequest/logo.jpg' privacyPolicyURL: 'https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html' description: Evolve Quest mobile application redirectUrl: - 'https://channelpartner.com/opengateway/application/evolvequest/redirect' jwksUri: 'https://channelpartner.com/opengateway/application/evolvequest/jwk' category: games operationalState: enable approvalStatus: approved digitalIdentity: '@type': ApiDigitalIdentity clientId: evolve_quest_channelPartner15 validFor: startDateTime: '2024-12-02T14:01:00.00Z' applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: 'https://contact.evolvequest.com' - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvequest.com channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: Application representation Retrieve_an_Application_with_permissions_from_its_identifier_response: value: '@type': Application '@baseType': LogicalResource id: '102' href: 'https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/102' name: Evolve West creationDate: '2024-12-02T14:10:00.00Z' commercialName: Evolve West logoUrl: 'https://channelpartner.com/opengateway/application/evolvequest/logo.jpg' privacyPolicyURL: 'https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html' description: Evolve West mobile application redirectUrl: - 'https://channelpartner.com/opengateway/application/evolvequest/redirect' jwksUri: 'https://channelpartner.com/opengateway/application/evolvequest/jwk' category: games operationalState: enable approvalStatus: approved digitalIdentity: '@type': ApiDigitalIdentity clientId: evolve_west_channelPartner15 validFor: startDateTime: '2024-12-02T14:11:00.00Z' apiConsumerRole: - grantedPermissionSet: - '@type': ApiPermissionSet creationDate: '2025-04-02T15:00:00.00Z' permission: '@type': ApiConsumerPermission managedAssetGroup: '@type': ApiListAssetGroup '@baseType': AssetGroup apiProduct: - '@type': ProductRef id: '123' '@referredType': ApiProduct validFor: startDateTime: '2025-04-02T15:00:00.00Z' applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: 'https://contact.evolvewest.com' - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvewest.com channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: Application representation Retrieve_an_Application_without_digital_identity_from_its_identifier_response: value: '@type': Application '@baseType': LogicalResource id: '103' href: 'https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/103' name: Evolve East creationDate: '2024-12-02T14:20:00.00Z' commercialName: Evolve East logoUrl: 'https://evolveeast.com/logo.jpg' privacyPolicyURL: 'https://evolveeast.com/privacyPolicy.html' description: Evolve East mobile application category: games operationalState: enable approvalStatus: approved applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole externalIdentifier: - '@type': ExternalIdentifier id: application_123 owner: ChannelPartner externalIdentifierType: Application privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: 'https://contact.evolveeast.com' - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolveeast.com channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: Application representation Retrieve_a_list_of_Application_response: value: - '@type': Application '@baseType': LogicalResource id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c name: Evolve Quest creationDate: '2024-12-02T14:00:00.00Z' commercialName: Evolve Quest logoUrl: 'https://channelpartner.com/opengateway/application/evolvequest/logo.jpg' privacyPolicyURL: 'https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html' description: Evolve Quest mobile application redirectUrl: - 'https://channelpartner.com/opengateway/application/evolvequest/redirect' jwksUri: 'https://channelpartner.com/opengateway/application/evolvequest/jwk' category: games operationalState: enable approvalStatus: approved digitalIdentity: '@type': ApiDigitalIdentity clientId: evolve_quest_channelPartner15 validFor: startDateTime: '2024-12-02T14:01:00.00Z' applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: 'https://contact.evolvequest.com' - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvequest.com channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole - '@type': Application '@baseType': LogicalResource id: '102' href: 'https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/102' name: Evolve West creationDate: '2024-12-02T14:10:00.00Z' commercialName: Evolve West logoUrl: 'https://channelpartner.com/opengateway/application/evolvequest/logo.jpg' privacyPolicyURL: 'https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html' description: Evolve West mobile application redirectUrl: - 'https://channelpartner.com/opengateway/application/evolvequest/redirect' jwksUri: 'https://channelpartner.com/opengateway/application/evolvequest/jwk' category: games operationalState: enable approvalStatus: approved digitalIdentity: '@type': ApiDigitalIdentity clientId: evolve_west_channelPartner15 validFor: startDateTime: '2024-12-02T14:11:00.00Z' apiConsumerRole: - grantedPermissionSet: - '@type': ApiPermissionSet creationDate: '2025-04-02T15:00:00.00Z' permission: '@type': ApiConsumerPermission managedAssetGroup: '@type': ApiListAssetGroup '@baseType': AssetGroup apiProduct: - '@type': ProductRef id: '123' '@referredType': ApiProduct validFor: startDateTime: '2025-04-02T15:00:00.00Z' applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: 'https://contact.evolvewest.com' - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvewest.com channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: A collection of Application representation Retrieve_a_list_of_Application_with_field_selection_and_filter_response: value: - '@type': Application '@baseType': LogicalResource id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c approvalStatus: approved applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 - '@type': Application '@baseType': LogicalResource id: '102' href: 'https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/102' approvalStatus: approved applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole description: A collection of Application with field selection and filter Retrieve_an_ApplicationOwner_from_its_identifier_response: value: '@type': ApplicationOwner id: e05b75dc-f843-40d9-8d16-112275a28385 href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/applicationOwner/e05b75dc-f843-40d9-8d16-112275a28385 name: Funtastic Games application owner role creationDate: '2024-12-01T13:00:00.00Z' description: Application owner role in the Open Gateway context engagedParty: '@type': ApplicationOwnerOrganization name: Funtastic Games SA tradingName: Funtastic Games isLegalEntity: true organizationType: 'dpv:ForProfitOrganisation' privacyPolicyURL: 'https://www.funtasticgames.com/privacy' taxNumber: 00.623.904/0001-73 organizationIdentification: - '@type': OrganizationIdentification identificationType: CNPJ identificationId: 00.623.904/0001-73 issuingAuthority: Receita Federal externalReference: - '@type': ExternalIdentifier id: funtastic_games_asp externalIdentifierType: ApplicationOwnerOrganization owner: ChannelPartner registeredGeographicAddress: '@type': LightGeographicAddress streetNr: '123' streetName: Avenida Paulista locality: Paraiso city: Sao Paulo stateOrProvince: Sao Paulo countryCode: '@type': ISO31661Alpha2StandardIdentifier value: BR postcode: 01311-000 geographicSubAddress: '@type': LightGeographicSubAddress buildingName: Fogo levelNumber: Planta 4 contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: contact@funtasticgames.com legalRepresentative: '@type': ApplicationOwnerRelatedIndividual familyName: OConnor givenName: Jane contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: jane@funtasticgames.com dataProtectionOfficer: '@type': ApplicationOwnerRelatedOrganization name: DPO Office organizationType: 'dpv:OrganisationalUnit' contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: dpo@funtasticgames.com privacyManager: '@type': ApplicationOwnerRelatedOrganization name: Privacy Office organizationType: 'dpv:OrganisationalUnit' contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: privacy@funtasticgames.com localRepresentative: - '@type': ApplicationOwnerRelatedLocalRepresentative countryCode: '@type': ISO31661Alpha2StandardIdentifier value: EU representative: '@type': ApplicationOwnerRelatedIndividual familyName: Juan givenName: Garcia contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium '@schemaLocation': 'https://mycsp.com/tmf-api/schema/Common/EmailContactMedium.schema.json' id: jgarcia preferred: true emailAddress: jgarcia@funtasticgames.com status: active approvalStatus: pendingApproval channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: ApplicationOwner representation. Retrieve_a_list_of_ApplicationOwner_response: value: - '@type': ApplicationOwner id: e05b75dc-f843-40d9-8d16-112275a28385 href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/applicationOwner/e05b75dc-f843-40d9-8d16-112275a28385 name: Funtastic Games application owner role creationDate: '2024-12-01T13:00:00.00Z' description: Application owner role in the Open Gateway context engagedParty: '@type': ApplicationOwnerOrganization name: Funtastic Games SA tradingName: Funtastic Games isLegalEntity: true organizationType: 'dpv:ForProfitOrganisation' privacyPolicyURL: 'https://www.funtasticgames.com/privacy' taxNumber: 00.623.904/0001-73 organizationIdentification: - '@type': OrganizationIdentification identificationType: CNPJ identificationId: 00.623.904/0001-73 issuingAuthority: Receita Federal externalReference: - '@type': ExternalIdentifier id: funtastic_games_asp externalIdentifierType: ApplicationOwnerOrganization owner: ChannelPartner registeredGeographicAddress: '@type': LightGeographicAddress streetNr: '123' streetName: Avenida Paulista locality: Paraiso city: Sao Paulo stateOrProvince: Sao Paulo countryCode: '@type': ISO31661Alpha2StandardIdentifier value: BR postcode: 01311-000 geographicSubAddress: '@type': LightGeographicSubAddress buildingName: Fogo levelNumber: Planta 4 contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: contact@funtasticgames.com legalRepresentative: '@type': ApplicationOwnerRelatedIndividual familyName: OConnor givenName: Jane contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: jane@funtasticgames.com dataProtectionOfficer: '@type': ApplicationOwnerRelatedOrganization name: DPO Office organizationType: 'dpv:OrganisationalUnit' contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: dpo@funtasticgames.com privacyManager: '@type': ApplicationOwnerRelatedOrganization name: Privacy Office organizationType: 'dpv:OrganisationalUnit' contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: privacy@funtasticgames.com localRepresentative: - '@type': ApplicationOwnerRelatedLocalRepresentative countryCode: '@type': ISO31661Alpha2StandardIdentifier value: EU representative: '@type': ApplicationOwnerRelatedIndividual familyName: Juan givenName: Garcia contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium '@schemaLocation': 'https://mycsp.com/tmf-api/schema/Common/EmailContactMedium.schema.json' id: jgarcia preferred: true emailAddress: jgarcia@funtasticgames.com status: active approvalStatus: pendingApproval channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: A collection of ApplicationOwner representation Retrieve_a_list_of_ApplicationOwner_with_field_selection_and_filter_response: value: - '@type': ApplicationOwner href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/applicationOwner/e05b75dc-f843-40d9-8d16-112275a28385 id: e05b75dc-f843-40d9-8d16-112275a28385 approvalStatus: approved description: A collection of ApplicationOwner with field selection and filter Retrieve_a_Monitor_from_its_identifier_response: value: '@type': Monitor id: 77795e7f-5213-4b9c-b672-6838a6b76152 href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/monitor/77795e7f-5213-4b9c-b672-6838a6b76152 state: Completed request: method: POST to: 'https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application' body: '@type': Application '@baseType': LogicalResource name: Evolve Quest commercialName: Evolve Quest logoUrl: 'https://channelpartner.com/opengateway/application/evolvequest/logo.jpg' privacyPolicyURL: 'https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html' description: Evolve Quest mobile application redirectUrl: - 'https://channelpartner.com/opengateway/application/evolvequest/redirect' jwksUri: 'https://channelpartner.com/opengateway/application/evolvequest/jwk' category: games applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: 'https://contact.evolvequest.com' - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvequest.com externalIdentifier: - '@type': ExternalIdentifier id: application_123 owner: ChannelPartner externalIdentifierType: Application response: statusCode: '201' body: '@type': Application '@baseType': LogicalResource id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c name: Evolve Quest commercialName: Evolve Quest logoUrl: 'https://channelpartner.com/opengateway/application/evolvequest/logo.jpg' privacyPolicyURL: 'https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html' description: Evolve Quest mobile application redirectUrl: - 'https://channelpartner.com/opengateway/application/evolvequest/redirect' jwksUri: 'https://channelpartner.com/opengateway/application/evolvequest/jwk' category: games operationalState: enable approvalStatus: approved digitalIdentity: '@type': ApiDigitalIdentity clientId: evolve_quest_channelPartner15 validFor: startDateTime: '2024-12-02T14:01:00.00Z' applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: 'https://contact.evolvequest.com' - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvequest.com externalIdentifier: - '@type': ExternalIdentifier id: application_123 owner: ChannelPartner externalIdentifierType: Application channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole sourceHref: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c description: Monitor representation. Retrieve_a_list_of_Monitor_response: value: - '@type': Monitor id: 77795e7f-5213-4b9c-b672-6838a6b76152 href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/monitor/77795e7f-5213-4b9c-b672-6838a6b76152 state: Completed request: method: POST to: 'https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application' body: '@type': Application '@baseType': LogicalResource name: Evolve Quest commercialName: Evolve Quest logoUrl: 'https://channelpartner.com/opengateway/application/evolvequest/logo.jpg' privacyPolicyURL: 'https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html' description: Evolve Quest mobile application redirectUrl: - 'https://channelpartner.com/opengateway/application/evolvequest/redirect' jwksUri: 'https://channelpartner.com/opengateway/application/evolvequest/jwk' category: games applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: 'https://contact.evolvequest.com' - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvequest.com externalIdentifier: - '@type': ExternalIdentifier id: application_123 owner: ChannelPartner externalIdentifierType: Application response: statusCode: '201' body: '@type': Application '@baseType': LogicalResource id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c name: Evolve Quest commercialName: Evolve Quest logoUrl: 'https://channelpartner.com/opengateway/application/evolvequest/logo.jpg' privacyPolicyURL: 'https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html' description: Evolve Quest mobile application redirectUrl: - 'https://channelpartner.com/opengateway/application/evolvequest/redirect' jwksUri: 'https://channelpartner.com/opengateway/application/evolvequest/jwk' category: games operationalState: enable approvalStatus: approved digitalIdentity: '@type': ApiDigitalIdentity clientId: evolve_quest_channelPartner15 validFor: startDateTime: '2024-12-02T14:01:00.00Z' applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: 'https://contact.evolvequest.com' - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvequest.com externalIdentifier: - '@type': ExternalIdentifier id: application_123 owner: ChannelPartner externalIdentifierType: Application channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole sourceHref: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c description: A collection of Monitor representation Retrieve_a_list_of_Monitor_with_field_selection_and_filter_response: value: - '@type': Monitor id: 77795e7f-5213-4b9c-b672-6838a6b76152 href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/monitor/77795e7f-5213-4b9c-b672-6838a6b76152 state: Completed sourceHref: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c description: A collection of Monitor with field selection and filter Create_an_API_Product_Order_for_ordering_subscribe_a_new_ProductOffering_request: value: '@type': ApiProductOrder externalId: - '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerCustomerOrder id: order_2232342 owner: ChannelPartner description: Camara API order for an Application Owner productOrderItem: - '@type': ApiProductOrderItemAdd '@baseType': DCSProductOrderItem id: '1' productOffering: '@type': ProductOfferingRef id: 2d4ef4d3-08ce-441d-ac76-133b6dad0ccb name: Location Verification Antifraud CAMARA API Standalone '@referredType': OpenGatewayProductOffering productAction: '@type': ApiProductActionAddDeviceLocationVerification '@baseType': ApiProductActionAdd '@schemaLocation': >- https://mycsp.com/tmf-api/schema/Customer/ApiProductActionAddDeviceLocationVerification.schema.json purpose: 'dpv:FraudPreventionAndDetection' bestAccuracy: 500 targetApplication: '@type': ApplicationRef id: f1cba17d-789a-4037-b3e3-2c96e887576c '@referredType': Application externalIdentifier: '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerProduct id: device_location_1234 owner: ChannelPartner approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: 2d4ef4d3-08ce-441d-ac76-133b6dad0ccb_terms_1 name: device_location_verification_terms '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-10-20T00:00:00.000Z' applicationLegalBasisForInputData: 'dpv:Consent' process: - '@type': DpvProcess processingOperation: - 'dpv:Assess' context: '@type': DpvContext processingContext: - 'dpv:AutomatedDecisionMaking' - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:FixedOccurrencesDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' - '@type': DpvProcess processingOperation: - 'dpv:Profiling' context: '@type': DpvContext processingContext: - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:EndlessDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' dataExportStorageCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' userConsentScreenshot: '@type': SimpleAttachment content: JVBERi...JSVFT0Y= mimeType: application/pdf description: POST API Order Request Example Create_an_API_Product_Order_for_ordering_subscribe_a_new_ProductOffering_response: value: '@type': ApiProductOrder id: 86387671-0997-461b-99c7-d624ffb0640c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/86387671-0997-461b-99c7-d624ffb0640c state: acknowledged creationDate: '2025-02-02T12:00:00.00Z' externalId: - '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerCustomerOrder id: order_2232342 owner: ChannelPartner description: Camara API order for an Application Owner productOrderItem: - '@type': ApiProductOrderItemAdd '@baseType': DCSProductOrderItem id: '1' state: completed productOffering: '@type': ProductOfferingRef id: 2d4ef4d3-08ce-441d-ac76-133b6dad0ccb name: Location Verification Antifraud CAMARA API Standalone '@referredType': OpenGatewayProductOffering productAction: '@type': ApiProductActionAddDeviceLocationVerification '@baseType': ApiProductActionAdd '@schemaLocation': >- https://mycsp.com/tmf-api/schema/Customer/ApiProductActionAddDeviceLocationVerification.schema.json purpose: 'dpv:FraudPreventionAndDetection' bestAccuracy: 500 targetApplication: '@type': ApplicationRef id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c '@referredType': Application externalIdentifier: '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerProduct id: device_location_1234 owner: ChannelPartner approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: 2d4ef4d3-08ce-441d-ac76-133b6dad0ccb_terms_1 name: device_location_verification_terms '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-10-20T00:00:00.000Z' applicationLegalBasisForInputData: 'dpv:Consent' process: - '@type': DpvProcess processingOperation: - 'dpv:Assess' context: '@type': DpvContext processingContext: - 'dpv:AutomatedDecisionMaking' - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:FixedOccurrencesDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' - '@type': DpvProcess processingOperation: - 'dpv:Profiling' context: '@type': DpvContext processingContext: - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:EndlessDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' dataExportStorageCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' userConsentScreenshot: '@type': SimpleAttachment content: JVBERi...JSVFT0Y= mimeType: application/pdf channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: POST API Order Response Example Create_an_API_Product_Order_for_ordering_unsubscribe_the_removal_of_an_existing_Product_request: value: '@type': ApiProductOrder externalId: - '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerCustomerOrder id: order_2232342 owner: ChannelPartner description: Camara API Unsubscription for an Application Owner productOrderItem: - '@type': ProductOrderItemDelete '@baseType': DCSProductOrderItem id: '1' product: '@type': ProductRef id: 8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb '@referredType': ApiProduct description: POST API Order Request Example Create_an_API_Product_Order_for_ordering_unsubscribe_the_removal_of_an_existing_Product_response: value: '@type': ApiProductOrder id: d86065be-f2fd-490b-bb6a-dca24cc7f65a href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/d86065be-f2fd-490b-bb6a-dca24cc7f65a state: acknowledged creationDate: '2025-03-02T12:00:00.00Z' externalId: - '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerCustomerOrder id: order_2232342 owner: ChannelPartner description: Camara API Unsubscription for an Application Owner productOrderItem: - '@type': ProductOrderItemDelete '@baseType': DCSProductOrderItem '@schemaLocation': 'https://mycsp.com/tmf-api/schema/Customer/ProductOrderItemDelete.schema.json' id: '1' state: acknowledged product: '@type': ProductRef id: 8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb '@referredType': ApiProduct channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: POST API Order Response Example Create_an_API_Product_Order_for_ordering_subscribe_a_new_ProductOffering_bundle_request: value: '@type': ApiProductOrder externalId: - '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerCustomerOrder id: order_6453 owner: ChannelPartner productOrderItem: - '@type': ApiProductOrderItemAdd '@baseType': DCSProductOrderItem id: '1' productOffering: '@type': ProductOfferingRef id: 5e9b10e5-d707-4a16-89d1-687c7f0bf81a '@referredType': OpenGatewayProductOffering productAction: '@type': ApiProductActionAdd targetApplication: '@type': ApplicationRef id: f1cba17d-789a-4037-b3e3-2c96e887576c '@referredType': Application externalIdentifier: '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerProduct id: device_location_bundle_0987 owner: ChannelPartner approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: 5e9b10e5-d707-4a16-89d1-687c7f0bf81a_terms_1 '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' productOrderItemRelationship: - '@type': OpenGatewayOrderItemRelationship id: '2' relationshipType: bundles - '@type': OpenGatewayOrderItemRelationship id: '3' relationshipType: bundles - '@type': ApiProductOrderItemAdd '@baseType': DCSProductOrderItem id: '2' productOffering: '@type': ProductOfferingRef id: ab7792f8-6628-4c4b-a557-699adc26d4ce '@referredType': OpenGatewayProductOffering productAction: '@type': ApiProductActionAddDeviceLocationVerificationBundled '@baseType': ApiProductActionAdd '@schemaLocation': >- https://mycsp.com/tmf-api/schema/Customer/ApiProductActionAddDeviceLocationVerificationBundled.schema.json purpose: 'dpv:FraudPreventionAndDetection' bestAccuracy: 500 targetApplication: '@type': ApplicationRef id: f1cba17d-789a-4037-b3e3-2c96e887576c '@referredType': Application externalIdentifier: '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerProduct id: device_location_bundle_0987 owner: ChannelPartner approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: ab7792f8-6628-4c4b-a557-699adc26d4ce_terms_1 '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' applicationLegalBasisForInputData: 'dpv:Consent' process: - '@type': DpvProcess processingOperation: - 'dpv:Assess' context: '@type': DpvContext processingContext: - 'dpv:AutomatedDecisionMaking' - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:FixedOccurrencesDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' - '@type': DpvProcess processingOperation: - 'dpv:Profiling' context: '@type': DpvContext processingContext: - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:EndlessDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' dataExportStorageCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' userConsentScreenshot: '@type': SimpleAttachment content: JVBERi...JSVFT0Y= mimeType: application/pdf - '@type': ApiProductOrderItemAdd '@baseType': DCSProductOrderItem id: '3' productOffering: '@type': ProductOfferingRef id: 0a2782b7-81a7-4af9-9e4f-d51bc690ec2d '@referredType': OpenGatewayProductOffering productAction: '@type': ApiProductActionAdd targetApplication: '@type': ApplicationRef id: f1cba17d-789a-4037-b3e3-2c96e887576c '@referredType': Application externalIdentifier: '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerProduct id: device_location_bundle_0987 owner: ChannelPartner approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: 0a2782b7-81a7-4af9-9e4f-d51bc690ec2d_terms_1 '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' description: POST API Order Request Example Create_an_API_Product_Order_for_ordering_subscribe_a_new_ProductOffering_bundle_response: value: '@type': ApiProductOrder id: c5c005c5-34f9-4e7d-99df-8a30da246f8b href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/c5c005c5-34f9-4e7d-99df-8a30da246f8b state: acknowledged creationDate: '2025-01-01T10:00:00.00Z' externalId: - '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerCustomerOrder id: order_6453 owner: ChannelPartner productOrderItem: - '@type': ApiProductOrderItemAdd '@baseType': DCSProductOrderItem state: acknowledged id: '1' productOffering: '@type': ProductOfferingRef id: 5e9b10e5-d707-4a16-89d1-687c7f0bf81a '@referredType': OpenGatewayProductOffering productAction: '@type': ApiProductActionAdd targetApplication: '@type': ApplicationRef id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c '@referredType': Application externalIdentifier: '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerProduct id: device_location_bundle_0987 owner: ChannelPartner approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: 5e9b10e5-d707-4a16-89d1-687c7f0bf81a_terms_1 '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' productOrderItemRelationship: - '@type': OpenGatewayOrderItemRelationship id: '2' relationshipType: bundles - '@type': OpenGatewayOrderItemRelationship id: '3' relationshipType: bundles - '@type': ApiProductOrderItemAdd '@baseType': DCSProductOrderItem state: acknowledged id: '2' productOffering: '@type': ProductOfferingRef id: ab7792f8-6628-4c4b-a557-699adc26d4ce '@referredType': OpenGatewayProductOffering productAction: '@type': ApiProductActionAddDeviceLocationVerificationBundled '@baseType': ApiProductActionAdd '@schemaLocation': >- https://mycsp.com/tmf-api/schema/Customer/ApiProductActionAddDeviceLocationVerificationBundled.schema.json purpose: 'dpv:FraudPreventionAndDetection' bestAccuracy: 500 targetApplication: '@type': ApplicationRef id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c '@referredType': Application externalIdentifier: '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerProduct id: device_location_bundle_0987 owner: ChannelPartner approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: ab7792f8-6628-4c4b-a557-699adc26d4ce_terms_1 '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' applicationLegalBasisForInputData: 'dpv:Consent' process: - '@type': DpvProcess processingOperation: - 'dpv:Assess' context: '@type': DpvContext processingContext: - 'dpv:AutomatedDecisionMaking' - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:FixedOccurrencesDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' - '@type': DpvProcess processingOperation: - 'dpv:Profiling' context: '@type': DpvContext processingContext: - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:EndlessDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' dataExportStorageCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' userConsentScreenshot: '@type': SimpleAttachment content: JVBERi...JSVFT0Y= mimeType: application/pdf - '@type': ApiProductOrderItemAdd '@baseType': DCSProductOrderItem state: acknowledged id: '3' productOffering: '@type': ProductOfferingRef id: 0a2782b7-81a7-4af9-9e4f-d51bc690ec2d '@referredType': OpenGatewayProductOffering productAction: '@type': ApiProductActionAdd targetApplication: '@type': ApplicationRef id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c '@referredType': Application externalIdentifier: '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerProduct id: device_location_bundle_0987 owner: ChannelPartner approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: 0a2782b7-81a7-4af9-9e4f-d51bc690ec2d_terms_1 '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' productOrderItemRelationship: - '@type': OpenGatewayOrderItemRelationship id: '2' relationshipType: requires channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: POST API Order Response Example Create_an_Application_request: value: '@type': Application '@baseType': LogicalResource name: Evolve Quest commercialName: Evolve Quest logoUrl: 'https://channelpartner.com/opengateway/application/evolvequest/logo.jpg' privacyPolicyURL: 'https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html' description: Evolve Quest mobile application redirectUrl: - 'https://channelpartner.com/opengateway/application/evolvequest/redirect' jwksUri: 'https://channelpartner.com/opengateway/application/evolvequest/jwk' category: games applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: 'https://contact.evolvequest.com' - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvequest.com externalIdentifier: - '@type': ExternalIdentifier id: application_123 owner: ChannelPartner externalIdentifierType: Application description: POST Application Request Example Create_an_Application_response: value: '@type': Application '@baseType': LogicalResource id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c name: Evolve Quest creationDate: '2024-12-02T14:00:00.00Z' commercialName: Evolve Quest logoUrl: 'https://channelpartner.com/opengateway/application/evolvequest/logo.jpg' privacyPolicyURL: 'https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html' description: Evolve Quest mobile application redirectUrl: - 'https://channelpartner.com/opengateway/application/evolvequest/redirect' jwksUri: 'https://channelpartner.com/opengateway/application/evolvequest/jwk' category: games operationalState: enable approvalStatus: approved digitalIdentity: '@type': ApiDigitalIdentity clientId: evolve_quest_channelPartner15 applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: 'https://contact.evolvequest.com' - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvequest.com externalIdentifier: - '@type': ExternalIdentifier id: application_123 owner: ChannelPartner externalIdentifierType: Application channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: POST Application Response Example Create_an_ApplicationOwner_request: value: '@type': ApplicationOwner name: Funtastic Games application owner role description: Application owner role in the Open Gateway context engagedParty: '@type': ApplicationOwnerOrganization name: Funtastic Games SA tradingName: Funtastic Games isLegalEntity: true organizationType: 'dpv:ForProfitOrganisation' privacyPolicyURL: 'https://www.funtasticgames.com/privacy' taxNumber: 00.623.904/0001-73 organizationIdentification: - '@type': OrganizationIdentification identificationType: CNPJ identificationId: 00.623.904/0001-73 issuingAuthority: Receita Federal externalReference: - '@type': ExternalIdentifier id: funtastic_games_asp externalIdentifierType: ApplicationOwnerOrganization owner: ChannelPartner registeredGeographicAddress: '@type': LightGeographicAddress streetNr: '123' streetName: Avenida Paulista locality: Paraiso city: Sao Paulo stateOrProvince: Sao Paulo countryCode: '@type': ISO31661Alpha2StandardIdentifier value: BR postcode: 01311-000 geographicSubAddress: '@type': LightGeographicSubAddress buildingName: Fogo levelNumber: Planta 4 contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: contact@funtasticgames.com legalRepresentative: '@type': ApplicationOwnerRelatedIndividual familyName: OConnor givenName: Jane contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: jane@funtasticgames.com dataProtectionOfficer: '@type': ApplicationOwnerRelatedOrganization name: DPO Office organizationType: 'dpv:OrganisationalUnit' contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: dpo@funtasticgames.com privacyManager: '@type': ApplicationOwnerRelatedOrganization name: Privacy Office organizationType: 'dpv:OrganisationalUnit' contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: privacy@funtasticgames.com localRepresentative: - '@type': ApplicationOwnerRelatedLocalRepresentative countryCode: '@type': ISO31661Alpha2StandardIdentifier value: EU representative: '@type': ApplicationOwnerRelatedIndividual familyName: Juan givenName: Garcia contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium '@schemaLocation': 'https://mycsp.com/tmf-api/schema/Common/EmailContactMedium.schema.json' id: jgarcia preferred: true emailAddress: jgarcia@funtasticgames.com description: POST ApplicationOwner Request Example Create_an_ApplicationOwner_response: value: '@type': ApplicationOwner id: e05b75dc-f843-40d9-8d16-112275a28385 href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/applicationOwner/e05b75dc-f843-40d9-8d16-112275a28385 name: Funtastic Games application owner role creationDate: '2024-12-01T13:00:00.00Z' description: Application owner role in the Open Gateway context engagedParty: '@type': ApplicationOwnerOrganization name: Funtastic Games SA tradingName: Funtastic Games isLegalEntity: true organizationType: 'dpv:ForProfitOrganisation' privacyPolicyURL: 'https://www.funtasticgames.com/privacy' taxNumber: 00.623.904/0001-73 organizationIdentification: - '@type': OrganizationIdentification identificationType: CNPJ identificationId: 00.623.904/0001-73 issuingAuthority: Receita Federal externalReference: - '@type': ExternalIdentifier id: funtastic_games_asp externalIdentifierType: ApplicationOwnerOrganization owner: ChannelPartner registeredGeographicAddress: '@type': LightGeographicAddress streetNr: '123' streetName: Avenida Paulista locality: Paraiso city: Sao Paulo stateOrProvince: Sao Paulo countryCode: '@type': ISO31661Alpha2StandardIdentifier value: BR postcode: 01311-000 geographicSubAddress: '@type': LightGeographicSubAddress buildingName: Fogo levelNumber: Planta 4 contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: contact@funtasticgames.com legalRepresentative: '@type': ApplicationOwnerRelatedIndividual familyName: OConnor givenName: Jane contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: jane@funtasticgames.com dataProtectionOfficer: '@type': ApplicationOwnerRelatedOrganization name: DPO Office organizationType: 'dpv:OrganisationalUnit' contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: dpo@funtasticgames.com privacyManager: '@type': ApplicationOwnerRelatedOrganization name: Privacy Office organizationType: 'dpv:OrganisationalUnit' contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: privacy@funtasticgames.com localRepresentative: - '@type': ApplicationOwnerRelatedLocalRepresentative countryCode: '@type': ISO31661Alpha2StandardIdentifier value: EU representative: '@type': ApplicationOwnerRelatedIndividual familyName: Juan givenName: Garcia contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: jgarcia preferred: true emailAddress: jgarcia@funtasticgames.com status: active approvalStatus: pendingApproval channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: POST ApplicationOwner Response Example Update_an_Application_with_json_content_type_request: value: '@type': Application operationalState: disable description: Updating an Application object. Update_an_Application_with_json_content_type_response: value: '@type': Application '@baseType': LogicalResource id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c name: Evolve Quest creationDate: '2024-12-02T14:00:00.00Z' commercialName: Evolve Quest logoUrl: 'https://channelpartner.com/opengateway/application/evolvequest/logo.jpg' privacyPolicyURL: 'https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html' description: Evolve Quest mobile application redirectUrl: - 'https://channelpartner.com/opengateway/application/evolvequest/redirect' jwksUri: 'https://channelpartner.com/opengateway/application/evolvequest/jwk' category: games operationalState: disable approvalStatus: approved digitalIdentity: '@type': ApiDigitalIdentity clientId: evolve_quest_channelPartner15 validFor: startDateTime: '2024-12-02T14:01:00.00Z' applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: 'https://contact.evolvequest.com' - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvequest.com externalIdentifier: - '@type': ExternalIdentifier id: application_123 owner: ChannelPartner externalIdentifierType: Application channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: A response after PATCH-ing an Application object. Update_an_Application_with_merge-patch_json_content_type_request: value: '@type': Application operationalState: disable description: An example of a request for updating an Application object. Update_an_Application_with_merge-patch_json_content_type_response: value: '@type': Application '@baseType': LogicalResource id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c name: Evolve Quest creationDate: '2024-12-02T14:00:00.00Z' commercialName: Evolve Quest logoUrl: 'https://channelpartner.com/opengateway/application/evolvequest/logo.jpg' privacyPolicyURL: 'https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html' description: Evolve Quest mobile application redirectUrl: - 'https://channelpartner.com/opengateway/application/evolvequest/redirect' jwksUri: 'https://channelpartner.com/opengateway/application/evolvequest/jwk' category: games operationalState: disable approvalStatus: approved digitalIdentity: '@type': ApiDigitalIdentity clientId: evolve_quest_channelPartner15 validFor: startDateTime: '2024-12-02T14:01:00.00Z' applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: 'https://contact.evolvequest.com' - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvequest.com externalIdentifier: - '@type': ExternalIdentifier id: application_123 owner: ChannelPartner externalIdentifierType: Application channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: An example of a response for updating an Application object. Update_an_Application_with_json-patch_json_content_type_request: value: - op: replace path: /operationalState value: disable description: An example of a request for updating an Application object. Update_an_Application_with_json-patch_json_content_type_response: value: '@type': Application '@baseType': LogicalResource id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c name: Evolve Quest creationDate: '2024-12-02T14:00:00.00Z' commercialName: Evolve Quest logoUrl: 'https://channelpartner.com/opengateway/application/evolvequest/logo.jpg' privacyPolicyURL: 'https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html' description: Evolve Quest mobile application redirectUrl: - 'https://channelpartner.com/opengateway/application/evolvequest/redirect' jwksUri: 'https://channelpartner.com/opengateway/application/evolvequest/jwk' category: games operationalState: disable approvalStatus: approved digitalIdentity: '@type': ApiDigitalIdentity clientId: evolve_quest_channelPartner15 validFor: startDateTime: '2024-12-02T14:01:00.00Z' applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: 'https://contact.evolvequest.com' - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvequest.com externalIdentifier: - '@type': ExternalIdentifier id: application_123 owner: ChannelPartner externalIdentifierType: Application channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: An example of a response for updating an Application object. Update_an_Application_with_json-patch-query_json_content_type_request: value: - op: replace path: /externalIdentifier?id=application_123 value: '@type': ExternalIdentifier id: application_124 owner: ChannelPartner externalIdentifierType: Application description: An example of a request for updating an Application object. Update_an_Application_with_json-patch-query_json_content_type_response: value: '@type': Application '@baseType': LogicalResource id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c name: Evolve Quest creationDate: '2024-12-02T14:00:00.00Z' commercialName: Evolve Quest logoUrl: 'https://channelpartner.com/opengateway/application/evolvequest/logo.jpg' privacyPolicyURL: 'https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html' description: Evolve Quest mobile application redirectUrl: - 'https://channelpartner.com/opengateway/application/evolvequest/redirect' jwksUri: 'https://channelpartner.com/opengateway/application/evolvequest/jwk' category: games operationalState: disable approvalStatus: approved digitalIdentity: '@type': ApiDigitalIdentity clientId: evolve_quest_channelPartner15 validFor: startDateTime: '2024-12-02T14:01:00.00Z' applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: 'https://contact.evolvequest.com' - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvequest.com externalIdentifier: - '@type': ExternalIdentifier id: application_124 owner: ChannelPartner externalIdentifierType: Application channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: An example of a response for updating an Application object. Update_an_ApplicationOwner_with_json_content_type_request: value: '@type': ApplicationOwner status: inactive description: Updating an ApplicationOwner object. Update_an_ApplicationOwner_with_json_content_type_response: value: '@type': ApplicationOwner id: e05b75dc-f843-40d9-8d16-112275a28385 href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/applicationOwner/e05b75dc-f843-40d9-8d16-112275a28385 name: Funtastic Games application owner role creationDate: '2024-12-01T13:00:00.00Z' description: Application owner role in the Open Gateway context engagedParty: '@type': ApplicationOwnerOrganization name: Funtastic Games SA tradingName: Funtastic Games isLegalEntity: true organizationType: 'dpv:ForProfitOrganisation' privacyPolicyURL: 'https://www.funtasticgames.com/privacy' taxNumber: 00.623.904/0001-73 organizationIdentification: - '@type': OrganizationIdentification identificationType: CNPJ identificationId: 00.623.904/0001-73 issuingAuthority: Receita Federal externalReference: - '@type': ExternalIdentifier id: funtastic_games_asp externalIdentifierType: ApplicationOwnerOrganization owner: ChannelPartner registeredGeographicAddress: '@type': LightGeographicAddress streetNr: '123' streetName: Avenida Paulista locality: Paraiso city: Sao Paulo stateOrProvince: Sao Paulo countryCode: '@type': ISO31661Alpha2StandardIdentifier value: BR postcode: 01311-000 geographicSubAddress: '@type': LightGeographicSubAddress buildingName: Fogo levelNumber: Planta 4 contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: contact@funtasticgames.com legalRepresentative: '@type': ApplicationOwnerRelatedIndividual familyName: OConnor givenName: Jane contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: jane@funtasticgames.com dataProtectionOfficer: '@type': ApplicationOwnerRelatedOrganization name: DPO Office organizationType: 'dpv:OrganisationalUnit' contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: dpo@funtasticgames.com privacyManager: '@type': ApplicationOwnerRelatedOrganization name: Privacy Office organizationType: 'dpv:OrganisationalUnit' contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: privacy@funtasticgames.com localRepresentative: - '@type': ApplicationOwnerRelatedLocalRepresentative countryCode: '@type': ISO31661Alpha2StandardIdentifier value: EU representative: '@type': ApplicationOwnerRelatedIndividual familyName: Juan givenName: Garcia contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium '@schemaLocation': 'https://mycsp.com/tmf-api/schema/Common/EmailContactMedium.schema.json' id: jgarcia preferred: true emailAddress: jgarcia@funtasticgames.com status: inactive approvalStatus: pendingApproval channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: A response after PATCH-ing an ApplicationOwner object. Update_an_ApplicationOwner_with_merge-patch_json_content_type_request: value: '@type': ApplicationOwner status: inactive description: An example of a request for updating an ApplicationOwner object. Update_an_ApplicationOwner_with_merge-patch_json_content_type_response: value: '@type': ApplicationOwner id: e05b75dc-f843-40d9-8d16-112275a28385 href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/applicationOwner/e05b75dc-f843-40d9-8d16-112275a28385 name: Funtastic Games application owner role creationDate: '2024-12-01T13:00:00.00Z' description: Application owner role in the Open Gateway context engagedParty: '@type': ApplicationOwnerOrganization name: Funtastic Games SA tradingName: Funtastic Games isLegalEntity: true organizationType: 'dpv:ForProfitOrganisation' privacyPolicyURL: 'https://www.funtasticgames.com/privacy' taxNumber: 00.623.904/0001-73 organizationIdentification: - '@type': OrganizationIdentification identificationType: CNPJ identificationId: 00.623.904/0001-73 issuingAuthority: Receita Federal externalReference: - '@type': ExternalIdentifier id: funtastic_games_asp externalIdentifierType: ApplicationOwnerOrganization owner: ChannelPartner registeredGeographicAddress: '@type': LightGeographicAddress streetNr: '123' streetName: Avenida Paulista locality: Paraiso city: Sao Paulo stateOrProvince: Sao Paulo countryCode: '@type': ISO31661Alpha2StandardIdentifier value: BR postcode: 01311-000 geographicSubAddress: '@type': LightGeographicSubAddress buildingName: Fogo levelNumber: Planta 4 contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: contact@funtasticgames.com legalRepresentative: '@type': ApplicationOwnerRelatedIndividual familyName: OConnor givenName: Jane contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: jane@funtasticgames.com dataProtectionOfficer: '@type': ApplicationOwnerRelatedOrganization name: DPO Office organizationType: 'dpv:OrganisationalUnit' contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: dpo@funtasticgames.com privacyManager: '@type': ApplicationOwnerRelatedOrganization name: Privacy Office organizationType: 'dpv:OrganisationalUnit' contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: privacy@funtasticgames.com localRepresentative: - '@type': ApplicationOwnerRelatedLocalRepresentative countryCode: '@type': ISO31661Alpha2StandardIdentifier value: EU representative: '@type': ApplicationOwnerRelatedIndividual familyName: Juan givenName: Garcia contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium '@schemaLocation': 'https://mycsp.com/tmf-api/schema/Common/EmailContactMedium.schema.json' id: jgarcia preferred: true emailAddress: jgarcia@funtasticgames.com status: inactive approvalStatus: pendingApproval channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: An example of a response for updating an ApplicationOwner object. Update_an_ApplicationOwner_with_json-patch_json_content_type_request: value: - op: replace path: /status value: inactive description: An example of a request for updating an ApplicationOwner object. Update_an_ApplicationOwner_with_json-patch_json_content_type_response: value: '@type': ApplicationOwner id: e05b75dc-f843-40d9-8d16-112275a28385 href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/applicationOwner/e05b75dc-f843-40d9-8d16-112275a28385 name: Funtastic Games application owner role creationDate: '2024-12-01T13:00:00.00Z' description: Application owner role in the Open Gateway context engagedParty: '@type': ApplicationOwnerOrganization name: Funtastic Games SA tradingName: Funtastic Games isLegalEntity: true organizationType: 'dpv:ForProfitOrganisation' privacyPolicyURL: 'https://www.funtasticgames.com/privacy' taxNumber: 00.623.904/0001-73 organizationIdentification: - '@type': OrganizationIdentification identificationType: CNPJ identificationId: 00.623.904/0001-73 issuingAuthority: Receita Federal externalReference: - '@type': ExternalIdentifier id: funtastic_games_asp externalIdentifierType: ApplicationOwnerOrganization owner: ChannelPartner registeredGeographicAddress: '@type': LightGeographicAddress streetNr: '123' streetName: Avenida Paulista locality: Paraiso city: Sao Paulo stateOrProvince: Sao Paulo countryCode: '@type': ISO31661Alpha2StandardIdentifier value: BR postcode: 01311-000 geographicSubAddress: '@type': LightGeographicSubAddress buildingName: Fogo levelNumber: Planta 4 contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: contact@funtasticgames.com legalRepresentative: '@type': ApplicationOwnerRelatedIndividual familyName: OConnor givenName: Jane contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: jane@funtasticgames.com dataProtectionOfficer: '@type': ApplicationOwnerRelatedOrganization name: DPO Office organizationType: 'dpv:OrganisationalUnit' contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: dpo@funtasticgames.com privacyManager: '@type': ApplicationOwnerRelatedOrganization name: Privacy Office organizationType: 'dpv:OrganisationalUnit' contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: privacy@funtasticgames.com localRepresentative: - '@type': ApplicationOwnerRelatedLocalRepresentative countryCode: '@type': ISO31661Alpha2StandardIdentifier value: EU representative: '@type': ApplicationOwnerRelatedIndividual familyName: Juan givenName: Garcia contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium '@schemaLocation': 'https://mycsp.com/tmf-api/schema/Common/EmailContactMedium.schema.json' id: jgarcia preferred: true emailAddress: jgarcia@funtasticgames.com status: inactive approvalStatus: pendingApproval channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: An example of a response for updating an ApplicationOwner object. Update_an_ApplicationOwner_with_json-patch-query_json_content_type_request: value: - op: replace path: /engagedParty.contactMedium?id=1 value: '@type': EmailContactMedium id: '1' preferred: true emailAddress: newContact@funtasticgames.com description: An example of a request for updating an Application object. Update_an_ApplicationOwner_with_json-patch-query_json_content_type_response: value: '@type': ApplicationOwner id: e05b75dc-f843-40d9-8d16-112275a28385 href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/applicationOwner/e05b75dc-f843-40d9-8d16-112275a28385 name: Funtastic Games application owner role creationDate: '2024-12-01T13:00:00.00Z' description: Application owner role in the Open Gateway context engagedParty: '@type': ApplicationOwnerOrganization name: Funtastic Games SA tradingName: Funtastic Games isLegalEntity: true organizationType: 'dpv:ForProfitOrganisation' privacyPolicyURL: 'https://www.funtasticgames.com/privacy' taxNumber: 00.623.904/0001-73 organizationIdentification: - '@type': OrganizationIdentification identificationType: CNPJ identificationId: 00.623.904/0001-73 issuingAuthority: Receita Federal externalReference: - '@type': ExternalIdentifier id: funtastic_games_asp externalIdentifierType: ApplicationOwnerOrganization owner: ChannelPartner registeredGeographicAddress: '@type': LightGeographicAddress streetNr: '123' streetName: Avenida Paulista locality: Paraiso city: Sao Paulo stateOrProvince: Sao Paulo countryCode: '@type': ISO31661Alpha2StandardIdentifier value: BR postcode: 01311-000 geographicSubAddress: '@type': LightGeographicSubAddress buildingName: Fogo levelNumber: Planta 4 contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: newContact@funtasticgames.com legalRepresentative: '@type': ApplicationOwnerRelatedIndividual familyName: OConnor givenName: Jane contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: jane@funtasticgames.com dataProtectionOfficer: '@type': ApplicationOwnerRelatedOrganization name: DPO Office organizationType: 'dpv:OrganisationalUnit' contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: dpo@funtasticgames.com privacyManager: '@type': ApplicationOwnerRelatedOrganization name: Privacy Office organizationType: 'dpv:OrganisationalUnit' contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: privacy@funtasticgames.com localRepresentative: - '@type': ApplicationOwnerRelatedLocalRepresentative countryCode: '@type': ISO31661Alpha2StandardIdentifier value: EU representative: '@type': ApplicationOwnerRelatedIndividual familyName: Juan givenName: Garcia contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: jgarcia preferred: true emailAddress: jgarcia@funtasticgames.com status: active approvalStatus: pendingApproval channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole description: An example of a response for updating an ApplicationOwner object. ApiProductOrderCreateEvent_request: value: correlationId: 126-54f description: Event for a productOrder creation. domain: Open Gateway Onboarding eventId: '125' eventTime: '2025-02-02T12:00:00.00Z' eventType: ApiProductOrderCreateEvent priority: '1' timeOccurred: '2025-02-02T12:00:00.00Z' title: ApiProductOrderCreateEvent event: productOrder: '@type': ApiProductOrder id: 86387671-0997-461b-99c7-d624ffb0640c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/86387671-0997-461b-99c7-d624ffb0640c state: acknowledged externalId: - '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerCustomerOrder id: order_2232342 owner: ChannelPartner description: Camara API order for an Application Owner productOrderItem: - '@type': ApiProductOrderItemAdd '@baseType': DCSProductOrderItem id: '1' state: completed productOffering: '@type': ProductOfferingRef id: 2d4ef4d3-08ce-441d-ac76-133b6dad0ccb name: areocloud_device_location_verification '@referredType': OpenGatewayProductOffering product: '@type': ProductRef id: 8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProduct/8bb8bcdb-9fcf-4b4f-8b27-2dda848404fb '@referredType': ApiProduct productAction: '@type': ApiProductActionAddDeviceLocationVerification '@baseType': ApiProductAction '@schemaLocation': >- https://mycsp.com/tmf-api/schema/Customer/ApiProductActionAddDeviceLocationVerification.schema.json purpose: 'dpv:FraudPreventionAndDetection' bestAccuracy: 500 targetApplication: '@type': ApplicationRef id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c '@referredType': Application externalIdentifier: '@type': ExternalIdentifier externalIdentifierType: ApplicationOwnerProduct id: device_location_1234 owner: ChannelPartner approvedProductOfferingTermOrCondition: - '@type': ProductOfferingTermOrCondition productOfferingTermOrConditionSpecRef: '@type': ProductOfferingTermOrConditionSpecRef id: 2d4ef4d3-08ce-441d-ac76-133b6dad0ccb_terms_1 name: device_location_verification_terms '@referredType': OpenGatewayProductOfferingTermOrConditionSpecification productOfferingTermOrConditionApproval: approvalDate: '2023-11-20T00:00:00.000Z' applicationLegalBasisForInputData: 'dpv:Consent' process: - '@type': DpvProcess processingOperation: - 'dpv:Assess' context: '@type': DpvContext processingContext: - 'dpv:AutomatedDecisionMaking' - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:FixedOccurrencesDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' - '@type': DpvProcess processingOperation: - 'dpv:Profiling' context: '@type': DpvContext processingContext: - 'dpv:AutomatedScoringOfIndividuals' duration: 'dpv:EndlessDuration' frequency: 'dpv:SingularFrequency' dataExportTransitCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' dataExportStorageCountry: - '@type': DataExportCountry countryCode: '@type': ISO31661Alpha2StandardIdentifier value: US commercialOrganizationName: Globy Corporation dataPrivacyFrameworkURL: 'https://www.dataprivacyframework.gov/participant/abcde' userConsentScreenshot: '@type': SimpleAttachment content: JVBERi...JSVFT0Y= mimeType: application/pdf channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole '@baseType': Event '@type': ApiProductOrderCreateEvent description: Message example for an ApiProductOrderCreateEvent event ApiProductOrderStateChangeEvent_request: value: correlationId: 126-54f description: Event for a productOrder state change. domain: Open Gateway Onboarding eventId: '125' eventTime: '2025-02-02T12:01:00.00Z' eventType: ApiProductOrderStateChangeEvent priority: '1' timeOccurred: '2025-02-02T12:01:00.00Z' title: ApiProductOrderStateChangeEvent event: productOrder: '@type': ApiProductOrder id: 86387671-0997-461b-99c7-d624ffb0640c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/86387671-0997-461b-99c7-d624ffb0640c state: completed completionDate: '2025-02-02T12:01:00.00Z' '@baseType': Event '@type': ApiProductOrderStateChangeEvent description: Message example for an ApiProductOrderStateChangeEvent event ApiProductOrderAttributeValueChangeEvent_request: value: correlationId: 126-54f description: Event for a productOrder attribute value change. domain: Open Gateway Onboarding eventId: '125' eventTime: '2025-02-02T12:01:00.00Z' eventType: ApiProductOrderAttributeValueChangeEvent priority: '1' timeOccurred: '2025-02-02T12:01:00.00Z' title: ApiProductOrderAttributeValueChangeEvent event: productOrder: '@type': ApiProductOrder id: 86387671-0997-461b-99c7-d624ffb0640c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/apiProductOrder/86387671-0997-461b-99c7-d624ffb0640c state: completed completionDate: '2025-02-02T12:01:00.00Z' '@baseType': Event '@type': ApiProductOrderAttributeValueChangeEvent description: Message example for an ApiProductOrderAttributeValueChangeEvent event ApplicationCreateEvent_request: value: correlationId: 126-54f description: Event for a application creation. domain: Open Gateway Onboarding eventId: '125' eventTime: '2024-12-02T14:10:00.00Z' eventType: ApplicationCreateEvent priority: '1' timeOccurred: '2024-12-02T14:10:00.00Z' title: ApplicationCreateEvent event: application: '@type': Application '@baseType': LogicalResource id: '102' href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/102 name: Evolve West creationDate: '2024-12-02T14:10:00.00Z' commercialName: Evolve West logoUrl: 'https://channelpartner.com/opengateway/application/evolvequest/logo.jpg' privacyPolicyURL: 'https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html' description: Evolve West mobile application redirectUrl: - 'https://channelpartner.com/opengateway/application/evolvequest/redirect' jwksUri: 'https://channelpartner.com/opengateway/application/evolvequest/jwk' category: games operationalState: disable approvalStatus: pendingApproval digitalIdentity: '@type': ApiDigitalIdentity clientId: evolve_quest_channelPartner15 validFor: startDateTime: '2024-12-02T14:11:00.00Z' apiConsumerRole: - grantedPermissionSet: - '@type': ApiPermissionSet creationDate: '2025-04-02T15:00:00.00Z' permission: '@type': ApiConsumerPermission managedAssetGroup: '@type': ApiListAssetGroup '@baseType': AssetGroup apiProduct: - '@type': ProductRef id: '123' '@referredType': ApiProduct validFor: startDateTime: '2025-04-02T15:00:00.00Z' applicationOwner: '@type': PartyRoleRef id: e05b75dc-f843-40d9-8d16-112275a28385 '@referredType': PartyRole privacyRightsRequestContact: - '@type': WebFormContactMedium '@baseType': ContactMedium id: '1' preferred: false url: 'https://contact.evolvequest.com' - '@type': EmailContactMedium '@baseType': ContactMedium id: '2' preferred: true emailAddress: contact@evolvequest.com channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole '@baseType': Event '@type': ApplicationCreateEvent description: Message example for ApplicationCreateEvent event ApplicationApprovalStatusChangeEvent_request: value: correlationId: 126-54f description: Event for a application ApprovalStatus change. domain: Open Gateway Onboarding eventId: '125' eventTime: '2024-12-02T14:00:00.00Z' eventType: ApplicationApprovalStatusChangeEvent priority: '1' timeOccurred: '2024-12-02T14:00:00.00Z' title: ApplicationApprovalStatusChangeEvent event: application: '@type': Application '@baseType': LogicalResource id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c approvalStatus: approved '@baseType': Event '@type': ApplicationApprovalStatusChangeEvent description: Message example for an ApplicationApprovalStatusChangeEvent event ApplicationAttributeValueChangeEvent_request: value: correlationId: 126-54f description: Event for a application attribute value change. domain: Open Gateway Onboarding eventId: '125' eventTime: '2024-12-02T15:00:00.00Z' eventType: ApplicationAttributeValueChangeEvent priority: '1' timeOccurred: '2024-12-02T15:00:00.00Z' title: ApplicationAttributeValueChangeEvent event: application: '@type': Application '@baseType': LogicalResource id: f1cba17d-789a-4037-b3e3-2c96e887576c href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c description: Evolve Quest awarded mobile application. '@baseType': Event '@type': ApplicationAttributeValueChangeEvent description: Message example for an ApplicationAttributeValueChangeEvent event ApplicationOwnerCreateEvent_request: value: correlationId: 126-54f description: Event for a applicationOwner creation. domain: Open Gateway Onboarding eventId: '125' eventTime: '2024-12-01T13:00:00.00Z' eventType: ApplicationOwnerCreateEvent priority: '1' timeOccurred: '2024-12-01T13:00:00.00Z' title: ApplicationOwnerCreateEvent event: applicationOwner: '@type': ApplicationOwner id: e05b75dc-f843-40d9-8d16-112275a28385 href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/applicationOwner/e05b75dc-f843-40d9-8d16-112275a28385 name: Funtastic Games application owner role creationDate: '2024-12-01T13:00:00.00Z' engagedParty: '@type': ApplicationOwnerOrganization name: Funtastic Games SA tradingName: Funtastic Games isLegalEntity: true organizationType: 'dpv:ForProfitOrganisation' privacyPolicyURL: 'https://www.funtasticgames.com/privacy' taxNumber: 00.623.904/0001-73 organizationIdentification: - '@type': OrganizationIdentification identificationType: CNPJ identificationId: 00.623.904/0001-73 issuingAuthority: Receita Federal externalReference: - '@type': ExternalIdentifier id: funtastic_games_asp externalIdentifierType: ApplicationOwnerOrganization owner: ChannelPartner registeredGeographicAddress: '@type': LightGeographicAddress streetNr: '123' streetName: Avenida Paulista locality: Paraiso city: Sao Paulo stateOrProvince: Sao Paulo countryCode: '@type': ISO31661Alpha2StandardIdentifier value: BR postcode: 01311-000 geographicSubAddress: '@type': LightGeographicSubAddress buildingName: Fogo levelNumber: Planta 4 contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: contact@funtasticgames.com legalRepresentative: '@type': ApplicationOwnerRelatedIndividual familyName: OConnor givenName: Jane contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: jane@funtasticgames.com dataProtectionOfficer: '@type': ApplicationOwnerRelatedOrganization name: DPO Office organizationType: 'dpv:OrganisationalUnit' contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: dpo@funtasticgames.com privacyManager: '@type': ApplicationOwnerRelatedOrganization name: Privacy Office organizationType: 'dpv:OrganisationalUnit' contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: '1' preferred: true emailAddress: privacy@funtasticgames.com localRepresentative: - '@type': ApplicationOwnerRelatedLocalRepresentative countryCode: '@type': ISO31661Alpha2StandardIdentifier value: EU representative: '@type': ApplicationOwnerRelatedIndividual familyName: Juan givenName: Garcia contactMedium: - '@type': EmailContactMedium '@baseType': ContactMedium id: jgarcia preferred: true emailAddress: jgarcia@funtasticgames.com status: inactive approvalStatus: pendingApproval channelPartner: '@type': PartyRoleRef id: '15' '@referredType': PartyRole '@baseType': Event '@type': ApplicationOwnerCreateEvent description: Message example for ApplicationOwnerCreateEvent event ApplicationOwnerApprovalStatusChangeEvent_request: value: correlationId: 126-54f description: Event for a applicationOwner approvalStatus change. domain: Open Gateway Onboarding eventId: '125' eventTime: '2024-12-01T13:10:00.00Z' eventType: ApplicationOwnerApprovalStatusChangeEvent priority: '1' timeOccurred: '2024-12-01T13:10:00.00Z' title: ApplicationOwnerApprovalStatusChangeEvent event: applicationOwner: '@type': ApplicationOwner id: e05b75dc-f843-40d9-8d16-112275a28385 href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/applicationOwner/e05b75dc-f843-40d9-8d16-112275a28385 approvalStatus: approved '@baseType': Event '@type': ApplicationOwnerApprovalStatusChangeEvent description: Message example for an ApplicationOwnerApprovalStatusChangeEvent event ApplicationOwnerAttributeValueChangeEvent_request: value: correlationId: 126-54f description: Event for a applicationOwner attribute value change. domain: Open Gateway Onboarding eventId: '125' eventTime: '2024-12-01T15:00:00.00Z' eventType: ApplicationOwnerAttributeValueChangeEvent priority: '1' timeOccurred: '2024-12-01T15:00:00.00Z' title: ApplicationOwnerAttributeValueChangeEvent event: applicationOwner: '@type': ApplicationOwner id: e05b75dc-f843-40d9-8d16-112275a28385 href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/applicationOwner/e05b75dc-f843-40d9-8d16-112275a28385 description: Application owner role in the GSMA Open Gateway context. '@baseType': Event '@type': ApplicationOwnerAttributeValueChangeEvent description: Message example for an ApplicationOwnerAttributeValueChangeEvent event MonitorStateChangeEvent_request: value: correlationId: 987-46i description: Event for a monitor state change. domain: Open Gateway Onboarding eventId: '987' eventTime: '2024-12-02T14:00:00.00Z' eventType: MonitorStateChangeEvent priority: '1' timeOccurred: '2024-12-02T14:00:00.00Z' title: MonitorStateChangeEvent event: monitor: '@type': Monitor id: 77795e7f-5213-4b9c-b672-6838a6b76152 href: >- https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/monitor/77795e7f-5213-4b9c-b672-6838a6b76152 state: Completed '@baseType': Event '@type': MonitorStateChangeEvent description: Message example for an MonitorStateChangeEvent event