openapi: 3.2.0
info:
  title: Infobip OpenAPI Specification Connectivity API
  description: OpenAPI Specification that contains all public endpoints and webhooks.
  contact:
    name: Infobip support
    email: support@infobip.com
  version: 3.210.0
  x-generatedAt: '2026-07-23T15:23:37.825639538Z'
tags:
- name: connectivity
  description: 'Powerful infrastructure and tools that connect you to the world.

    '
  x-type: category
  x-displayName: Connectivity
paths:
  /number/1/notify:
    post:
      tags:
      - connectivity
      summary: Number Context lookup (async)
      description: This method allows you to get number context information for requested phone numbers and receive information at some endpoint asynchronously. Information may vary per country and your package. For package change, contact your account manager or [support](https://www.infobip.com/contact).
      operationId: number-context-lookup-async
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcNotifyRequest'
            examples:
              Look up several phone numbers:
                summary: Look up several phone numbers
                value:
                  notifyContentType: application/json
                  notifyUrl: https://www.example.com/number/lookup/report
                  to:
                  - '41793026727'
                  - '41793026834'
          application/xml:
            schema:
              $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcNotifyRequest'
            examples:
              Look up several phone numbers:
                summary: Look up several phone numbers
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><NcNotifyRequest>\n  <notifyContentType>application/json</notifyContentType>\n  <notifyUrl>https://www.example.com/number/lookup/report</notifyUrl>\n  <to>\n    <to>41793026727</to>\n    <to>41793026834</to>\n  </to>\n</NcNotifyRequest>\n"
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcResponseAsync'
              examples:
                Async number lookup response:
                  summary: Async number lookup response
                  value:
                    results:
                    - to: '3859851212'
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 3
                        name: PENDING_WAITING_DELIVERY
                        description: Message sent, waiting for delivery report
                      messageId: 2b691c32-1233-4716-a763-4f70cc929eae
                    - to: '3816038923'
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 3
                        name: PENDING_WAITING_DELIVERY
                        description: Message sent, waiting for delivery report
                      messageId: 24c753c7-8113-4983-9ddb-c50978ba47dc
                    bulkId: BULK-ID-123-xyz
            application/xml:
              schema:
                $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcResponseAsync'
              examples:
                Async number lookup response:
                  summary: Async number lookup response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ncResponseAsync>\n  <bulkId>BULK-ID-123-xyz</bulkId>\n  <results>\n    <result>\n      <to>3859851212</to>\n      <status>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>3</id>\n        <name>PENDING_WAITING_DELIVERY</name>\n        <description>Message sent, waiting for delivery report</description>\n      </status>\n      <messageId>2b691c32-1233-4716-a763-4f70cc929eae</messageId>\n    </result>\n    <result>\n      <to>3816038923</to>\n      <status>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>3</id>\n        <name>PENDING_WAITING_DELIVERY</name>\n        <description>Message sent, waiting for delivery report</description>\n      </status>\n      <messageId>24c753c7-8113-4983-9ddb-c50978ba47dc</messageId>\n    </result>\n  </results>\n</ncResponseAsync>\n"
        '400':
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - number-lookup:manage
      - number-lookup:send
  /number/1/query:
    post:
      tags:
      - connectivity
      summary: Number Context lookup
      description: This method allows you to get Number Context information for the requested phone numbers. For package change, contact your account manager or [support](https://www.infobip.com/contact).
      operationId: number-context-lookup
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcQueryRequest'
            examples:
              Look up a phone number:
                summary: Look up a phone number
                value:
                  to:
                  - '41793026727'
          application/xml:
            schema:
              $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcQueryRequest'
            examples:
              Look up a phone number:
                summary: Look up a phone number
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><NcQueryRequest>\n  <to>\n    <to>41793026727</to>\n  </to>\n</NcQueryRequest>\n"
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcResponse'
              examples:
                Number lookup response:
                  summary: Number lookup response
                  value:
                    results:
                    - to: '41793026727'
                      mccMnc: '22801'
                      imsi: '228011234567890'
                      originalNetwork:
                        networkName: Swisscom
                        networkPrefix: '79'
                        countryName: Switzerland
                        countryPrefix: '41'
                        networkId: 123
                      ported: false
                      roaming: false
                      servingMSC: '41001'
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: Ok
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                    bulkId: BULK-ID-123-xyz
                Ported number lookup response:
                  summary: Ported number lookup response
                  value:
                    results:
                    - to: '41793026727'
                      mccMnc: '22801'
                      imsi: '228011234567890'
                      originalNetwork:
                        networkName: Swisscom
                        networkPrefix: '79'
                        countryName: Switzerland
                        countryPrefix: '41'
                        networkId: 123
                      ported: true
                      portedNetwork:
                        networkName: Sunrise
                        networkPrefix: '77'
                        countryName: Switzerland
                        countryPrefix: '41'
                        networkId: 321
                      roaming: false
                      servingMSC: '41002'
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: Ok
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                    bulkId: BULK-ID-123-xyz
                Roaming number lookup response:
                  summary: Roaming number lookup response
                  value:
                    results:
                    - to: '41793026727'
                      mccMnc: '22801'
                      imsi: '228011234567890'
                      originalNetwork:
                        networkName: Swisscom
                        networkPrefix: '79'
                        countryName: Switzerland
                        countryPrefix: '41'
                        networkId: 123
                      ported: false
                      roaming: true
                      roamingNetwork:
                        networkName: Tele2
                        networkPrefix: '739'
                        countryName: Sweden
                        countryPrefix: '46'
                        networkId: 456
                      servingMSC: '46003'
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: Ok
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                    bulkId: BULK-ID-123-xyz
            application/xml:
              schema:
                $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcResponse'
              examples:
                Number lookup response:
                  summary: Number lookup response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ncResponse>\n  <bulkId>BULK-ID-123-xyz</bulkId>\n  <results>\n    <result>\n      <to>41793026727</to>\n      <mccMnc>22801</mccMnc>\n      <imsi>228011234567890</imsi>\n      <originalNetwork>\n        <networkName>Swisscom</networkName>\n        <networkPrefix>79</networkPrefix>\n        <countryName>Switzerland</countryName>\n        <countryPrefix>41</countryPrefix>\n        <networkId>123</networkId>\n      </originalNetwork>\n      <ported>false</ported>\n      <roaming>false</roaming>\n      <servingMSC>41001</servingMSC>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>Ok</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n    </result>\n  </results>\n</ncResponse>\n"
                Ported number lookup response:
                  summary: Ported number lookup response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ncResponse>\n  <bulkId>BULK-ID-123-xyz</bulkId>\n  <results>\n    <result>\n      <to>41793026727</to>\n      <mccMnc>22801</mccMnc>\n      <imsi>228011234567890</imsi>\n      <originalNetwork>\n        <networkName>Swisscom</networkName>\n        <networkPrefix>79</networkPrefix>\n        <countryName>Switzerland</countryName>\n        <countryPrefix>41</countryPrefix>\n        <networkId>123</networkId>\n      </originalNetwork>\n      <ported>true</ported>\n      <portedNetwork>\n        <networkName>Sunrise</networkName>\n        <networkPrefix>77</networkPrefix>\n        <countryName>Switzerland</countryName>\n        <countryPrefix>41</countryPrefix>\n        <networkId>321</networkId>\n      </portedNetwork>\n      <roaming>false</roaming>\n      <servingMSC>41002</servingMSC>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>Ok</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n    </result>\n  </results>\n</ncResponse>\n"
                Roaming number lookup response:
                  summary: Roaming number lookup response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ncResponse>\n  <bulkId>BULK-ID-123-xyz</bulkId>\n  <results>\n    <result>\n      <to>41793026727</to>\n      <mccMnc>22801</mccMnc>\n      <imsi>228011234567890</imsi>\n      <originalNetwork>\n        <networkName>Swisscom</networkName>\n        <networkPrefix>79</networkPrefix>\n        <countryName>Switzerland</countryName>\n        <countryPrefix>41</countryPrefix>\n        <networkId>123</networkId>\n      </originalNetwork>\n      <ported>false</ported>\n      <roaming>true</roaming>\n      <roamingNetwork>\n        <networkName>Tele2</networkName>\n        <networkPrefix>739</networkPrefix>\n        <countryName>Sweden</countryName>\n        <countryPrefix>46</countryPrefix>\n        <networkId>456</networkId>\n      </roamingNetwork>\n      <servingMSC>46003</servingMSC>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>Ok</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n    </result>\n  </results>\n</ncResponse>\n"
        '400':
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - number-lookup:manage
      - number-lookup:send
  /number/1/logs:
    get:
      tags:
      - connectivity
      summary: Get Number Context logs
      description: This method allows you to get logs of sent Number Context requests.
      operationId: get-number-context-logs
      parameters:
      - name: to
        in: query
        description: Destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: bulkId
        in: query
        description: Bulk ID for which log is requested.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: messageId
        in: query
        description: NC lookup ID for which log is requested.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: generalStatus
        in: query
        description: Requested Number Context [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes).
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageGeneralStatus'
      - name: sentSince
        in: query
        description: 'The logs will only include NC lookups sent after this date. Use it alongside `sentUntil` to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2015-02-22T17:42:05.390+0100
      - name: sentUntil
        in: query
        description: 'The logs will only include NC lookups sent before this date. Use it alongside `sentSince` to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2015-02-22T19:42:05.390+0100
      - name: limit
        in: query
        description: Maximum number of Number Context lookups in returned logs. If not set, the latest 50 records are returned. Maximum limit value is `1000` and you can only access logs for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          exclusiveMinimum: 0
          minimum: 0
      - name: mcc
        in: query
        description: Mobile Country Code.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: mnc
        in: query
        description: 'Mobile Network Code. Mobile Country Code is required if this property is used. '
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4033c81feb806caaa02f9cef553f79f0137a7aaa85d200d9d5e6449874c43c3d.NcLogResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/4033c81feb806caaa02f9cef553f79f0137a7aaa85d200d9d5e6449874c43c3d.NcLogResponse'
        '400':
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - number-lookup:logs:read
      - number-lookup:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 60
        numberOfTimeUnits: 0
        timeUnit: m
  /number-activation-state/1/network-reports:
    get:
      tags:
      - connectivity
      summary: Get Network Reports metadata
      description: Get a paginated list of Network Reports metadata.
      operationId: get-reports-metadata
      parameters:
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
      - name: dateFrom
        in: query
        description: 'Date in UTC that exactly defines the dateFrom property of the reports. <br />Format: yyyy-MM-dd <br />When both dateFrom and dateTo are provided then a list of reports between those two dates are returned.'
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '2024-03-02'
      - name: dateTo
        in: query
        description: 'Date in UTC that exactly defines the dateTo property of the reports. <br />Format: yyyy-MM-dd <br />When both dateFrom and dateTo are provided then a list of reports between those two dates are returned.'
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '2024-03-03'
      - name: reportId
        in: query
        description: The reportId to find
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 1f7a9938-0e3b-4e20-bb69-4968dca75078
      - name: networkId
        in: query
        description: The networkId of network that provided the report content.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
        example: 1717
      - name: networkName
        in: query
        description: The name of network that provided the report content.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: Verizon Wireless
      - name: generatedDateFrom
        in: query
        description: Filter by report generation date (inclusive lower bound)
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '2024-03-01'
      - name: generatedDateTo
        in: query
        description: Filter by report generation date (inclusive upper bound)
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '2024-03-31'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8018948352e80bbff88731d9fb43f611b84a58f2b44c304c63a8e4ae9c4bd661.PageReportMetadata'
              examples:
                Response for getting a list of Reports metadata results:
                  summary: Response for getting a list of Reports metadata results
                  value:
                    results:
                    - reportId: 1f7a9938-0e3b-4e20-bb69-4968dca75078
                      networkName: Verizon Wireless
                      networkId: 1717
                      generatedDate: '2024-03-19T00:00:00Z'
                      dateFrom: '2024-03-19T00:00:00Z'
                      dateTo: '2024-03-20T00:00:00Z'
                      expiryDate: '2024-05-18T00:00:00Z'
                    - reportId: 534a3153-0b3d-4408-9bc5-121d3e9c6537
                      networkName: AT&T Mobility
                      networkId: 1733
                      generatedDate: '2024-03-19T00:00:00Z'
                      dateFrom: '2024-03-19T00:00:00Z'
                      dateTo: '2024-03-20T00:00:00Z'
                      expiryDate: '2024-05-18T00:00:00Z'
                    paging:
                      page: 0
                      size: 2
                      totalPages: 30
                      totalResults: 61
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - number-activation-state:read
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-activation-state/1/network-reports/{reportId}/records:
    get:
      tags:
      - connectivity
      summary: Get Network Report content
      description: Get a paginated list of destination number activation state changes from a given Report.
      operationId: get-single-report
      parameters:
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
      - name: reportId
        in: path
        description: The reportId to retrieve
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8018948352e80bbff88731d9fb43f611b84a58f2b44c304c63a8e4ae9c4bd661.PageReports'
              examples:
                Response for getting a Deactivates Report content:
                  summary: Response for getting a Deactivates Report content
                  value:
                    results:
                    - date: 2024-03-05T00:00:00.000+0000
                      destination: '15123456789'
                      type: DEACTIVATION
                    - date: 2024-03-05T11:00:00.000+0000
                      destination: '15222222222'
                      type: DEACTIVATION
                      newDestination: '15777777777'
                    paging:
                      page: 1
                      size: 2
                      totalPages: 10
                      totalResults: 21
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                type: object
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - number-activation-state:read
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /mi/verification/1/verify:
    post:
      tags:
      - connectivity
      summary: Silent Mobile Verification
      description: 'Verify possession of end-user''s mobile phone number with the mobile network operator''s data connection.

        API and URL may vary per country. Please contact your sales for more details.'
      operationId: silent-mobile-verification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SmvVerifyRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Silent Mobile Verification request status.
                    enum:
                    - REDIRECT
                  token:
                    type: string
                    format: uuid
                    description: Unique request ID. The whole flow from the request to response has same token so it can be used for debugging in case of error or matching API request with the callback webhook response.
                    example: 123e4567-e89b-12d3-a456-426655440000
                  deviceRedirectUrl:
                    type: string
                    format: uri
                    description: An URL to perform mobile device redirect to if specified so by 'status'.
                    example: https://api.infobip.com/mno-domain/smv-check-endpoint
              examples:
                OK:
                  summary: OK
                  description: OK
                  value:
                    status: REDIRECT
                    token: 123e4567-e89b-12d3-a456-426655440000
                    deviceRedirectUrl: https://api.infobip.com/mno-domain/smv-check-endpoint
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  status:
                    type: string
                    description: Silent Mobile Verification request status.
                    enum:
                    - ERROR
                  token:
                    type: string
                    format: uuid
                    description: Unique request ID. The whole flow from the request to response has same token so it can be used for debugging in case of error or matching API request with the callback webhook response.
                    example: 123e4567-e89b-12d3-a456-426655440000
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    error:
                      id: 202
                      name: EC_CONSENT_NOT_GRANTED
                      description: User consent not granted
                    status: ERROR
                    token: 123e4567-e89b-12d3-a456-426655440000
        '401':
          description: Unauthorized - Platform authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Unauthorized:
                  summary: Unauthorized
                  description: Unauthorized
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: Invalid login details
        '403':
          description: Permission denied - Platform authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Permission denied:
                  summary: Permission denied
                  description: Permission denied
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: No permission to access resource
        '422':
          description: Unprocessable content
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  status:
                    type: string
                    description: Silent Mobile Verification request status.
                    enum:
                    - ERROR
                  token:
                    type: string
                    format: uuid
                    description: Unique request ID. The whole flow from the request to response has same token so it can be used for debugging in case of error or matching API request with the callback webhook response.
                    example: 123e4567-e89b-12d3-a456-426655440000
              examples:
                Unprocessable content:
                  summary: Unprocessable content
                  description: Unprocessable content
                  value:
                    error:
                      id: 400
                      name: EC_UNPROCESSABLE_CONTENT
                      description: Unable to process provided data.
                    status: ERROR
                    token: 123e4567-e89b-12d3-a456-426655440000
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  status:
                    type: string
                    description: Silent Mobile Verification request status.
                    enum:
                    - ERROR
                  token:
                    type: string
                    format: uuid
                    description: Unique request ID. The whole flow from the request to response has same token so it can be used for debugging in case of error or matching API request with the callback webhook response.
                    example: 123e4567-e89b-12d3-a456-426655440000
              examples:
                Internal server error:
                  summary: Internal server error
                  description: Internal server error
                  value:
                    error:
                      id: 1000
                      name: EC_INTERNAL_ERROR
                      description: Internal error in Infobip platform. Contact Support to resolve the issue.
                    status: ERROR
                    token: 123e4567-e89b-12d3-a456-426655440000
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-identity:manage
  /mi/verification/1/verify/advanced:
    post:
      tags:
      - connectivity
      summary: Advanced Silent Mobile Verification
      description: 'Verify possession of the end user''s mobile phone number with a mobile network operator''s data connection.

        If request body is supplied with additional data, the following can be done:

        - SIM swap check before the mobile phone number verification

        - Fallback SMS message if silent mobile verification fails


        API and URL may vary per country. Contact your Account Manager for implementation details.'
      operationId: advanced-silent-mobile-verification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SmvVerifyAdvancedRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: Silent Mobile Verification request status.
                    enum:
                    - ACCEPTED
                  token:
                    type: string
                    format: uuid
                    description: Unique request ID. The whole flow from the request to response has same token so it can be used for debugging in case of error or matching API request with the callback webhook response.
                    example: 123e4567-e89b-12d3-a456-426655440000
              examples:
                OK:
                  summary: OK
                  description: OK
                  value:
                    status: ACCEPTED
                    token: 6a31ccca-ceba-4998-a3b0-16ae5e182ab0
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  status:
                    type: string
                    description: Silent Mobile Verification request status.
                    enum:
                    - ERROR
                  token:
                    type: string
                    format: uuid
                    description: Unique request ID. The whole flow from the request to response has same token so it can be used for debugging in case of error or matching API request with the callback webhook response.
                    example: 123e4567-e89b-12d3-a456-426655440000
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    error:
                      id: 202
                      name: EC_CONSENT_NOT_GRANTED
                      description: User consent not granted
                    status: ERROR
                    token: 56693a53-4174-4e81-8e9c-b8863a7ad827
        '401':
          description: Unauthorized - Platform authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Unauthorized:
                  summary: Unauthorized
                  description: Unauthorized
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: Invalid login details
        '403':
          description: Permission denied - Platform authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Permission denied:
                  summary: Permission denied
                  description: Permission denied
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: No permission to access resource
        '422':
          description: Unprocessable content
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  status:
                    type: string
                    description: Silent Mobile Verification request status.
                    enum:
                    - ERROR
                  token:
                    type: string
                    format: uuid
                    description: Unique request ID. The whole flow from the request to response has same token so it can be used for debugging in case of error or matching API request with the callback webhook response.
                    example: 123e4567-e89b-12d3-a456-426655440000
              examples:
                Unprocessable content:
                  summary: Unprocessable content
                  description: Unprocessable content
                  value:
                    error:
                      id: 400
                      name: EC_UNPROCESSABLE_CONTENT
                      description: Unable to process provided data.
                    status: ERROR
                    token: 56693a53-4174-4e81-8e9c-b8863a7ad827
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  status:
                    type: string
                    description: Silent Mobile Verification request status.
                    enum:
                    - ERROR
                  token:
                    type: string
                    format: uuid
                    description: Unique request ID. The whole flow from the request to response has same token so it can be used for debugging in case of error or matching API request with the callback webhook response.
                    example: 123e4567-e89b-12d3-a456-426655440000
              examples:
                Internal server error:
                  summary: Internal server error
                  description: Internal server error
                  value:
                    error:
                      id: 1000
                      name: EC_INTERNAL_ERROR
                      description: Internal error in Infobip platform. Contact Support to resolve the issue.
                    status: ERROR
                    token: 56693a53-4174-4e81-8e9c-b8863a7ad827
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-identity:manage
  /mi/verification/1/verify/synchronous:
    post:
      tags:
      - connectivity
      summary: Synchronous Silent Mobile Verification
      description: 'Verify possession of end-user''s mobile phone number with the mobile network operator''s data connection.

        This API endpoint is available only in Brazil. Please contact your sales for more details.'
      operationId: synchronous-silent-mobile-verification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SmvVerifySynchronousRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                    description: Verification result.
                    enum:
                    - VALID
                    - INVALID
                  token:
                    type: string
                    format: uuid
                    description: Unique request ID. The whole flow from the request to response has same token so it can be used for debugging in case of error or matching API request with the callback webhook response.
                    example: 123e4567-e89b-12d3-a456-426655440000
              examples:
                VALID:
                  summary: VALID
                  description: VALID
                  value:
                    result: VALID
                    token: 6a31ccca-ceba-4998-a3b0-16ae5e182ab0
                INVALID:
                  summary: INVALID
                  description: INVALID
                  value:
                    result: INVALID
                    token: 6a31ccca-ceba-4998-a3b0-16ae5e182ab0
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  result:
                    type: string
                    description: Verification result.
                    enum:
                    - ERROR
                  token:
                    type: string
                    format: uuid
                    description: Unique request ID. The whole flow from the request to response has same token so it can be used for debugging in case of error or matching API request with the callback webhook response.
                    example: 123e4567-e89b-12d3-a456-426655440000
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    error:
                      id: 202
                      name: EC_CONSENT_NOT_GRANTED
                      description: User consent not granted
                    result: ERROR
                    token: 56693a53-4174-4e81-8e9c-b8863a7ad827
        '401':
          description: Unauthorized - Platform authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Unauthorized:
                  summary: Unauthorized
                  description: Unauthorized
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: Invalid login details
        '403':
          description: Permission denied - Platform authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Permission denied:
                  summary: Permission denied
                  description: Permission denied
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: No permission to access resource
        '422':
          description: Unprocessable content
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  result:
                    type: string
                    description: Verification result.
                    enum:
                    - ERROR
                  token:
                    type: string
                    format: uuid
                    description: Unique request ID. The whole flow from the request to response has same token so it can be used for debugging in case of error or matching API request with the callback webhook response.
                    example: 123e4567-e89b-12d3-a456-426655440000
              examples:
                Unprocessable content:
                  summary: Unprocessable content
                  description: Unprocessable content
                  value:
                    error:
                      id: 400
                      name: EC_UNPROCESSABLE_CONTENT
                      description: Unable to process provided data.
                    result: ERROR
                    token: 56693a53-4174-4e81-8e9c-b8863a7ad827
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  result:
                    type: string
                    description: Verification result.
                    enum:
                    - ERROR
                  token:
                    type: string
                    format: uuid
                    description: Unique request ID. The whole flow from the request to response has same token so it can be used for debugging in case of error or matching API request with the callback webhook response.
                    example: 123e4567-e89b-12d3-a456-426655440000
              examples:
                Internal server error:
                  summary: Internal server error
                  description: Internal server error
                  value:
                    error:
                      id: 1000
                      name: EC_INTERNAL_ERROR
                      description: Internal error in Infobip platform. Contact Support to resolve the issue.
                    result: ERROR
                    token: 56693a53-4174-4e81-8e9c-b8863a7ad827
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-identity:manage
      x-deprecationInformation:
        deprecation: 2025-12-24T00:00:00.000+0000
  /mi/verification/1/zero-rated/init:
    post:
      tags:
      - connectivity
      summary: Zero rated request initialization
      description: 'Initialise zero rated request.

        This API endpoint is available only in Brazil. Please contact your sales for more details.'
      operationId: initiate-zero-rated-silent-mobile-verification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.InitZeroRatedRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    type: string
                    format: uuid
                    description: Unique request ID. The whole flow from the request to response has same token so it can be used for debugging in case of error or matching API request with the callback webhook response.
                    example: 123e4567-e89b-12d3-a456-426655440000
                  deviceRedirectUrl:
                    type: string
                    format: uri
                    description: An URL to perform mobile device redirect to if specified so by 'status'.
                    example: https://api.infobip.com/mno-domain/smv-check-endpoint
              examples:
                OK:
                  summary: OK
                  description: OK
                  value:
                    token: 6a31ccca-ceba-4998-a3b0-16ae5e182ab0
                    deviceRedirectUrl: https://api.infobip.com/mi/verification/1/zero-rated?token=6a31ccca-ceba-4998-a3b0-16ae5e182ab0
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  token:
                    type: string
                    format: uuid
                    description: Unique request ID. The whole flow from the request to response has same token so it can be used for debugging in case of error or matching API request with the callback webhook response.
                    example: 123e4567-e89b-12d3-a456-426655440000
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    error:
                      id: 202
                      name: EC_CONSENT_NOT_GRANTED
                      description: User consent not granted
                    token: 56693a53-4174-4e81-8e9c-b8863a7ad827
        '401':
          description: Unauthorized - Platform authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Unauthorized:
                  summary: Unauthorized
                  description: Unauthorized
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: Invalid login details
        '403':
          description: Permission denied - Platform authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Permission denied:
                  summary: Permission denied
                  description: Permission denied
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: No permission to access resource
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  token:
                    type: string
                    format: uuid
                    description: Unique request ID. The whole flow from the request to response has same token so it can be used for debugging in case of error or matching API request with the callback webhook response.
                    example: 123e4567-e89b-12d3-a456-426655440000
              examples:
                Internal server error:
                  summary: Internal server error
                  description: Internal server error
                  value:
                    error:
                      id: 1000
                      name: EC_INTERNAL_ERROR
                      description: Internal error in Infobip platform. Contact Support to resolve the issue.
                    token: 56693a53-4174-4e81-8e9c-b8863a7ad827
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-identity:manage
  /mi/verification/1/verify/zero-rated:
    post:
      tags:
      - connectivity
      summary: Zero rated request verify
      description: 'Verify possession of end-user''s mobile phone number with the mobile network operator''s data connection.

        This API endpoint is available only in Brazil. Please contact your sales for more details.'
      operationId: zero-rated-silent-mobile-verification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.VerifyZeroRatedRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: string
                    description: Verification result.
                    enum:
                    - VALID
                    - INVALID
                  token:
                    type: string
                    format: uuid
                    description: Unique request ID. The whole flow from the request to response has same token so it can be used for debugging in case of error or matching API request with the callback webhook response.
                    example: 123e4567-e89b-12d3-a456-426655440000
              examples:
                VALID:
                  summary: VALID
                  description: VALID
                  value:
                    result: VALID
                    token: 6a31ccca-ceba-4998-a3b0-16ae5e182ab0
                INVALID:
                  summary: INVALID
                  description: INVALID
                  value:
                    result: INVALID
                    token: 6a31ccca-ceba-4998-a3b0-16ae5e182ab0
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  result:
                    type: string
                    description: Verification result.
                    enum:
                    - ERROR
                  token:
                    type: string
                    format: uuid
                    description: Unique request ID. The whole flow from the request to response has same token so it can be used for debugging in case of error or matching API request with the callback webhook response.
                    example: 123e4567-e89b-12d3-a456-426655440000
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    result: ERROR
                    token: 6a31ccca-ceba-4998-a3b0-16ae5e182ab0
                    error:
                      id: 201
                      name: EC_INVALID_TOKEN
                      description: Token is invalid or does not exist
        '401':
          description: Unauthorized - Platform authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Unauthorized:
                  summary: Unauthorized
                  description: Unauthorized
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: Invalid login details
        '403':
          description: Permission denied - Platform authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Permission denied:
                  summary: Permission denied
                  description: Permission denied
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: No permission to access resource
        '422':
          description: Unprocessable content
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  result:
                    type: string
                    description: Verification result.
                    enum:
                    - ERROR
                  token:
                    type: string
                    format: uuid
                    description: Unique request ID. The whole flow from the request to response has same token so it can be used for debugging in case of error or matching API request with the callback webhook response.
                    example: 123e4567-e89b-12d3-a456-426655440000
              examples:
                Unprocessable content:
                  summary: Unprocessable content
                  description: Unprocessable content
                  value:
                    result: ERROR
                    token: 6a31ccca-ceba-4998-a3b0-16ae5e182ab0
                    error:
                      id: 400
                      name: EC_UNPROCESSABLE_CONTENT
                      description: Unable to process provided data.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  result:
                    type: string
                    description: Verification result.
                    enum:
                    - ERROR
                  token:
                    type: string
                    format: uuid
                    description: Unique request ID. The whole flow from the request to response has same token so it can be used for debugging in case of error or matching API request with the callback webhook response.
                    example: 123e4567-e89b-12d3-a456-426655440000
              examples:
                Internal server error:
                  summary: Internal server error
                  description: Internal server error
                  value:
                    error:
                      id: 1000
                      name: EC_INTERNAL_ERROR
                      description: Internal error in Infobip platform. Contact Support to resolve the issue.
                    result: ERROR
                    token: 56693a53-4174-4e81-8e9c-b8863a7ad827
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-identity:manage
  /mi/number-intelligence/1/query:
    post:
      tags:
      - connectivity
      summary: Number Intelligence
      description: 'Use this method to perform a query by a mobile phone number (MSISDN) for a given attribute name.

        API and URL may vary per country. Contact your Account Manager for implementation details.'
      operationId: query-number-intelligence
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.NiQueryRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    type: string
                    format: uuid
                    description: Unique request identifier.
              examples:
                OK:
                  summary: OK
                  description: OK
                  value:
                    token: 6a31ccca-ceba-4998-a3b0-16ae5e182ab0
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  token:
                    type: string
                    format: uuid
                    description: Unique request identifier.
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    error:
                      id: 202
                      name: EC_CONSENT_NOT_GRANTED
                      description: User consent not granted
                    token: 56693a53-4174-4e81-8e9c-b8863a7ad827
        '401':
          description: Unauthorized - Platform authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Unauthorized:
                  summary: Unauthorized
                  description: Unauthorized
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: Invalid login details
        '403':
          description: Permission denied - Platform authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Permission denied:
                  summary: Permission denied
                  description: Permission denied
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: No permission to access resource
        '422':
          description: Unprocessable content
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  token:
                    type: string
                    format: uuid
                    description: Unique request identifier.
              examples:
                Unprocessable content:
                  summary: Unprocessable content
                  description: Unprocessable content
                  value:
                    error:
                      id: 400
                      name: EC_UNPROCESSABLE_CONTENT
                      description: Unable to process provided data.
                    token: 56693a53-4174-4e81-8e9c-b8863a7ad827
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  token:
                    type: string
                    format: uuid
                    description: Unique request identifier.
              examples:
                Internal server error:
                  summary: Internal server error
                  description: Internal server error
                  value:
                    error:
                      id: 1000
                      name: EC_INTERNAL_ERROR
                      description: Internal error in Infobip platform. Contact Support to resolve the issue.
                    token: 56693a53-4174-4e81-8e9c-b8863a7ad827
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-identity:manage
  /mi/simswap/1/check:
    post:
      tags:
      - connectivity
      summary: SIM Swap
      description: 'Verify if there was a SIM swap event for a given mobile phone number and period.<br/>

        API and URL may vary per country. Contact your Account Manager for implementation details.'
      operationId: check-sim-swap
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SimSwapCheckRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    type: string
                    format: uuid
                    description: Unique request identifier.
                  simSwapOccurred:
                    type:
                    - boolean
                    - 'null'
                    description: Indicates whether SIM swap occurred in the requested period.
                  networkInfo:
                    type: object
                    description: Additional network information about the SIM swap.
              examples:
                OK:
                  summary: OK
                  description: OK
                  value:
                    requestId: 665b6d63-0b65-4faf-a499-25530f0e93e0
                    simSwapOccurred: false
                    networkInfo:
                      simSwapTimestamp: null
                      simSwapPeriodStartHours: null
                      simSwapPeriodEndHours: null
                With additional timestamp:
                  summary: With additional timestamp
                  description: With additional timestamp
                  value:
                    requestId: 665b6d63-0b65-4faf-a499-25530f0e93e0
                    simSwapOccurred: true
                    networkInfo:
                      simSwapTimestamp: '2020-04-15T20:00:00Z'
                      simSwapPeriodStartHours: null
                      simSwapPeriodEndHours: null
                With additional period:
                  summary: With additional period
                  description: With additional period
                  value:
                    requestId: 665b6d63-0b65-4faf-a499-25530f0e93e0
                    simSwapOccurred: true
                    networkInfo:
                      simSwapTimestamp: null
                      simSwapPeriodStartHours: 24
                      simSwapPeriodEndHours: 72
        '400':
          description: Bad request - no coverage
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  requestId:
                    type: string
                    format: uuid
                    description: Unique request identifier.
                  simSwapOccurred:
                    type:
                    - boolean
                    - 'null'
                    description: Always null on error.
                  networkInfo:
                    type: object
                    description: Network information (may be empty on error).
              examples:
                Bad request - no coverage:
                  summary: Bad request - no coverage
                  description: Bad request - no coverage
                  value:
                    error:
                      id: 100
                      name: EC_NO_COVERAGE
                      description: No coverage for requested mobile phone number
                    requestId: bfe2be7d-69a0-48e7-9672-e3e0236463c7
                    simSwapOccurred: null
                    networkInfo:
                      simSwapTimestamp: null
                      simSwapPeriodStartHours: null
                      simSwapPeriodEndHours: null
        '401':
          description: Unauthorized - Platform authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Unauthorized:
                  summary: Unauthorized
                  description: Unauthorized
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: Invalid login details
        '403':
          description: Permission denied - Platform authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Permission denied:
                  summary: Permission denied
                  description: Permission denied
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: No permission to access resource
        '422':
          description: Unprocessable content
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  requestId:
                    type: string
                    format: uuid
                    description: Unique request identifier.
                  simSwapOccurred:
                    type:
                    - boolean
                    - 'null'
                    description: Always null on error.
                  networkInfo:
                    type: object
                    description: Network information (may be empty on error).
              examples:
                Unprocessable content:
                  summary: Unprocessable content
                  description: Unprocessable content
                  value:
                    error:
                      id: 400
                      name: EC_UNPROCESSABLE_CONTENT
                      description: Unable to process provided data.
                    requestId: 665b6d63-0b65-4faf-a499-25530f0e93e0
                    simSwapOccurred: null
                    networkInfo:
                      simSwapTimestamp: null
                      simSwapPeriodStartHours: null
                      simSwapPeriodEndHours: null
        '500':
          description: Internal error - operation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  requestId:
                    type: string
                    format: uuid
                    description: Unique request identifier.
                  simSwapOccurred:
                    type:
                    - boolean
                    - 'null'
                    description: Always null on error.
                  networkInfo:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
              examples:
                Internal error - operation failed:
                  summary: Internal error - operation failed
                  description: Internal error - operation failed
                  value:
                    error:
                      id: 1000
                      name: EC_INTERNAL_ERROR
                      description: Internal error in Infobip platform. Contact Support to resolve the issue.
                    requestId: 665b6d63-0b65-4faf-a499-25530f0e93e0
                    simSwapOccurred: null
                    networkInfo:
                      simSwapTimestamp: null
                      simSwapPeriodStartHours: null
                      simSwapPeriodEndHours: null
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-identity:manage
  /mi/national-identity-number/1/check:
    post:
      tags:
      - connectivity
      summary: National Identity Number check
      description: 'Check if provided mobile phone number (MSISDN) belongs to user with provided national identity number.

        '
      operationId: check-national-identity-number
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.NinCheckRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    type: string
                    format: uuid
                    description: Unique request identifier.
                  match:
                    type: string
                    description: Match result.
                    enum:
                    - MATCHED
                    - NOT_MATCHED
              examples:
                OK:
                  summary: OK
                  description: OK
                  value:
                    token: 6a31ccca-ceba-4998-a3b0-16ae5e182ab0
                    match: MATCHED
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  token:
                    type: string
                    format: uuid
                    description: Unique request identifier.
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    error:
                      id: 202
                      name: EC_CONSENT_NOT_GRANTED
                      description: User consent not granted
                    token: 56693a53-4174-4e81-8e9c-b8863a7ad827
        '401':
          description: Unauthorized - Platform authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Unauthorized:
                  summary: Unauthorized
                  description: Unauthorized
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: Invalid login details
        '403':
          description: Permission denied - Platform authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Permission denied:
                  summary: Permission denied
                  description: Permission denied
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: No permission to access resource
        '422':
          description: Unprocessable content
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  token:
                    type: string
                    format: uuid
                    description: Unique request identifier.
              examples:
                Unprocessable content:
                  summary: Unprocessable content
                  description: Unprocessable content
                  value:
                    error:
                      id: 400
                      name: EC_UNPROCESSABLE_CONTENT
                      description: Unable to process provided data.
                    token: 56693a53-4174-4e81-8e9c-b8863a7ad827
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto'
                  token:
                    type: string
                    format: uuid
                    description: Unique request identifier.
              examples:
                Internal server error:
                  summary: Internal server error
                  description: Internal server error
                  value:
                    error:
                      id: 1000
                      name: EC_INTERNAL_ERROR
                      description: Internal error in Infobip platform. Contact Support to resolve the issue.
                    token: 56693a53-4174-4e81-8e9c-b8863a7ad827
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-identity:manage
  /biometrics/1/scenarios:
    get:
      tags:
      - connectivity
      summary: Get Scenarios
      description: This function is used to retrieve all scenarios enabled for your account.
      operationId: get-biometrics-scenarios
      parameters:
      - name: applicationTypes
        in: query
        description: 'One or more application types to filter scenarios. If none is set, then scenarios for all application types are returned in the response. Example: `?applicationTypes=extraction,kyc`.'
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            description: Application type identifier.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.ScenarioResponse'
              examples:
                OK:
                  summary: OK
                  description: OK
                  value:
                    scenarios:
                    - name: CODE_EXTRACTION_QR
                      description: Scenario for default code extraction.
                      applicationType: EXTRACTION
                    - name: PASSPORT_MRZ_STANDARD
                      description: Scan MRZ and image from passport, extract MRZ data and ask for selfie to compare it with the scanned image.
                      applicationType: KYC
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Not found:
                  summary: Not found
                  description: Not found
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_UNKNOWN_APPLICATION
                        text: Application cannot be found. Check application name in url parameter!
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Too Many Requests:
                  summary: Too Many Requests
                  description: Too Many Requests
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_TOO_MANY_REQUESTS
                        text: Too many requests.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - biometrics:manage
  /biometrics/1/extraction/sessions:
    get:
      tags:
      - connectivity
      summary: Get Extraction Session
      description: This function is used to retrieve a session by `sessionId` received in [Create Extraction Session](#platform-connectivity/biometrics/create-biometrics-extraction-session) response.
      operationId: get-biometrics-extraction-session
      parameters:
      - name: X-Session-Id
        in: header
        description: Session ID header.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: efc373be-ab6d-4c63-b798-1f65b7b4b2b3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.GetSessionResponse'
              examples:
                OK:
                  summary: OK
                  description: OK
                  value:
                    session:
                      scenarioName: SOME_SCENARIO_NAME
                      locationInfo:
                        country: HRV
                        language: en-US
                      partnerReference: MyRef-jqhof
                      webhook:
                        url: https://example.com/webhook
                        type: ON_END
                      successUrl: https://example.com/success
                      cancelUrl: https://example.com/cancel
                      retainData: true
                      status: ACTIVE
                      id: efc373be-ab6d-4c63-b798-1f65b7b4b2b3
                      applicationType: KYC
                      createdAt: '2021-11-02T14:15:45.7058838Z'
                      validUntil: '2021-11-02T14:25:45.7059354Z'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Not found:
                  summary: Not found
                  description: Not found
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_SESSION_NOT_FOUND
                        text: Session not found. Check session ID!
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Too Many Requests:
                  summary: Too Many Requests
                  description: Too Many Requests
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_TOO_MANY_REQUESTS
                        text: Too many requests.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - biometrics:manage
    post:
      tags:
      - connectivity
      summary: Create Extraction Session
      description: This function is used to initiate a session. It is the very first step for extraction application.
      operationId: create-biometrics-extraction-session
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.ExtractionSessionRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.CreatedSessionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_ACCOUNT_VALIDATION
                        text: Account does not have scenario enabled.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Too Many Requests:
                  summary: Too Many Requests
                  description: Too Many Requests
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_TOO_MANY_REQUESTS
                        text: Too many requests.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - biometrics:manage
    delete:
      tags:
      - connectivity
      summary: Abort Extraction Session
      description: This function is used to abort the session. Use `sessionId` received in the [Create Extraction Session](#platform-connectivity/biometrics/create-biometrics-extraction-session) response.
      operationId: delete-biometrics-extraction-session
      parameters:
      - name: X-Session-Id
        in: header
        description: Session ID header.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: efc373be-ab6d-4c63-b798-1f65b7b4b2b3
      responses:
        '204':
          description: Aborted successfully
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Not found:
                  summary: Not found
                  description: Not found
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_SESSION_NOT_FOUND
                        text: Session not found. Check session ID!
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Too Many Requests:
                  summary: Too Many Requests
                  description: Too Many Requests
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_TOO_MANY_REQUESTS
                        text: Too many requests.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - biometrics:manage
  /biometrics/1/kyc/sessions:
    get:
      tags:
      - connectivity
      summary: Get KYC Session
      description: This function is used to retrieve a session by `sessionId` received in the [Create KYC Session](#platform-connectivity/biometrics/create-biometrics-kyc-session) response.
      operationId: get-biometrics-kyc-session
      parameters:
      - name: X-Session-Id
        in: header
        description: Session ID header.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: efc373be-ab6d-4c63-b798-1f65b7b4b2b3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.GetSessionResponse'
              examples:
                OK:
                  summary: OK
                  description: OK
                  value:
                    session:
                      scenarioName: SOME_SCENARIO_NAME
                      locationInfo:
                        country: HRV
                        language: en-US
                      partnerReference: MyRef-jqhof
                      webhook:
                        url: https://example.com/webhook
                        type: ON_END
                      successUrl: https://example.com/success
                      cancelUrl: https://example.com/cancel
                      retainData: true
                      status: ACTIVE
                      id: efc373be-ab6d-4c63-b798-1f65b7b4b2b3
                      applicationType: KYC
                      createdAt: '2021-11-02T14:15:45.7058838Z'
                      validUntil: '2021-11-02T14:25:45.7059354Z'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Not found:
                  summary: Not found
                  description: Not found
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_SESSION_NOT_FOUND
                        text: Session not found. Check session ID!
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Too Many Requests:
                  summary: Too Many Requests
                  description: Too Many Requests
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_TOO_MANY_REQUESTS
                        text: Too many requests.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - biometrics:manage
    post:
      tags:
      - connectivity
      summary: Create KYC Session
      description: This function is used to initiate a session. It is the very first step for KYC application.
      operationId: create-biometrics-kyc-session
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.KycSessionRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.CreatedSessionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_ACCOUNT_VALIDATION
                        text: Account does not have scenario enabled.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Too Many Requests:
                  summary: Too Many Requests
                  description: Too Many Requests
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_TOO_MANY_REQUESTS
                        text: Too many requests.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - biometrics:manage
    delete:
      tags:
      - connectivity
      summary: Abort KYC Session
      description: This function is used to abort the session. Use `sessionId` received in the [Create KYC Session](#platform-connectivity/biometrics/create-biometrics-kyc-session) response.
      operationId: delete-biometrics-kyc-session
      parameters:
      - name: X-Session-Id
        in: header
        description: Session ID header.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: efc373be-ab6d-4c63-b798-1f65b7b4b2b3
      responses:
        '204':
          description: Aborted successfully
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Not found:
                  summary: Not found
                  description: Not found
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_SESSION_NOT_FOUND
                        text: Session not found. Check session ID!
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Too Many Requests:
                  summary: Too Many Requests
                  description: Too Many Requests
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_TOO_MANY_REQUESTS
                        text: Too many requests.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - biometrics:manage
  /biometrics/1/enrollment/sessions:
    get:
      tags:
      - connectivity
      summary: Get Enrollment Session
      description: This function is used to retrieve a session by `sessionId` received in the [Create Enrollment Session](#platform-connectivity/biometrics/create-biometrics-enrollment-session) response.
      operationId: get-biometrics-enrollment-session
      parameters:
      - name: X-Session-Id
        in: header
        description: Session ID header.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: efc373be-ab6d-4c63-b798-1f65b7b4b2b3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.GetSessionResponse'
              examples:
                OK:
                  summary: OK
                  description: OK
                  value:
                    session:
                      scenarioName: SOME_SCENARIO_NAME
                      locationInfo:
                        country: HRV
                        language: en-US
                      partnerReference: MyRef-jqhof
                      webhook:
                        url: https://example.com/webhook
                        type: ON_END
                      successUrl: https://example.com/success
                      cancelUrl: https://example.com/cancel
                      retainData: true
                      status: ACTIVE
                      id: efc373be-ab6d-4c63-b798-1f65b7b4b2b3
                      applicationType: KYC
                      createdAt: '2021-11-02T14:15:45.7058838Z'
                      validUntil: '2021-11-02T14:25:45.7059354Z'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Not found:
                  summary: Not found
                  description: Not found
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_SESSION_NOT_FOUND
                        text: Session not found. Check session ID!
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Too Many Requests:
                  summary: Too Many Requests
                  description: Too Many Requests
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_TOO_MANY_REQUESTS
                        text: Too many requests.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - biometrics:manage
    post:
      tags:
      - connectivity
      summary: Create Enrollment Session
      description: This function is used to initiate a session. It is the very first step for Enrollment application.
      operationId: create-biometrics-enrollment-session
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.EnrollmentSessionRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.CreatedSessionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_ACCOUNT_VALIDATION
                        text: Account does not have scenario enabled.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Too Many Requests:
                  summary: Too Many Requests
                  description: Too Many Requests
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_TOO_MANY_REQUESTS
                        text: Too many requests.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - biometrics:manage
    delete:
      tags:
      - connectivity
      summary: Abort Enrollment Session
      description: This function is used to abort the session. Use `sessionId` received in the [Create Enrollment Session](#platform-connectivity/biometrics/create-biometrics-enrollment-session) response.
      operationId: delete-biometrics-enrollment-session
      parameters:
      - name: X-Session-Id
        in: header
        description: Session ID header.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: efc373be-ab6d-4c63-b798-1f65b7b4b2b3
      responses:
        '204':
          description: Aborted successfully
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Not found:
                  summary: Not found
                  description: Not found
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_SESSION_NOT_FOUND
                        text: Session not found. Check session ID!
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Too Many Requests:
                  summary: Too Many Requests
                  description: Too Many Requests
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_TOO_MANY_REQUESTS
                        text: Too many requests.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - biometrics:manage
  /biometrics/1/verification/sessions:
    get:
      tags:
      - connectivity
      summary: Get Verification Session
      description: This function is used to retrieve a session by `sessionId` received in the [Create Verification Session](#platform-connectivity/biometrics/create-biometrics-verification-session) response.
      operationId: get-biometrics-verification-session
      parameters:
      - name: X-Session-Id
        in: header
        description: Session ID header.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: efc373be-ab6d-4c63-b798-1f65b7b4b2b3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.GetSessionResponse'
              examples:
                OK:
                  summary: OK
                  description: OK
                  value:
                    session:
                      scenarioName: SOME_SCENARIO_NAME
                      locationInfo:
                        country: HRV
                        language: en-US
                      partnerReference: MyRef-jqhof
                      webhook:
                        url: https://example.com/webhook
                        type: ON_END
                      successUrl: https://example.com/success
                      cancelUrl: https://example.com/cancel
                      retainData: true
                      status: ACTIVE
                      id: efc373be-ab6d-4c63-b798-1f65b7b4b2b3
                      applicationType: KYC
                      createdAt: '2021-11-02T14:15:45.7058838Z'
                      validUntil: '2021-11-02T14:25:45.7059354Z'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Not found:
                  summary: Not found
                  description: Not found
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_SESSION_NOT_FOUND
                        text: Session not found. Check session ID!
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Too Many Requests:
                  summary: Too Many Requests
                  description: Too Many Requests
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_TOO_MANY_REQUESTS
                        text: Too many requests.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - biometrics:manage
    post:
      tags:
      - connectivity
      summary: Create Verification Session
      description: This function is used to initiate a session. It is the very first step for Verification application.
      operationId: create-biometrics-verification-session
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.VerificationSessionRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.CreatedSessionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_ACCOUNT_VALIDATION
                        text: Account does not have scenario enabled.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Too Many Requests:
                  summary: Too Many Requests
                  description: Too Many Requests
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_TOO_MANY_REQUESTS
                        text: Too many requests.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - biometrics:manage
    delete:
      tags:
      - connectivity
      summary: Abort Verification Session
      description: This function is used to abort the session. Use `sessionId` received in the [Create Verification Session](#platform-connectivity/biometrics/create-biometrics-verification-session) response.
      operationId: delete-biometrics-verification-session
      parameters:
      - name: X-Session-Id
        in: header
        description: Session ID header.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: efc373be-ab6d-4c63-b798-1f65b7b4b2b3
      responses:
        '204':
          description: Aborted successfully
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Not found:
                  summary: Not found
                  description: Not found
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_SESSION_NOT_FOUND
                        text: Session not found. Check session ID!
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Too Many Requests:
                  summary: Too Many Requests
                  description: Too Many Requests
                  value:
                    requestError:
                      serviceException:
                        messageId: EC_TOO_MANY_REQUESTS
                        text: Too many requests.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - biometrics:manage
  /camara/number-verification/v0/authorize:
    get:
      tags:
      - connectivity
      summary: Number verify device authorization
      description: 'Use this method to redirect the mobile device on the MNO network for authorization, based on the mobile device IP address.

        Upon authorization, the device is redirected back to the URL specified in `redirectUrl`.

        When redirected back, a new query parameter `code` is being added.

        It needs to be sent in a subsequent verify request to complete verification.


        **Error handling behavior:**

        - When `redirectUrl` parameter **is provided**: All errors are returned as a 302 redirect back to the `redirectUrl` with OAuth 2.0 error query parameters (`error`, `error_description` (optional), `state`).

        - When `redirectUrl` parameter **is NOT provided**: A JSON response is returned (see below).

        '
      operationId: authorize-number-verify
      parameters:
      - name: clientId
        in: query
        description: Client ID to identify the client on whose behalf the device is making the request. This is **provided to the client** upon registration. The value is usually the username that is being used to login into Infobip portal when generating [API key header](https://www.infobip.com/docs/essentials/api-essentials/api-authentication#api-key-header) and/or client_id that is being used when [generating OAuth2 token](https://www.infobip.com/docs/api/platform/account-management/create-oauth2-token).
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: enterprise-client-id
      - name: redirectUrl
        in: query
        description: URL to redirect back the device to after authorization on MNO network. **This URL needs to be static**. For request tracking and correlation purposes, the `state` query parameter will be added to this URL before redirecting the device back.
        required: true
        style: form
        explode: true
        schema:
          type: string
          format: uri
        example: https://enterprise.com/authorization-complete
      - name: state
        in: query
        description: String that will be returned as a query parameter in the `redirectUrl`.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 51A7_7131
      - name: login_hint
        in: query
        description: OIDC login hint. Expects a phone number in `tel:+{phone_number_with_country_code}` format.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: tel:+441134961234
      responses:
        '302':
          description: ' Redirect to MNO authorization endpoint. Response body is empty, information is returned in response headers.'
          headers:
            Location:
              description: 'MNO authorization endpoint URL


                **Error redirect:** When an error occurs and `redirectUrl` was provided, the error is returned as OAuth 2.0 query parameters in the redirect URL.


                **Error redirect URL format:** `{redirectUrl}?error={error_code}&error_description={error_description}&state={state}`


                Note: `error_description` is optional.


                **OAuth error codes:**


                - `invalid_request` - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed.

                - `unauthorized_client` - The client is not authorized to request an authorization code using this method.

                - `access_denied` - The user or authorization server denied the request (for example, the user cannot be authenticated or denied the consent).

                - `unsupported_response_type` - The authorization server does not support obtaining an authorization code using this method.

                - `invalid_scope` - The requested scope is either invalid, unknown, or malformed.

                - `consent_required` - The authorization server requires user consent.

                - `server_error` - The authorization server encountered an unexpected condition that prevented it from fulfilling the request.

                - `temporarily_unavailable` - The authorization server is currently unable to handle the request due to a temporary overloading or maintenance of the server.

                - `invalid_request_object` - The request parameter contains an invalid Request Object.

                - `request_uri_not_supported` - The authorization server does not support use of the request_uri parameter.

                '
              style: simple
              explode: false
              schema:
                type: string
                format: uri
                example: https://mno.example.com/authorize?queryParam=...
            x-correlator:
              description: Correlation ID for tracking the request
              style: simple
              explode: false
              schema:
                type: string
                format: uuid
                example: 6a31ccca-ceba-4998-a3b0-16ae5e182ab0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraResponseBaseDto'
        '400':
          description: 'Bad request.

            When `redirectUrl` is available, this error is returned via 302 redirect with `error=invalid_request`'
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 400
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - INVALID_ARGUMENT
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Client specified an invalid argument, request body or query param
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    status: 400
                    code: INVALID_ARGUMENT
                    message: Client specified an invalid argument, request body or query param
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraUnauthenticatedErrorResponse'
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Unauthenticated:
                  summary: Unauthenticated
                  description: Unauthenticated
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHENTICATED
                        text: Invalid login details
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 500
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - INTERNAL
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Server error
              examples:
                Internal server error:
                  summary: Internal server error
                  description: Internal server error
                  value:
                    status: 500
                    code: INTERNAL
                    message: Server error
  /camara/number-verification/v0/verify:
    post:
      tags:
      - connectivity
      summary: Number Verification
      description: Use this method to verify possession of the end-user's mobile phone number with the mobile network operator's data connection.
      operationId: verify-number
      parameters:
      - name: X-Correlator
        in: header
        description: '`Code` parameter that was received on `/authorize` request. This header is not required only if OAuth2 `grant_type=authorization_code` was used on token generation.'
        required: false
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
      requestBody:
        description: Number verification request object.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.NumberVerifyRequestDto'
            examples:
              Phone verification:
                summary: Phone verification
                description: Phone verification
                value:
                  phoneNumber: '+441134961234'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.NumberVerifyResponseDto'
              examples:
                Verified:
                  summary: Verified
                  description: Verified
                  value:
                    devicePhoneNumberVerified: true
                Not verified:
                  summary: Not verified
                  description: Not verified
                  value:
                    devicePhoneNumberVerified: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 400
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - INVALID_ARGUMENT
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Client specified an invalid argument, request body or query param
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    status: 400
                    code: INVALID_ARGUMENT
                    message: Client specified an invalid argument, request body or query param
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraUnauthenticatedErrorResponse'
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Unauthenticated:
                  summary: Unauthenticated
                  description: Unauthenticated
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHENTICATED
                        text: Invalid login details
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraPermissionDeniedErrorResponse'
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Permission denied:
                  summary: Permission denied
                  description: Permission denied
                  value:
                    status: 403
                    code: PERMISSION_DENIED
                    message: Client does not have sufficient permissions to perform this action
                Unauthorized:
                  summary: Unauthorized
                  description: Unauthorized
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: Invalid login details
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 404
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - NOT_FOUND
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Not found
              examples:
                Not found:
                  summary: Not found
                  description: Not found
                  value:
                    status: 404
                    code: NOT_FOUND
                    message: Not found
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 409
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - CONFLICT
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Another request is created for the same MSISDN
              examples:
                Conflict:
                  summary: Conflict
                  description: Conflict
                  value:
                    status: 409
                    code: CONFLICT
                    message: Another request is created for the same MSISDN
        '422':
          description: Unprocessable content
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 422
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - SERVICE_NOT_APPLICABLE
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - The service is not available for the provided identifier
              examples:
                Unprocessable content:
                  summary: Unprocessable content
                  description: Unprocessable content
                  value:
                    status: 422
                    code: SERVICE_NOT_APPLICABLE
                    message: The service is not available for the provided identifier
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 500
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - INTERNAL
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Server error
              examples:
                Internal server error:
                  summary: Internal server error
                  description: Internal server error
                  value:
                    status: 500
                    code: INTERNAL
                    message: Server error
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-identity:manage
  /camara/number-verification/v2/dcql:
    post:
      tags:
      - connectivity
      summary: Number verification DCQL Request
      description: Use this method to generate a credential request structure for the Android CredentialManager. The response must be passed to the device for SIM-based (TS.43) authentication.
      operationId: create-dcql-request
      requestBody:
        description: DCQL request object specifying the desired use case
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.DcqlRequestDto'
            examples:
              Get phone number:
                summary: Get phone number
                description: Get phone number
                value:
                  useCase: GET_PHONE_NUMBER
                  nonce: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                  carrierIds:
                  - 123
                  - 456
              Verify phone number:
                summary: Verify phone number
                description: Verify phone number
                value:
                  useCase: VERIFY_PHONE_NUMBER
                  nonce: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                  carrierIds:
                  - 123
                  - 456
        required: true
      responses:
        '200':
          description: OK — per-carrier map of DCQL credential objects or error objects
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.DcqlResponseDto'
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.DcqlNotFoundErrorResponse'
              examples:
                All carriers successful:
                  summary: All carriers successful
                  description: All carriers successful
                  value:
                    '123':
                      id: miapi.infobip.com
                      format: dc-authorization+sd-jwt
                      meta:
                        credential_authorization_jwt: eyJhbGciOiJFUzI1NiIs...
                        vct_values:
                        - number-verification/device-phone-number/ts43
                      claims:
                      - path:
                        - android_carrier_hint
                        values:
                        - 123
                    '456':
                      id: miapi.infobip.com
                      format: dc-authorization+sd-jwt
                      meta:
                        credential_authorization_jwt: eyJhbGciOiJFUzI1NiIs...
                        vct_values:
                        - number-verification/device-phone-number/ts43
                      claims:
                      - path:
                        - android_carrier_hint
                        values:
                        - 456
                Some carriers failed, some succeeded:
                  summary: Some carriers failed, some succeeded
                  description: Some carriers failed, some succeeded
                  value:
                    '123':
                      id: miapi.infobip.com
                      format: dc-authorization+sd-jwt
                      meta:
                        credential_authorization_jwt: eyJhbGciOiJFUzI1NiIs...
                        vct_values:
                        - number-verification/device-phone-number/ts43
                      claims:
                      - path:
                        - android_carrier_hint
                        values:
                        - 123
                    '456':
                      status: 404
                      code: NOT_FOUND
                      message: Not found
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 400
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - INVALID_ARGUMENT
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Client specified an invalid argument, request body or query param
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    status: 400
                    code: INVALID_ARGUMENT
                    message: Client specified an invalid argument, request body or query param
        '401':
          description: Unauthorized - Platform authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Unauthorized:
                  summary: Unauthorized
                  description: Unauthorized
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: Invalid login details
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraPermissionDeniedErrorResponse'
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Permission denied:
                  summary: Permission denied
                  description: Permission denied
                  value:
                    status: 403
                    code: PERMISSION_DENIED
                    message: Client does not have sufficient permissions to perform this action
                Unauthorized:
                  summary: Unauthorized
                  description: Unauthorized
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: Invalid login details
        '422':
          description: Unprocessable content
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 422
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - SERVICE_NOT_APPLICABLE
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - The service is not available for the provided identifier
              examples:
                Unprocessable content:
                  summary: Unprocessable content
                  description: Unprocessable content
                  value:
                    status: 422
                    code: SERVICE_NOT_APPLICABLE
                    message: The service is not available for the provided identifier
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 500
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - INTERNAL
                  message:
                    type: string
                    enum:
                    - Server error
              examples:
                Internal server error:
                  summary: Internal server error
                  description: Internal server error
                  value:
                    status: 500
                    code: INTERNAL
                    message: Server error
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-identity:manage
  /camara/number-verification/v2/device-phone-number:
    get:
      tags:
      - connectivity
      summary: Get Phone Number
      description: Use this method to retrieve the phone number associated with the device SIM.
      operationId: get-device-phone-number
      parameters:
      - name: X-Correlator
        in: header
        description: In SIM based (TS.43) verification flow this should be the `vp_token` (SD-JWT) value received from Android Credential Manager.
        required: false
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.DevicePhoneNumberResponseDto'
              examples:
                Verified:
                  summary: Verified
                  description: Verified
                  value:
                    devicePhoneNumber: '+441134961234'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 400
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - INVALID_ARGUMENT
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Client specified an invalid argument, request body or query param
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    status: 400
                    code: INVALID_ARGUMENT
                    message: Client specified an invalid argument, request body or query param
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraUnauthenticatedErrorResponse'
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Unauthenticated:
                  summary: Unauthenticated
                  description: Unauthenticated
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHENTICATED
                        text: Invalid login details
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraPermissionDeniedErrorResponse'
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Permission denied:
                  summary: Permission denied
                  description: Permission denied
                  value:
                    status: 403
                    code: PERMISSION_DENIED
                    message: Client does not have sufficient permissions to perform this action
                Unauthorized:
                  summary: Unauthorized
                  description: Unauthorized
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: Invalid login details
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 404
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - NOT_FOUND
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Not found
              examples:
                Not found:
                  summary: Not found
                  description: Not found
                  value:
                    status: 404
                    code: NOT_FOUND
                    message: Not found
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 409
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - CONFLICT
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Another request is created for the same MSISDN
              examples:
                Conflict:
                  summary: Conflict
                  description: Conflict
                  value:
                    status: 409
                    code: CONFLICT
                    message: Another request is created for the same MSISDN
        '422':
          description: Unprocessable content
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 422
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - SERVICE_NOT_APPLICABLE
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - The service is not available for the provided identifier
              examples:
                Unprocessable content:
                  summary: Unprocessable content
                  description: Unprocessable content
                  value:
                    status: 422
                    code: SERVICE_NOT_APPLICABLE
                    message: The service is not available for the provided identifier
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 500
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - INTERNAL
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Server error
              examples:
                Internal server error:
                  summary: Internal server error
                  description: Internal server error
                  value:
                    status: 500
                    code: INTERNAL
                    message: Server error
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-identity:manage
  /camara/number-verification/v2/verify:
    post:
      tags:
      - connectivity
      summary: Number Verification
      description: Use this method to verify possession of the end-user's mobile phone number with the phone SIM card.
      operationId: verify-number-v2
      parameters:
      - name: X-Correlator
        in: header
        description: 'In SIM based (TS.43) verification flow this should be the `vp_token` (SD-JWT) value received from Android Credential Manager. If using SIM based (TS.43) verification flow, this header is mandatory.

          '
        required: false
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: Number verification request object.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.NumberVerifyV2RequestDto'
            examples:
              Phone verification:
                summary: Phone verification
                description: Phone verification
                value:
                  phoneNumber: '+441134961234'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.NumberVerifyResponseDto'
              examples:
                Verified:
                  summary: Verified
                  description: Verified
                  value:
                    devicePhoneNumberVerified: true
                Not verified:
                  summary: Not verified
                  description: Not verified
                  value:
                    devicePhoneNumberVerified: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 400
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - INVALID_ARGUMENT
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Client specified an invalid argument, request body or query param
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    status: 400
                    code: INVALID_ARGUMENT
                    message: Client specified an invalid argument, request body or query param
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraUnauthenticatedErrorResponse'
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Unauthenticated:
                  summary: Unauthenticated
                  description: Unauthenticated
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHENTICATED
                        text: Invalid login details
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraPermissionDeniedErrorResponse'
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Permission denied:
                  summary: Permission denied
                  description: Permission denied
                  value:
                    status: 403
                    code: PERMISSION_DENIED
                    message: Client does not have sufficient permissions to perform this action
                Unauthorized:
                  summary: Unauthorized
                  description: Unauthorized
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: Invalid login details
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 404
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - NOT_FOUND
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Not found
              examples:
                Not found:
                  summary: Not found
                  description: Not found
                  value:
                    status: 404
                    code: NOT_FOUND
                    message: Not found
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 409
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - CONFLICT
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Another request is created for the same MSISDN
              examples:
                Conflict:
                  summary: Conflict
                  description: Conflict
                  value:
                    status: 409
                    code: CONFLICT
                    message: Another request is created for the same MSISDN
        '422':
          description: Unprocessable content
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 422
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - SERVICE_NOT_APPLICABLE
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - The service is not available for the provided identifier
              examples:
                Unprocessable content:
                  summary: Unprocessable content
                  description: Unprocessable content
                  value:
                    status: 422
                    code: SERVICE_NOT_APPLICABLE
                    message: The service is not available for the provided identifier
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 500
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - INTERNAL
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Server error
              examples:
                Internal server error:
                  summary: Internal server error
                  description: Internal server error
                  value:
                    status: 500
                    code: INTERNAL
                    message: Server error
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-identity:manage
  /camara/location/v0/verify:
    post:
      tags:
      - connectivity
      summary: Device Location Verification
      description: 'Use this method to verify whether the device location is within a requested area.

        A circle with a center specified by the latitude and longitude, and a radius specified by the accuracy.

        '
      operationId: verify-device-location
      requestBody:
        description: Device location verification request object.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraDeviceLocationVerifyRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  verificationResult:
                    type: boolean
                    description: Result of the location verification.
              examples:
                In requested radius:
                  summary: In requested radius
                  description: In requested radius
                  value:
                    verificationResult: true
                Not in requested radius:
                  summary: Not in requested radius
                  description: Not in requested radius
                  value:
                    verificationResult: false
        '303':
          description: Give consent for device location verification
          content:
            application/json:
              schema:
                type: object
                properties:
                  consentUrl:
                    type: string
                    format: uri
                    description: URL to redirect user for consent.
              examples:
                Consent not given:
                  summary: Consent not given
                  description: Consent not given
                  value:
                    consentUrl: https://mno.com/consent-page
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 400
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - INVALID_ARGUMENT
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Client specified an invalid argument, request body or query param
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    status: 400
                    code: INVALID_ARGUMENT
                    message: Client specified an invalid argument, request body or query param
        '401':
          description: Unauthorized - Platform authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Unauthorized:
                  summary: Unauthorized
                  description: Unauthorized
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: Invalid login details
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraPermissionDeniedErrorResponse'
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Permission denied:
                  summary: Permission denied
                  description: Permission denied
                  value:
                    status: 403
                    code: PERMISSION_DENIED
                    message: Client does not have sufficient permissions to perform this action
                Unauthorized:
                  summary: Unauthorized
                  description: Unauthorized
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: Invalid login details
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 404
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - NOT_FOUND
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Not found
              examples:
                Not found:
                  summary: Not found
                  description: Not found
                  value:
                    status: 404
                    code: NOT_FOUND
                    message: Not found
        '422':
          description: Unprocessable content
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 422
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - SERVICE_NOT_APPLICABLE
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - The service is not available for the provided identifier
              examples:
                Unprocessable content:
                  summary: Unprocessable content
                  description: Unprocessable content
                  value:
                    status: 422
                    code: SERVICE_NOT_APPLICABLE
                    message: The service is not available for the provided identifier
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 500
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - INTERNAL
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Server error
              examples:
                Internal server error:
                  summary: Internal server error
                  description: Internal server error
                  value:
                    status: 500
                    code: INTERNAL
                    message: Server error
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-identity:manage
  /camara/sim-swap/v0/check:
    post:
      tags:
      - connectivity
      summary: SIM Swap
      description: Use this method to verify if there was a SIM swap event for a given mobile phone number and period.
      operationId: sim-swap-check
      requestBody:
        description: SIM swap check request object.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraSimSwapCheckRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraSimSwapCheckResponseDto'
              examples:
                OK:
                  summary: OK
                  description: OK
                  value:
                    swapped: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 400
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - INVALID_ARGUMENT
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Client specified an invalid argument, request body or query param
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    status: 400
                    code: INVALID_ARGUMENT
                    message: Client specified an invalid argument, request body or query param
        '401':
          description: Unauthorized - Platform authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Unauthorized:
                  summary: Unauthorized
                  description: Unauthorized
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: Invalid login details
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraPermissionDeniedErrorResponse'
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Permission denied:
                  summary: Permission denied
                  description: Permission denied
                  value:
                    status: 403
                    code: PERMISSION_DENIED
                    message: Client does not have sufficient permissions to perform this action
                Unauthorized:
                  summary: Unauthorized
                  description: Unauthorized
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: Invalid login details
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 404
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - SIM_SWAP.UNKNOWN_PHONE_NUMBER
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - SIM Swap can't be checked because the phone number is unknown
              examples:
                Not found:
                  summary: Not found
                  description: Not found
                  value:
                    status: 404
                    code: SIM_SWAP.UNKNOWN_PHONE_NUMBER
                    message: SIM Swap can't be checked because the phone number is unknown
        '422':
          description: Unprocessable content
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 422
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - SERVICE_NOT_APPLICABLE
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - The service is not available for the provided identifier
              examples:
                Unprocessable content:
                  summary: Unprocessable content
                  description: Unprocessable content
                  value:
                    status: 422
                    code: SERVICE_NOT_APPLICABLE
                    message: The service is not available for the provided identifier
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 500
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - INTERNAL
                  message:
                    type: string
                    enum:
                    - Server error
              examples:
                Internal server error:
                  summary: Internal server error
                  description: Internal server error
                  value:
                    status: 500
                    code: INTERNAL
                    message: Server error
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-identity:manage
  /camara/sim-swap/v0/retrieve-date:
    post:
      tags:
      - connectivity
      summary: Retrieve SIM Swap date
      description: Use this method to retrieve the last date when the SIM Swap occurred for a given mobile phone number.
      operationId: sim-swap-retrieve-date
      requestBody:
        description: SIM swap retrieve date request object.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraSimSwapRetrieveDateRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraSimSwapRetrieveDateResponseDto'
              examples:
                OK:
                  summary: OK
                  description: OK
                  value:
                    latestSimChange: '2024-01-03T02:05:58Z'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 400
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - INVALID_ARGUMENT
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Client specified an invalid argument, request body or query param
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    status: 400
                    code: INVALID_ARGUMENT
                    message: Client specified an invalid argument, request body or query param
        '401':
          description: Unauthorized - Platform authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Unauthorized:
                  summary: Unauthorized
                  description: Unauthorized
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: Invalid login details
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraPermissionDeniedErrorResponse'
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Permission denied:
                  summary: Permission denied
                  description: Permission denied
                  value:
                    status: 403
                    code: PERMISSION_DENIED
                    message: Client does not have sufficient permissions to perform this action
                Unauthorized:
                  summary: Unauthorized
                  description: Unauthorized
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: Invalid login details
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 404
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - NOT_FOUND
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Not found
              examples:
                Not found:
                  summary: Not found
                  description: Not found
                  value:
                    status: 404
                    code: NOT_FOUND
                    message: Not found
        '422':
          description: Unprocessable content
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 422
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - SERVICE_NOT_APPLICABLE
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - The service is not available for the provided identifier
              examples:
                Unprocessable content:
                  summary: Unprocessable content
                  description: Unprocessable content
                  value:
                    status: 422
                    code: SERVICE_NOT_APPLICABLE
                    message: The service is not available for the provided identifier
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 500
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - INTERNAL
                  message:
                    type: string
                    enum:
                    - Server error
              examples:
                Internal server error:
                  summary: Internal server error
                  description: Internal server error
                  value:
                    status: 500
                    code: INTERNAL
                    message: Server error
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-identity:manage
  /camara/kyc-match/v0.3/match:
    post:
      tags:
      - connectivity
      summary: KYC Match
      description: Use this method to match customer data against Mobile Operators data.
      operationId: know-your-customer-match
      requestBody:
        description: KYC match request object.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraKycMatchRequestDto'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraKycMatchResponseDto'
              examples:
                OK:
                  summary: OK
                  description: OK
                  value:
                    idDocumentMatch: 'true'
                    nameMatch: 'false'
                    nameMatchScore: 85
                    givenNameMatch: 'false'
                    givenNameMatchScore: 90
                    familyNameMatch: 'true'
                    nameKanaHankakuMatch: not_available
                    nameKanaZenkakuMatch: 'false'
                    nameKanaZenkakuMatchScore: 70
                    middleNamesMatch: 'true'
                    familyNameAtBirthMatch: 'false'
                    familyNameAtBirthMatchScore: 60
                    addressMatch: 'false'
                    addressMatchScore: 80
                    streetNameMatch: 'true'
                    streetNumberMatch: 'false'
                    streetNumberMatchScore: 75
                    postalCodeMatch: 'true'
                    regionMatch: 'false'
                    regionMatchScore: 65
                    localityMatch: 'true'
                    countryMatch: 'true'
                    houseNumberExtensionMatch: not_available
                    birthdateMatch: 'true'
                    emailMatch: 'false'
                    emailMatchScore: 88
                    genderMatch: 'true'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 400
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - INVALID_ARGUMENT
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Client specified an invalid argument, request body or query param
              examples:
                Bad request:
                  summary: Bad request
                  description: Bad request
                  value:
                    status: 400
                    code: INVALID_ARGUMENT
                    message: Client specified an invalid argument, request body or query param
        '401':
          description: Unauthorized - Platform authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Unauthorized:
                  summary: Unauthorized
                  description: Unauthorized
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: Invalid login details
        '403':
          description: Permission denied
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraPermissionDeniedErrorResponse'
                - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse'
              examples:
                Permission denied:
                  summary: Permission denied
                  description: Permission denied
                  value:
                    status: 403
                    code: PERMISSION_DENIED
                    message: Client does not have sufficient permissions to perform this action
                Unauthorized:
                  summary: Unauthorized
                  description: Unauthorized
                  value:
                    requestError:
                      serviceException:
                        messageId: UNAUTHORIZED
                        text: Invalid login details
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 404
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - NOT_FOUND
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Not found
              examples:
                Not found:
                  summary: Not found
                  description: Not found
                  value:
                    status: 404
                    code: NOT_FOUND
                    message: Not found
        '422':
          description: Unprocessable content
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 422
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - SERVICE_NOT_APPLICABLE
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - The service is not available for the provided identifier
              examples:
                Unprocessable content:
                  summary: Unprocessable content
                  description: Unprocessable content
                  value:
                    status: 422
                    code: SERVICE_NOT_APPLICABLE
                    message: The service is not available for the provided identifier
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    enum:
                    - 500
                  code:
                    type: string
                    description: Error code.
                    enum:
                    - INTERNAL
                  message:
                    type: string
                    description: Detailed error message.
                    enum:
                    - Server error
              examples:
                Internal server error:
                  summary: Internal server error
                  description: Internal server error
                  value:
                    status: 500
                    code: INTERNAL
                    message: Server error
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-identity:manage
webhooks:
  receive-silent-mobile-verification-result:
    post:
      tags:
      - connectivity
      summary: Receive silent mobile verification result
      description: Silent mobile verification request will be processed asynchronously after the request is made to silent mobile verification API. After processing of the request is done, results will be delivered to the URL provided in silent mobile verification request.
      externalDocs:
        description: Learn more about the Mobile Identity platform and its use cases.
        url: https://www.infobip.com/docs/mobile-identity
      operationId: receive-silent-mobile-verification-result
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/acc54cffc2fdf57be1405002c65f11d7bb0b2506a15f7e1c75bb3cbcc41d6219.ResultResponse'
            examples:
              Successful response:
                summary: Successful response
                description: Successful silent mobile verification result.
                value:
                  result: VALID
                  token: 123e4567-e89b-12d3-a456-426655440000
                  error: null
              Unsuccessful response:
                summary: Unsuccessful response
                description: Error occurred while processing silent mobile verification request.
                value:
                  result: ERROR
                  token: 123e4567-e89b-12d3-a456-426655440000
                  error:
                    id: 202
                    name: EC_CONSENT_NOT_GRANTED
                    description: User consent not granted
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-advanced-silent-mobile-verification-result:
    post:
      tags:
      - connectivity
      summary: Receive advanced silent mobile verification result
      description: Advanced silent mobile verification request will be processed asynchronously after the request is made to advanced silent mobile verification API. After processing of the request is done, results will be delivered to the URL provided in advanced silent mobile verification request.
      externalDocs:
        description: Learn more about the Mobile Identity platform and its use cases.
        url: https://www.infobip.com/docs/mobile-identity
      operationId: receive-advanced-silent-mobile-verification-result
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/aaab91bc67ad6fdd15298ef61b480f76a93a7cae8c7684c83b1e909cda7f154f.ResultResponse'
            examples:
              Successful response:
                summary: Successful response
                description: Successful advanced silent mobile verification result.
                value:
                  token: 123e4567-e89b-12d3-a456-426655440000
                  result: VALID
                  status: COMPLETED
                  error: null
              Unsuccessful response:
                summary: Unsuccessful response
                description: Error occurred while processing silent mobile verification request.
                value:
                  token: 123e4567-e89b-12d3-a456-426655440000
                  result: ERROR
                  status: COMPLETED
                  error:
                    id: 202
                    name: EC_CONSENT_NOT_GRANTED
                    description: User consent not granted
              Unsuccessful response and fallback to SMS:
                summary: Unsuccessful response and fallback to SMS
                description: Error occurred while processing silent mobile verification request and fallback to SMS was issued.
                value:
                  token: 123e4567-e89b-12d3-a456-426655440000
                  result: OTP_SMS_SENT
                  status: COMPLETED
                  error: null
              Successful response with detected SIM Swap event:
                summary: Successful response with detected SIM Swap event
                description: Successful advanced silent mobile verification result of a detected SIM Swap event.
                value:
                  token: 123e4567-e89b-12d3-a456-426655440000
                  result: SIM_SWAP_DETECTED
                  status: COMPLETED
                  error: null
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-number-intelligence-query-results:
    post:
      tags:
      - connectivity
      summary: Receive number intelligence query results
      description: Number intelligence query request will be processed asynchronously after the request is made to number intelligence API. After processing of the request is done, results will be delivered to the URL provided in number intelligence request.
      externalDocs:
        description: Learn more about the Mobile Identity platform and its use cases.
        url: https://www.infobip.com/docs/mobile-identity
      operationId: receive-number-intelligence-query-results
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c33580c9fc909cbe636f10f5fddd71adf658d961011f6b0e7df8bbb45e9ab4cb.QueryResultResponse'
            examples:
              Successful response:
                summary: Successful response
                description: Successful SIM swap attribute query result.
                value:
                  token: e1ec531a-1de8-4c2e-8fee-464c7769ce90
                  niAttributes:
                    simSwap:
                      simSwapOccurred: true
                      networkInfo:
                        simSwapTimestamp: '2020-04-15T20:00:00+02:00'
                        simSwapPeriodStartHours: null
                        simSwapPeriodEndHours: null
                    nationalIdentityNumber:
                      match: MATCHED
              Error on attribute level:
                summary: Error on attribute level
                description: Error occurred while querying SIM swap attribute.
                value:
                  token: e1ec531a-1de8-4c2e-8fee-464c7769ce90
                  niAttributes:
                    simSwap:
                      simSwapOccurred: null
                      networkInfo: null
                      error:
                        id: 101
                        name: EC_GATEWAY_OPERATION_FAILED
                        description: Provider service failed
                    nationalIdentityNumber:
                      match: null
                      error:
                        id: 101
                        name: EC_GATEWAY_OPERATION_FAILED
                        description: Provider service failed
              Error on number intelligence operation level:
                summary: Error on number intelligence operation level
                description: Error occurred while executing number intelligence operation.
                value:
                  token: e1ec531a-1de8-4c2e-8fee-464c7769ce90
                  niAttributes: 'null'
                  error:
                    id: 202
                    name: EC_CONSENT_NOT_GRANTED
                    description: User consent not granted
              National Identity Number NO_DATA match:
                summary: National Identity Number NO_DATA match
                description: National Identity Number could not conclude due to insufficient data from a provider.
                value:
                  token: e1ec531a-1de8-4c2e-8fee-464c7769ce90
                  niAttributes:
                    nationalIdentityNumber:
                      match: NO_DATA
                      error:
                        id: 1
                        name: EC_UNKNOWN_SUBSCRIBER
                        description: The number does not exist or it has not been assigned to any active subscriber in the operator’s user database.
                    simSwap:
                      simSwapOccurred: true
                      networkInfo:
                        simSwapTimestamp: null
                        simSwapPeriodStartHours: 24
                        simSwapPeriodEndHours: 48
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-extraction-session-results:
    post:
      tags:
      - connectivity
      summary: Receive Extraction Session Results
      description: Webhook that will be called with information about the Extraction Session status and results. The webhook URL provided in the [Create Extraction Session](#platform-connectivity/biometrics/create-biometrics-extraction-session) request will be called with the POST method that contains all the info in JSON format. It only expects `200 OK` status with no content in response.
      operationId: receive-extraction-session-results
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.ExtractionWebhookRequest'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback
  receive-kyc-session-results:
    post:
      tags:
      - connectivity
      summary: Receive KYC Session Results
      description: Webhook which will be called with information about the KYC session status and results. The webhook URL provided in the [Create KYC Session](#platform-connectivity/biometrics/create-biometrics-kyc-session) request will be called with the POST method that contains all the info in JSON format. It only expects `200 OK` status with no content in response.
      operationId: receive-kyc-session-results
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.KycWebhookRequest'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback
  receive-enrollment-session-results:
    post:
      tags:
      - connectivity
      summary: Receive Enrollment Session Results
      description: Webhook that will be called with information about the Enrollment Session status and results. The webhook URL provided in the [Create Enrollment Session](#platform-connectivity/biometrics/create-biometrics-enrollment-session) request will be called with the POST method that contains all the info in JSON format. It only expects `200 OK` status with no content in response.
      operationId: receive-enrollment-session-results
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.EnrollmentWebhookRequest'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback
  receive-verification-session-results:
    post:
      tags:
      - connectivity
      summary: Receive Verification Session Results
      description: Webhook which will be called with information about the Verification session status and results. The webhook URL provided in the [Create Verification Session](#platform-connectivity/biometrics/create-biometrics-verification-session) request will be called with the POST method that contains all the info in JSON format. It only expects `200 OK` status with no content in response.
      operationId: receive-verification-session-results
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.VerificationWebhookRequest'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback
components:
  schemas:
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcResponseAsync:
      type: object
      properties:
        results:
          type: array
          description: Collection of preliminary lookup results.
          items:
            $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcResponseAsyncDetails'
        bulkId:
          type: string
          description: The ID that uniquely identifies the request.
      title: NcResponseAsync
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.NumberVerifyV2RequestDto:
      type: object
      properties:
        phoneNumber:
          type: string
          description: Mobile phone number (MSISDN) to verify. The number must be in international format.
          example: '+441134961234'
      required:
      - phoneNumber
      title: NumberVerifyV2RequestDto
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcLogPrice:
      type: object
      properties:
        currency:
          type: string
          description: The currency in which the price is expressed.
          readOnly: true
        pricePerLookup:
          type: number
          format: double
          description: Price per one NC lookup.
          readOnly: true
      title: NcLogPrice
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcResponseAsyncDetails:
      type: object
      description: Collection of preliminary lookup results.
      properties:
        to:
          type: string
          description: The looked up phone number.
          readOnly: true
        status:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcStatus'
        messageId:
          type: string
          description: The ID that uniquely identifies the performed lookup.
          readOnly: true
      title: NcResponseAsyncDetails
    8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.ScenarioDescription:
      type: object
      description: Object containing scenario identifier and its description.
      properties:
        name:
          type: string
          description: Scenario identifier. This value should be used in all Create Session requests.
        description:
          type: string
          description: Scenario description.
        applicationType:
          type: string
          description: Application type identifier.
      title: ScenarioDescription
    8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.LocationInfo:
      type: object
      description: End user location information.
      properties:
        country:
          type: string
          description: End user country needed for processing documents. Format [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3).
          example: HRV
        language:
          type: string
          default: en-US
          description: 'End user language. Will be used within the UI when completing scenario steps. Format: [ISO 639-1](http://www.lingoes.net/en/translator/langcode.htm).'
          example: en-US
      required:
      - country
      title: LocationInfo
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraNotFoundErrorResponse:
      type: object
      description: Camara API error response.
      properties:
        status:
          type: integer
          format: int32
          description: HTTP status code.
          example: 404
        code:
          type: string
          description: Error code.
          example: NOT_FOUND
        message:
          type: string
          description: Detailed error message.
          example: Not found
      title: Camara Error Response
    8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.ExtractionSessionRequest:
      type: object
      description: JSON containing session parameters and client identifiers for extraction application.
      properties:
        scenarioName:
          type: string
          description: 'Request a specific scenario within the application. To get possible values call [Get Scenarios](#platform-connectivity/biometrics/get-biometrics-scenarios) with the following query parameter: `?applicationTypes=extraction`. Check scenario descriptions in the response to find the scenario you need, and copy its `name`.'
          example: CODE_EXTRACTION_QR
        locationInfo:
          $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.LocationInfo'
        partnerReference:
          type: string
          description: Your (usually unique) identifier of the end user performing the scenario. Will be sent together with the rest of the information via the webhook.
          example: MyRef-jqhof
        webhook:
          $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.WebhookInfo'
        successUrl:
          type: string
          description: End user will be sent to this URL after the selected scenario has been successfully completed.
          example: https://example.com/success
        cancelUrl:
          type: string
          description: End user will be sent to this URL if they cancel the scenario.
          example: https://example.com/cancel
        retainData:
          type: boolean
          description: Indicates whether Infobip should store and retain data. This value overrides value in account configuration.
          example: true
      required:
      - locationInfo
      - scenarioName
      - webhook
      title: ExtractionSessionRequest
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.DeviceLocationRequestDto:
      type: object
      description: Check if provided MSISDN is in location defined by provided coordinates.
      properties:
        latitude:
          type: number
          format: float
          description: Latitude that will be used to check for location of a mobile phone for provided phone number.
          maximum: 90
          minimum: -90
        longitude:
          type: number
          format: float
          description: Longitude that will be used to check for location of a mobile phone for provided phone number.
          maximum: 180
          minimum: -180
        accuracy:
          type: integer
          format: int32
          description: Accuracy in km that will be used to check for location of a mobile phone for provided phone number.
          maximum: 20
          minimum: 2
      title: DeviceLocationRequestDto
    eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.EnrollmentWebhookRequest:
      type: object
      properties:
        sessionId:
          type: string
          description: Unique session identifier.
          example: efc373be-ab6d-4c63-b798-1f65b7b4b2b3
        partnerReference:
          type: string
          description: Your identifier of the end user performing a scenario sent in the initial request.
          example: MyRef-jqhof
        status:
          type: string
          description: Current session status.
          enum:
          - CREATED
          - ACTIVE
          - SUCCESS
          - EXPIRED
          - CANCELED
          example: SUCCESS
        data:
          $ref: '#/components/schemas/eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.EnrollmentWebhookData'
      required:
      - data
      - partnerReference
      - sessionId
      title: EnrollmentWebhookRequest
    c33580c9fc909cbe636f10f5fddd71adf658d961011f6b0e7df8bbb45e9ab4cb.QueryResultResponse:
      type: object
      description: Query result for each attribute sent to number intelligence query request
      properties:
        token:
          type: string
          description: Unique request identifier. This value was returned on number intelligence query request.
        niAttributes:
          type: object
          description: List of query results for attributes provided on number intelligence query request.
          properties:
            simSwap:
              type: object
              description: Object representing SIM swap occurrence.
              properties:
                simSwapOccurred:
                  type: boolean
                  description: Information if SIM swap has occurred or not.
                networkInfo:
                  type: object
                  description: Addition time information about SIM swap occurrence.
                  properties:
                    simSwapTimestamp:
                      type: string
                      description: Timestamp of SIM swap occurrence. This value will is null in case there is no information about occurrence timestamp.
                    simSwapPeriodStartHours:
                      type: number
                      format: integer
                      description: Starting hour of time frame when SIM swap occurred. This value will is null in case there is no information about occurrence timeframe starting hour.
                    simSwapPeriodEndHours:
                      type: number
                      format: integer
                      description: Ending hour of time frame when SIM swap occurred. This value will is null in case there is no information about occurrence timeframe ending hour.
                error:
                  $ref: '#/components/schemas/4503c9be2d8553d1e8648e283b9ba9017ae14f51177b500d7b5df7dc4842e4d2.ErrorInfoResponse'
            nationalIdentityNumber:
              type: object
              description: Object representing if national identity number and MSISDN matches.
              properties:
                match:
                  type: string
                  description: Information if user with provided national identity number owns provided MSISDN.
                  enum:
                  - MATCHED
                  - NOT_MATCHED
                  - NO_DATA
                error:
                  $ref: '#/components/schemas/4503c9be2d8553d1e8648e283b9ba9017ae14f51177b500d7b5df7dc4842e4d2.ErrorInfoResponse'
        error:
          $ref: '#/components/schemas/4503c9be2d8553d1e8648e283b9ba9017ae14f51177b500d7b5df7dc4842e4d2.ErrorInfoResponse'
      title: NumberIntelligenceQueryResultResponse
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.NumberVerifyRequestDto:
      type: object
      description: Number verification request object.
      properties:
        phoneNumber:
          type: string
          description: Mobile phone number (MSISDN) to verify. The number must be in international format.
          example: '+441134961234'
      required:
      - phoneNumber
      title: NumberVerifyRequestDto
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.DltDto:
      type: object
      description: Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
      properties:
        principalEntityId:
          type: string
          description: Your assigned DLT principal entity ID.
        contentTemplateId:
          type: string
          description: Registered DLT content template ID which matches message you are sending.
      required:
      - principalEntityId
      title: DltDto
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.AttributesRequestDto:
      type: object
      description: 'Object with parameters per attribute for Number Intelligence to query.<br/>

        Attribute value <strong>MUST NOT</strong> be <strong>null</strong> as in that case it will be ignored.<br/>

        In some cases where attribute value has no parameters it <strong>NEEDS TO BE</strong> an empty object.'
      example:
        simSwap:
          period: 24
        nationalIdentityNumber:
          nationalId: 123.456.789-10
      properties:
        simSwap:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SimSwapRequestDto'
        nationalIdentityNumber:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.NationalIdentityNumberDto'
        deviceLocation:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.DeviceLocationRequestDto'
      title: AttributesRequestDto
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcResponse:
      type: object
      properties:
        results:
          type: array
          description: Collection of lookup results.
          items:
            $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcResponseDetails'
        bulkId:
          type: string
          description: The ID that uniquely identifies the request.
      title: NcResponse
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SmvVerifySynchronousRequestDto:
      type: object
      description: Silent Mobile Verification Synchronous request object.
      properties:
        consentGranted:
          type: boolean
          description: Indicates whether you have consent from mobile phone number's owner to perform this request. All requests that do not have this property set to "true" will be rejected.
          example: true
        phoneNumber:
          type: string
          description: Mobile phone number (MSISDN) to verify. The number must be in international format.
          example: '441134961234'
        deviceIp:
          type: string
          format: xxx.xxx.xxx.xxx|xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx
          description: IPv4 or IPv6 address of the mobile device that will be verified with operator.
          example: 10.20.30.100|1111:22222:3333:4444:AAAA:BBBB:CCCC:DDDD
        devicePort:
          type: integer
          format: int32
          description: Port of the mobile device that will be verified with operator. Can be used only when "deviceIp" is also provided.
          example: 54321
      required:
      - consentGranted
      - deviceIp
      - devicePort
      - phoneNumber
      title: SmvVerifySynchronousRequestDto
    aaab91bc67ad6fdd15298ef61b480f76a93a7cae8c7684c83b1e909cda7f154f.ResultResponse:
      type: object
      description: Advanced silent mobile verification request result
      properties:
        token:
          type: string
          description: Unique request identifier. This value was returned on advanced silent mobile verification request.
        result:
          type: string
          description: Advanced silent mobile verification request result.
          enum:
          - UNABLE_TO_VERIFY
          - SIM_SWAP_DETECTED
          - SIM_SWAP_CHECK_FAILED
          - INVALID
          - VALID
          - OTP_SMS_SENT
        status:
          type: string
          description: Advanced silent mobile verification request status.
          enum:
          - COMPLETED
          - DEVICE_REDIRECT
        error:
          $ref: '#/components/schemas/4503c9be2d8553d1e8648e283b9ba9017ae14f51177b500d7b5df7dc4842e4d2.ErrorInfoResponse'
      title: AdvancedSilentMobileVerificationResultResponse
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraDeviceLocationVerifyRequestDto:
      type: object
      properties:
        ueId:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraUserEquipmentIdentifierDto'
        uePort:
          type: integer
          format: int32
          description: User equipment port.
          example: 8080
          maximum: 65535
          minimum: 0
        latitude:
          type: number
          format: double
          description: Latitude of the location.
          example: 51.5074
          maximum: 90
          minimum: -90
        longitude:
          type: number
          format: double
          description: Longitude of the location.
          example: -0.1278
          maximum: 180
          minimum: -180
        accuracy:
          type: integer
          format: int32
          description: Radius of the circle in kilometers.
          example: 10
          maximum: 200
          minimum: 2
      required:
      - accuracy
      - latitude
      - longitude
      - ueId
      title: CamaraDeviceLocationVerifyRequestDto
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SmsFailoverDto:
      type: object
      description: SMS failover message contents. In case this field is null, no SMS failover will be done.
      properties:
        from:
          type: string
          description: Message failover sender.
          example: '441134961234'
        text:
          type: string
          description: Message failover text.
          example: 'One time verification pin: 1234'
        validityPeriod:
          type: integer
          format: int32
          description: The message validity period in seconds. When the period expires, it will not be allowed for the message to be sent.
          example: 5
          minimum: 0
        regional:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.RegionalDto'
      required:
      - from
      - text
      title: SmsFailoverDto
    eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.VerificationWebhookRequest:
      type: object
      properties:
        sessionId:
          type: string
          description: Unique session identifier.
          example: efc373be-ab6d-4c63-b798-1f65b7b4b2b3
        partnerReference:
          type: string
          description: Your identifier of the end user performing a scenario sent in the initial request.
          example: MyRef-jqhof
        status:
          type: string
          description: Current session status.
          enum:
          - CREATED
          - ACTIVE
          - SUCCESS
          - EXPIRED
          - CANCELED
          example: SUCCESS
        data:
          $ref: '#/components/schemas/eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.VerificationWebhookData'
      required:
      - data
      - partnerReference
      - sessionId
      title: VerificationWebhookRequest
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcStatus:
      type: object
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group ID.
          readOnly: true
        groupName:
          type: string
          description: Status group name that describes which category the status code belongs to, e.g. PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED.
          readOnly: true
        id:
          type: integer
          format: int32
          description: Status ID.
          readOnly: true
        name:
          type: string
          description: '[Status name](https://www.infobip.com/docs/essentials/response-status-and-error-codes).'
          readOnly: true
        description:
          type: string
          description: Human-readable description of the status.
          readOnly: true
        action:
          type: string
          description: Action that should be taken to recover from the error.
          readOnly: true
      title: NcStatus
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcQueryRequest:
      type: object
      properties:
        to:
          type: array
          description: 'Array of phone numbers to look up. Numbers must be in international format (Example: `41793026727`). Numbers longer than 256 characters in the request will be clipped during processing. The clipped numbers will be included in the response, reports, and logs.'
          items:
            type: string
            description: 'Array of phone numbers to look up. Numbers must be in international format (Example: `41793026727`). Numbers longer than 256 characters in the request will be clipped during processing. The clipped numbers will be included in the response, reports, and logs.'
          maxItems: 1000
          minItems: 1
      required:
      - to
      title: NcQueryRequest
      xml:
        name: NumberContextRequest
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.RegionalDto:
      type: object
      description: Region specific parameters, often specified by local laws. Use this if country or region that you are sending SMS to requires some extra parameters.
      properties:
        indiaDlt:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.DltDto'
      title: RegionalDto
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SimSwapCheckRequestDto:
      type: object
      description: SIM Swap request object.
      properties:
        consentGranted:
          type: boolean
          description: Indicates whether you have consent from mobile phone number's owner to perform this request. All requests that do not have this property set to "true" will be rejected.
          example: true
        phoneNumber:
          type: string
          description: Mobile phone number (MSISDN) to verify. The number must be in international format.
          example: '441134961234'
        period:
          type: integer
          format: int32
          description: SIM swap check will be verified with MNO in "period" amount of hours from when this request was received. The value should be greater than 0.
          example: 15
          minimum: 0
      required:
      - consentGranted
      - period
      - phoneNumber
      title: SimSwapCheckRequestDto
    eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.KycWebhookRequest:
      type: object
      properties:
        sessionId:
          type: string
          description: Unique session identifier.
          example: efc373be-ab6d-4c63-b798-1f65b7b4b2b3
        partnerReference:
          type: string
          description: Your identifier of the end user performing a scenario sent in the initial request.
          example: MyRef-jqhof
        status:
          type: string
          description: Current session status.
          enum:
          - CREATED
          - ACTIVE
          - SUCCESS
          - EXPIRED
          - CANCELED
          example: SUCCESS
        data:
          $ref: '#/components/schemas/eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.KycWebhookData'
      required:
      - data
      - partnerReference
      - sessionId
      title: KycWebhookRequest
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Network:
      type: object
      description: Information about the roaming network.
      properties:
        networkName:
          type: string
          description: Optional human readable name of the network.
          readOnly: true
        networkPrefix:
          type: string
          description: Network prefix.
          readOnly: true
        countryName:
          type: string
          description: Optional name of the country the network operates in.
          readOnly: true
        countryPrefix:
          type: string
          description: Country prefix.
          readOnly: true
        networkId:
          type: integer
          format: int32
          description: ID of the network.
          readOnly: true
      readOnly: true
      title: Network Information
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraSimSwapRetrieveDateResponseDto:
      type: object
      description: SIM swap retrieve date response object.
      properties:
        latestSimChange:
          type: string
          format: date-time
          description: Timestamp of the latest SIM swap event.
      title: CamaraSimSwapRetrieveDateResponseDto
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.VerifyZeroRatedRequestDto:
      type: object
      description: Silent Mobile Verification zero rated request verification.
      properties:
        token:
          type: string
          format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
          description: 'Unique request ID.<br>

            The whole flow from the request to response has same token so it can be used for debugging in case of error or matching API request with the callback webhook response.'
          example: 123e4567-e89b-12d3-a456-426655440000
      title: VerifyZeroRatedRequestDto
    8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.EnrollmentSessionRequest:
      type: object
      description: JSON containing session parameters and client identifiers for Enrollment application.
      properties:
        scenarioName:
          type: string
          description: 'Request a specific scenario within the application. To get possible values call [Get Scenarios](#platform-connectivity/biometrics/get-biometrics-scenarios) with the following query parameter: `?applicationTypes=enrollment`. Check scenario descriptions in the response to find the scenario you need, and copy its `name`.'
          example: FACE_ENROLLMENT
        locationInfo:
          $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.LocationInfo'
        partnerReference:
          type: string
          description: Your (usually unique) identifier of the end user performing the scenario. Will be sent together with the rest of the information via the webhook.
          example: MyRef-jqhof
        webhook:
          $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.WebhookInfo'
        successUrl:
          type: string
          description: End user will be sent to this URL after the selected scenario has been successfully completed.
          example: https://example.com/success
        cancelUrl:
          type: string
          description: End user will be sent to this URL if they cancel the scenario.
          example: https://example.com/cancel
        retainData:
          type: boolean
          description: Indicates whether Infobip should store and retain data. This value overrides value in account configuration.
          example: true
      required:
      - locationInfo
      - scenarioName
      - webhook
      title: EnrollmentSessionRequest
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ErrorDto:
      type:
      - object
      - 'null'
      description: Error object describing occurred error, present only if an error has occurred.
      properties:
        id:
          type: integer
          format: int32
          description: 'Unique identifier of occurred error on Infobip platform.<br/>

            Response Status and Error Codes documentation page, section [Mobile Identity Error Codes](https://www.infobip.com/docs/essentials/response-status-and-error-codes#mobile-identity-error-codes),

            contains all available Mobile Identity error IDs.'
        name:
          type: string
          description: 'Unique value of occurred error under Mobile Identity product.<br/>

            Response Status and Error Codes documentation page, section [Mobile Identity Error Codes](https://www.infobip.com/docs/essentials/response-status-and-error-codes#mobile-identity-error-codes),

            contains all available Mobile Identity error codes.'
        description:
          type: string
          description: 'Description of occurred error for easier error comprehension.<br/>

            Response Status and Error Codes documentation page, section [Mobile Identity Error Codes](https://www.infobip.com/docs/essentials/response-status-and-error-codes#mobile-identity-error-codes),

            contains descriptions of all errors that can occur on Mobile Identity platform.'
      title: ErrorDto
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.DcqlRequestDto:
      type: object
      properties:
        useCase:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.Ts43UseCase'
        nonce:
          type: string
          description: 'A single-use, client generated value. The client keeps it and uses it to correlate the eventual response. Infobip embeds this same value in the credential_authorization_jwt payload.

            '
          example: 2307e608-e619-4df5-a460-a99b4446f3f0
        carrierIds:
          type: array
          description: Array of Android canonical carrier IDs.
          example:
          - 123
          - 456
          items:
            type: integer
            format: int32
            description: Array of Android canonical carrier IDs.
        operationType:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.OperationType'
      required:
      - carrierIds
      - nonce
      - useCase
      title: DcqlRequestDto
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.Claim:
      type: object
      description: Claim object containing the optional hint used by Android to suggest the right SIM in dual-SIM devices.
      properties:
        path:
          type: array
          description: Name of the hint parameter
          example:
          - android_carrier_hint
          items:
            type: string
            description: Name of the hint parameter
            example: '["android_carrier_hint"]'
        values:
          type: array
          description: Value of the hint parameter
          example:
          - 1234
          items:
            type: integer
            format: int32
            description: Value of the hint parameter
      title: Claim
    4033c81feb806caaa02f9cef553f79f0137a7aaa85d200d9d5e6449874c43c3d.NcLogResponse:
      type: object
      properties:
        results:
          type: array
          description: Collection of logs.
          items:
            $ref: '#/components/schemas/4033c81feb806caaa02f9cef553f79f0137a7aaa85d200d9d5e6449874c43c3d.NcLog'
      title: NcLogResponse
    8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.BiometricData:
      type: object
      description: Biometric data.
      oneOf:
      - $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.BiometricReference'
      - $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.BiometricVector'
      title: BiometricData
    8018948352e80bbff88731d9fb43f611b84a58f2b44c304c63a8e4ae9c4bd661.ReportMetadata:
      type: object
      properties:
        reportId:
          type: string
          description: The unique reportId. Needed for accessing the report content
          example: 138a2a58-0cf3-4ed3-a828-c3dc35eb2bb6
          maxLength: 64
        networkName:
          type: string
          description: The name of network that provided the report content.
          example: Verizon Wireless
        networkId:
          type: integer
          format: int32
          description: The networkId of network that provided the report content.
          example: 1717
        generatedDate:
          type: string
          description: 'Date in UTC then given report was generated. Format: yyyy-MM-dd'
          example: '2024-03-09'
        dateFrom:
          type: string
          description: 'Date in UTC that defines since when the report has data about activation changes on a given network. <br />Format: yyyy-MM-ddNote that multiple reports for the same date range on the same network are possible. <br />'
          example: '2024-03-07'
        dateTo:
          type: string
          description: 'Date in UTC that defines till when the report has data about activation changes on a given network. <br />Format: yyyy-MM-dd <br />Note that multiple reports for the same date range on the same network are possible.'
          example: '2024-03-08'
        expiryDate:
          type: string
          description: 'Date in UTC that defines when the report will be considered expired and consequently deleted. <br />Format: yyyy-MM-dd'
          example: '2024-06-08'
      required:
      - dateFrom
      - dateTo
      - expiryDate
      - generatedDate
      - networkId
      - networkName
      - reportId
      title: ReportMetadata
    8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.KycSessionRequest:
      type: object
      description: JSON containing session parameters and client identifiers for KYC application.
      properties:
        scenarioName:
          type: string
          description: 'Request a specific scenario within the application. To get possible values call [Get Scenarios](#platform-connectivity/biometrics/get-biometrics-scenarios) with the following query parameter: `?applicationTypes=kyc`. Check scenario descriptions in the response to find the scenario you need, and copy its `name`.'
          example: KYC_PASSPORT_HRV
        locationInfo:
          $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.LocationInfo'
        partnerReference:
          type: string
          description: Your (usually unique) identifier of the end user performing the scenario. Will be sent together with the rest of the information via the webhook.
          example: MyRef-jqhof
        webhook:
          $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.WebhookInfo'
        successUrl:
          type: string
          description: End user will be sent to this URL after the selected scenario has been successfully completed.
          example: https://example.com/success
        cancelUrl:
          type: string
          description: End user will be sent to this URL if they cancel the scenario.
          example: https://example.com/cancel
        retainData:
          type: boolean
          description: Indicates whether Infobip should store and retain data. This value overrides value in account configuration.
          example: true
      required:
      - locationInfo
      - scenarioName
      - webhook
      title: KycSessionRequest
    8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.GenericSession:
      type: object
      description: Session object.
      properties:
        scenarioName:
          type: string
          description: Request a specific scenario within the application.
          example: SOME_SCENARIO_NAME
        locationInfo:
          $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.LocationInfo'
        partnerReference:
          type: string
          description: Your (usually unique) identifier of the end user performing the scenario. Will be sent together with the rest of the information via the webhook.
          example: MyRef-jqhof
        webhook:
          $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.WebhookInfo'
        successUrl:
          type: string
          description: End user will be sent to this URL after the selected scenario has been successfully completed.
          example: https://example.com/success
        cancelUrl:
          type: string
          description: End user will be sent to this URL if they cancel the scenario.
          example: https://example.com/cancel
        retainData:
          type: boolean
          description: Indicates whether Infobip should store and retain data. This value overrides value in account configuration.
          example: true
        status:
          type: string
          description: Current session status.
          enum:
          - CREATED
          - ACTIVE
          - SUCCESS
          - EXPIRED
          - CANCELED
          example: ACTIVE
        id:
          type: string
          description: Unique session identifier.
          example: efc373be-ab6d-4c63-b798-1f65b7b4b2b3
        applicationType:
          type: string
          description: Application type identifier.
          example: KYC
        createdAt:
          type: string
          format: date-time
          description: 'Session creation date and time. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          example: '2021-11-02T14:15:45.7058838Z'
        validUntil:
          type: string
          format: date-time
          description: 'Session validity date and time. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          example: '2021-11-02T14:25:45.7059354Z'
      required:
      - locationInfo
      - scenarioName
      - webhook
      title: GenericSession
    eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.ExtractionWebhookData:
      type: object
      description: Result data object.
      properties:
        payload:
          type: string
          description: Payload extracted from scanned code.
          example: '1234567890'
      title: ExtractionWebhookData
    eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.ExtractionWebhookRequest:
      type: object
      properties:
        sessionId:
          type: string
          description: Unique session identifier.
          example: efc373be-ab6d-4c63-b798-1f65b7b4b2b3
        partnerReference:
          type: string
          description: Your identifier of the end user performing a scenario sent in the initial request.
          example: MyRef-jqhof
        status:
          type: string
          description: Current session status.
          enum:
          - CREATED
          - ACTIVE
          - SUCCESS
          - EXPIRED
          - CANCELED
          example: SUCCESS
        data:
          $ref: '#/components/schemas/eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.ExtractionWebhookData'
      required:
      - data
      - partnerReference
      - sessionId
      title: ExtractionWebhookRequest
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraSimSwapRetrieveDateRequestDto:
      type: object
      properties:
        phoneNumber:
          type: string
          description: Mobile phone number (MSISDN) to verify. The number must be in international format.
          example: '+441134961234'
      required:
      - phoneNumber
      title: CamaraSimSwapRetrieveDateRequestDto
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SmvVerifyRequestDto:
      type: object
      description: Silent Mobile Verification request object.
      properties:
        consentGranted:
          type: boolean
          description: Indicates whether you have consent from mobile phone number's owner to perform this request. All requests that do not have this property set to "true" will be rejected.
          example: true
        phoneNumber:
          type: string
          description: Mobile phone number (MSISDN) to verify. The number must be in international format.
          example: '441134961234'
        callbackUrl:
          type: string
          description: Your URL that will be called to provide [result](#platform-connectivity/mobile-identity/receive-silent-mobile-verification-result) when the process is completed.
          example: https://api.infobip.com/my-callback-webook/my-path
        returnUrl:
          type: string
          description: An URL to which the mobile device will be redirected to when verification is complete.
          example: https://api.infobip.com/my-site/my-shop.html
        deviceIp:
          type: string
          format: xxx.xxx.xxx.xxx|xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx
          description: IPv4 or IPv6 address of the mobile device that will be verified with operator. Currently, can be used only in Brazil.
          example: 10.20.30.100|1111:22222:3333:4444:AAAA:BBBB:CCCC:DDDD
        devicePort:
          type: integer
          format: int32
          description: Port of the mobile device that will be verified with operator. Can be used only when "deviceIp" is also provided. Currently, can be used only in Brazil.
          example: 54321
      required:
      - callbackUrl
      - consentGranted
      - phoneNumber
      title: SmvVerifyRequestDto
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraSimSwapCheckRequestDto:
      type: object
      properties:
        phoneNumber:
          type: string
          description: Mobile phone number (MSISDN) to verify. The number must be in international format.
          example: '+441134961234'
        maxAge:
          type: integer
          format: int32
          default: 240
          description: SIM swap check will be verified with MNO in "period" amount of hours from when this request was received. The value should be greater than 0.
          example: 15
          maximum: 2400
          minimum: 1
      required:
      - phoneNumber
      title: CamaraSimSwapCheckRequestDto
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.Meta:
      type: object
      properties:
        credential_authorization_jwt:
          type: string
          description: JWT token for credential authorization signed by Infobip.
          example: eyJhbGciOiJIUzI1NiI...
        vct_values:
          type: array
          description: Array containing the Google-defined TS.43 credential type identifier that corresponds to the CAMARA scope from the request
          items:
            type: string
            description: Array containing the Google-defined TS.43 credential type identifier that corresponds to the CAMARA scope from the request
      title: Meta
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcNotifyRequest:
      type: object
      properties:
        notifyContentType:
          type: string
          description: Preferred lookup report content type. Can be `application/json` or `application/xml`.
        notifyUrl:
          type: string
          description: The URL on your call back server on which the lookup report will be sent.
        to:
          type: array
          description: 'Array of phone numbers to look up. Numbers must be in international format (Example: `41793026727`). Numbers longer than 256 characters in the request will be clipped during processing. The clipped numbers will be included in the response, reports, and logs.'
          items:
            type: string
            description: 'Array of phone numbers to look up. Numbers must be in international format (Example: `41793026727`). Numbers longer than 256 characters in the request will be clipped during processing. The clipped numbers will be included in the response, reports, and logs.'
      required:
      - to
      title: NcNotifyRequest
      xml:
        name: NumberContextRequest
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.NiQueryRequestDto:
      type: object
      description: Number Intelligence query request object.
      properties:
        consentGranted:
          type: boolean
          description: Indicates whether you have consent from mobile phone number's owner to perform this request. All requests that do not have this property set to "true" will be rejected.
          example: true
        phoneNumber:
          type: string
          description: Mobile phone number (MSISDN) to perform a query by. The number must be in international format.
          example: '441134961234'
        callbackUrl:
          type: string
          description: Your URL that will be called to provide [query results](#platform-connectivity/mobile-identity/receive-number-intelligence-query-results) when the process is completed.
          example: https://api.infobip.com/my-callback-webook/my-path
        attributes:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.AttributesRequestDto'
      required:
      - attributes
      - callbackUrl
      - consentGranted
      - phoneNumber
      title: NiQueryRequestDto
    4033c81feb806caaa02f9cef553f79f0137a7aaa85d200d9d5e6449874c43c3d.NcLog:
      type: object
      description: Collection of logs.
      properties:
        bulkId:
          type: string
          description: The ID that uniquely identifies the request.
        messageId:
          type: string
          description: The ID that uniquely identifies the performed lookup.
        to:
          type: string
          description: The looked up phone number.
        sentAt:
          type: string
          format: date-time
          description: 'Tells when the lookup was performed. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        doneAt:
          type: string
          format: date-time
          description: 'Tells when Infobip finished processing the lookup (e.g. lookup request was delivered to the destination network). Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        mccMnc:
          type: string
          description: Mobile country and network codes.
        price:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcLogPrice'
        status:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcStatus'
        error:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcError'
      title: NcLog
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.NumberVerifyResponseDto:
      type: object
      description: Number verification response object.
      properties:
        devicePhoneNumberVerified:
          type: boolean
          description: Device verification result.
      title: NumberVerifyResponseDto
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.DcqlResponseDto:
      type: object
      additionalProperties:
        allOf:
        - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.DcqlCredentialPerCarrierDtoResponse'
        x-additionalPropertiesName: carrierId
      description: 'Map of resolved DCQL credential objects keyed by carrier ID, used to build the credential request structure for the Android

        CredentialManager (TS.43 SIM-based authentication). If one or more requested carriers could not be resolved, their error responses

        will be returned in the same map. For unresolved carrier response structure, see `DCQL Carrier Error Map` section.

        '
      title: DCQL Credential Map
    8018948352e80bbff88731d9fb43f611b84a58f2b44c304c63a8e4ae9c4bd661.DeactivationType:
      type: string
      description: 'Type of the activation information. Potential values are: <br />    DEACTIVATION - number was deactivated. All messaging to this number must stop. <br />  ACTIVATION - number was activated after being deactivated previously. These numbers must opt-in again to a program to begin any messaging activity. <br />  SUSPENSION - number got suspended. Messaging to this number must be suspended. <br />  REACTIVATION - number was reactivated after being previously suspended. Messaging to this number can resume. <br />'
      enum:
      - DEACTIVATION
      - REACTIVATION
      - SUSPENSION
      example: DEACTIVATION
      title: DeactivationType
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraResponseBaseDto:
      type: object
      title: CamaraResponseBaseDto
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcResponseDetails:
      type: object
      description: Collection of lookup results.
      properties:
        to:
          type: string
          description: The looked up phone number.
          readOnly: true
        mccMnc:
          type: string
          description: Mobile country code and mobile network code concatenated. MccMnc will start with the MCC, and it will always have three digits, followed by the MNC (length of the MNC depends on the value of the MCC, and it can be two or three).
          readOnly: true
        imsi:
          type: string
          description: International Mobile Subscriber Identity, used to uniquely identify the user of a mobile network.
          readOnly: true
        originalNetwork:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Network'
        ported:
          type: boolean
          description: True if number has been ported.
          readOnly: true
        portedNetwork:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Network'
        roaming:
          type: boolean
          description: True if number is currently in roaming.
          readOnly: true
        roamingNetwork:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Network'
        servingMSC:
          type: string
          description: Serving mobile switching center.
          readOnly: true
        status:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcStatus'
        error:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcError'
      title: NcResponseDetails
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.NationalIdentityNumberDto:
      type: object
      description: Check if provided MSISDN belongs to user with provided national identity number.
      properties:
        nationalId:
          type: string
          description: 'National Identification Number that will be used to check for a match against a mobile phone number.

            '
          minLength: 1
        documentType:
          type: string
          description: 'Document type that will be used to check for a match against a mobile phone number.

            Currently, used and mandatory only in Colombia. Available values are `CC`, `CE` and `NIT`.

            '
      title: NationalIdentityNumberDto
    8018948352e80bbff88731d9fb43f611b84a58f2b44c304c63a8e4ae9c4bd661.PageReportMetadata:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/8018948352e80bbff88731d9fb43f611b84a58f2b44c304c63a8e4ae9c4bd661.ReportMetadata'
        paging:
          $ref: '#/components/schemas/8018948352e80bbff88731d9fb43f611b84a58f2b44c304c63a8e4ae9c4bd661.PageInfo'
      title: PageReportMetadata
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ServiceException:
      type: object
      description: Service exception object containing error details.
      properties:
        messageId:
          type: string
          description: Identifier of the error.
          example: UNAUTHORIZED
        text:
          type: string
          description: Detailed error description.
          example: Invalid login details
      title: ServiceException
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraSimSwapCheckResponseDto:
      type: object
      description: SIM swap check response object.
      properties:
        swapped:
          type: boolean
          description: Indicates whether the SIM card has been swapped during the period.
      title: CamaraSimSwapCheckResponseDto
    8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.BiometricVector:
      type: object
      allOf:
      - $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.BiometricData'
      - type: object
        properties:
          vector:
            type: array
            description: Biometric vector associated with the end user. Used when Infobip didn't store the vector in enrolment phase.
            example:
            - -0.09652680158615112
            - 0.07107646763324738
            - -0.029479391872882843
            - -0.006973235867917538
            items:
              type: number
              format: double
      title: BiometricVector
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SimSwapRequestDto:
      type: object
      description: Check if sim swap has occurred for requested MSISDN in provided time period.
      properties:
        period:
          type: integer
          format: int32
          description: 'If SIM swap attribute is included it will be verified with MNO allowed hour period.

            The value should be greater than 0.

            '
          example: 15
          minimum: 0
      title: SimSwapRequestDto
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraPermissionDeniedErrorResponse:
      type: object
      description: Camara API error response for permission denied requests.
      properties:
        status:
          type: integer
          format: int32
          description: HTTP status code.
          example: 403
        code:
          type: string
          description: Error code.
          example: PERMISSION_DENIED
        message:
          type: string
          description: Detailed error message.
          example: Client does not have sufficient permissions to perform this action
      title: Camara Error Response
    8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.ScenarioResponse:
      type: object
      properties:
        scenarios:
          type: array
          description: List of all enabled scenarios.
          items:
            $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.ScenarioDescription'
      title: ScenarioResponse
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SimSwapCheckDto:
      type: object
      description: SIM swap check parameters. In case this field is null, no SIM swap checks will be done.
      properties:
        period:
          type: integer
          format: int32
          description: SIM swap check will be verified with MNO in "period" amount of hours from when this request was received. The value should be greater than 0.
          example: 15
          minimum: 0
        proceedOn:
          type: array
          description: 'If specified, proceed to the SMV verify in case:

            - SIM swap check fails

            - There is no SIM swap coverage

            - Result of the SIM swap check was unknown'
          items:
            $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SimSwapProceedOnDto'
          uniqueItems: true
      required:
      - period
      title: SimSwapCheckDto
    eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.MrzWebhookData:
      type: object
      description: Results of reading Machine Readable Zone (MRZ) data.
      properties:
        name:
          type: string
          description: Name; part of the MRZ name of a holder.
          example: NAME
        surname:
          type: string
          description: Surname; part of the MRZ name of a holder.
          example: SURNAME
        documentNumber:
          type: string
          description: MRZ document number.
          example: '123456789'
        birthDate:
          type: string
          description: 'MRZ date of birth. Has the following format: `YYMMDD`.'
          example: '000101'
        expiryDate:
          type: string
          description: 'MRZ date of expiry. Has the following format: `YYMMDD`.'
          example: '250101'
        country:
          type: string
          description: MRZ issuing state or organization.
          example: HRV
        sex:
          type: string
          description: MRZ gender.
          example: F
        nationality:
          type: string
          description: MRZ nationality.
          example: HRV
        optionalData:
          type: array
          description: MRZ optional data.
          example:
          - mrzOptionalItem1
          - mrzOptionalItem2
          items:
            type: string
        personalNumber:
          type: string
          description: Personal identification number, part of MRZ optional data.
          example: 01234567890
        type:
          type: string
          description: MRZ document code.
          example: P
      title: MrzWebhookData
    8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.GetSessionResponse:
      type: object
      description: JSON containing execution results and details about the retrieved session.
      properties:
        session:
          $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.GenericSession'
      title: GetSessionResponse
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.NcError:
      type: object
      properties:
        groupId:
          type: integer
          format: int32
          description: Error group ID.
          readOnly: true
        groupName:
          type: string
          description: Error group name.
          readOnly: true
        id:
          type: integer
          format: int32
          description: Error ID.
          readOnly: true
        name:
          type: string
          description: Error name.
          readOnly: true
        description:
          type: string
          description: Human-readable description of the error.
          readOnly: true
        permanent:
          type: boolean
          description: Tells if the error is permanent.
          readOnly: true
      title: NcError
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.MatchResult:
      type: string
      enum:
      - 'TRUE'
      - 'FALSE'
      - NOT_AVAILABLE
      title: MatchResult
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.PlatformErrorResponse:
      type: object
      description: Platform error response for authentication and authorization errors.
      properties:
        requestError:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.RequestError'
      title: Platform Error Response
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SimSwapProceedOnDto:
      type: string
      description: 'If specified, proceed to the SMV verify in case:

        - SIM swap check fails

        - There is no SIM swap coverage

        - Result of the SIM swap check was unknown'
      enum:
      - ANY_ERROR
      - UNKNOWN
      - NO_COVERAGE
      title: SimSwapProceedOnDto
    8018948352e80bbff88731d9fb43f611b84a58f2b44c304c63a8e4ae9c4bd661.PageReports:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/8018948352e80bbff88731d9fb43f611b84a58f2b44c304c63a8e4ae9c4bd661.ReportLineItem'
        paging:
          $ref: '#/components/schemas/8018948352e80bbff88731d9fb43f611b84a58f2b44c304c63a8e4ae9c4bd661.PageInfo'
      title: PageReports
    acc54cffc2fdf57be1405002c65f11d7bb0b2506a15f7e1c75bb3cbcc41d6219.ResultResponse:
      type: object
      description: Silent mobile verification request result
      properties:
        result:
          type: string
          description: Silent mobile verification request result.
          enum:
          - VALID
          - INVALID
          - ERROR
        token:
          type: string
          description: Unique request identifier. This value was returned on silent mobile verification request.
        error:
          $ref: '#/components/schemas/4503c9be2d8553d1e8648e283b9ba9017ae14f51177b500d7b5df7dc4842e4d2.ErrorInfoResponse'
      title: SilentMobileVerificationResultResponse
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.DcqlNotFoundErrorResponse:
      type: object
      additionalProperties:
        allOf:
        - $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraNotFoundErrorResponse'
        x-additionalPropertiesName: carrierId
      description: 'Map of DCQL error responses keyed by carrier ID, returned when one or more requested carriers could not be resolved.

        Resolved carriers will be returned in the same map. For resolved carrier response structure, see `DCQL Credential Map` section.

        '
      title: DCQL Carrier Error Map
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageGeneralStatus:
      type: string
      description: Status group name that describes which category the status code belongs to, i.e., [PENDING](https://www.infobip.com/docs/essentials/response-status-and-error-codes#pending-general-status-codes), [UNDELIVERABLE](https://www.infobip.com/docs/essentials/response-status-and-error-codes#undeliverable-general-status-codes), [DELIVERED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#delivered-general-status-codes), [EXPIRED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#expired-general-status-codes), [REJECTED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#rejected-general-status-codes).
      enum:
      - ACCEPTED
      - PENDING
      - UNDELIVERABLE
      - DELIVERED
      - EXPIRED
      - REJECTED
      title: MessageGeneralStatus
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraUserEquipmentIdentifierDto:
      type: object
      description: User equipment identifier.
      properties:
        externalId:
          type: string
          description: External identifier.
          example: 123456789@domain.com
        msisdn:
          type: string
          description: Mobile phone number (MSISDN) in international format.
          example: '+441134961234'
        ipv4Addr:
          type: string
          description: IPv4 address of the device.
          example: 192.168.1.100
          pattern: ^$|^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))
        ipv6Addr:
          type: string
          description: IPv6 address of the device.
          example: 2001:db8::1
          pattern: ^$|^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))
      required:
      - msisdn
      title: CamaraUserEquipmentIdentifierDto
    8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.WebhookInfo:
      type: object
      description: Webhook that will be called with the information about the request status. The webhook will be called with a POST method that contains all the info in JSON format. Check webhook endpoint for more details.
      properties:
        url:
          type: string
          format: uri
          description: Your webhook URL onto which the request is received.
          example: https://example.com/webhook
        type:
          type: string
          default: ON_END
          description: Defines what kind of requests you want to receive on a webhook. `ON_END` - only final status at the end, `ON_STATUS_CHANGE` - any change in the scenario.
          enum:
          - ON_END
          - ON_STATUS_CHANGE
          example: ON_END
      required:
      - url
      title: WebhookInfo
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.RequestError:
      type: object
      description: Request error object.
      properties:
        serviceException:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.ServiceException'
      title: RequestError
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraKycMatchRequestDto:
      type: object
      description: Camara Know Your Customer Match request object
      properties:
        phoneNumber:
          type: string
          description: Mobile phone number (MSISDN) to verify. The number must be in international format.
          example: '+441134961234'
        idDocument:
          type: string
          description: Id number associated to the official identity document in the country.
          example: '987654321'
        name:
          type: string
          description: Complete name of the customer, usually composed of first/given name and last/family/sur-name in a country.
          example: Jane Smith
        givenName:
          type: string
          description: First/given name or compound first/given name of the customer.
          example: Jane
        familyName:
          type: string
          description: Last name, family name, or surname of the customer.
          example: Smith
        nameKanaHankaku:
          type: string
          description: Complete name of the customer in Hankaku-Kana format (reading of name) for Japan.
          example: ｼﾞｪｰﾝ ｽﾐｽ
        nameKanaZenkaku:
          type: string
          description: Complete name of the customer in Zenkaku-Kana format (reading of name) for Japan.
          example: ジェーン スミス
        middleNames:
          type: string
          description: Middle name/s of the customer.
          example: Marie
        familyNameAtBirth:
          type: string
          description: Last/family/sur-name at birth of the customer.
          example: Johnson
        address:
          type: string
          description: Complete address of the customer.
          example: 742 Evergreen Terrace, Springfield, IL 62704
        streetName:
          type: string
          description: Name of the street of the customer's address. It should not include the type of the street.
          example: ' Evergreen Terrace'
        streetNumber:
          type: string
          description: The street number of the customer's address.  Number identifying a specific property on the 'streetName'.
          example: '742'
        postalCode:
          type: string
          description: Zip code or postal code.
          example: '62704'
        region:
          type: string
          description: Region/prefecture of the customer's address.
          example: Illinois
        locality:
          type: string
          description: Locality of the customer's address.
          example: Springfield
        country:
          type: string
          description: Country of the customer's address. Format ISO 3166-1 alpha-2.
          example: US
        houseNumberExtension:
          type: string
          description: Specific identifier of the house needed depending on the property type. For example, number of apartment in an apartment building.
          example: Apt 2B
        birthdate:
          type: string
          format: date
          description: The birthdate of the customer, in RFC 3339 / ISO 8601 calendar date format (YYYY-MM-DD).
          example: '1985-07-15'
        email:
          type: string
          format: email
          description: Email address of the customer in the RFC specified format (local-part@domain).
          example: jane.smith@example.com
        gender:
          type: string
          description: Gender of the customer.
          enum:
          - MALE
          - FEMALE
          - OTHER
          example: FEMALE
      required:
      - phoneNumber
      title: CamaraKycMatchRequestDto
    ApiRequestError:
      type: object
      properties:
        serviceException:
          $ref: '#/components/schemas/ApiRequestErrorDetails'
      title: ApiRequestError
    eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.VerificationWebhookData:
      type: object
      description: Result data object.
      properties:
        faceMatch:
          type: boolean
          description: The result of comparing face images between a document and a selfie. `True`, if distance between images is less than configured threshold, which means that the faces most likely match. `False` means that the faces most likely do not match.
          example: true
        faceDistance:
          type: number
          format: float
          description: Distance between face images from a document and a selfie. Possible values are numbers between `0.00` and `1.00`. The closer the number is to `0.00`, the more likely it is that the images match.
          example: 0.232
        faceConfidenceScore:
          type: number
          format: float
          description: Confidence score between face images from a document and a selfie. Possible values are numbers between `0.00` and `100.00`. The closer the number is to `100.00`, the more likely it is that the images match.
          example: 83
      title: VerificationWebhookData
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.Ts43UseCase:
      type: string
      description: The TS.43 operation use case.
      enum:
      - GET_PHONE_NUMBER
      - VERIFY_PHONE_NUMBER
      example: GET_PHONE_NUMBER
      title: Ts43UseCase
    578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.DevicePhoneNumberResponseDto:
      type: object
      description: Device phone number response object.
      properties:
        devicePhoneNumber:
          type: string
          description: Device phone number result.
      title: DevicePhoneNumberResponseDto
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraKycMatchResponseDto:
      type: object
      description: Camara Know Your Customer Match response object
      properties:
        idDocumentMatch:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.MatchResult'
        nameMatch:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.MatchResult'
        nameMatchScore:
          type: integer
          format: int32
        givenNameMatch:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.MatchResult'
        givenNameMatchScore:
          type: integer
          format: int32
        familyNameMatch:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.MatchResult'
        familyNameMatchScore:
          type: integer
          format: int32
        nameKanaHankakuMatch:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.MatchResult'
        nameKanaHankakuMatchScore:
          type: integer
          format: int32
        nameKanaZenkakuMatch:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.MatchResult'
        nameKanaZenkakuMatchScore:
          type: integer
          format: int32
        middleNamesMatch:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.MatchResult'
        middleNamesMatchScore:
          type: integer
          format: int32
        familyNameAtBirthMatch:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.MatchResult'
        familyNameAtBirthMatchScore:
          type: integer
          format: int32
        addressMatch:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.MatchResult'
        addressMatchScore:
          type: integer
          format: int32
        streetNameMatch:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.MatchResult'
        streetNameMatchScore:
          type: integer
          format: int32
        streetNumberMatch:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.MatchResult'
        streetNumberMatchScore:
          type: integer
          format: int32
        postalCodeMatch:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.MatchResult'
        regionMatch:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.MatchResult'
        regionMatchScore:
          type: integer
          format: int32
        localityMatch:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.MatchResult'
        localityMatchScore:
          type: integer
          format: int32
        countryMatch:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.MatchResult'
        houseNumberExtensionMatch:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.MatchResult'
        birthdateMatch:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.MatchResult'
        emailMatch:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.MatchResult'
        emailMatchScore:
          type: integer
          format: int32
        genderMatch:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.MatchResult'
      title: CamaraKycMatchResponseDto
    eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.KycWebhookData:
      type: object
      description: Result data object.
      properties:
        mrzData:
          $ref: '#/components/schemas/eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.MrzWebhookData'
        faceMatch:
          type: boolean
          description: The result of comparing face images between a document and a selfie. `True`, if distance between images is less than configured threshold, which means that the faces most likely match. `False` means that the faces most likely do not match.
          example: true
        faceDistance:
          type: number
          format: float
          description: Distance between face images from a document and a selfie. Possible values are numbers between `0.00` and `1.00`. The closer the number is to `0.00`, the more likely it is that the images match.
          example: 0.232
        faceConfidenceScore:
          type: number
          format: float
          description: Confidence score between face images from a document and a selfie. Possible values are numbers between `0.00` and `100.00`. The closer the number is to `100.00`, the more likely it is that the images match.
          example: 83
        biometricReference:
          type: string
          description: 36-character unique identifier of a biometric vector associated with the end user. Used, if Infobip needs to store the vector.
          example: usr_eb1cfc67ead74fc29ff2c65c4cec2baf
        biometricVector:
          type: array
          description: Biometric vector associated with the end user. Used, if Infobip does not store the vector.
          example:
          - -0.09652680158615112
          - 0.07107646763324738
          - -0.029479391872882843
          - -0.006973235867917538
          items:
            type: number
            format: double
      title: KycWebhookData
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.DcqlCredentialPerCarrierDtoResponse:
      type: object
      description: DCQL credential object per carrier.
      properties:
        id:
          type: string
          description: Aggregator ID.
          example: miapi.infobip.com
        format:
          type: string
          description: 'Fixed value for the DCQL credential: `dc-authorization+sd-jwt`.'
          example: dc-authorization+sd-jwt
        meta:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.Meta'
        claims:
          type: array
          description: Array of claim objects containing the optional hint used by Android to suggest the right SIM in dual-SIM devices.
          items:
            $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.Claim'
      title: DcqlCredentialPerCarrierDtoResponse
    8018948352e80bbff88731d9fb43f611b84a58f2b44c304c63a8e4ae9c4bd661.ReportLineItem:
      type: object
      properties:
        date:
          type: string
          description: Date in UTC when the activation state change has happened. Format yyyy-MM-dd'T'HH:mm:ss.SSSZ
          example: 2024-03-05T11:00:00.000+0000
        destination:
          type: string
          description: The phone number that changed its activation state
          example: '15987654321'
        type:
          $ref: '#/components/schemas/8018948352e80bbff88731d9fb43f611b84a58f2b44c304c63a8e4ae9c4bd661.DeactivationType'
        newDestination:
          type: string
          description: Optional information about a new phone number that replaced the original deactivated phone number. <br />Only optionally included in case of DEACTIVATION type of the entry
          example: '15123456789'
      required:
      - date
      - destination
      - type
      title: ReportLineItem
    ApiRequestErrorDetails:
      type: object
      properties:
        messageId:
          type: string
          description: Identifier of the error.
        text:
          type: string
          description: Detailed error description.
        validationErrors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              description: Validation errors.
          description: Validation errors.
      title: ApiRequestErrorDetails
    8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.CreatedSessionResponse:
      type: object
      description: JSON containing information about the new session.
      properties:
        sessionId:
          type: string
          description: Unique session identifier.
          example: efc373be-ab6d-4c63-b798-1f65b7b4b2b3
        redirectUrl:
          type: string
          description: URL with `sessionId` to be sent to the end user which would then directly apply the scenario.
          example: https://example.com/web/?sessionId=efc373be-ab6d-4c63-b798-1f65b7b4b2b3
      title: CreatedSessionResponse
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.InitZeroRatedRequestDto:
      type: object
      description: Silent Mobile Verification zero rated request initialization.
      properties:
        consentGranted:
          type: boolean
          description: Indicates whether you have consent from mobile phone number's owner to perform this request. All requests that do not have this property set to "true" will be rejected.
          example: true
        phoneNumber:
          type: string
          description: Mobile phone number (MSISDN) to verify. The number must be in international format.
          example: '441134961234'
        returnUrl:
          type: string
          description: An URL to which the mobile device will be redirected to when verification is complete.
          example: https://api.infobip.com/my-site/my-shop.html
      required:
      - consentGranted
      - phoneNumber
      title: InitZeroRatedRequestDto
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.OperationType:
      type: string
      enum:
      - SILENT_MOBILE_VERIFICATION
      - KNOW_YOUR_CUSTOMER
      - SIM_SWAP
      - NUMBER_SHARE
      - NUMBER_INTELLIGENCE
      - DEVICE_LOCATION
      - NATIONAL_IDENTITY_NUMBER
      title: OperationType
    eb583710b0e1739c1b6da279daf56e71bef92e0a50c90d88ff2c7fea69527204.EnrollmentWebhookData:
      type: object
      description: Result data object.
      properties:
        biometricReference:
          type: string
          description: 36-character unique identifier of a biometric vector associated with the end user. Used, if Infobip needs to store the vector.
          example: usr_eb1cfc67ead74fc29ff2c65c4cec2baf
        biometricVector:
          type: array
          description: Biometric vector associated with the end user. Used, if Infobip does not store the vector.
          example:
          - -0.09652680158615112
          - 0.07107646763324738
          - -0.029479391872882843
          - -0.006973235867917538
          items:
            type: number
            format: double
      title: EnrollmentWebhookData
    8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.VerificationSessionRequest:
      type: object
      description: JSON containing session parameters and client identifiers for Verification application.
      properties:
        scenarioName:
          type: string
          description: 'Request a specific scenario within the application. To get possible values call [Get Scenarios](#platform-connectivity/biometrics/get-biometrics-scenarios) with the following query parameter: `?applicationTypes=verification`. Check scenario descriptions in the response to find the scenario you need, and copy its `name`.'
          example: FACE_VERIFICATION
        locationInfo:
          $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.LocationInfo'
        partnerReference:
          type: string
          description: Your (usually unique) identifier of the end user performing the scenario. Will be sent together with the rest of the information via the webhook.
          example: MyRef-jqhof
        webhook:
          $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.WebhookInfo'
        successUrl:
          type: string
          description: End user will be sent to this URL after the selected scenario has been successfully completed.
          example: https://example.com/success
        cancelUrl:
          type: string
          description: End user will be sent to this URL if they cancel the scenario.
          example: https://example.com/cancel
        retainData:
          type: boolean
          description: Indicates whether Infobip should store and retain data. This value overrides value in account configuration.
          example: true
        biometricData:
          $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.BiometricData'
      required:
      - locationInfo
      - scenarioName
      - webhook
      title: VerificationSessionRequest
    ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SmvVerifyAdvancedRequestDto:
      type: object
      description: Silent Mobile Verification Advanced request object.
      properties:
        consentGranted:
          type: boolean
          description: Indicates whether you have consent from mobile phone number's owner to perform this request. All requests that do not have this property set to "true" will be rejected.
          example: true
        phoneNumber:
          type: string
          description: Mobile phone number (MSISDN) to verify. The number must be in international format.
          example: '441134961234'
        callbackUrl:
          type: string
          description: Your URL that will be called to provide [result](#platform-connectivity/mobile-identity/receive-advanced-silent-mobile-verification-result) when the process is completed.
          example: https://api.infobip.com/my-callback-webook/my-path
        returnUrl:
          type: string
          description: An URL to which the mobile device will be redirected to when verification is complete.
          example: https://api.infobip.com/my-site/my-shop.html
        smsFailover:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SmsFailoverDto'
        simSwapCheck:
          $ref: '#/components/schemas/c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.SimSwapCheckDto'
        deviceIp:
          type: string
          format: xxx.xxx.xxx.xxx|xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx
          description: IPv4 or IPv6 address of the mobile device that will be verified with operator. Currently, can be used only in Brazil.
          example: 10.20.30.100|1111:22222:3333:4444:AAAA:BBBB:CCCC:DDDD
        devicePort:
          type: integer
          format: int32
          description: Port of the mobile device that will be verified with operator. Can be used only when "deviceIp" is also provided. Currently, can be used only in Brazil.
          example: 54321
      required:
      - callbackUrl
      - consentGranted
      - phoneNumber
      title: SmvVerifyAdvancedRequestDto
    8018948352e80bbff88731d9fb43f611b84a58f2b44c304c63a8e4ae9c4bd661.PageInfo:
      type: object
      properties:
        page:
          type: integer
          format: int32
          description: Requested page number.
          minimum: 0
        size:
          type: integer
          format: int32
          description: Requested page size.
          minimum: 1
        totalPages:
          type: integer
          format: int32
          description: The total number of pages of the results matching the requested parameters.
          minimum: 0
        totalResults:
          type: integer
          format: int64
          description: The total number of the results matching the requested parameters.
          minimum: 0
      required:
      - page
      - size
      - totalPages
      - totalResults
      title: PageInfo
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.NinCheckRequestDto:
      type: object
      description: National Identity Number check request object.
      properties:
        consentGranted:
          type: boolean
          description: Indicates whether you have consent from mobile phone number's owner to perform this request. All requests that do not have this property set to "true" will be rejected.
          example: true
        phoneNumber:
          type: string
          description: Mobile phone number (MSISDN) to perform a query by. The number must be in international format.
          example: '441134961234'
        nationalId:
          type: string
          description: National Identification Number that will be used to check for a match against a mobile phone number.
          example: 123.456.789-10
          maxLength: 50
          minLength: 1
        documentType:
          type: string
          description: 'Document type that will be used to check for a match against a mobile phone number.

            Currently, used and mandatory only in Colombia.

            '
          enum:
          - CC
          - CE
          - NIT
      required:
      - consentGranted
      - nationalId
      - phoneNumber
      title: NinCheckRequestDto
    c4fb96364cd87b1d1d15720880c5153ef26f58342e4ec03b9d5896f2251f17ae.CamaraUnauthenticatedErrorResponse:
      type: object
      description: Camara API error response for unauthenticated requests.
      properties:
        status:
          type: integer
          format: int32
          description: HTTP status code.
          example: 401
        code:
          type: string
          description: Error code.
          example: UNAUTHENTICATED
        message:
          type: string
          description: Detailed error message.
          example: Request not authenticated due to missing, invalid, or expired credentials
      title: Camara Error Response
    8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.BiometricReference:
      type: object
      allOf:
      - $ref: '#/components/schemas/8a19359d3a412667abbd2d38733e247b91417d2a845ae41758328736ea0ecce9.BiometricData'
      - type: object
        properties:
          reference:
            type: string
            description: 36-character unique identifier of a biometric vector associated with the end user. Used, if Infobip needs to store the vector in enrolment phase and return reference in result.
            example: usr_eb1cfc67ead74fc29ff2c65c4cec2baf
      title: BiometricReference
    4503c9be2d8553d1e8648e283b9ba9017ae14f51177b500d7b5df7dc4842e4d2.ErrorInfoResponse:
      type: object
      description: Information about error occurred. If there is no error this object is omitted.
      properties:
        id:
          type: number
          format: integer
          description: Unique identifier of occurred error on Infobip platform.
        name:
          type: string
          description: Unique string identifier of occurred error on Mobile Identity platform.
        description:
          type: string
          description: Description of error occurred for easier comprehension.
      title: MobileIdentityErrorInfoResponse
  responses:
    ApiException401:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiException'
          example:
            requestError:
              serviceException:
                messageId: UNAUTHORIZED
                text: Unauthorized
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiException'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>UNAUTHORIZED</messageId>\n      <text>Unauthorized</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
    ApiException500:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiException'
          example:
            requestError:
              serviceException:
                messageId: GENERAL_ERROR
                text: Something went wrong. Please contact support.
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiException'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>GENERAL_ERROR</messageId>\n      <text>Something went wrong. Please contact support.</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
    ApiException429:
      description: Too Many Requests
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiException'
          example:
            requestError:
              serviceException:
                messageId: TOO_MANY_REQUESTS
                text: Too many requests
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiException'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>TOO_MANY_REQUESTS</messageId>\n      <text>Too many requests</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
    ApiException403:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiException'
          example:
            requestError:
              serviceException:
                messageId: FORBIDDEN
                text: Forbidden
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiException'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>FORBIDDEN</messageId>\n      <text>Forbidden</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      description: 'This is the most secure authorization type and the one with the most flexibility.


        API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can

        be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases.

        Finally, the loss of an API key is easily manageable.


        You can manage your API keys from [GUI](https://portal.infobip.com/settings/accounts/api-keys), or programmatically

        with [dedicated API](#platform-&-connectivity/settings).


        API key Authorization header example:


        ```shell

        Authorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9

        ```

        '
      name: Authorization
      in: header
    Basic:
      type: http
      description: 'Basic authorization type can be used in situations when the API key is not available. For example, API methods for generating API keys should be authenticated

        with the Basic type.


        In this case, the credentials included in the Authorization header should be a Base64 encoded username and password combination. More formally, basic

        authentication header can be constructed in three steps:


        * Username and password are concatenated using the colon `(:)` as a separator `username:password`.

        * The resulting string is encoded using the [RFC2045-MIME](https://www.ietf.org/rfc/rfc2045.txt) variant of Base64.

        * Encoded string is added as credentials after the `"Basic "` type.


        Example:


        ```shell

        Username: "Aladdin"

        Password: "openSesame"


        Concatenated string: "Aladdin:openSesame"


        Base64 encoded string: "QWxhZGRpbjpvcGVuU2VzYW1l"


        Authorization header: "Basic QWxhZGRpbjpvcGVuU2VzYW1l"

        ```


        > **Implementation detail**: Base64 encoding is a standard and many available programming languages and frameworks provide convenient methods for encoding

        > strings.

        '
      scheme: basic
    IBSSOTokenHeader:
      type: apiKey
      description: 'This authorization type is suited for situations when you do not want to store Infobip credentials in your own app. Instead, your users will input their Infobip

        credentials every time they access your application and the application will use those credentials to create a session. From then on, the session token can be

        used to authenticate subsequent API requests. Note that the session will expire automatically after a predefined period of inactivity, and can also be manually

        terminated by making an appropriate API call.


        You can find more details on the creation and behavior of the session at

        the [dedicated documentation page](#platform-connectivity/account-management/create-session).


        After obtaining the session token by calling the above-referenced API method you can include it in the Authorization header like this:


        ```shell

        Authorization: IBSSO 2f9b4d31-2d0d-49a8-85f0-9b862bdca394

        ```

        '
      name: Authorization
      in: header
    OAuth2:
      type: oauth2
      description: 'Similarly to the IBSSO Token authentication you can use OAuth 2.0 bearer token with Infobip serving both as resource and authorization server. You can obtain

        the access token using the client credentials grant from `auth/1/oauth2/token` endpoint. It will provide you with your access token, and its expiration period.

        You can use the token to authorize your API calls until it expires. You can find out more about the process in

        the [official specification](https://tools.ietf.org/html/rfc6749#section-4.4).


        You can include your access token in the Authorization HTTP request header like this:


        ```http

        Authorization: Bearer <access_token>

        ```'
      flows:
        clientCredentials:
          tokenUrl: https://api.infobip.com/auth/1/oauth2/token
          scopes: {}