openapi: 3.2.0
info:
  title: 3gpp-ueid Verify Msisdn API
  version: 1.2.0
  description: "API for UE ID service.\n© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  \nAll rights reserved.\n"
servers:
- url: '{apiRoot}/3gpp-ueid/v1'
  variables:
    apiRoot:
      default: https://example.com
      description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
security:
- {}
- oAuth2ClientCredentials: []
tags:
- name: Verify Msisdn
paths:
  /verify-msisdn:
    post:
      summary: Request to verify whether the UE's MSISDN provided by the AF matches the UE ID in the form of MSISDN retrieved from the UDM.
      operationId: VerifyMsisdn
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MsisdnVerifReq'
      responses:
        '200':
          description: 'OK. The MSISDN verification request is successfully received and processed, and the MSISDN verification outcome is returned in the response body.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MsisdnVerifResp'
        '307':
          $ref: TS29122_CommonData.yaml#/components/responses/307
        '308':
          $ref: TS29122_CommonData.yaml#/components/responses/308
        '400':
          $ref: TS29122_CommonData.yaml#/components/responses/400
        '401':
          $ref: TS29122_CommonData.yaml#/components/responses/401
        '403':
          $ref: TS29122_CommonData.yaml#/components/responses/403
        '404':
          $ref: TS29122_CommonData.yaml#/components/responses/404
        '411':
          $ref: TS29122_CommonData.yaml#/components/responses/411
        '413':
          $ref: TS29122_CommonData.yaml#/components/responses/413
        '415':
          $ref: TS29122_CommonData.yaml#/components/responses/415
        '429':
          $ref: TS29122_CommonData.yaml#/components/responses/429
        '500':
          $ref: TS29122_CommonData.yaml#/components/responses/500
        '503':
          $ref: TS29122_CommonData.yaml#/components/responses/503
        default:
          $ref: TS29122_CommonData.yaml#/components/responses/default
      tags:
      - Verify Msisdn
components:
  schemas:
    MsisdnVerifResp:
      description: Represents the MSISDN verification response.
      type: object
      properties:
        verifResult:
          type: boolean
          description: 'Indicates the verification result on whether the UE''s MSISDN provided by the AF matches the UE''s MSISDN retrieved from the UDM or not. Set to true if the UE''s MSISDN provided by the AF matches the UE''s MSISDN retrieved from the UDM. Set to false if the UE''s MSISDN provided by the AF does not match the UE''s MSISDN retrieved from UDM.

            '
      required:
      - verifResult
    MsisdnVerifReq:
      description: Represents the MSISDN verification request.
      type: object
      properties:
        afId:
          type: string
        msisdn:
          $ref: TS29122_CommonData.yaml#/components/schemas/Msisdn
        appPortId:
          $ref: TS29122_CommonData.yaml#/components/schemas/Port
        dnn:
          $ref: TS29571_CommonData.yaml#/components/schemas/Dnn
        ipDomain:
          type: string
        mtcProviderId:
          $ref: TS29571_CommonData.yaml#/components/schemas/MtcProviderInformation
        portNumber:
          $ref: TS29122_CommonData.yaml#/components/schemas/Port
        snssai:
          $ref: TS29571_CommonData.yaml#/components/schemas/Snssai
        ueIpAddr:
          $ref: TS29571_CommonData.yaml#/components/schemas/IpAddr
        ueMacAddr:
          $ref: TS29571_CommonData.yaml#/components/schemas/MacAddr48
        suppFeat:
          $ref: TS29571_CommonData.yaml#/components/schemas/SupportedFeatures
      required:
      - afId
      - msisdn
      oneOf:
      - required:
        - ueIpAddr
      - required:
        - ueMacAddr
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: '{tokenUrl}'
          scopes: {}
externalDocs:
  description: 3GPP TS 29.522 V19.5.0; 5G System; Network Exposure Function Northbound APIs.
  url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/