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

# Get a transaction

> 
Retrieves a single processed transaction by its unique transaction hash.

Note transactions must be submitted via the Faraday API to be available on this endpoint. 

### Response
Includes:
- Transaction hash
- Network (e.g., Solana, Ethereum)
- Amount (in base units)
- Travel Rule compliance status
- Timestamp of creation or observation
- Full IVMS101 sender and recipient records, if available

### Notes
- If IVMS101 records are missing, `sender` or `recipient` will be `null`.
- Use this endpoint to audit a transaction or verify compliance.




## OpenAPI

````yaml /api-reference/faraday-api.json get /v1/transactions/{tx_hash}
openapi: 3.1.0
info:
  title: Faraday API
  description: >-

    The **Faraday API** provides secure, compliant infrastructure for stablecoin
    transactions, identity verification, and transaction monitoring across
    multiple blockchains.


    ### Key Features

    - **Swap Routing** — Discover optimal swap paths for stablecoin transfers,
    including cross-chain routes.

    - **IVMS101 Person Records** — Create, query, and manage structured person
    data for FATF Travel Rule compliance.

    - **Transaction Submission and Monitoring** — Submit and track stablecoin
    transactions.

    - **Reporting** — View historical transaction reports including associated
    IVMS101 records.


    ### Authentication

    Most requests require an API key (Bearer token).


    Generate and manage API keys by signing in to https://app.range.org/


    API Keys can be found under the APIs section. A free monthly credit
    allowance is available, with more credits available to paid plans.


    Include this header with every authenticated Faraday request:


    ```

    Authorization: Bearer <your_token>

    ```


    ### Base URL

    - Production: `https://api.faraday.range.org`


    ### Example Request

    ```bash

    curl -X GET 'https://api.faraday.range.org/v1/persons'   --header
    'Authorization: Bearer <your_token>'

    ```
            
  contact:
    name: Faraday
    url: https://range.org/faraday
    email: faraday@range.org
  license:
    name: ''
  version: 1.0.0
servers:
  - url: https://api.faraday.range.org
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Transactions
    description: Send, track and find transactions
  - name: Persons
    description: >-
      Manage IVMS101 Person records. This includes creation and retrieval of
      structured person data for compliance with FATF Travel Rule standards.
  - name: Chains
    description: Chains supported by Faraday
  - name: Tokens
    description: Tokens supported by Faraday
  - name: Providers
    description: Providers supported by Faraday
paths:
  /v1/transactions/{tx_hash}:
    get:
      tags:
        - Transactions
      summary: Get a transaction
      description: >

        Retrieves a single processed transaction by its unique transaction hash.


        Note transactions must be submitted via the Faraday API to be available
        on this endpoint. 


        ### Response

        Includes:

        - Transaction hash

        - Network (e.g., Solana, Ethereum)

        - Amount (in base units)

        - Travel Rule compliance status

        - Timestamp of creation or observation

        - Full IVMS101 sender and recipient records, if available


        ### Notes

        - If IVMS101 records are missing, `sender` or `recipient` will be
        `null`.

        - Use this endpoint to audit a transaction or verify compliance.
      operationId: get_transaction_by_hash
      parameters:
        - name: tx_hash
          in: path
          description: Unique transaction hash to retrieve
          required: true
          schema:
            type: string
      responses:
        '200':
          description: |

            **OK**

            Transaction successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionReport'
              examples:
                Transaction report:
                  value:
                    amount: 1000000
                    created_at: '2025-11-06T19:45:32Z'
                    network: eth
                    recipient:
                      account_numbers:
                        - account_number: '0x10ADD26fb2D17dA265e0567B8F56cb4687979fbE'
                      addresses:
                        - address_type: HOME
                          country: CH
                          street_name: Reichenbach Falls
                          town_name: Meiringen
                      kind: natural
                      name_identifiers:
                        - primary_identifier: James Moriarty
                          type: LEGL
                      national_identifiers:
                        - country: CH
                          identifier_type: RAID
                          national_identifier: '987654321'
                      person:
                        country_of_residence: CH
                        customer_identification: MORIARTY-001
                        date_of_birth: '1985-02-10'
                        place_of_birth: Bern
                    sender:
                      account_numbers:
                        - account_number: GvFbpZcqXNoZbAH8ETAA4DYBzaEHY4v2Vt7r71ZqJCTc
                      addresses:
                        - address_type: HOME
                          building_number: 221B
                          country: GB
                          street_name: Baker Street
                          town_name: London
                      kind: natural
                      name_identifiers:
                        - primary_identifier: Sherlock Holmes
                          type: LEGL
                      national_identifiers:
                        - country: GB
                          identifier_type: RAID
                          national_identifier: '123456789'
                      person:
                        country_of_residence: GB
                        customer_identification: CUST-123
                        date_of_birth: '1990-05-14'
                        place_of_birth: London
                    travel_rule_compliant: true
                    tx_hash: >-
                      0x9a9b6f5a123c4def5678901234567890abcdef1234567890abcdef1234567890
        '401':
          description: |

            **Unauthorized**

            This error indicates that the API key is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Missing key:
                  summary: API Key Missing
                  description: >-
                    An API key is missing in the request and should be provided
                    in the `Authorization: Bearer` header.
                  value:
                    details:
                      message: >-
                        No API key found, please set this in an Authorization:
                        Bearer header
                    error: authentication failed
                Unauthorized:
                  summary: Unauthorized
                  description: >-
                    The API key may be invalid, an empty key was provided, or
                    the key is not authorized.
                  value:
                    details:
                      message: The API key provided is not authorised or invalid
                    error: authentication failed
        '403':
          description: >

            **Forbidden**


            This error indicates that the API key is valid but the requested
            feature or resource is disabled for this workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Disabled API Key:
                  summary: Feature disabled
                  description: >-
                    The API key is valid but the associated feature or endpoint
                    has been disabled for this workspace.
                  value:
                    details:
                      message: Feature disabled for this API key
                    error: authentication failed
        '404':
          description: >

            **Not Found**


            Returned when no transaction was found for the provided transaction
            hash.

            This may occur if the transaction was submitted directly to a
            blockchain

            rather than through the Faraday API.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Transaction not found:
                  value:
                    details:
                      message: transaction not found
                    error: not found
        '429':
          description: >

            **Too Many Requests**


            This error indicates that the API key has exceeded its allowed
            number of requests within the current quota.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Rate Limited API Key:
                  summary: Rate limit exceeded
                  description: The API key has exceeded its quota.
                  value:
                    details:
                      message: API Key Rate limit exceeded
                    error: authentication failed
        '500':
          description: >

            **Internal Server Error**


            An unexpected internal error occurred while processing the request.
            This typically indicates a transient backend or database issue.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Internal Server Error:
                  summary: Internal error
                  description: >-
                    An unhandled exception or service outage prevented the
                    request from completing successfully.
                  value:
                    error: internal server error
components:
  schemas:
    TransactionReport:
      type: object
      description: |-
        Summary of a processed on-chain transaction.

        A `TransactionReport` captures the lifecycle and compliance details
        of a submitted transfer, including its hash, network, amount,
        and any associated IVMS101 sender and recipient records.
      required:
        - tx_hash
        - network
        - amount
        - travel_rule_compliant
        - created_at
      properties:
        amount:
          type: integer
          format: int64
          description: |-
            The transaction amount in the smallest base unit.

            For example, 1 USDC = `1000000` when using 6-decimal precision.
          example: 1000000
        created_at:
          type: string
          format: date-time
          description: |-
            Timestamp when the transaction was created or first observed.

            Uses UTC and ISO 8601 format.
          example: '2025-11-06T19:45:32Z'
        network:
          type: string
          description: |-
            The blockchain network on which the transaction was broadcast.

            Typically matches one of the supported Faraday networks such as
            `ethereum"`, or `"solana"`.
          example: solana
        recipient:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/Person'
              description: >-
                Full IVMS101 record of the transaction recipient, if available.


                Will be `null` if the recipient record has not been attached or
                processed.
        sender:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/Person'
              description: >-
                Full IVMS101 record of the transaction sender, if available.


                Will be `null` if the sender record has not been attached or
                processed.
        travel_rule_compliant:
          type: boolean
          description: >-
            Whether this transaction was compliant with the Travel Rule (FATF
            R.16).


            If `true`, sender and recipient identity information were

            successfully attached and transmitted according to IVMS101
            standards.
          example: true
        tx_hash:
          type: string
          description: |-
            The on-chain transaction hash.

            Used to uniquely identify the transaction on the given network.
          example: '0x9a9b6f5a123c4def5678901234567890abcdef1234567890abcdef1234567890'
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
    Person:
      type: object
      required:
        - id
        - created_at
        - person
        - name_identifiers
        - national_identifiers
        - account_numbers
        - addresses
      properties:
        account_numbers:
          type: array
          items:
            $ref: '#/components/schemas/AccountNumber'
          description: Account numbers (bank or wallet identifiers).
          example:
            - account_number: GB29NWBK60161331926819
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/Address'
          description: Registered or physical addresses.
          example:
            - address_type: GEOG
              country: GB
              town_name: London
        created_at:
          type: string
          format: date-time
          description: Timestamp when the person was created (UTC).
          example: '2025-07-29T14:45:00'
        id:
          type: string
          format: uuid
          description: Unique identifier of the person record.
          example: d2fd3b17-1fcd-4c4f-bc0e-3b6f858a5e5d
        name_identifiers:
          type: array
          items:
            $ref: '#/components/schemas/NameIdentifier'
          description: List of name identifiers (e.g., legal name, aliases).
          example:
            - is_legal: true
              kind: LEGL
              primary_identifier: Acme Corp
        national_identifiers:
          type: array
          items:
            $ref: '#/components/schemas/NationalIdentifier'
          description: National identifiers (e.g., passport, tax ID).
          example:
            - country_of_issue: GB
              identifier_type: tax_id
              national_identifier: '123456789'
        person:
          $ref: '#/components/schemas/PersonCore'
          description: The core person object (either natural or legal).
    AccountNumber:
      type: object
      description: >-
        Identifier of an account that is used to process the transaction.
        Case-sensitive. See IVMS101 Section 5.2.1.3.3.
      properties:
        account_number:
          type: string
          description: Represents a bank or virtual asset account number.
          example: HOLMESACC12345
          maxLength: 50
          minLength: 1
    Address:
      type: object
      description: >-
        Describes a full postal address used for geographic or legal
        identification. See IVMS101 Section 5.2.6.
      properties:
        address_lines:
          type:
            - array
            - 'null'
          items:
            type: string
            maxLength: 140
            minLength: 1
          description: >-
            Free format address lines. See IVMS101 Section 5.2.6.3.15 and
            constraint C8.
          example: '["Company HQ", "Main Street"]'
        address_type:
          $ref: '#/components/schemas/AddressType'
          description: >-
            Identifies the nature of the address (geographic/home/business). See
            IVMS101 Section 5.2.6.3.1.
        building_name:
          type:
            - string
            - 'null'
          description: Name of the building or house. See IVMS101 Section 5.2.6.3.6.
          example: Holmes Residence
          maxLength: 35
          minLength: 1
        building_number:
          type:
            - string
            - 'null'
          description: >-
            Number that identifies the position of a building on a street. See
            IVMS101 Section 5.2.6.3.5.
          example: 221B
          maxLength: 16
          minLength: 1
        country:
          type: string
          description: >-
            ISO 3166-1 alpha-2 country code. See IVMS101 constraint C3 and
            Section 5.2.6.3.16.
          example: GB
        country_sub_division:
          type:
            - string
            - 'null'
          description: >-
            Identifies a subdivision of a country (state/region/province). See
            IVMS101 Section 5.2.6.3.14.
          example: England
          maxLength: 35
          minLength: 1
        department:
          type:
            - string
            - 'null'
          description: >-
            Identification of a division of a large organisation or building.
            See IVMS101 Section 5.2.6.3.2.
          example: Compliance Department
          maxLength: 35
          minLength: 1
        district_name:
          type:
            - string
            - 'null'
          description: >-
            Subdivision within a country subdivision. See IVMS101 Section
            5.2.6.3.13.
          example: Greater London
          maxLength: 35
          minLength: 1
        floor:
          type:
            - string
            - 'null'
          description: Floor or storey within a building. See IVMS101 Section 5.2.6.3.7.
          example: 2nd Floor
          maxLength: 70
          minLength: 1
        post_box:
          type:
            - string
            - 'null'
          description: Numbered box in a post office. See IVMS101 Section 5.2.6.3.8.
          example: PO123
          maxLength: 16
          minLength: 1
        postcode:
          type:
            - string
            - 'null'
          description: Postal code. See IVMS101 Section 5.2.6.3.10.
          example: NW1 6XE
          maxLength: 16
          minLength: 1
        room:
          type:
            - string
            - 'null'
          description: Building room number. See IVMS101 Section 5.2.6.3.9.
          example: Room 221
          maxLength: 35
          minLength: 1
        street_name:
          type:
            - string
            - 'null'
          description: Name of a street or thoroughfare. See IVMS101 Section 5.2.6.3.4.
          example: Main Street
          maxLength: 70
          minLength: 1
        sub_department:
          type:
            - string
            - 'null'
          description: Identification of a sub-division. See IVMS101 Section 5.2.6.3.3.
          example: Risk Team
          maxLength: 35
          minLength: 1
        town_location_name:
          type:
            - string
            - 'null'
          description: >-
            Specific location name within the town. See IVMS101 Section
            5.2.6.3.12.
          example: Westminster
          maxLength: 35
          minLength: 1
        town_name:
          type: string
          description: Name of built-up area. See IVMS101 Section 5.2.6.3.11.
          example: London
          maxLength: 35
          minLength: 1
    NameIdentifier:
      type: object
      description: >-
        Contains primary and secondary names used to identify a person. See
        IVMS101 Section 5.2.3.
      properties:
        is_legal:
          type: boolean
          description: Indicates if this is the legal name. See IVMS101 constraints C6/C5.
          example: true
        kind:
          $ref: '#/components/schemas/NameTypeCode'
          description: >-
            The nature of the name specified (legal, alias, birth, etc.). See
            IVMS101 Section 5.2.4.3.3.
        primary_identifier:
          type: string
          description: >-
            Primary identifier (surname or full name). See IVMS101 Section
            5.2.4.3.1.
          example: Sherlock Holmes
          maxLength: 100
          minLength: 1
        secondary_identifier:
          type:
            - string
            - 'null'
          description: >-
            Secondary identifier (forenames, initials). See IVMS101 Section
            5.2.4.3.2.
          example: S. Holmes
          maxLength: 100
    NationalIdentifier:
      type: object
      description: >-
        A distinct identifier used by governments to uniquely identify a natural
        or legal person. Refer to IVMS101 Sections 5.2.8 and 5.2.9.
      properties:
        country_of_issue:
          type:
            - string
            - 'null'
          description: >-
            ISO 3166-1 alpha-2 country code of the issuing authority. See
            IVMS101 constraint C3.
          example: GB
        identifier_type:
          type: string
          description: >-
            Specifies the type of the national identifier. See IVMS101 Section
            5.2.8.3.2.
          example: LEIX
          maxLength: 35
          minLength: 1
        national_identifier:
          type: string
          description: >-
            An identifier issued by an appropriate issuing authority. See
            IVMS101 Section 5.2.8.3.1.
          example: GB123456789
          maxLength: 35
          minLength: 1
        registration_authority:
          type:
            - string
            - 'null'
          description: >-
            Registration authority code; 8-character. See IVMS101 Sections
            C9/C10.
          example: RA000001
          maxLength: 8
          minLength: 8
    PersonCore:
      oneOf:
        - type: object
          required:
            - person
            - kind
          properties:
            kind:
              type: string
              enum:
                - natural
            person:
              type: object
              description: >-
                Represents a uniquely distinguishable individual; one single
                person with KYC-related attributes. See IVMS101 Section 5.2.2.3.
              properties:
                country_of_residence:
                  type:
                    - string
                    - 'null'
                  description: >-
                    ISO 3166-1 alpha-2 country code of residence. See IVMS101
                    constraint C3 and Section 5.2.2.3.6.

                    ISO 3166-1 alpha-2 country code
                  example: GB
                customer_identification:
                  type:
                    - string
                    - 'null'
                  description: >-
                    A distinct identifier that uniquely identifies the person to
                    the institution in context. See IVMS101 Section 5.2.2.3.4.
                  example: HOLMES001
                  maxLength: 50
                date_of_birth:
                  type:
                    - string
                    - 'null'
                  format: date
                  description: >-
                    Date of birth; must be a historic date per constraint C2.
                    See IVMS101 Section 5.2.7.
                  example: '1854-01-06'
                place_of_birth:
                  type:
                    - string
                    - 'null'
                  description: >-
                    Place of birth (town/city/subdivision/country). See IVMS101
                    Section 5.2.7.3.2.
                  example: Baker Street, London
                  maxLength: 100
                  minLength: 1
        - type: object
          required:
            - person
            - kind
          properties:
            kind:
              type: string
              enum:
                - legal
            person:
              type: object
              description: >-
                Represents a legal entity such as a company or organisation. See
                IVMS101 Section 5.2.9.
              properties:
                country_of_registration:
                  type:
                    - string
                    - 'null'
                  description: >-
                    ISO 3166-1 alpha-2 country code of registration. See IVMS101
                    constraint C3 and Section 5.2.9.3.5.

                    ISO 3166-1 alpha-2 country code
                  example: GB
                customer_identification:
                  type:
                    - string
                    - 'null'
                  description: >-
                    A distinct identifier that uniquely identifies the legal
                    person. See IVMS101 Section 5.2.9.3.3.
                  example: HOLMES_CORP
                  maxLength: 50
      description: Core person data for either a natural or legal person.
    AddressType:
      type: string
      description: >-
        Indicates the type of address used for identification purposes. See
        IVMS101 Section 5.2.6.
      enum:
        - GEOG
        - HOME
        - BIZZ
      example: GEOG
    NameTypeCode:
      type: string
      description: Specifies the type of name identifier as per IVMS101 Section 7.1.2.
      enum:
        - LEGL
        - ALIA
        - BIRT
        - MAID
        - MISC
      example: LEGL
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````