Sinch Verification API — Verifications

naftiko: 1.0.0-alpha2
info:
  label: Sinch Verification API — Verifications
  description: 'Sinch Verification API — Verifications. 6 operations. Lead operation: Start a Verification. Self-contained
    Naftiko capability covering one Sinch business surface.'
  tags:
  - Sinch
  - Verifications
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SINCH_API_KEY: SINCH_API_KEY
capability:
  consumes:
  - type: http
    namespace: verification-verifications
    baseUri: https://verification.api.sinch.com
    description: Sinch Verification API — Verifications business capability. Self-contained, no shared references.
    resources:
    - name: verification-v1-verifications
      path: /verification/v1/verifications
      operations:
      - name: startverification
        method: POST
        description: Start a Verification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: verification-v1-verifications-id-id
      path: /verification/v1/verifications/id/{id}
      operations:
      - name: reportverificationbyid
        method: PUT
        description: Report a Verification by Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The verification request identifier
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: verification-v1-verifications-id-id-status
      path: /verification/v1/verifications/id/{id}/status
      operations:
      - name: getverificationstatusbyid
        method: GET
        description: Get Verification Status by Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The verification request identifier
          required: true
    - name: verification-v1-verifications-reference-reference-status
      path: /verification/v1/verifications/reference/{reference}/status
      operations:
      - name: getverificationstatusbyreference
        method: GET
        description: Get Verification Status by Reference
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: reference
          in: path
          type: string
          description: The custom reference string
          required: true
    - name: verification-v1-verifications-type-endpoint
      path: /verification/v1/verifications/{type}/{endpoint}
      operations:
      - name: reportverification
        method: PUT
        description: Report a Verification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: path
          type: string
          description: The verification method type
          required: true
        - name: endpoint
          in: path
          type: string
          description: The phone number being verified in E.164 format
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: verification-v1-verifications-type-endpoint-status
      path: /verification/v1/verifications/{type}/{endpoint}/status
      operations:
      - name: getverificationstatusbyidentity
        method: GET
        description: Get Verification Status by Identity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: path
          type: string
          description: The verification method type
          required: true
        - name: endpoint
          in: path
          type: string
          description: The phone number in E.164 format
          required: true
    authentication:
      type: basic
      username: '{{env.SINCH_USER}}'
      password: '{{env.SINCH_PASS}}'
  exposes:
  - type: rest
    namespace: verification-verifications-rest
    port: 8080
    description: REST adapter for Sinch Verification API — Verifications. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/verification/v1/verifications
      name: verification-v1-verifications
      description: REST surface for verification-v1-verifications.
      operations:
      - method: POST
        name: startverification
        description: Start a Verification
        call: verification-verifications.startverification
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/verification/v1/verifications/id/{id}
      name: verification-v1-verifications-id-id
      description: REST surface for verification-v1-verifications-id-id.
      operations:
      - method: PUT
        name: reportverificationbyid
        description: Report a Verification by Id
        call: verification-verifications.reportverificationbyid
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/verification/v1/verifications/id/{id}/status
      name: verification-v1-verifications-id-id-status
      description: REST surface for verification-v1-verifications-id-id-status.
      operations:
      - method: GET
        name: getverificationstatusbyid
        description: Get Verification Status by Id
        call: verification-verifications.getverificationstatusbyid
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/verification/v1/verifications/reference/{reference}/status
      name: verification-v1-verifications-reference-reference-status
      description: REST surface for verification-v1-verifications-reference-reference-status.
      operations:
      - method: GET
        name: getverificationstatusbyreference
        description: Get Verification Status by Reference
        call: verification-verifications.getverificationstatusbyreference
        with:
          reference: rest.reference
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/verification/v1/verifications/{type}/{endpoint}
      name: verification-v1-verifications-type-endpoint
      description: REST surface for verification-v1-verifications-type-endpoint.
      operations:
      - method: PUT
        name: reportverification
        description: Report a Verification
        call: verification-verifications.reportverification
        with:
          type: rest.type
          endpoint: rest.endpoint
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/verification/v1/verifications/{type}/{endpoint}/status
      name: verification-v1-verifications-type-endpoint-status
      description: REST surface for verification-v1-verifications-type-endpoint-status.
      operations:
      - method: GET
        name: getverificationstatusbyidentity
        description: Get Verification Status by Identity
        call: verification-verifications.getverificationstatusbyidentity
        with:
          type: rest.type
          endpoint: rest.endpoint
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: verification-verifications-mcp
    port: 9090
    transport: http
    description: MCP adapter for Sinch Verification API — Verifications. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: start-verification
      description: Start a Verification
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: verification-verifications.startverification
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: report-verification-id
      description: Report a Verification by Id
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: verification-verifications.reportverificationbyid
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-verification-status-id
      description: Get Verification Status by Id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: verification-verifications.getverificationstatusbyid
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-verification-status-reference
      description: Get Verification Status by Reference
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: verification-verifications.getverificationstatusbyreference
      with:
        reference: tools.reference
      outputParameters:
      - type: object
        mapping: $.
    - name: report-verification
      description: Report a Verification
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: verification-verifications.reportverification
      with:
        type: tools.type
        endpoint: tools.endpoint
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-verification-status-identity
      description: Get Verification Status by Identity
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: verification-verifications.getverificationstatusbyidentity
      with:
        type: tools.type
        endpoint: tools.endpoint
      outputParameters:
      - type: object
        mapping: $.