> ## Documentation Index
> Fetch the complete documentation index at: https://docs.services.payward.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Travel Rule verification

> Creates a Travel Rule verification case for a known wallet address.

Use this endpoint when the wallet address is known before a specific product flow needs to continue.



## OpenAPI

````yaml https://d2588n1sy4m36o.cloudfront.net/uat/merged/openapi.json post /v1/users/{user_id}/travel-rule/verifications
openapi: 3.1.0
info:
  title: PWS Public API
  version: '1'
  description: >-
    Integrate with Payward Services to onboard users, manage accounts and funds,
    trade assets, and receive event notifications.
  contact:
    name: Payward Services
servers:
  - url: https://api.sandbox.services.payward.com
security: []
tags:
  - name: Assets
    description: List the assets PWS is willing to swap.
    x-displayName: Assets
  - name: Conversions
    description: >-
      Rule-driven and on-demand fiat ↔ crypto value movement, including
      conversion rules and deposits.
    x-displayName: Conversions
  - name: Auto Earn
    description: >-
      Manage Auto Earn preferences and retrieve allocation and reward
      information.
    x-displayName: Auto Earn
  - name: Bonded Earn
    description: >-
      Allocate funds to and deallocate funds from bonded earn strategies, review
      allocations, and track request status.
    x-displayName: Bonded Earn
  - name: Funding
    description: >-
      Discover deposit and withdrawal options, manage deposit addresses, and
      move funds between accounts.
    x-displayName: Funding
  - name: Derivative transfers
    description: >-
      Move funds between an account's spot balance and the same owner's futures
      balance.
    x-displayName: Derivative transfers
  - name: Portfolio
    description: 'Inspect a customer''s portfolio: balances, valuations, and transactions.'
    x-displayName: Portfolio
  - name: Ramp
    description: >-
      Support Ramp flows with discovery, quotes, limits, and hosted checkout
      experiences.
    x-displayName: Ramp
  - name: Reports
    description: Settlement and reconciliation reports for the partner.
    x-displayName: Reports
  - name: Swaps
    description: Account-funded quotes that lock a price until they expire or are executed.
    x-displayName: Swaps
  - name: Onchain quotes
    description: Wallet-funded quotes that return the data needed to settle onchain.
    x-displayName: Onchain quotes
  - name: Price trigger swaps
    description: Swaps that wait for a target price before submitting a trade.
    x-displayName: Price trigger swaps
  - name: Travel Rule verifications
    description: Travel Rule address ownership verification flows.
    x-displayName: Travel Rule verifications
  - name: Users
    description: >-
      User onboarding and status flows that the partner manages.


      - **Create User** provisions an account-owned user from an external
      reference and optional email.

      - **Get User** retrieves the user's profile, verification status, and
      required actions.


      Use the returned user `id` for calls that require the user's identifier.
    x-displayName: Users
  - name: Verifications
    description: Identity verification (KYC) submission and status for end users.
    x-displayName: Verifications
  - name: Webhooks
    description: >-
      Register HTTPS destinations to receive event deliveries, rotate signing
      secrets, and inspect, update, or delete existing subscriptions. Each
      subscription is owned by the authenticated partner; deliveries are signed
      with HMAC-SHA256 and retried on transient failures.
    x-displayName: Webhooks
paths:
  /v1/users/{user_id}/travel-rule/verifications:
    parameters:
      - $ref: '#/components/parameters/UserId'
    post:
      tags:
        - Travel Rule verifications
      summary: Create Travel Rule verification
      description: >-
        Creates a Travel Rule verification case for a known wallet address.


        Use this endpoint when the wallet address is known before a specific
        product flow needs to continue.
      operationId: createTravelRuleVerification
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/TravelRuleVerifications_CreateTravelRuleVerificationBody
            examples:
              hosted-wallet:
                summary: Hosted wallet verification
                value:
                  address: '0x8ba1f109551bD432803012645Ac136ddd64DBA72'
                  method: hosted_declaration
              self-hosted-wallet:
                summary: Self-hosted wallet verification
                value:
                  address: '0x8ba1f109551bD432803012645Ac136ddd64DBA72'
                  method: self_attestation
                  evidence:
                    ownership_confirmed: true
                    two_factor_completed: true
                    two_factor_method: otp
                    attestation_text: >-
                      In accordance with Payward's Terms of Service, I, customer
                      {userID}, confirm that the wallet address {wallet-address}
                      is a self-hosted wallet owned and controlled solely by me.
                      I make this declaration on {date}, and it applies to all
                      deposits and withdrawals between this wallet and my
                      account.
                    user_confirmed_at: '2026-06-23T10:00:00Z'
      responses:
        '201':
          description: ''
          headers:
            X-Trace-Id:
              $ref: '#/components/headers/TraceId'
            Strict-Transport-Security:
              $ref: '#/components/headers/StrictTransportSecurity'
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/TravelRuleVerifications_CreateTravelRuleVerificationEnvelope
              examples:
                hosted-wallet-verified:
                  summary: Hosted wallet verified
                  value:
                    data:
                      verification_id: ver_0195e4d2-a4d0-7b12-8f4a-123456789abc
                      wallet_type: hosted
                      method: hosted_declaration
                      status: verified
                self-hosted-wallet-verified:
                  summary: Self-hosted wallet verified
                  value:
                    data:
                      verification_id: ver_0195e4d2-a4d0-7b12-8f4a-123456789abc
                      wallet_type: self_hosted
                      method: self_attestation
                      status: verified
        '400':
          $ref: '#/components/responses/TravelRuleBadRequestResponse'
        '401':
          $ref: '#/components/responses/TravelRuleUnauthenticatedResponse'
        '403':
          $ref: '#/components/responses/TravelRuleForbiddenResponse'
        '409':
          $ref: '#/components/responses/TravelRuleVerificationConflictResponse'
        '429':
          $ref: '#/components/responses/TravelRuleResourceExhaustedResponse'
        '500':
          $ref: '#/components/responses/TravelRuleInternalResponse'
        '503':
          $ref: '#/components/responses/TravelRuleUnavailableResponse'
        '504':
          $ref: '#/components/responses/TravelRuleDeadlineExceededResponse'
      security:
        - ApiKey: []
          ApiSign: []
          ApiNonce: []
components:
  parameters:
    UserId:
      name: user_id
      in: path
      required: true
      example: AA23N84GGQN4WE6I
      schema:
        $ref: '#/components/schemas/UserId'
  schemas:
    TravelRuleVerifications_CreateTravelRuleVerificationBody:
      description: Request to create a hosted declaration or self-attestation verification.
      oneOf:
        - $ref: >-
            #/components/schemas/TravelRuleVerifications_HostedDeclarationVerificationBody
          title: Hosted declaration
        - $ref: >-
            #/components/schemas/TravelRuleVerifications_SelfAttestationVerificationBody
          title: Self-attestation
      discriminator:
        propertyName: method
        mapping:
          hosted_declaration: >-
            #/components/schemas/TravelRuleVerifications_HostedDeclarationVerificationBody
          self_attestation: >-
            #/components/schemas/TravelRuleVerifications_SelfAttestationVerificationBody
    TravelRuleVerifications_CreateTravelRuleVerificationEnvelope:
      description: Response returned after creating a Travel Rule verification case.
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/TravelRuleVerifications_TravelRuleVerification'
          description: Travel Rule verification case.
    UserId:
      description: Globally unique public identifier for a user.
      type: string
      minLength: 14
      maxLength: 42
    TravelRuleVerifications_HostedDeclarationVerificationBody:
      description: Request to verify a hosted wallet through a hosted declaration.
      type: object
      additionalProperties: false
      required:
        - address
        - method
      properties:
        address:
          description: Wallet address to verify.
          type: string
          minLength: 1
          maxLength: 256
        method:
          description: Hosted declaration discriminator.
          type: string
          enum:
            - hosted_declaration
    TravelRuleVerifications_SelfAttestationVerificationBody:
      description: Request to verify a self-hosted wallet through self-attestation.
      type: object
      additionalProperties: false
      required:
        - address
        - method
        - evidence
      properties:
        address:
          description: Wallet address to verify.
          type: string
          minLength: 1
          maxLength: 256
        method:
          description: Self-attestation discriminator.
          type: string
          enum:
            - self_attestation
        evidence:
          $ref: '#/components/schemas/TravelRuleVerifications_SelfAttestationEvidence'
          description: >-
            Evidence that the user confirmed ownership and completed
            partner-side two-factor authentication.
    TravelRuleVerifications_TravelRuleVerification:
      description: Travel Rule verification case for a wallet address.
      type: object
      required:
        - verification_id
        - wallet_type
        - status
      properties:
        verification_id:
          description: Stable PWS identifier for the verification case.
          type: string
          minLength: 1
          maxLength: 64
        wallet_type:
          $ref: '#/components/schemas/TravelRuleVerifications_VerificationWalletType'
          description: Type of wallet being verified.
        method:
          $ref: '#/components/schemas/TravelRuleVerifications_VerificationMethod'
          description: >-
            Verification method submitted or started for this case, when one has
            been selected.
        status:
          $ref: '#/components/schemas/TravelRuleVerifications_VerificationStatus'
          description: Current verification status.
        created_at:
          $ref: '#/components/schemas/DateTime'
          description: Time at which PWS created the verification case projection.
        updated_at:
          $ref: '#/components/schemas/DateTime'
          description: Time at which PWS last updated the verification case projection.
    BadRequestError:
      title: Bad Request
      description: Request validation failed or the request could not be processed.
      oneOf:
        - title: Bad Request
          allOf:
            - $ref: '#/components/schemas/PwsValidationErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsValidationError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        status:
                          type: integer
                          format: int32
                          const: 400
                        code:
                          type: string
                          enum:
                            - bad_request
        - title: Gateway
          description: >-
            Gateway-level validation failure returned before the request reaches
            the service.
          allOf:
            - $ref: '#/components/schemas/PwsValidationErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsValidationError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        type:
                          type: string
                          const: service_error
                        status:
                          type: integer
                          format: int32
                          const: 400
                        code:
                          type: string
                          const: gateway
    UnauthenticatedError:
      title: Unauthenticated
      description: Authentication credentials are missing, invalid, or not accepted.
      oneOf:
        - title: Unauthenticated
          allOf:
            - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsGeneralError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        status:
                          type: integer
                          format: int32
                          const: 401
                        code:
                          type: string
                          enum:
                            - unauthenticated
        - title: Gateway
          description: Authentication failure returned by the API gateway.
          allOf:
            - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsGeneralError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        type:
                          type: string
                          const: service_error
                        status:
                          type: integer
                          format: int32
                          const: 401
                        code:
                          type: string
                          const: gateway
    ForbiddenError:
      title: Forbidden
      description: The caller is not allowed to perform this operation.
      oneOf:
        - title: Forbidden
          allOf:
            - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsGeneralError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        status:
                          type: integer
                          format: int32
                          const: 403
                        code:
                          type: string
                          enum:
                            - forbidden
        - title: Gateway
          description: Authorization failure returned by the API gateway.
          allOf:
            - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
            - type: object
              required:
                - error
              properties:
                error:
                  allOf:
                    - $ref: '#/components/schemas/PwsGeneralError'
                    - type: object
                      required:
                        - status
                        - code
                      properties:
                        type:
                          type: string
                          const: service_error
                        status:
                          type: integer
                          format: int32
                          const: 403
                        code:
                          type: string
                          const: gateway
    TravelRuleVerifications_WalletTypeMismatchError:
      description: >-
        The wallet address already has a verification with a different wallet
        type.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 409
                    code:
                      type: string
                      enum:
                        - wallet_type_mismatch
    TravelRuleVerifications_VerificationNotEnabledError:
      description: Travel Rule address verification is not enabled for the user.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 409
                    code:
                      type: string
                      enum:
                        - verification_not_enabled
    TravelRuleVerifications_SatoshiTestRequiredError:
      description: >-
        The address requires a Satoshi test and cannot use a weaker verification
        method.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 409
                    code:
                      type: string
                      enum:
                        - satoshi_test_required
    TravelRuleVerifications_VerificationRejectedError:
      description: Travel Rule rejected the submitted verification.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 409
                    code:
                      type: string
                      enum:
                        - verification_rejected
    ResourceExhaustedError:
      description: The request was rate limited or a resource quota was exhausted.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 429
                    code:
                      type: string
                      enum:
                        - resource_exhausted
    InternalError:
      description: An unexpected server-side error occurred.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 500
                    code:
                      type: string
                      enum:
                        - internal
    UnavailableError:
      description: The service is temporarily unavailable.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 503
                    code:
                      type: string
                      enum:
                        - unavailable
    DeadlineExceededError:
      description: The request deadline was exceeded before a response could be produced.
      allOf:
        - $ref: '#/components/schemas/PwsGeneralErrorEnvelope'
        - type: object
          required:
            - error
          properties:
            error:
              allOf:
                - $ref: '#/components/schemas/PwsGeneralError'
                - type: object
                  required:
                    - status
                    - code
                  properties:
                    status:
                      type: integer
                      format: int32
                      const: 504
                    code:
                      type: string
                      enum:
                        - deadline_exceeded
    TravelRuleVerifications_SelfAttestationEvidence:
      description: Partner-collected evidence supporting a self-hosted wallet verification.
      type: object
      required:
        - ownership_confirmed
        - two_factor_completed
        - two_factor_method
        - attestation_text
        - user_confirmed_at
      properties:
        ownership_confirmed:
          description: Whether the user confirmed that they own or control the wallet.
          type: boolean
        two_factor_completed:
          description: >-
            Whether the partner confirmed that the user completed two-factor
            authentication.
          type: boolean
        two_factor_method:
          $ref: '#/components/schemas/TravelRuleVerifications_TwoFactorMethod'
          description: Two-factor authentication method completed by the user.
        attestation_text:
          description: Ownership statement confirmed by the user.
          type: string
          minLength: 1
          maxLength: 4096
        user_confirmed_at:
          $ref: '#/components/schemas/DateTime'
          description: Time at which the user confirmed the ownership statement.
    TravelRuleVerifications_VerificationWalletType:
      description: Wallet type for the verification case.
      type: string
      enum:
        - hosted
        - self_hosted
    TravelRuleVerifications_VerificationMethod:
      description: Verification method for the case.
      type: string
      enum:
        - hosted_declaration
        - self_attestation
    TravelRuleVerifications_VerificationStatus:
      description: >-
        Partner-facing proactive verification status. Pending is reserved for
        recovery when the Travel submission outcome is uncertain.
      type: string
      enum:
        - pending
        - verified
        - failed
    DateTime:
      description: RFC 3339 timestamp.
      type: string
      format: date-time
    PwsValidationErrorEnvelope:
      description: Error envelope for request validation failures.
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/PwsValidationError'
          description: Validation error details.
    PwsValidationError:
      description: Standard PWS API error object for request validation failures.
      type: object
      required:
        - type
        - status
        - instance
        - code
      properties:
        type:
          description: Machine-readable error class.
          type: string
        status:
          description: HTTP status code returned for this error.
          type: integer
          format: int32
        instance:
          description: Request identifier for this specific error occurrence.
          type: string
        code:
          description: Stable machine-readable error code.
          type: string
        doc_url:
          description: Optional link to documentation for this error.
          type: string
          format: uri
        causes:
          description: Validation failures that contributed to the error.
          type: array
          items:
            $ref: '#/components/schemas/PwsErrorCause'
    PwsGeneralErrorEnvelope:
      description: Error envelope for operational or domain failures.
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/PwsGeneralError'
          description: General error details.
    PwsGeneralError:
      description: Standard PWS API error object for non-validation failures.
      allOf:
        - $ref: '#/components/schemas/PwsErrorBase'
        - type: object
          properties:
            causes:
              description: Additional error details, when present.
              type: array
              items:
                type: object
                additionalProperties: true
    TravelRuleVerifications_TwoFactorMethod:
      description: Partner-side two-factor authentication method completed by the user.
      type: string
      enum:
        - otp
        - passkey
    PwsErrorCause:
      description: A single request validation failure.
      type: object
      required:
        - field
        - message
      properties:
        field:
          description: Dot-notation path to the offending request field.
          type: string
        message:
          description: Human-readable explanation of the failed validation rule.
          type: string
    PwsErrorBase:
      description: Common fields present on every PWS API error object.
      type: object
      required:
        - type
        - status
        - instance
        - code
      properties:
        type:
          description: Machine-readable error class.
          type: string
        status:
          description: HTTP status code returned for this error.
          type: integer
          format: int32
        instance:
          description: Request identifier for this specific error occurrence.
          type: string
        code:
          description: Stable machine-readable error code.
          type: string
        doc_url:
          description: Optional link to documentation for this error.
          type: string
          format: uri
  headers:
    TraceId:
      description: Trace identifier for the request. Include it when contacting support.
      schema:
        type: string
        example: 4bf92f3577b34da6a3ce929d0e0e4736
    StrictTransportSecurity:
      description: Enforces HTTPS for the duration specified by `max-age`.
      schema:
        type: string
        example: max-age=31536000; includeSubDomains; preload
    CacheControl:
      description: Prevents caching of sensitive financial data. Always `no-store`.
      schema:
        type: string
        enum:
          - no-store
        example: no-store
  responses:
    TravelRuleBadRequestResponse:
      description: ''
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BadRequestError'
          examples:
            invalid-request:
              $ref: '#/components/examples/travel-rule-bad-request'
    TravelRuleUnauthenticatedResponse:
      description: ''
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthenticatedError'
          examples:
            authentication-failed:
              $ref: '#/components/examples/travel-rule-unauthenticated'
    TravelRuleForbiddenResponse:
      description: ''
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ForbiddenError'
          examples:
            caller-is-not-allowed:
              $ref: '#/components/examples/travel-rule-forbidden'
    TravelRuleVerificationConflictResponse:
      description: The verification conflicts with the current Travel Rule state.
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            oneOf:
              - $ref: >-
                  #/components/schemas/TravelRuleVerifications_WalletTypeMismatchError
                title: Wallet type mismatch
              - $ref: >-
                  #/components/schemas/TravelRuleVerifications_VerificationNotEnabledError
                title: Verification not enabled
              - $ref: >-
                  #/components/schemas/TravelRuleVerifications_SatoshiTestRequiredError
                title: Satoshi test required
              - $ref: >-
                  #/components/schemas/TravelRuleVerifications_VerificationRejectedError
                title: Verification rejected
          examples:
            wallet-type-mismatch:
              $ref: '#/components/examples/travel-rule-wallet-type-mismatch'
            verification-not-enabled:
              $ref: '#/components/examples/travel-rule-verification-not-enabled'
            satoshi-test-required:
              $ref: '#/components/examples/travel-rule-satoshi-test-required'
            verification-rejected:
              $ref: '#/components/examples/travel-rule-verification-rejected'
    TravelRuleResourceExhaustedResponse:
      description: ''
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResourceExhaustedError'
          examples:
            rate-limit-exceeded:
              $ref: '#/components/examples/travel-rule-resource-exhausted'
    TravelRuleInternalResponse:
      description: ''
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InternalError'
          examples:
            internal-error:
              $ref: '#/components/examples/travel-rule-internal'
    TravelRuleUnavailableResponse:
      description: ''
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnavailableError'
          examples:
            service-unavailable:
              $ref: '#/components/examples/travel-rule-unavailable'
    TravelRuleDeadlineExceededResponse:
      description: ''
      headers:
        X-Trace-Id:
          $ref: '#/components/headers/TraceId'
        Strict-Transport-Security:
          $ref: '#/components/headers/StrictTransportSecurity'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DeadlineExceededError'
          examples:
            request-deadline-exceeded:
              $ref: '#/components/examples/travel-rule-deadline-exceeded'
  examples:
    travel-rule-bad-request:
      summary: Invalid request
      value:
        error:
          type: travel_rule_error
          instance: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b
          status: 400
          code: bad_request
          causes:
            - field: address
              message: must be a valid address for the selected network
    travel-rule-unauthenticated:
      summary: Authentication failed
      value:
        error:
          type: travel_rule_error
          instance: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b
          status: 401
          code: unauthenticated
    travel-rule-forbidden:
      summary: Caller is not allowed
      value:
        error:
          type: travel_rule_error
          instance: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b
          status: 403
          code: forbidden
    travel-rule-wallet-type-mismatch:
      summary: Wallet type conflicts with the existing verification
      value:
        error:
          type: travel_rule_error
          instance: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b
          status: 409
          code: wallet_type_mismatch
    travel-rule-verification-not-enabled:
      summary: Verification is not enabled
      value:
        error:
          type: travel_rule_error
          instance: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b
          status: 409
          code: verification_not_enabled
    travel-rule-satoshi-test-required:
      summary: A Satoshi test is required
      value:
        error:
          type: travel_rule_error
          instance: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b
          status: 409
          code: satoshi_test_required
    travel-rule-verification-rejected:
      summary: Verification was rejected
      value:
        error:
          type: travel_rule_error
          instance: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b
          status: 409
          code: verification_rejected
    travel-rule-resource-exhausted:
      summary: Rate limit exceeded
      value:
        error:
          type: travel_rule_error
          instance: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b
          status: 429
          code: resource_exhausted
    travel-rule-internal:
      summary: Internal error
      value:
        error:
          type: travel_rule_error
          instance: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b
          status: 500
          code: internal
    travel-rule-unavailable:
      summary: Service unavailable
      value:
        error:
          type: travel_rule_error
          instance: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b
          status: 503
          code: unavailable
    travel-rule-deadline-exceeded:
      summary: Request deadline exceeded
      value:
        error:
          type: travel_rule_error
          instance: 5f4d2a8e-91a4-4d6c-8a17-9b1e2c3f4a5b
          status: 504
          code: deadline_exceeded
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: API-Key
      description: Your public API key. Identifies the partner making the request.
    ApiSign:
      type: apiKey
      in: header
      name: API-Sign
      description: HMAC signature over the request, computed with your private key.
    ApiNonce:
      type: apiKey
      in: header
      name: API-Nonce
      description: Monotonically increasing nonce included in the request signature.

````