Telnyx API — Verify

naftiko: 1.0.0-alpha2
info:
  label: Telnyx API — Verify
  description: 'Telnyx API — Verify. 16 operations. Lead operation: List verifications by phone number. Self-contained Naftiko
    capability covering one Telnyx business surface.'
  tags:
  - Telnyx
  - Verify
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TELNYX_API_KEY: TELNYX_API_KEY
capability:
  consumes:
  - type: http
    namespace: telnyx-verify
    baseUri: https://api.telnyx.com/v2
    description: Telnyx API — Verify business capability. Self-contained, no shared references.
    resources:
    - name: verifications-by_phone_number-phone_number
      path: /verifications/by_phone_number/{phone_number}
      operations:
      - name: listverifications
        method: GET
        description: List verifications by phone number
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: phone_number
          in: path
          type: string
          description: The phone number associated with the verifications to retrieve.
          required: true
    - name: verifications-by_phone_number-phone_number-actions-verify
      path: /verifications/by_phone_number/{phone_number}/actions/verify
      operations:
      - name: verifyverificationcodebyphonenumber
        method: POST
        description: Verify verification code by phone number
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: phone_number
          in: path
          type: string
          description: The phone number associated with the verification code being verified.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: verifications-call
      path: /verifications/call
      operations:
      - name: createverificationcall
        method: POST
        description: Trigger Call verification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: verifications-flashcall
      path: /verifications/flashcall
      operations:
      - name: createflashcallverification
        method: POST
        description: Trigger Flash call verification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: verifications-sms
      path: /verifications/sms
      operations:
      - name: createverificationsms
        method: POST
        description: Trigger SMS verification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: verifications-whatsapp
      path: /verifications/whatsapp
      operations:
      - name: createwhatsappverification
        method: POST
        description: Trigger WhatsApp verification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: verifications-verification_id
      path: /verifications/{verification_id}
      operations:
      - name: retrieveverification
        method: GET
        description: Retrieve verification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: verification_id
          in: path
          type: string
          description: The identifier of the verification to retrieve.
          required: true
    - name: verifications-verification_id-actions-verify
      path: /verifications/{verification_id}/actions/verify
      operations:
      - name: verifyverificationcodebyid
        method: POST
        description: Verify verification code by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: verification_id
          in: path
          type: string
          description: The identifier of the verification to retrieve.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: verify_profiles
      path: /verify_profiles
      operations:
      - name: listprofiles
        method: GET
        description: List all Verify profiles
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: object
          description: 'Consolidated filter parameter (deepObject style). Originally: filter[name]'
        - name: page
          in: query
          type: object
          description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]'
      - name: createverifyprofile
        method: POST
        description: Create a Verify profile
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: verify_profiles-templates
      path: /verify_profiles/templates
      operations:
      - name: listprofilemessagetemplates
        method: GET
        description: Retrieve Verify profile message templates
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createmessagetemplate
        method: POST
        description: Create message template
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: verify_profiles-templates-template_id
      path: /verify_profiles/templates/{template_id}
      operations:
      - name: updatemessagetemplate
        method: PATCH
        description: Update message template
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: template_id
          in: path
          type: string
          description: The identifier of the message template to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: verify_profiles-verify_profile_id
      path: /verify_profiles/{verify_profile_id}
      operations:
      - name: deleteprofile
        method: DELETE
        description: Delete Verify profile
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: verify_profile_id
          in: path
          type: string
          description: The identifier of the Verify profile to delete.
          required: true
      - name: getverifyprofile
        method: GET
        description: Retrieve Verify profile
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: verify_profile_id
          in: path
          type: string
          description: The identifier of the Verify profile to retrieve.
          required: true
      - name: updateverifyprofile
        method: PATCH
        description: Update Verify profile
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: verify_profile_id
          in: path
          type: string
          description: The identifier of the Verify profile to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.TELNYX_API_KEY}}'
  exposes:
  - type: rest
    namespace: telnyx-verify-rest
    port: 8080
    description: REST adapter for Telnyx API — Verify. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/verifications/by-phone-number/{phone-number}
      name: verifications-by-phone-number-phone-number
      description: REST surface for verifications-by_phone_number-phone_number.
      operations:
      - method: GET
        name: listverifications
        description: List verifications by phone number
        call: telnyx-verify.listverifications
        with:
          phone_number: rest.phone_number
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/verifications/by-phone-number/{phone-number}/actions/verify
      name: verifications-by-phone-number-phone-number-actions-verify
      description: REST surface for verifications-by_phone_number-phone_number-actions-verify.
      operations:
      - method: POST
        name: verifyverificationcodebyphonenumber
        description: Verify verification code by phone number
        call: telnyx-verify.verifyverificationcodebyphonenumber
        with:
          phone_number: rest.phone_number
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/verifications/call
      name: verifications-call
      description: REST surface for verifications-call.
      operations:
      - method: POST
        name: createverificationcall
        description: Trigger Call verification
        call: telnyx-verify.createverificationcall
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/verifications/flashcall
      name: verifications-flashcall
      description: REST surface for verifications-flashcall.
      operations:
      - method: POST
        name: createflashcallverification
        description: Trigger Flash call verification
        call: telnyx-verify.createflashcallverification
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/verifications/sms
      name: verifications-sms
      description: REST surface for verifications-sms.
      operations:
      - method: POST
        name: createverificationsms
        description: Trigger SMS verification
        call: telnyx-verify.createverificationsms
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/verifications/whatsapp
      name: verifications-whatsapp
      description: REST surface for verifications-whatsapp.
      operations:
      - method: POST
        name: createwhatsappverification
        description: Trigger WhatsApp verification
        call: telnyx-verify.createwhatsappverification
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/verifications/{verification-id}
      name: verifications-verification-id
      description: REST surface for verifications-verification_id.
      operations:
      - method: GET
        name: retrieveverification
        description: Retrieve verification
        call: telnyx-verify.retrieveverification
        with:
          verification_id: rest.verification_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/verifications/{verification-id}/actions/verify
      name: verifications-verification-id-actions-verify
      description: REST surface for verifications-verification_id-actions-verify.
      operations:
      - method: POST
        name: verifyverificationcodebyid
        description: Verify verification code by ID
        call: telnyx-verify.verifyverificationcodebyid
        with:
          verification_id: rest.verification_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/verify-profiles
      name: verify-profiles
      description: REST surface for verify_profiles.
      operations:
      - method: GET
        name: listprofiles
        description: List all Verify profiles
        call: telnyx-verify.listprofiles
        with:
          filter: rest.filter
          page: rest.page
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createverifyprofile
        description: Create a Verify profile
        call: telnyx-verify.createverifyprofile
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/verify-profiles/templates
      name: verify-profiles-templates
      description: REST surface for verify_profiles-templates.
      operations:
      - method: GET
        name: listprofilemessagetemplates
        description: Retrieve Verify profile message templates
        call: telnyx-verify.listprofilemessagetemplates
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createmessagetemplate
        description: Create message template
        call: telnyx-verify.createmessagetemplate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/verify-profiles/templates/{template-id}
      name: verify-profiles-templates-template-id
      description: REST surface for verify_profiles-templates-template_id.
      operations:
      - method: PATCH
        name: updatemessagetemplate
        description: Update message template
        call: telnyx-verify.updatemessagetemplate
        with:
          template_id: rest.template_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/verify-profiles/{verify-profile-id}
      name: verify-profiles-verify-profile-id
      description: REST surface for verify_profiles-verify_profile_id.
      operations:
      - method: DELETE
        name: deleteprofile
        description: Delete Verify profile
        call: telnyx-verify.deleteprofile
        with:
          verify_profile_id: rest.verify_profile_id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getverifyprofile
        description: Retrieve Verify profile
        call: telnyx-verify.getverifyprofile
        with:
          verify_profile_id: rest.verify_profile_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateverifyprofile
        description: Update Verify profile
        call: telnyx-verify.updateverifyprofile
        with:
          verify_profile_id: rest.verify_profile_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: telnyx-verify-mcp
    port: 9090
    transport: http
    description: MCP adapter for Telnyx API — Verify. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-verifications-phone-number
      description: List verifications by phone number
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-verify.listverifications
      with:
        phone_number: tools.phone_number
      outputParameters:
      - type: object
        mapping: $.
    - name: verify-verification-code-phone-number
      description: Verify verification code by phone number
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-verify.verifyverificationcodebyphonenumber
      with:
        phone_number: tools.phone_number
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: trigger-call-verification
      description: Trigger Call verification
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-verify.createverificationcall
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: trigger-flash-call-verification
      description: Trigger Flash call verification
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-verify.createflashcallverification
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: trigger-sms-verification
      description: Trigger SMS verification
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-verify.createverificationsms
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: trigger-whatsapp-verification
      description: Trigger WhatsApp verification
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-verify.createwhatsappverification
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-verification
      description: Retrieve verification
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-verify.retrieveverification
      with:
        verification_id: tools.verification_id
      outputParameters:
      - type: object
        mapping: $.
    - name: verify-verification-code-id
      description: Verify verification code by ID
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-verify.verifyverificationcodebyid
      with:
        verification_id: tools.verification_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-verify-profiles
      description: List all Verify profiles
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-verify.listprofiles
      with:
        filter: tools.filter
        page: tools.page
      outputParameters:
      - type: object
        mapping: $.
    - name: create-verify-profile
      description: Create a Verify profile
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-verify.createverifyprofile
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-verify-profile-message-templates
      description: Retrieve Verify profile message templates
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-verify.listprofilemessagetemplates
      outputParameters:
      - type: object
        mapping: $.
    - name: create-message-template
      description: Create message template
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: telnyx-verify.createmessagetemplate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-message-template
      description: Update message template
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: telnyx-verify.updatemessagetemplate
      with:
        template_id: tools.template_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-verify-profile
      description: Delete Verify profile
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: telnyx-verify.deleteprofile
      with:
        verify_profile_id: tools.verify_profile_id
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-verify-profile
      description: Retrieve Verify profile
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: telnyx-verify.getverifyprofile
      with:
        verify_profile_id: tools.verify_profile_id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-verify-profile
      description: Update Verify profile
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: telnyx-verify.updateverifyprofile
      with:
        verify_profile_id: tools.verify_profile_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.