GET

List conditions for touchpoint

Lists all conditions available for a given touchpoint.

Path Params

enterpriseId string required

Your Enterprise Id.
touchpointId string required

The id of a Touchpoint.

Responses

200

All available Conditions on a given Touchpoint.

Response Body

object

Wrapper object for a list of Conditions. Not paginated.

conditions array of objects
ANY OF
- name string enum required
  
  The name of the condition.
  
  transfer.destination.type
- label string required
  
  A label for the condition that you can display to users.
- description string required
  
  A description for the condition that you can display to an end user.
- status string enum required
  Status of the condition. Indicates if the condition is usable ACTIVE or not INACTIVE.
  
  ACTIVE - The condition is available for use.
  
  INACTIVE - The condition is NOT available for use.
  ACTIVEINACTIVE
- parameters array of objects required
  
  A list of Parameters to control how the condition behaves.
  ANY OF
  
  name string enum required
  
  The name of the condition parameter.
  
  type
  
  label string required
  
  A description for the condition parameter which can be shown to an end user.
  
  description string required
  
  A description for the condition parameter which can be shown to an end user.
  
  type string enum required
  
  Accepts only enumerated values as listed in the 'values' property of this condition.
  
  ENUMERATED
  
  required string enum required
  
  A value must always be provided, i.e. the parameter is required.
  
  ALWAYS
  
  allowMultiple boolean required
  
  true, if multiple values can be provided, i.e. as a list of values. When false only one value can be provided, i.e. a list with more than one element will be rejected.
  
  values array of objects required
  
  A list of valid values, only values from this list will be accepted.
  
  ANY OF
  
  value string enum required
  
  The actual value.
  
  whitelistedAddress
  
  label string required
  
  A label for the condition parameter Value which can be shown to an end user.
  
  description string required
  
  A description for the condition parameter Value which can be shown to an end user.
- name string enum required
  
  The name of the condition.
  
  transfer.velocity.limit
- label string required
  
  A label for the condition which can be shown to an end user.
- description string required
  
  A description for the condition which can be shown to an end user.
- status string enum required
  Status of the condition. Indicates if the condition is usable ACTIVE or not INACTIVE.
  
  ACTIVE - The condition is available for use.
  
  INACTIVE - The condition is NOT available for use.
  ACTIVEINACTIVE
- parameters array of objects required
  
  A list of Parameters to control how the condition behaves.
  ANY OF
  
  name string enum required
  
  The name of the condition parameter.
  
  amount
  
  label string required
  
  A description for the condition parameter which can be shown to an end user.
  
  description string required
  
  A description for the condition parameter which can be shown to an end user.
  
  type string enum required
  
  The type of acceptable values for this condition parameter.
  
  NON_NEGATIVE_NUMBER
  
  required string enum required
  
  A value must always be provided, i.e. the parameter is required.
  
  ALWAYS
  
  allowMultiple boolean required
  
  true, if multiple values can be provided, i.e. as a list of values. When false only one value can be provided, i.e. a list with more than one element will be rejected.
- name string enum required
  
  The name of the condition.
  
  transfer.amount
- label string required
  
  A label for the condition which can be shown to an end user.
- description string required
  
  A description for the condition which can be shown to an end user.
- status string enum required
  Status of the condition. Indicates if the condition is usable ACTIVE or not INACTIVE.
  
  ACTIVE - The condition is available for use.
  
  INACTIVE - The condition is NOT available for use.
  ACTIVEINACTIVE
- parameters array of objects required
  
  A list of Parameters to control how the condition behaves.
  ANY OF
  
  name string enum required
  
  The name of the condition parameter.
  
  operator
  
  label string required
  
  A label for the condition parameter that you can display to users.
  
  description string required
  
  A description for the condition parameter which can be shown to an end user.
  
  type string enum required
  
  Accepts only enumerated values as listed in the 'values' property of this condition.
  
  ENUMERATED
  
  required string enum required
  
  A value must always be provided, i.e. the parameter is required.
  
  ALWAYS
  
  allowMultiple boolean required
  
  true, if multiple values can be provided, i.e. as a list of values. When false only one value can be provided, i.e. a list with more than one element will be rejected.
  
  values array of objects required
  
  A list of valid values, only values from this list will be accepted.
  
  ANY OF
  
  value string enum required
  
  The actual value.
  
  >
  
  label string required
  
  A label for the condition parameter Value which can be shown to an end user.
  
  description string required
  
  A description for the condition parameter Value which can be shown to an end user.
- name string enum required
  
  The name of the condition.
  
  transfer.initiators
- label string required
  
  A label for the condition which can be shown to an end user.
- description string required
  
  A description for the condition which can be shown to an end user.
- status string enum required
  
  Identifies if the condition is currently active and usable.
  
  ACTIVEINACTIVE
- parameters array of objects required
  
  A list of parameters that control how the condition behaves.
  ANY OF
  
  name string enum required
  
  The name of the condition parameter.
  
  userIds
  
  label string required
  
  A description for the condition parameter which can be shown to an end user.
  
  description string required
  
  A description for the condition parameter which can be shown to an end user.
  
  type string enum required
  
  The type of acceptable values for this condition parameter, a valid HMAC BitGo ID.
  
  BITGO_USER_ID
  
  required string enum required
  
  ALWAYS if the parameter is required otherwise OPTIONAL.
  
  ALWAYS
  
  allowMultiple boolean required
  
  true, if multiple values can be provided, i.e. as a list of values. When false only one value can be provided, i.e. a list with more than one element will be rejected.
- name string enum required
  
  The name of the condition.
  
  transfer.webhook
- label string required
  
  A label for the condition that you can display to an end user.
- description string required
  
  A description for the Condition which can be shown to an end user.
- status string enum required
  
  Identifies if the condition is currently active and usable.
  
  ACTIVEINACTIVE
- parameters array of objects required
  
  A list of parameters that control how the condition behaves.
  ANY OF
  
  name string enum required
  
  The name of the condition parameter.
  
  webhookUrl
  
  label string required
  
  A description for the condition parameter that you can display to an end user.
  
  description string required
  
  The webhook URL to post the transfer payload to.
  
  type string enum required
  
  The type of acceptable values for this condition parameter. Must be a valid webhook URL string.
  
  FREE_FORM
  
  required string enum required
  
  ALWAYS if the parameter is required otherwise OPTIONAL.
  
  ALWAYS
  
  allowMultiple boolean required
  
  true, if multiple values can be provided, i.e. as a list of values. When false only one value can be provided, i.e. a list with more than one element will be rejected.

401

Unauthorized

Response Body

object

code string
message string
status integer

403

Forbidden

Response Body

object

code string
message string
status integer

404

The specified resource was not found

Response Body

object

code string
message string
status integer

500

Server Error - Transient error please try again

Response Body

object

code string
message string
status integer

Language

Credentials

Bearer

Request

curl --request GET \
     --url 'https://app.bitgo-test.com/api/policy/v1/enterprises/enterpriseId/touchpoints/touchpointId/conditions' \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Request

const url = 'https://app.bitgo-test.com/api/policy/v1/enterprises/enterpriseId/touchpoints/touchpointId/conditions';
const options = {method: 'GET', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Request

require 'uri'
require 'net/http'

url = URI("https://app.bitgo-test.com/api/policy/v1/enterprises/enterpriseId/touchpoints/touchpointId/conditions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN'

response = http.request(request)
puts response.read_body

Request

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://app.bitgo-test.com/api/policy/v1/enterprises/enterpriseId/touchpoints/touchpointId/conditions', [
  'headers' => [
    'accept' => 'application/json',
    'Authorization' => 'Bearer YOUR_ACCESS_TOKEN',
  ],
]);

echo $response->getBody();

Request

import requests

url = "https://app.bitgo-test.com/api/policy/v1/enterprises/enterpriseId/touchpoints/touchpointId/conditions"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

response = requests.get(url, headers=headers)

print(response.text)

Response

{
  "conditions": [
    {
      "description": "Allows creating a condition based on the type of the funds destination",
      "label": "Destination",
      "name": "transfer.destination.type",
      "parameters": [
        {
          "allowMultiple": false,
          "description": "The type of destination this condition will match",
          "label": "Type",
          "name": "type",
          "required": "ALWAYS",
          "type": "ENUMERATED",
          "values": [
            {
              "description": "The destination is whitelisted",
              "label": "Whitelisted address",
              "value": "whitelistedAddress"
            },
            {
              "description": "The destination is not whitelisted",
              "label": "Non-whitelisted address",
              "value": "nonWhitelistedAddress"
            }
          ]
        },
        {
          "allowMultiple": false,
          "description": "The asset this condition applies to. Optional.",
          "label": "Asset",
          "name": "coin",
          "required": "OPTIONAL",
          "type": "COIN",
          "values": []
        }
      ],
      "status": "ACTIVE"
    },
    {
      "description": "Allows creating a condition based on whether the transfer initiator is a listed user",
      "label": "Transfer Initiated By",
      "name": "transfer.initiators",
      "parameters": [
        {
          "allowMultiple": true,
          "description": "The list of user ids to check the transfer initiator against.",
          "label": "User Ids",
          "name": "userIds",
          "required": "ALWAYS",
          "type": "BITGO_USER_ID",
          "values": []
        }
      ],
      "status": "ACTIVE"
    },
    {
      "description": "Allows creating a Condition based on whether the transfer webhook post call returns a 200 status code",
      "label": "Transfer Webhook",
      "name": "transfer.webhook",
      "parameters": [
        {
          "allowMultiple": false,
          "description": "The webhook url to post transfer payload to",
          "label": "Webhook Url",
          "name": "webhookUrl",
          "required": "ALWAYS",
          "type": "FREE_FORM",
          "values": "https://webhook.site/91561f7b-4141-4ee2-8336-e10650cd000f"
        },
        {
          "allowMultiple": false,
          "description": "The asset this condition applies to.",
          "label": "Asset",
          "name": "coin",
          "required": "OPTIONAL",
          "type": "COIN",
          "values": "btc"
        }
      ],
      "status": "ACTIVE"
    },
    {
      "description": "Allows creating a condition based on the amount of coin or USD that can be spent over a period of time",
      "label": "Spending Limit",
      "name": "transfer.velocity.limit",
      "parameters": [
        {
          "allowMultiple": false,
          "description": "The amount that can be spend withing the time window",
          "label": "Amount",
          "name": "amount",
          "required": "ALWAYS",
          "type": "NON_NEGATIVE_NUMBER",
          "values": []
        },
        {
          "allowMultiple": false,
          "description": "The period of time this condition covers, in seconds",
          "label": "time window",
          "name": "timeWindow",
          "required": "ALWAYS",
          "type": "NON_NEGATIVE_NUMBER",
          "values": []
        },
        {
          "allowMultiple": false,
          "description": "The unit that the amount is denoted in, can be a coin or a fiat currency",
          "label": "Unit",
          "name": "coin",
          "required": "ALWAYS",
          "type": "COIN_OR_USD",
          "values": []
        },
        {
          "allowMultiple": false,
          "description": "Entities that will be included in the velocity calculation",
          "label": "scope",
          "name": "scope",
          "required": "ALWAYS",
          "type": "ENUMERATED",
          "values": [
            {
              "description": "Only spending from the transferring wallet will be included",
              "label": "Wallet",
              "value": "wallet"
            },
            {
              "description": "Spending from the entire transferring wallet's enterprise will be included",
              "label": "Enterprise",
              "value": "enterprise"
            }
          ]
        }
      ],
      "status": "ACTIVE"
    },
    {
      "description": "Allows creating a condition based on the Transfer Amount",
      "label": "Spending limit",
      "name": "transfer.amount",
      "parameters": [
        {
          "allowMultiple": false,
          "description": "The comparison operator to use when comparing the transfer amount with the given limit",
          "label": "Comparison Operator",
          "name": "operator",
          "required": "ALWAYS",
          "type": "ENUMERATED",
          "values": [
            {
              "description": "The transfer amount must be greater than the given limit for the condition to trigger",
              "label": "Greater than",
              "value": "\u003e"
            },
            {
              "description": "The transfer amount must be greater than or equal to the given limit for the condition to trigger",
              "label": "Greater than or equal to",
              "value": "\u003e="
            },
            {
              "description": "The transfer amount must be less than the given limit for the condition to trigger",
              "label": "Less than",
              "value": "\u003c"
            },
            {
              "description": "The transfer amount must be less than or equal to the given limit for the condition to trigger",
              "label": "Less than or equal to",
              "value": "\u003c="
            }
          ]
        },
        {
          "allowMultiple": false,
          "description": "The transfer amount will be compared with this limit",
          "label": "The amount to compare to",
          "name": "amount",
          "required": "ALWAYS",
          "type": "NON_NEGATIVE_NUMBER",
          "values": []
        },
        {
          "allowMultiple": false,
          "description": "This condition only applies to transfers of this currency (USD applies to all transfers)",
          "label": "Currency",
          "name": "coin",
          "required": "ALWAYS",
          "type": "COIN_OR_USD",
          "values": []
        }
      ],
      "status": "ACTIVE"
    }
  ]
}

{
  "code": "Unauthorized",
  "message": "Unauthorized",
  "status": 401
}

{
  "code": "AccessDenied",
  "message": "License not added for enterprise",
  "status": 403
}

{
  "code": "NotFound",
  "message": "Touchpoint not found",
  "status": 404
}

{
  "code": "Internal_Server_Error",
  "message": "Database is down",
  "status": 500
}