Trulioo Verifications API — Transactions

naftiko: 1.0.0-alpha2
info:
  label: Trulioo Verifications API — Transactions
  description: >-
    Retrieve verification transaction records, statuses, partial results, and downloadable
    documents from completed Trulioo Verify calls.
  tags:
    - Trulioo
    - Transactions
    - Documents
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
  - namespace: env
    keys:
      TRULIOO_USERNAME: TRULIOO_USERNAME
      TRULIOO_PASSWORD: TRULIOO_PASSWORD
capability:
  consumes:
    - type: http
      namespace: verifications-transactions
      baseUri: https://api.trulioo.com
      description: Trulioo verification transaction lookups and document downloads.
      resources:
        - name: transactionrecord
          path: /v3/verifications/transactionrecord/{transactionRecordId}
          operations:
            - name: getTransactionRecord
              method: GET
              description: Get Transaction Record
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: transactionRecordId
                  in: path
                  type: string
                  required: true
        - name: transactionrecord-withaddress
          path: /v3/verifications/transactionrecord/{transactionRecordId}/withaddress
          operations:
            - name: getTransactionRecordWithAddress
              method: GET
              description: Get Transaction Record With Address
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: transactionRecordId
                  in: path
                  type: string
                  required: true
        - name: transaction-status
          path: /v3/verifications/transaction/{transactionId}/status
          operations:
            - name: getTransactionStatus
              method: GET
              description: Get Transaction Status
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: transactionId
                  in: path
                  type: string
                  required: true
        - name: transaction-partialresult
          path: /v3/verifications/transaction/{transactionRecordId}/partialresult
          operations:
            - name: getPartialTransactionResult
              method: GET
              description: Get Partial Transaction Result
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: transactionRecordId
                  in: path
                  type: string
                  required: true
        - name: documentdownload
          path: /v3/verifications/documentdownload/{transactionRecordId}/{fieldName}
          operations:
            - name: downloadDocument
              method: GET
              description: Download Evidence Document
              outputRawFormat: binary
              outputParameters:
                - name: result
                  type: binary
                  value: $.
              inputParameters:
                - name: transactionRecordId
                  in: path
                  type: string
                  required: true
                - name: fieldName
                  in: path
                  type: string
                  required: true
      authentication:
        type: basic
        username: '{{env.TRULIOO_USERNAME}}'
        password: '{{env.TRULIOO_PASSWORD}}'
  exposes:
    - type: rest
      namespace: verifications-transactions-rest
      port: 8080
      description: REST adapter for Trulioo verification transactions.
      resources:
        - path: /v3/verifications/transactionrecord/{transactionRecordId}
          name: transactionrecord
          description: REST surface for transaction record retrieval.
          operations:
            - method: GET
              name: getTransactionRecord
              description: Get Transaction Record
              call: verifications-transactions.getTransactionRecord
              with:
                transactionRecordId: rest.path.transactionRecordId
              outputParameters:
                - type: object
                  mapping: $.
    - type: mcp
      namespace: verifications-transactions-mcp
      port: 9090
      transport: http
      description: MCP adapter for Trulioo verification transactions.
      tools:
        - name: trulioo-get-transaction-record
          description: Get Trulioo verification transaction record
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: verifications-transactions.getTransactionRecord
          with:
            transactionRecordId: tools.transactionRecordId
          outputParameters:
            - type: object
              mapping: $.
        - name: trulioo-get-transaction-status
          description: Get Trulioo verification transaction status
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: verifications-transactions.getTransactionStatus
          with:
            transactionId: tools.transactionId
          outputParameters:
            - type: object
              mapping: $.