Query parameters

• user_id string Required
• channel string
• sub_channel string
• limit integer

  Maximum number of transactions to retrieve

• next_cursor string

  The purpose of this parameter is to retrieve the next page. This value is obtained from a previous response.

Responses

• 200 application/json

  OK

  Hide response attribute Show response attribute object

  • data object
    Hide data attributes Show data attributes object

    • transactions array[object] Required
      Hide transactions attributes Show transactions attributes object

      • id string Required

        Transaction id

      • score integer

        Quality score of the transaction. Can be null if the transaction is not completed. The value is between 0 and 100, where 0 is no fraud and 100 is definitely fraud.

      • score_reasons string

        Provides additional details when the transaction score is high, explaining why the user received that particular score. Populated only if the score is bigger than 0.

      • duplication_potential number

        Probability [0, 1] that this item is a duplicate. A value of 1 means that the user has completed this item in the past

      • data object Required
        Hide data attributes Show data attributes object

        • channel string

          Optional channel the user is coming from.

        • sub_channel string

          Optional sub-channel the user is coming from. Unique per channel.

        • project_source string

          Optional source of the project.

        • project_sub_source string

          Optional sub-source of the project. Unique per project_source.

        • user_id string Required

          Unique identifier of the user. Unique per channel & sub_channel.

        • project_type string Required

          The kind of project the user is joining.

          Values are survey, offer, or custom.

        • project_id string Required

          Unique identifier of the project. Unique per project_type, project_source & project_sub_source.

        • targeted_country string

          Optional country you are expecting the user to be in.

        • custom_tags object

          Optional custom tags to be associated with the transaction. Included in transaction lookup API calls.

          Hide custom_tags attribute Show custom_tags attribute object

          • * string Additional properties
        • redirect_url string Required

          URL to redirect the user to after they complete the transaction. {tx_id} will be replaced with the actual transaction id.

        • tx_ref_id string

          Optional reference id of a previously created transaction. If provided, all other fields will be ignored, except for redirect_url and custom_tags, which will be merged/overridden instead. Useful when a user is sent multiple times for a project (e.g. before & after a survey).

        • ext_survey_source string

          Optional survey source. Cannot be empty when ext_survey_id is not empty. if ext_survey_id and ext_survey_source are set, the partner opts in to deduplicate the transaction against all other partners' transactions that have these set Only available when type is survey

          Values are lucid, purespectrum, cint, or prodege.

        • ext_survey_id string

          Optional survey_id. Cannot be empty when ext_survey_source is not empty. if ext_survey_id and ext_survey_source are set, the partner opts in to deduplicate the transaction against all other partners' transactions that have these set Only available when type is survey

        • brand_image_url string

          Optional url to an image. This is used to customize the loader while the user is redirected. If this is not set a default loader is used.

        • expected_ip string

          Optional expected ip of the user. If set it must be a valid IPv4 or Ipv6 address

        • expected_user_agent string

          Optional expected User Agent. If set it must be between 1 and 255 characters.

        • user_demographic object
          Hide user_demographic attributes Show user_demographic attributes object

          • age integer

            Non negative number describing the age of the user.

          • gender string

            Gender of the user.

            Values are male, female, or other.

          • annual_household_income_usd integer

            Non negative number describing the annual household income of the user in USD.

      • state_transitions array[object]

        Each entry in the array represents a transition of state for a transaction.

        Hide state_transitions attributes Show state_transitions attributes object

        • termination_reason string

          Values are quota, qualification, or quality.

        • state string Required

          Values are completed, terminated, or reconciled.

        • ts string(date-time) Required
      • created_at string(date-time) Required

        Date and time when the transaction was created.

      • completed_at string(date-time)

        Date and time when the transaction was completed. If you receive a redirect but this is null, the user likely skipped the transaction or tempered with the frontend. Furthermore, it is recommended to compare the complete time with the time the user was redirected to your site. If the difference is too big, this could indicate a fraud attempt.

    • score_avg number(float) Deprecated

      Average of all scores or null. This field is deprecated and will be removed in future versions

    • score_med number(float) Deprecated

      Median of all scores or null. This field is deprecated and will be removed in future versions

    • next_cursor string | null

      use this to get the next page by adding query param next_cursor