Quick access and live status

GET: request method; 200: last response's status code; ∙∙∙: if live tests are passing for the production, staging 0, and staging 1 services; 100ms: response time of the last test.
ResourceCreateRetrieveUpdateDeleteList

Introduction

We organize the API of Oriskami around REST, designing it to have resource-oriented URLs and to use HTTP response codes that indicate API errors.

By using standard HTTP methods for authentication and resource access, we allow regular HTTP clients to understand our API. As well, we return JSON for all responses from the API, including errors.

The API documentation outlines as follows:

  1. the summary section summarizes the API resources, methods, and method arguments;
  2. the pagination section indicates how to filter results;
  3. the access control section describes the authentication mechanism and the selection of the API version; and
  4. the resources section details all the available resources.

Access control

Requests to the Oriskami API are authenticated with several parameters defined in the header of each request. This section describes:

  1. the request headers parameters and notably the access token; and
  2. the access control mechanisms when API keys are valid.

If you use one of our API bindings (see on github), you do not have to worry about the exact details and you can skip the request headers section

Request headers

Access tokens are the primary authentication parameter for requests. You can create, delete, and re-generate API keys in my.oriskami.com. Then, the API requires a version because, as we update the API, several versions of the API will exist in parallel—today, only the latest version is used.

The following table summarizes the headers of a typical request.

Header Requests Example values
User-Agent * Oriskami/v1 PythonBindings/0.8.0
Authorization * Bearer 9spB-ChM6J ... QH7f6xz=
Content-Type POST application/x-www-form-urlencoded
Accept-Version * 1.0.0

Per API key

To define the access control per API key there are two approaches:

  1. restrict access to resources and resource actions for each API key; and
  2. whitelist IP address(es), thereby preventing requests from other IPs.

These approaches are illustrated below.

Access control Example values
IP "" —by default any IP can access the resources
"1.1.1.1" —only the IP address 1.1.1.1 is allowed
"1.1.1.1, 1.1.1.2, 1.1.1.3" —three IP addresses are allowed
Resource, action Event [GET], Event [POST], Event [DELETE] —to allow all actions on Events
EventLabel [GET] —to only allow the retrieving of EventLabel

Use my.oriskami.com to change access control per API key. Lastly, note that we only accept API requests made over https.

Errors

Using regular HTTP response codes, we indicate the status of each request. In general, the status codes that begin with 2xx inform of a successful request. Those in the range 4xx indicate that the data sent lead to an error. Finally, we use codes 5xx to report an error from our side.

Status Reason Description
200 OK Everything fine. The request returns content
201 OK Everything fine. The request created the resource and returns content
400 Bad Request A parameter may be missing
401 Unauthorized The key to access the API is invalid
402 Payment Required Your prepaid account is too low to process the request.
404 Not Found The resource doesn’t exist
405 Method Not Allowed The resource exists, but you are not authorized to call this method.
429 Too Many Requests You have made too many API requests.
500, 502, 503, 504 Server errors An error occured on our side

Resources

Oriskami Access receives metadata about online payments made on e-commerce services, it analyzes this metadata in search for markers of risks and when it detects a risk, it triggers alert notifications. Accordingly, Oriskami Access is organized as a router whose building blocks are filters, notifiers, as well as mechanisms to configure and test the router.

Therefore at the top level, there are the Router resources to:

  1. configure how Oriskami gets the data—RouterData;
  2. specify global parameters—RouterParameter;
  3. retrieve the current router flow configuration—RouterFlow;
  4. test the router flow configuration—RouterTest.

Then, there are the Filter resources to:

  1. whitelist transactions that have no risk—FilterWhitelist;
  2. blacklist transactions whose details have already been involved in payment fraud—FilterBlacklist;
  3. identify transactions matching some rules—FilterRulesBase, FilterRulesCustom, FilterRulesAI;
  4. score the risk of the transactions—FilterScoringsDedicated.

Finally, there are the Notifier resources to:

  1. put on hold the transaction on the e-commerce platform—FilterECommerce;
  2. send an email or an SMS when a risk is detected—FilterEmail, FilterSMS;
  3. make an HTTP request to Slack or to a webhook of yours—FilterSlack, FilterWebhook.

Data Scrapper

We use the resource called Scrapper to interface with the live stream of transaction data from your service.

In the background, Oriskami sets up a configurable cron to retrieve at regular time interval the data from your service. To prevent overloading your service, Oriskami allows to throttle the number of request per time period.

Once data is retrieved with retrieve or list, transaction data are passed through and billed as EventPast or Event. Use EventPast if you’re bootstrapping data into Oriskami but you don’t want that data to be analyzed. Use Event if you want to analyze live transactions.

Basically, you can:

  • retrieve or list transactions by their id or id range and pass them to the Event or EventPast API endpoints;

  • update a transaction’s status given its id; and

  • retrieve general information about your service’s data cursor (start, end).

Attribute Remarks
Id
id or platform_id

An id (integer) to uniquely refer to the transaction.

update Data Scrapper

Update the status of a transaction on your service.

Parameters

DefinitionCopy

Example RequestCopy

list Data Scrapper

The list method allows to list (copy and pass through) the transaction data from your service into Oriskami’s risk analysis flows. Typically, you’ll specify one or more filtering steps to indicate the id bounds to retrieve, and to validate that the data scrapper parses correctly your service’s data.

If you’re bootstraping your data bucket at Oriskami with your service’s data, start with a small range and once you know the data is correctly being passed through, proceed with a wider range.

Filter Default Example Description
limit 10 {"limit":10} At most 10 returned results
gt {"id":{"gt":10}} id greater than 10
gte {"id":{"gte":10}} id greater than or equal to 10
lt {"id":{"lt":10}} id less than 10
lte {"id":{"lte":10}} id less than or equal to 10

Parameters

q
required
Query parameter to search for.
query_target
required
Target population compared to the base population.
query_base
required
Base population.
sample_size
required
Size of the random sample being returned.
limit
required
Maximum number of results to return.
gt
required
Greater than `id`.
gte
required
Greater or equal than `id`.
lt
required
Less than `id`.
lte
required
Lesser or equal than `id`.

DefinitionCopy

Example RequestCopy

retrieve Data Scrapper

Retrieve the data from your service for a given event id.

Parameters

id
required
The identifier of the transaction to retrieve.

DefinitionCopy

Example RequestCopy

Event

We use the resource called Event to describe online payments. Each Event has a unique numerical identifier, which we refer to as id, whereas payment attributes are described in parameters and client-specific attributes are described in extra.

For retrieve, update, and delete Event methods, an id is mandatory; a total transaction amount is also mandatory. However, many parameters are not mandatory, e.g., if you sell digital goods and you do not ship any product, you will have no billing address or transport information.

Still, we strongly recommend providing an account_id, customer_ip_address, an address, an email, a pmeth_bin—i.e., the Bank Identification Number of a payment card (if applicable), and several timestamps such as account_creation_time and invoice_time.

Attribute Remarks
Id
id

A unique id (integer) to reference the Event.
account_id The id of the client account.
email The customer email address.
names As typed by the customer.
Account
account_creation_time

In ISO 8601 format.
account_n_fulfilled Number of orders made on this account.
account_total_since_created
account_total_cur In ISO 4217 format—get in touch with us if you need multi-currency within the same shop.
Invoice
invoice_time

In ISO 8601 format.
invoice_address_country
invoice_address_place
invoice_address_street1
invoice_address_street2
invoice_name As typed by the customer.
invoice_phone1 In E.164 format.
invoice_phone2 In E.164 format.
Transport
transport_date

In ISO 8601 format.
transport_type
transport_mode
transport_weight
transport_unit
transport_cur
Delivery
delivery_address_country
delivery_address_place
delivery_address_street1
delivery_address_street2
delivery_name As typed by the customer.
delivery_phone1 In E.164 format.
delivery_phone2 In E.164 format.
customer_ip_address
Payment method
pmeth_origin

In ISO 3166-1 alpha-3 format.
pmeth_validity In MMYY format, i.e., the month with a padding zero and the last two digits of the year.
pmeth_brand
pmeth_bin Five or six digit Bank Identification Number
pmeth_3ds Whether 3DS was active.
Cart
cart_products
cart_details An array of objects describing each cart item.
cart_n The number of items in the cart.
Amounts
amount_pmeth
amount_discounts
amount_products
amount_transport
amount_total
amount_cur In ISO 4217 format—get in touch with us if you need multi-currency within the same shop.
Extra
extra

If you want extra information to be taken into account by our machine learning algorithms, get in touch with us—you can already send the data.

update Event

Update the Event referred by its id and replace its values by those that are passed. Parameters not provided are left unchanged.

Parameters

DefinitionCopy

Example RequestCopy

delete Event

Delete an Event.

Parameters

id
required
The identifier of the `Event` to be deleted.

DefinitionCopy

Example RequestCopy

create Event

Parameters

parameters
required
The characteristics of this event.

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031523,
  "iss": "Oriskami OÜ",
  "data": [
    {
      "id": "1",
      "parameters": {
        "id": "1",
        "email": "abc@gmail.com",
        "extra": {
          "client_specific_attribute_1": "true",
          "client_specific_attribute_2": 123.12
        },
        "names": "M Abc",
        "cart_n": "15000",
        "pmeth_3ds": "-1",
        "pmeth_bin": "510000",
        "account_id": "10000",
        "amount_cur": "EUR",
        "pmeth_brand": "MC",
        "amount_pmeth": "ABC Payment Service Provider",
        "amount_total": "30.00",
        "cart_details": [
          {
            "n": "1",
            "pu": "10.00",
            "cur": "EUR",
            "name": "Product ref #12345",
            "amount": "10.00"
          }
        ],
        "invoice_name": "M ABC",
        "invoice_time": "2017-05-17 21:55:00",
        "pmeth_origin": "FRA",
        "cart_products": [
          "Product ref #12345"
        ],
        "delivery_name": "M ABC",
        "transport_cur": "EUR",
        "invoice_phone1": "0123456789",
        "invoice_phone2": null,
        "pmeth_validity": "0121",
        "transport_date": "2017-05-18 08:00:00",
        "transport_mode": "TNT",
        "transport_type": "Delivery",
        "transport_unit": "kg",
        "amount_products": "20.00",
        "delivery_phone1": "0123450689",
        "delivery_phone2": null,
        "amount_discounts": "0.00",
        "amount_transport": "10.00",
        "transport_weight": "9.000",
        "account_total_cur": "EUR",
        "account_n_fulfilled": "1",
        "customer_ip_address": "1.2.3.4",
        "account_creation_time": "2017-05-17 21:50:00",
        "invoice_address_place": "75008 Paris",
        "delivery_address_place": "75008 Paris",
        "order_payment_accepted": "2017-05-17 22:00:00",
        "invoice_address_country": "France",
        "invoice_address_street1": "1 Av. des Champs-Élysées",
        "delivery_address_country": "France",
        "delivery_address_street1": "1 Av. des Champs-Élysées",
        "account_total_since_created": "49.40"
      }
    }
  ],
  "flow": "risk",
  "object": "events",
  "billing": {
    "cur": "EUR",
    "price": "0.10",
    "balance": "0.00"
  },
  "unsigned": "false",
  "status_code": 201,
  "query_time_ms": "117.56"
}

list Event

The list method allows to retrieve Event in bulk with a maximum of 100 returned resource Event. To search and filter the range of items returned, several parameters exist. They are described in the following table.

Filter Default Example Description
q {"q":"this-week"} Search this week’s transactions
limit 10 {"limit":10} At most 10 returned results
gt {"id":{"gt":10}} id greater than 10
gte {"id":{"gte":10}} id greater than or equal to 10
lt {"id":{"lt":10}} id less than 10
lte {"id":{"lte":10}} id less than or equal to 10

Parameters

q
required
Query parameter to search for.
query_target
required
Target population compared to the base population.
query_base
required
Base population.
sample_size
required
Size of the random sample being returned.
limit
required
Maximum number of results to return.
gt
required
Greater than `id`.
gte
required
Greater or equal than `id`.
lt
required
Less than `id`.
lte
required
Lesser or equal than `id`.

DefinitionCopy

Example RequestCopy

retrieve Event

Retrieve the details of an existing Event.

Parameters

id
required
The identifier of the `Event` to be retrieved.

DefinitionCopy

Example RequestCopy

EventLabel

Events are labeled to discriminate between regular Events and Events considered as fraudulent—themselves, these fraudulent Events lead to a loss or not. For this typical scenario, Oriskami uses the label is_loss, which takes values in {true, false, null}.

Internally, the statistical algorithms of Oriskami consider as fraudulent the Events that have a true or false value for is_loss, whereas those that have a null value are non-frauds. We summarize this classification in the following table.

Labels Value Is fraud? Description
is_loss "true" Yes Lead to a financial loss.
"false" Yes Considered as a fraud but no loss was incurred.
null No Ok.
Other labels Labels other than is_loss are allowed but, currently, are unused.

delete EventLabel

Delete an EventLabel.

Parameters

id
required
The `Event` id.
label
required
The `EventLabel` to delete.

DefinitionCopy

Example RequestCopy

update EventLabel

Update the EventLabel of an Event.

Parameters

id
required
The `Event` id.
label
required
The `EventLabel` to update.
value
The value is either `"true"` or `"false"` (by default).

DefinitionCopy

Example RequestCopy

list EventLabel

List of EventLabel.

Parameters

DefinitionCopy

Example RequestCopy

retrieve EventLabel

Retrieve the EventLabels for an Event id.

Parameters

id
required
The `Event` id.

DefinitionCopy

Example RequestCopy

EventLastId

API endpoint to retrieve the last event id.

list EventLastId

Returns the EventLastId.

Parameters

DefinitionCopy

Example RequestCopy

EventNotification

When a blacklist or a rule is hit, or when a risk score is high, notifications such as webhooks, emails, sms, or slack are triggered. This API endpoint allows to list the history of notifications.

list EventNotification

List the history of EventNotification for Event.

Parameters

DefinitionCopy

Example RequestCopy

retrieve EventNotification

Retrieve the history of EventNotification for an Event id.

Parameters

id
required
The id of the `Event`.

DefinitionCopy

Example RequestCopy

EventPast

This API end points is the entry point to send your historical transactions. These transactions are helpful to parameterize your router whitelists, rules, and scores, to test your configuration on these historical transactions, and to lookup in your history of transactions when carrying out payment verifications.

Technically, EventPast is just a synonymous API endpoint for Event. The two differences are that historical transactions are not scored live, and that they are not billed as live transactions but as historical transactions.

list EventPast

Parameters

q
required
Query parameter to search for.
query_target
required
Target population compared to the base population.
query_base
required
Base population.
sample_size
required
Size of the random sample being returned.
limit
required
Maximum number of results to return.
gt
required
Greater than `id`.
gte
required
Greater or equal than `id`.
lt
required
Less than `id`.
lte
required
Lesser or equal than `id`.

DefinitionCopy

Example RequestCopy

retrieve EventPast

Retrieve the details of an existing EventPast.

Parameters

id
required
The identifier of the `EventPast` to be retrieved.

DefinitionCopy

Example RequestCopy

delete EventPast

Delete an EventPast.

Parameters

id
required
The identifier of the `EventPast` to be deleted.

DefinitionCopy

Example RequestCopy

create EventPast

Parameters

parameters
required
The characteristics of this event.

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031525,
  "iss": "Oriskami OÜ",
  "data": [
    {
      "id": "1",
      "parameters": {
        "id": "1",
        "email": "abc@gmail.com",
        "extra": {
          "client_specific_attribute_1": "true",
          "client_specific_attribute_2": 123.12
        },
        "names": "M Abc",
        "cart_n": "15000",
        "pmeth_3ds": "-1",
        "pmeth_bin": "510000",
        "account_id": "10000",
        "amount_cur": "EUR",
        "pmeth_brand": "MC",
        "amount_pmeth": "ABC Payment Service Provider",
        "amount_total": "30.00",
        "cart_details": [
          {
            "n": "1",
            "pu": "10.00",
            "cur": "EUR",
            "name": "Product ref #12345",
            "amount": "10.00"
          }
        ],
        "invoice_name": "M ABC",
        "invoice_time": "2017-05-17 21:55:00",
        "pmeth_origin": "FRA",
        "cart_products": [
          "Product ref #12345"
        ],
        "delivery_name": "M ABC",
        "transport_cur": "EUR",
        "invoice_phone1": "0123456789",
        "invoice_phone2": null,
        "pmeth_validity": "0121",
        "transport_date": "2017-05-18 08:00:00",
        "transport_mode": "TNT",
        "transport_type": "Delivery",
        "transport_unit": "kg",
        "amount_products": "20.00",
        "delivery_phone1": "0123450689",
        "delivery_phone2": null,
        "amount_discounts": "0.00",
        "amount_transport": "10.00",
        "transport_weight": "9.000",
        "account_total_cur": "EUR",
        "account_n_fulfilled": "1",
        "customer_ip_address": "1.2.3.4",
        "account_creation_time": "2017-05-17 21:50:00",
        "invoice_address_place": "75008 Paris",
        "delivery_address_place": "75008 Paris",
        "order_payment_accepted": "2017-05-17 22:00:00",
        "invoice_address_country": "France",
        "invoice_address_street1": "1 Av. des Champs-Élysées",
        "delivery_address_country": "France",
        "delivery_address_street1": "1 Av. des Champs-Élysées",
        "account_total_since_created": "49.40"
      }
    }
  ],
  "flow": "risk",
  "object": "event_past",
  "billing": {
    "cur": "EUR",
    "price": "0.01",
    "balance": "0.00"
  },
  "unsigned": "false",
  "status_code": 201,
  "query_time_ms": "43.32"
}

update EventPast

Update the EventPast referred by its id and replace its values by those that are passed. Parameters not provided are left unchanged.

Parameters

DefinitionCopy

Example RequestCopy

EventQueue

When Events require special attention, they are pushed into EventQueues. This API endpoint helps manage the EventQueue an Event belongs to—that queue is called the active queue.

If the event is queued, then the value of active is a string, e.g., peer_review or rules_base, and if it is currently unqueued, active is null.

retrieve EventQueue

Retrieve the EventQueue for an Event id.

Parameters

id
required
The `Event` id.

DefinitionCopy

Example RequestCopy

update EventQueue

Update the EventQueue of an Event to dequeue an Event from the current active queue, e.g., rules_base and to enqueue it in another queue such as peer_review.

Parameters

id
required
The `Event` id.
active
required
The `EventQueue` which is `active`.

DefinitionCopy

Example RequestCopy

delete EventQueue

Delete an EventQueue of an Event—then the Event has no more active queue.

Parameters

id
required
The id of the `Event` to dequeue.

DefinitionCopy

Example RequestCopy

list EventQueue

List the EventQueues of all Events.

Parameters

DefinitionCopy

Example RequestCopy

EventReview

When Events require special attention, they are pushed into EventQueues and the processing of these Events is paused until risk operation analysts carry out a manual review.

This API endpoint helps manage the EventReviews.

retrieve EventReview

Retrieve the EventReview of an Event id.

Parameters

id
required
The `Event` id.

DefinitionCopy

Example RequestCopy

update EventReview

Update the EventReview of an Event id.

Parameters

id
required
The `Event` id.
review_id
required
The `EventReview` id—starts at `0`, if `null` a new review is appended at the end.
reviewer_id
The id of the reviewer who authors carried out the review.
message
The message of the `EventReview`.

DefinitionCopy

Example RequestCopy

list EventReview

List of EventReview.

Parameters

DefinitionCopy

Example RequestCopy

delete EventReview

Delete an EventReview.

Parameters

id
required
The identifier of the `EventReview` to be deleted.
review_id
required
The `EventReview` to delete.

DefinitionCopy

Example RequestCopy

EventTest

This API endpoint helps manage EventTest.

retrieve EventTest

Retrieve the EventTest of an Event id.

Parameters

id
required
The `Event` id.

DefinitionCopy

Example RequestCopy

list EventTest

List of EventTest.

Parameters

DefinitionCopy

Example RequestCopy

Filter

Manage Filters

update Filter

Whether the set of Filters is active or not.

Parameters

id
required
The id—set it to `0`.
is_active
required
Whether the `Filters` are active—takes values in `{"true","false"}`.

DefinitionCopy

Example RequestCopy

list Filter

Returns the status of the Filters.

Parameters

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031428,
  "iss": "Oriskami OÜ",
  "data": [
    {
      "is_active": "true"
    }
  ],
  "flow": "risk",
  "object": "filters",
  "unsigned": "false",
  "status_code": 200,
  "query_time_ms": "45.66"
}

FilterBlacklist

Blacklists are often used to prevent credit cards, emails, IP addresses, or phone numbers that were previously used to make fraudulent purchases from being used to make additional purchases [1].

We distinguish between three types of blacklists:

  1. dedicated blacklists are specific to your client account;
  2. mutualized blacklists are blacklists pooled across the clients of Oriskami;
  3. external blacklists are provided by external services, whose role is to curate a database of payment frauds.

The table below summarizes these three blacklist subtypes.

Type Attribute Remark
Dedicated email
ip_address Disable if you do not track the customer_ip_address.
phone
account_id Prevent account_id involved in previous frauds to reuse the account.
Mutualized email
ip_address Disable if you do not track the customer_ip_address.
phone
External email, ip_address, phone Soon.

The FilterBlacklist API endpoint helps you manage the active blacklists.

update FilterBlacklist

Update the status of the FilterBlacklist referred by its id.

Parameters

id
required
The id of the blacklist.
is_active
required
The status of the blacklist—in `{"true","false"}`.

DefinitionCopy

Example RequestCopy

list FilterBlacklist

List the FilterBlacklist.

Parameters

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031432,
  "iss": "Oriskami OÜ",
  "data": [],
  "flow": "risk",
  "object": "filter_blacklists",
  "unsigned": "false",
  "status_code": 200,
  "query_time_ms": "38.67"
}

FilterRulesAI

Once Oriskami has a set of Events, some of which have a non-null is_loss EventLabel, it runs statistical calculations on your data and identifies a set of rules that are highly correlated with your risk of payment fraud.

On my.oriskami.com, we refer to these rules as “Suggested by AI”. By default, these rules are disabled. You may add them to the set of rules that Events are tested against. Then, if an Event matches one of these rules, its processing will be paused until risk operation analysts carry out the necessary verifications.

The FilterRulesAI API endpoint helps manage rules determined by Oriskami’s statistical calculation algorithms. See above for more details about rules.

delete FilterRulesAI

Delete an FilterRulesAI.

Parameters

id
required
The identifier of the `FilterRulesAI` to be deleted.

DefinitionCopy

Example RequestCopy

update FilterRulesAI

Update the FilterRulesAI referred by its id and replace its values by those that are passed. Parameters not provided are left unchanged.

Parameters

id
required
The `FilterRulesAI` id.
is_active
required
Whether the rule is active—takes values in `{"true","false"}`

DefinitionCopy

Example RequestCopy

list FilterRulesAI

List of FilterRulesAI.

Parameters

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031439,
  "iss": "Oriskami OÜ",
  "data": [],
  "flow": "risk",
  "object": "filter_rules_ai",
  "unsigned": "false",
  "status_code": 200,
  "query_time_ms": "44.27"
}

FilterRulesBase

The FilterRulesBase API endpoint helps manage base rules. See above for a description of what rules are.

list FilterRulesBase

List of FilterRulesBase.

Parameters

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031415,
  "iss": "Oriskami OÜ",
  "data": [],
  "flow": "risk",
  "object": "filter_rules_base",
  "unsigned": "false",
  "status_code": 200,
  "query_time_ms": "52.52"
}

update FilterRulesBase

Update the FilterRulesBase referred by its id and replace its values by those that are passed. Parameters not provided are left unchanged.

Parameters

id
required
The `FilterRulesBase` id.
value
required
The parameterizable value.
is_active
required
Whether the rule is active—takes values in `{"true","false"}`

DefinitionCopy

Example RequestCopy

FilterRulesCustom

The concept of rules is similar to that of whitelists, blacklists and graylists. However, instead of relying on list matches, a rule performs a test, the result of which is usually binary [1].

There are at least two rule subtypes:

  1. matching rules: partial, complete, or regular expression match) and
  2. threshold rules: less than or greater than a threshold.

Examples of such rules include the following:

  • Is this payment made from the United States?

  • Is this an order for a high risk product from our catalogue?

  • Is this amount greater than the threshold value?

The FilterRulesCustom API endpoint helps manage custom rules.

list FilterRulesCustom

List of Custom rule.

Parameters

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031428,
  "iss": "Oriskami OÜ",
  "data": [],
  "flow": "risk",
  "object": "filter_rules_custom",
  "unsigned": "false",
  "status_code": 200,
  "query_time_ms": "32.77"
}

delete FilterRulesCustom

Delete an FilterRulesCustom.

Parameters

id
required
The identifier of the `FilterRulesCustom` to be deleted.

DefinitionCopy

Example RequestCopy

update FilterRulesCustom

Update the FilterRulesCustom referred by its id and replace its values by those that are passed. Parameters not provided are left unchanged.

Parameters

DefinitionCopy

Example RequestCopy

create FilterRulesCustom

Parameters

DefinitionCopy

Example RequestCopy

FilterScoringsDedicated

There are two broad types of risk scores [1]:

  1. the sum scores and
  2. the scores estimated by statistical models.

Oriskami’s dedicated scorings are of the latter kind. These risk scores are statistical models optimized numerically.

The outcome of statistical models to predict risk is either a number between 0 (0%) and 1 (100%), which reflects the likelihood that a payment is a fraud or a class, e.g., fraud/not-fraud.

The FilterDedicatedScorings API endpoint helps manage the risk scores determined by Oriskami’s statistical calculation algorithms.

update FilterScoringsDedicated

Update the FilterScoringsDedicated referred by its id and replace its values by those passed.

Parameters

id
required
The `FilterScoringsDedicated` id.
is_active
required
Whether the rule is active—takes values in `{"true","false"}`.
score_id
required
The id of the score.

DefinitionCopy

Example RequestCopy

list FilterScoringsDedicated

List of FilterScoringsDedicated.

Parameters

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031403,
  "iss": "Oriskami OÜ",
  "data": null,
  "flow": "risk",
  "object": "filter_scorings_dedicated",
  "last_id": null,
  "unsigned": "false",
  "status_code": 200,
  "query_time_ms": "38.05"
}

FilterWhitelist

These lists are designed to identify clients who are exempt from payment fraud. This is notably the case for clients from marketplaces like Amazon, which perform payment verifications. As well, clients paying with online banking or bank transfers are usually exempt from payment fraud. Properly designing whitelists is crucial to prevent running fraud verifications on real clients and diverting scarce merchant resources [1].

The FilterWhitelists API endpoint helps manage the set of whitelists.

list FilterWhitelist

List of Whitelist.

Parameters

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031448,
  "iss": "Oriskami OÜ",
  "data": [],
  "flow": "risk",
  "object": "filter_whitelists",
  "unsigned": "false",
  "status_code": 200,
  "query_time_ms": "40.42"
}

update FilterWhitelist

Update the FilterWhitelist referred by its id and replace its values by those that are passed. Parameters not provided are left unchanged.

Parameters

DefinitionCopy

Example RequestCopy

create FilterWhitelist

Parameters

description
required
A description for the whitelist.
feature
required
The feature to use for the pattern matching.
value
required
The pattern to match.
is_active
required
Whether the rule is active or not—taking values in `{"true", "false"}`.

DefinitionCopy

Example RequestCopy

delete FilterWhitelist

Delete a FilterWhitelist.

Parameters

id
required
The `FilterWhitelist` id to be deleted—starts at `0`.

DefinitionCopy

Example RequestCopy

Monitors

create Monitors

Parameters

id
required
A monitor id.

DefinitionCopy

Example RequestCopy

Notifier

Manage Notifiers

update Notifier

Whether Notifiers are active.

Parameters

id
required
The id—set it to `0`.
is_active
required
Whether the `Notifiers` are active—takes values in `{"true","false"}`.

DefinitionCopy

Example RequestCopy

list Notifier

Returns the status of the Notifiers.

Parameters

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031433,
  "iss": "Oriskami OÜ",
  "data": [
    {
      "is_active": "true"
    }
  ],
  "flow": "risk",
  "object": "notifiers",
  "unsigned": "false",
  "status_code": 200,
  "query_time_ms": "44.25"
}

NotifierECommerce

When the rules and scores detect a risk for an Event, notifications are triggered and the e-commerce services are alerted.

This API endpoints helps manage the NotifierECommerce, which updates the status of orders on standard platforms such as PrestaShop or Magento.

list NotifierECommerce

List the NotifierECommerce.

Parameters

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031454,
  "iss": "Oriskami OÜ",
  "data": [],
  "flow": "risk",
  "object": "notifier_ecommerce",
  "unsigned": "false",
  "status_code": 200,
  "query_time_ms": "30.40"
}

update NotifierECommerce

Update the NotifierECommerce referred by its id.

Parameters

id
required
The id of the notifier—i.e., `"0"` because its a singleton.
is_active
required
Whether the notifier is active or not—takes values in `{"true","false"}`.

DefinitionCopy

Example RequestCopy

NotifierEmail

When the rules and scores detect a risk for an Event, notifications are triggered and the e-commerce services are alerted.

This API endpoints helps manage the NotifierEmail.

list NotifierEmail

List of NotifierEmail.

Parameters

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031409,
  "iss": "Oriskami OÜ",
  "data": [],
  "flow": "risk",
  "object": "notifier_emails",
  "unsigned": "false",
  "status_code": 200,
  "query_time_ms": "30.02"
}

update NotifierEmail

Update the NotifierEmail referred by its id and replace its values by those that are passed. Parameters not provided are left unchanged.

Parameters

DefinitionCopy

Example RequestCopy

create NotifierEmail

Parameters

description
required
A description for the `NotifierEmail`.
value
required
The email address.
is_active
required
Whether the notifier is active or not—takes values in `{"true", "false"}`.

DefinitionCopy

Example RequestCopy

delete NotifierEmail

Delete an NotifierEmail.

Parameters

id
required
The identifier of the `NotifierEmail` to be deleted.

DefinitionCopy

Example RequestCopy

NotifierSlack

When the rules and scores detect a risk for an Event, notifications are triggered and the e-commerce services are alerted.

This API endpoints helps manage the NotifierSlack, which posts a webhook on Slack.

delete NotifierSlack

Delete an NotifierSlack.

Parameters

id
required
The identifier of the `NotifierSlack` to be deleted.

DefinitionCopy

Example RequestCopy

create NotifierSlack

Parameters

description
required
A description for the slack notifier.
value
required
The url of the slack [incoming webhook](https://api.slack.com/incoming-webhooks).
is_active
required
Whether the webhook is active or not—takes values in `{"true", "false"}`.

DefinitionCopy

Example RequestCopy

update NotifierSlack

Update the NotifierSlack referred by its id and replace its values by those that are passed. Parameters not provided are left unchanged.

Parameters

DefinitionCopy

Example RequestCopy

list NotifierSlack

List of NotifierSlack.

Parameters

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031413,
  "iss": "Oriskami OÜ",
  "data": [],
  "flow": "risk",
  "object": "notifier_slack",
  "unsigned": "false",
  "status_code": 200,
  "query_time_ms": "50.63"
}

NotifierSms

When the rules and scores detect a risk for an Event, notifications are triggered and the e-commerce services are alerted.

This API endpoints helps manage the NotifierSms.

list NotifierSms

List of NotifierSms.

Parameters

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031419,
  "iss": "Oriskami OÜ",
  "data": [],
  "flow": "risk",
  "object": "notifier_sms",
  "unsigned": "false",
  "status_code": 200,
  "query_time_ms": "44.19"
}

delete NotifierSms

Delete a NotifierSms.

Parameters

id
required
The identifier of the `NotifierSms` to be deleted.

DefinitionCopy

Example RequestCopy

create NotifierSms

Parameters

description
required
A description for the `NotifierSms`.
value
required
The phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
is_active
required
Whether the notifier is active or not—takes values in `{"true", "false"}`.

DefinitionCopy

Example RequestCopy

update NotifierSms

Update the NotifierSms referred by its id and replace its values by those that are passed. Parameters not provided are left unchanged.

Parameters

DefinitionCopy

Example RequestCopy

NotifierWebhook

When the rules and scores detect a risk for an Event, notifications are triggered and the e-commerce services are alerted.

This API endpoints helps manage the NotifierWebhook, which posts a webhook on one of your http endpoints.

delete NotifierWebhook

Delete an NotifierWebhook.

Parameters

id
required
The identifier of the `NotifierWebhook` to be deleted.

DefinitionCopy

Example RequestCopy

create NotifierWebhook

Parameters

description
required
A description for the slack notifier.
value
required
The url of a webhook.
is_active
required
Whether the webhook is active or not—takes values in `{"true", "false"}`.

DefinitionCopy

Example RequestCopy

update NotifierWebhook

Update the NotifierWebhook referred by its id and replace its values by those that are passed. Parameters not provided are left unchanged.

Parameters

DefinitionCopy

Example RequestCopy

list NotifierWebhook

List of NotifierWebhook.

Parameters

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031424,
  "iss": "Oriskami OÜ",
  "data": [],
  "flow": "risk",
  "object": "notifier_webhooks",
  "unsigned": "false",
  "status_code": 200,
  "query_time_ms": "37.68"
}

Router

The Router is the primary building block of Oriskami Access. This API endpoint is designed to retrieve in a single request the router configuration.

retrieve Router

A Router's configuration.

Parameters

DefinitionCopy

Example RequestCopy

RouterBackup

Manage RouterBackups

list RouterBackup

List of RouterBackup.

Parameters

DefinitionCopy

Example RequestCopy

retrieve RouterBackup

By calling retrieve on a RouterBackup, the current Flow is replaced by the RouterBackup id.

Parameters

id
required
The `RouterBackup` id—cf. [list `RouterBackup`](#list_backup).

DefinitionCopy

Example RequestCopy

delete RouterBackup

Delete a RouterBackup.

Parameters

id
required
The `RouterBackup` id to be deleted—starts at `0`.

DefinitionCopy

Example RequestCopy

create RouterBackup

Create a new RouterBackup with a default template.

Parameters

DefinitionCopy

Example RequestCopy

RouterData

list RouterData

List of RouterData.

Parameters

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031402,
  "iss": "Oriskami OÜ",
  "data": {
    "bin": {
      "is_active": "false"
    },
    "geoip": {
      "is_active": "false"
    },
    "phone": {
      "is_active": "false"
    },
    "client": {
      "language": "en"
    },
    "geocoding": {
      "is_active": "false"
    },
    "is_active": "true",
    "blacklists": {
      "is_active": "true"
    },
    "service_providers": {
      "net/ping": {
        "id": 34,
        "url": null,
        "name": "net/ping",
        "service": "net",
        "credentials": []
      },
      "net/dns-a": {
        "id": 35,
        "url": null,
        "name": "net/dns-a",
        "service": "net",
        "credentials": []
      },
      "net/dns-mx": {
        "id": 36,
        "url": null,
        "name": "net/dns-mx",
        "service": "net",
        "credentials": []
      },
      "net/dns-ns": {
        "id": 39,
        "url": null,
        "name": "net/dns-ns",
        "service": "net",
        "credentials": []
      },
      "net/dns-soa": {
        "id": 40,
        "url": null,
        "name": "net/dns-soa",
        "service": "net",
        "credentials": []
      },
      "net/dns-srv": {
        "id": 41,
        "url": null,
        "name": "net/dns-srv",
        "service": "net",
        "credentials": []
      },
      "net/dns-txt": {
        "id": 38,
        "url": null,
        "name": "net/dns-txt",
        "service": "net",
        "credentials": []
      },
      "net/request": {
        "id": 46,
        "url": null,
        "name": "net/request",
        "service": "net",
        "credentials": []
      },
      "geoip/ip-api": {
        "id": 16,
        "url": "http://ip-api.com/",
        "name": "geoip/ip-api",
        "service": "geoip",
        "credentials": [
          {
            "name": "API_KEY"
          }
        ]
      },
      "net/oriskami": {
        "id": 50,
        "url": null,
        "name": "net/oriskami",
        "service": "net",
        "credentials": [
          {
            "name": "API_KEY"
          }
        ]
      },
      "net/tcp-port": {
        "id": 43,
        "url": null,
        "name": "net/tcp-port",
        "service": "net",
        "credentials": []
      },
      "phone/twilio": {
        "id": 28,
        "url": "https://www.twilio.com",
        "name": "phone/twilio",
        "service": "phone",
        "credentials": [
          {
            "name": "ACCOUNT_SID"
          },
          {
            "name": "AUTH_TOKEN"
          }
        ]
      },
      "geoip/maxmind": {
        "id": 47,
        "url": null,
        "name": "geoip/maxmind",
        "service": "geoip",
        "credentials": []
      },
      "net/dns-cname": {
        "id": 37,
        "url": null,
        "name": "net/dns-cname",
        "service": "net",
        "credentials": []
      },
      "net/ssl-qualys": {
        "id": 44,
        "url": null,
        "name": "net/ssl-qualys",
        "service": "net",
        "credentials": []
      },
      "net/traceroute": {
        "id": 48,
        "url": null,
        "name": "net/traceroute",
        "service": "net",
        "credentials": [
          {
            "name": "API_KEY"
          }
        ]
      },
      "bin/binlist.net": {
        "id": 2,
        "url": null,
        "name": "bin/binlist.net",
        "service": "bin",
        "credentials": []
      },
      "geoip/freegeoip": {
        "id": 17,
        "url": "https://freegeoip.net/",
        "name": "geoip/freegeoip",
        "service": "geoip",
        "credentials": []
      },
      "net/dns-reverse": {
        "id": 42,
        "url": null,
        "name": "net/dns-reverse",
        "service": "net",
        "credentials": []
      },
      "phone/numverify": {
        "id": 29,
        "url": "https://numverify.com",
        "name": "phone/numverify",
        "service": "phone",
        "credentials": [
          {
            "name": "API_KEY"
          }
        ]
      },
      "bin/bincodes.com": {
        "id": 1,
        "url": null,
        "name": "bin/bincodes.com",
        "service": "bin",
        "credentials": [
          {
            "name": "API_KEY"
          }
        ]
      },
      "geocoding/google": {
        "id": 4,
        "url": "https://console.developers.google.com/apis/credentials",
        "name": "geocoding/google",
        "service": "geocoding",
        "credentials": [
          {
            "name": "API_KEY"
          }
        ]
      },
      "geocoding/yandex": {
        "id": 15,
        "url": "https://tech.yandex.com/",
        "name": "geocoding/yandex",
        "service": "geocoding",
        "credentials": [
          {
            "name": "API_KEY"
          }
        ]
      },
      "net/oriskami-mrtg": {
        "id": 51,
        "url": null,
        "name": "net/oriskami-mrtg",
        "service": "net",
        "credentials": null
      },
      "geocoding/opencage": {
        "id": 9,
        "url": "https://geocoder.opencagedata.com/api",
        "name": "geocoding/opencage",
        "service": "geocoding",
        "credentials": [
          {
            "name": "API_KEY"
          }
        ]
      },
      "net/oriskami-pings": {
        "id": 52,
        "url": null,
        "name": "net/oriskami-pings",
        "service": "net",
        "credentials": null
      },
      "net/ssl-certificate": {
        "id": 45,
        "url": null,
        "name": "net/ssl-certificate",
        "service": "net",
        "credentials": []
      },
      "blacklists/dnsbl.sorbs.net": {
        "id": 21,
        "url": null,
        "name": "blacklists/dnsbl.sorbs.net",
        "service": "blacklists",
        "credentials": []
      },
      "blacklists/zen.spamhaus.org": {
        "id": 27,
        "url": null,
        "name": "blacklists/zen.spamhaus.org",
        "service": "blacklists",
        "credentials": []
      },
      "blacklists/b.barracudacentral.org": {
        "id": 18,
        "url": null,
        "name": "blacklists/b.barracudacentral.org",
        "service": "blacklists",
        "credentials": []
      }
    }
  },
  "flow": "risk",
  "object": "router_data",
  "unsigned": "false",
  "status_code": 200,
  "query_time_ms": "49.06"
}

update RouterData

Whether RouterData is active.

Parameters

id
required
The id—set it to `0`.
is_active
required
The value is either `"true"` or `"false"`.

DefinitionCopy

Example RequestCopy

RouterDataBin

update RouterDataBin

Whether RouterDataBin is active.

Parameters

id
required
The id—set it to `0`.
is_active
required
The value is either `"true"` or `"false"`.

DefinitionCopy

Example RequestCopy

list RouterDataBin

List of RouterDataBin.

Parameters

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031432,
  "iss": "Oriskami OÜ",
  "data": {
    "is_active": "false"
  },
  "flow": "risk",
  "object": "router_data_bin",
  "unsigned": "false",
  "status_code": 200,
  "query_time_ms": "34.24"
}

RouterDataBlacklist

update RouterDataBlacklist

Whether RouterDataBlacklist is active.

Parameters

id
required
The id—set it to `0`.
is_active
required
The value is either `"true"` or `"false"`.

DefinitionCopy

Example RequestCopy

list RouterDataBlacklist

List of RouterDataBlacklist.

Parameters

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031433,
  "iss": "Oriskami OÜ",
  "data": {
    "is_active": "true"
  },
  "flow": "risk",
  "object": "router_data_blacklists",
  "unsigned": "false",
  "status_code": 200,
  "query_time_ms": "47.23"
}

RouterDataFeature

list RouterDataFeature

List of RouterDataFeature.

Parameters

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031447,
  "iss": "Oriskami OÜ",
  "data": [
    {
      "id": 1662,
      "name": "account_id",
      "type": "float"
    },
    {
      "id": 836,
      "name": "account_n_fulfilled",
      "type": "float"
    },
    {
      "id": 862,
      "name": "all_country_continent",
      "type": "text"
    },
    {
      "id": 808,
      "name": "all_country_iso2",
      "type": "text"
    },
    {
      "id": 796,
      "name": "amount_checksum",
      "type": "float"
    },
    {
      "id": 1289,
      "name": "amount_coupon_in_0_10",
      "type": "boolean"
    },
    {
      "id": 1308,
      "name": "amount_coupon_in_10_20",
      "type": "boolean"
    },
    {
      "id": 1430,
      "name": "amount_coupon_in_1400_2400",
      "type": "boolean"
    },
    {
      "id": 1374,
      "name": "amount_coupon_in_150_250",
      "type": "boolean"
    },
    {
      "id": 1309,
      "name": "amount_coupon_in_20_30",
      "type": "boolean"
    },
    {
      "id": 1431,
      "name": "amount_coupon_in_2400_4000",
      "type": "boolean"
    },
    {
      "id": 1375,
      "name": "amount_coupon_in_250_450",
      "type": "boolean"
    },
    {
      "id": 1310,
      "name": "amount_coupon_in_30_50",
      "type": "boolean"
    },
    {
      "id": 1432,
      "name": "amount_coupon_in_4000_8000",
      "type": "boolean"
    },
    {
      "id": 1376,
      "name": "amount_coupon_in_450_800",
      "type": "boolean"
    },
    {
      "id": 1311,
      "name": "amount_coupon_in_50_75",
      "type": "boolean"
    },
    {
      "id": 1335,
      "name": "amount_coupon_in_75_150",
      "type": "boolean"
    },
    {
      "id": 1405,
      "name": "amount_coupon_in_800_1400",
      "type": "boolean"
    },
    {
      "id": 73,
      "name": "amount_cur",
      "type": "text"
    },
    {
      "id": 821,
      "name": "amount_f_products",
      "type": "float"
    },
    {
      "id": 787,
      "name": "amount_f_total",
      "type": "float"
    },
    {
      "id": 828,
      "name": "amount_f_transport",
      "type": "float"
    },
    {
      "id": 809,
      "name": "amount_is_coupon",
      "type": "boolean"
    },
    {
      "id": 797,
      "name": "amount_products",
      "type": "float"
    },
    {
      "id": 1336,
      "name": "amount_products_in_0_10",
      "type": "boolean"
    },
    {
      "id": 1377,
      "name": "amount_products_in_10_20",
      "type": "boolean"
    },
    {
      "id": 1464,
      "name": "amount_products_in_1400_2400",
      "type": "boolean"
    },
    {
      "id": 1433,
      "name": "amount_products_in_150_250",
      "type": "boolean"
    },
    {
      "id": 1378,
      "name": "amount_products_in_20_30",
      "type": "boolean"
    },
    {
      "id": 1465,
      "name": "amount_products_in_2400_4000",
      "type": "boolean"
    },
    {
      "id": 1434,
      "name": "amount_products_in_250_450",
      "type": "boolean"
    },
    {
      "id": 1379,
      "name": "amount_products_in_30_50",
      "type": "boolean"
    },
    {
      "id": 1466,
      "name": "amount_products_in_4000_8000",
      "type": "boolean"
    },
    {
      "id": 1435,
      "name": "amount_products_in_450_800",
      "type": "boolean"
    },
    {
      "id": 1380,
      "name": "amount_products_in_50_75",
      "type": "boolean"
    },
    {
      "id": 1406,
      "name": "amount_products_in_75_150",
      "type": "boolean"
    },
    {
      "id": 1447,
      "name": "amount_products_in_800_1400",
      "type": "boolean"
    },
    {
      "id": 743,
      "name": "amount_total",
      "type": "float"
    },
    {
      "id": 1274,
      "name": "amount_total_in_0_10",
      "type": "boolean"
    },
    {
      "id": 1290,
      "name": "amount_total_in_10_20",
      "type": "boolean"
    },
    {
      "id": 1407,
      "name": "amount_total_in_1400_2400",
      "type": "boolean"
    },
    {
      "id": 1337,
      "name": "amount_total_in_150_250",
      "type": "boolean"
    },
    {
      "id": 1291,
      "name": "amount_total_in_20_30",
      "type": "boolean"
    },
    {
      "id": 1408,
      "name": "amount_total_in_2400_4000",
      "type": "boolean"
    },
    {
      "id": 1338,
      "name": "amount_total_in_250_450",
      "type": "boolean"
    },
    {
      "id": 1292,
      "name": "amount_total_in_30_50",
      "type": "boolean"
    },
    {
      "id": 1409,
      "name": "amount_total_in_4000_8000",
      "type": "boolean"
    },
    {
      "id": 1339,
      "name": "amount_total_in_450_800",
      "type": "boolean"
    },
    {
      "id": 1293,
      "name": "amount_total_in_50_75",
      "type": "boolean"
    },
    {
      "id": 1312,
      "name": "amount_total_in_75_150",
      "type": "boolean"
    },
    {
      "id": 1381,
      "name": "amount_total_in_800_1400",
      "type": "boolean"
    },
    {
      "id": 810,
      "name": "amount_transport",
      "type": "float"
    },
    {
      "id": 1382,
      "name": "amount_transport_in_0_10",
      "type": "boolean"
    },
    {
      "id": 1410,
      "name": "amount_transport_in_10_20",
      "type": "boolean"
    },
    {
      "id": 1513,
      "name": "amount_transport_in_1400_2400",
      "type": "boolean"
    },
    {
      "id": 1448,
      "name": "amount_transport_in_150_250",
      "type": "boolean"
    },
    {
      "id": 1411,
      "name": "amount_transport_in_20_30",
      "type": "boolean"
    },
    {
      "id": 1514,
      "name": "amount_transport_in_2400_4000",
      "type": "boolean"
    },
    {
      "id": 1449,
      "name": "amount_transport_in_250_450",
      "type": "boolean"
    },
    {
      "id": 1412,
      "name": "amount_transport_in_30_50",
      "type": "boolean"
    },
    {
      "id": 1515,
      "name": "amount_transport_in_4000_8000",
      "type": "boolean"
    },
    {
      "id": 1450,
      "name": "amount_transport_in_450_800",
      "type": "boolean"
    },
    {
      "id": 1413,
      "name": "amount_transport_in_50_75",
      "type": "boolean"
    },
    {
      "id": 1436,
      "name": "amount_transport_in_75_150",
      "type": "boolean"
    },
    {
      "id": 1467,
      "name": "amount_transport_in_800_1400",
      "type": "boolean"
    },
    {
      "id": 1672,
      "name": "cart_product_terms",
      "type": "json"
    },
    {
      "id": 750,
      "name": "cart_products",
      "type": "json"
    },
    {
      "id": 940,
      "name": "cart_products_n_distinct",
      "type": "float"
    },
    {
      "id": 2,
      "name": "cart_products_n_distinct_gte_02",
      "type": "boolean"
    },
    {
      "id": 1153,
      "name": "cart_products_n_distinct_gte_03",
      "type": "boolean"
    },
    {
      "id": 4,
      "name": "cart_products_n_distinct_gte_04",
      "type": "boolean"
    },
    {
      "id": 5,
      "name": "cart_products_n_distinct_gte_06",
      "type": "boolean"
    },
    {
      "id": 1156,
      "name": "cart_products_n_distinct_gte_08",
      "type": "boolean"
    },
    {
      "id": 1157,
      "name": "cart_products_n_distinct_gte_12",
      "type": "boolean"
    },
    {
      "id": 1158,
      "name": "cart_products_n_distinct_gte_16",
      "type": "boolean"
    },
    {
      "id": 863,
      "name": "dist_delivery_invoice",
      "type": "float"
    },
    {
      "id": 1010,
      "name": "dist_delivery_invoice_gte_10",
      "type": "boolean"
    },
    {
      "id": 1059,
      "name": "dist_delivery_invoice_gte_100",
      "type": "boolean"
    },
    {
      "id": 1099,
      "name": "dist_delivery_invoice_gte_1000",
      "type": "boolean"
    },
    {
      "id": 1159,
      "name": "dist_delivery_invoice_gte_10000",
      "type": "boolean"
    },
    {
      "id": 811,
      "name": "dist_delivery_ip",
      "type": "float"
    },
    {
      "id": 901,
      "name": "dist_delivery_ip_gte_10",
      "type": "boolean"
    },
    {
      "id": 941,
      "name": "dist_delivery_ip_gte_100",
      "type": "boolean"
    },
    {
      "id": 969,
      "name": "dist_delivery_ip_gte_1000",
      "type": "boolean"
    },
    {
      "id": 986,
      "name": "dist_delivery_ip_gte_10000",
      "type": "boolean"
    },
    {
      "id": 970,
      "name": "dist_delivery_shop_gte_10",
      "type": "boolean"
    },
    {
      "id": 987,
      "name": "dist_delivery_shop_gte_100",
      "type": "boolean"
    },
    {
      "id": 998,
      "name": "dist_delivery_shop_gte_1000",
      "type": "boolean"
    },
    {
      "id": 1011,
      "name": "dist_delivery_shop_gte_10000",
      "type": "boolean"
    },
    {
      "id": 1160,
      "name": "dist_invoice_delivery_ip_gte_10",
      "type": "boolean"
    },
    {
      "id": 1197,
      "name": "dist_invoice_delivery_ip_gte_100",
      "type": "boolean"
    },
    {
      "id": 1209,
      "name": "dist_invoice_delivery_ip_gte_1000",
      "type": "boolean"
    },
    {
      "id": 1213,
      "name": "dist_invoice_delivery_ip_gte_10000",
      "type": "boolean"
    },
    {
      "id": 798,
      "name": "dist_invoice_ip",
      "type": "float"
    },
    {
      "id": 878,
      "name": "dist_invoice_ip_gte_10",
      "type": "boolean"
    },
    {
      "id": 902,
      "name": "dist_invoice_ip_gte_100",
      "type": "boolean"
    },
    {
      "id": 942,
      "name": "dist_invoice_ip_gte_1000",
      "type": "boolean"
    },
    {
      "id": 971,
      "name": "dist_invoice_ip_gte_10000",
      "type": "boolean"
    },
    {
      "id": 943,
      "name": "dist_invoice_shop_gte_10",
      "type": "boolean"
    },
    {
      "id": 972,
      "name": "dist_invoice_shop_gte_100",
      "type": "boolean"
    },
    {
      "id": 988,
      "name": "dist_invoice_shop_gte_1000",
      "type": "boolean"
    },
    {
      "id": 999,
      "name": "dist_invoice_shop_gte_10000",
      "type": "boolean"
    },
    {
      "id": 837,
      "name": "dist_shop_ip_gte_10",
      "type": "boolean"
    },
    {
      "id": 845,
      "name": "dist_shop_ip_gte_100",
      "type": "boolean"
    },
    {
      "id": 864,
      "name": "dist_shop_ip_gte_1000",
      "type": "boolean"
    },
    {
      "id": 879,
      "name": "dist_shop_ip_gte_10000",
      "type": "boolean"
    },
    {
      "id": 717,
      "name": "email",
      "type": "text"
    },
    {
      "id": 590,
      "name": "email_domain",
      "type": "text"
    },
    {
      "id": 846,
      "name": "email_domain_has_dot",
      "type": "boolean"
    },
    {
      "id": 654,
      "name": "email_domain_has_minus",
      "type": "boolean"
    },
    {
      "id": 903,
      "name": "email_domain_has_number",
      "type": "boolean"
    },
    {
      "id": 1000,
      "name": "email_domain_has_underscore",
      "type": "boolean"
    },
    {
      "id": 692,
      "name": "email_domain_is_disposable",
      "type": "boolean"
    },
    {
      "id": 693,
      "name": "email_domain_is_free",
      "type": "boolean"
    },
    {
      "id": 812,
      "name": "email_domain_len",
      "type": "float"
    },
    {
      "id": 904,
      "name": "email_domain_len_gte_02",
      "type": "boolean"
    },
    {
      "id": 905,
      "name": "email_domain_len_gte_04",
      "type": "boolean"
    },
    {
      "id": 906,
      "name": "email_domain_len_gte_06",
      "type": "boolean"
    },
    {
      "id": 907,
      "name": "email_domain_len_gte_08",
      "type": "boolean"
    },
    {
      "id": 650,
      "name": "email_domain_len_gte_10",
      "type": "boolean"
    },
    {
      "id": 909,
      "name": "email_domain_len_gte_12",
      "type": "boolean"
    },
    {
      "id": 910,
      "name": "email_domain_len_gte_14",
      "type": "boolean"
    },
    {
      "id": 911,
      "name": "email_domain_len_gte_16",
      "type": "boolean"
    },
    {
      "id": 881,
      "name": "email_domain_n_accents",
      "type": "float"
    },
    {
      "id": 882,
      "name": "email_domain_n_letters",
      "type": "float"
    },
    {
      "id": 883,
      "name": "email_domain_n_numbers",
      "type": "float"
    },
    {
      "id": 1060,
      "name": "email_domain_n_numbers_gte_01",
      "type": "boolean"
    },
    {
      "id": 1061,
      "name": "email_domain_n_numbers_gte_02",
      "type": "boolean"
    },
    {
      "id": 1062,
      "name": "email_domain_n_numbers_gte_03",
      "type": "boolean"
    },
    {
      "id": 1063,
      "name": "email_domain_n_numbers_gte_04",
      "type": "boolean"
    },
    {
      "id": 1064,
      "name": "email_domain_n_numbers_gte_05",
      "type": "boolean"
    },
    {
      "id": 1065,
      "name": "email_domain_n_numbers_gte_06",
      "type": "boolean"
    },
    {
      "id": 1066,
      "name": "email_domain_n_numbers_gte_07",
      "type": "boolean"
    },
    {
      "id": 1067,
      "name": "email_domain_n_numbers_gte_08",
      "type": "boolean"
    },
    {
      "id": 912,
      "name": "email_domain_n_specials",
      "type": "float"
    },
    {
      "id": 1100,
      "name": "email_domain_n_specials_gte_01",
      "type": "boolean"
    },
    {
      "id": 1101,
      "name": "email_domain_n_specials_gte_02",
      "type": "boolean"
    },
    {
      "id": 1102,
      "name": "email_domain_n_specials_gte_03",
      "type": "boolean"
    },
    {
      "id": 1103,
      "name": "email_domain_n_specials_gte_04",
      "type": "boolean"
    },
    {
      "id": 1104,
      "name": "email_domain_n_specials_gte_05",
      "type": "boolean"
    },
    {
      "id": 1105,
      "name": "email_domain_n_specials_gte_06",
      "type": "boolean"
    },
    {
      "id": 1106,
      "name": "email_domain_n_specials_gte_07",
      "type": "boolean"
    },
    {
      "id": 1107,
      "name": "email_domain_n_specials_gte_08",
      "type": "boolean"
    },
    {
      "id": 738,
      "name": "email_login",
      "type": "text"
    },
    {
      "id": 603,
      "name": "email_login_has_dot",
      "type": "boolean"
    },
    {
      "id": 602,
      "name": "email_login_has_minus",
      "type": "boolean"
    },
    {
      "id": 601,
      "name": "email_login_has_number",
      "type": "boolean"
    },
    {
      "id": 604,
      "name": "email_login_has_underscore",
      "type": "boolean"
    },
    {
      "id": 799,
      "name": "email_login_len",
      "type": "float"
    },
    {
      "id": 885,
      "name": "email_login_len_gte_02",
      "type": "boolean"
    },
    {
      "id": 886,
      "name": "email_login_len_gte_04",
      "type": "boolean"
    },
    {
      "id": 887,
      "name": "email_login_len_gte_06",
      "type": "boolean"
    },
    {
      "id": 888,
      "name": "email_login_len_gte_08",
      "type": "boolean"
    },
    {
      "id": 597,
      "name": "email_login_len_gte_10",
      "type": "boolean"
    },
    {
      "id": 598,
      "name": "email_login_len_gte_12",
      "type": "boolean"
    },
    {
      "id": 891,
      "name": "email_login_len_gte_14",
      "type": "boolean"
    },
    {
      "id": 892,
      "name": "email_login_len_gte_16",
      "type": "boolean"
    },
    {
      "id": 866,
      "name": "email_login_n_accents",
      "type": "float"
    },
    {
      "id": 867,
      "name": "email_login_n_letters",
      "type": "float"
    },
    {
      "id": 868,
      "name": "email_login_n_numbers",
      "type": "float"
    },
    {
      "id": 1012,
      "name": "email_login_n_numbers_gte_01",
      "type": "boolean"
    },
    {
      "id": 1013,
      "name": "email_login_n_numbers_gte_02",
      "type": "boolean"
    },
    {
      "id": 1014,
      "name": "email_login_n_numbers_gte_03",
      "type": "boolean"
    },
    {
      "id": 1015,
      "name": "email_login_n_numbers_gte_04",
      "type": "boolean"
    },
    {
      "id": 1016,
      "name": "email_login_n_numbers_gte_05",
      "type": "boolean"
    },
    {
      "id": 1017,
      "name": "email_login_n_numbers_gte_06",
      "type": "boolean"
    },
    {
      "id": 1018,
      "name": "email_login_n_numbers_gte_07",
      "type": "boolean"
    },
    {
      "id": 1019,
      "name": "email_login_n_numbers_gte_08",
      "type": "boolean"
    },
    {
      "id": 893,
      "name": "email_login_n_specials",
      "type": "float"
    },
    {
      "id": 1068,
      "name": "email_login_n_specials_gte_01",
      "type": "boolean"
    },
    {
      "id": 1069,
      "name": "email_login_n_specials_gte_02",
      "type": "boolean"
    },
    {
      "id": 1070,
      "name": "email_login_n_specials_gte_03",
      "type": "boolean"
    },
    {
      "id": 1071,
      "name": "email_login_n_specials_gte_04",
      "type": "boolean"
    },
    {
      "id": 1072,
      "name": "email_login_n_specials_gte_05",
      "type": "boolean"
    },
    {
      "id": 1073,
      "name": "email_login_n_specials_gte_06",
      "type": "boolean"
    },
    {
      "id": 1074,
      "name": "email_login_n_specials_gte_07",
      "type": "boolean"
    },
    {
      "id": 1075,
      "name": "email_login_n_specials_gte_08",
      "type": "boolean"
    },
    {
      "id": 591,
      "name": "email_tld",
      "type": "text"
    },
    {
      "id": 698,
      "name": "email_tld_is_cc",
      "type": "boolean"
    },
    {
      "id": 751,
      "name": "email_tld_len",
      "type": "float"
    },
    {
      "id": 848,
      "name": "email_tld_len_gte_03",
      "type": "boolean"
    },
    {
      "id": 849,
      "name": "email_tld_len_gte_04",
      "type": "boolean"
    },
    {
      "id": 850,
      "name": "email_tld_len_gte_05",
      "type": "boolean"
    },
    {
      "id": 822,
      "name": "geo_delivery_addr",
      "type": "text"
    },
    {
      "id": 1076,
      "name": "geo_delivery_admin_level1long",
      "type": "text"
    },
    {
      "id": 1077,
      "name": "geo_delivery_admin_level2long",
      "type": "text"
    },
    {
      "id": 823,
      "name": "geo_delivery_city",
      "type": "text"
    },
    {
      "id": 913,
      "name": "geo_delivery_confidence",
      "type": "text"
    },
    {
      "id": 851,
      "name": "geo_delivery_country",
      "type": "text"
    },
    {
      "id": 973,
      "name": "geo_delivery_country_area",
      "type": "float"
    },
    {
      "id": 1020,
      "name": "geo_delivery_country_borders",
      "type": "json"
    },
    {
      "id": 1021,
      "name": "geo_delivery_country_capital",
      "type": "text"
    },
    {
      "id": 715,
      "name": "geo_delivery_country_code",
      "type": "text"
    },
    {
      "id": 1108,
      "name": "geo_delivery_country_continent",
      "type": "text"
    },
    {
      "id": 1161,
      "name": "geo_delivery_country_currencies",
      "type": "json"
    },
    {
      "id": 975,
      "name": "geo_delivery_country_iso2",
      "type": "text"
    },
    {
      "id": 976,
      "name": "geo_delivery_country_iso3",
      "type": "text"
    },
    {
      "id": 1109,
      "name": "geo_delivery_country_languages",
      "type": "json"
    },
    {
      "id": 944,
      "name": "geo_delivery_country_lat",
      "type": "float"
    },
    {
      "id": 945,
      "name": "geo_delivery_country_lon",
      "type": "float"
    },
    {
      "id": 977,
      "name": "geo_delivery_country_name",
      "type": "text"
    },
    {
      "id": 1162,
      "name": "geo_delivery_country_population",
      "type": "float"
    },
    {
      "id": 946,
      "name": "geo_delivery_country_raw",
      "type": "text"
    },
    {
      "id": 1001,
      "name": "geo_delivery_country_region",
      "type": "text"
    },
    {
      "id": 1110,
      "name": "geo_delivery_country_subregion",
      "type": "text"
    },
    {
      "id": 1111,
      "name": "geo_delivery_country_timezones",
      "type": "json"
    },
    {
      "id": 978,
      "name": "geo_delivery_country_wiki",
      "type": "text"
    },
    {
      "id": 200,
      "name": "geo_delivery_cty_adm1",
      "type": "text"
    },
    {
      "id": 201,
      "name": "geo_delivery_cty_adm1_adm2",
      "type": "text"
    },
    {
      "id": 202,
      "name": "geo_delivery_cty_zip",
      "type": "text"
    },
    {
      "id": 947,
      "name": "geo_delivery_cty_zip_str",
      "type": "text"
    },
    {
      "id": 813,
      "name": "geo_delivery_lat",
      "type": "float"
    },
    {
      "id": 814,
      "name": "geo_delivery_lon",
      "type": "float"
    },
    {
      "id": 894,
      "name": "geo_delivery_place_raw",
      "type": "text"
    },
    {
      "id": 948,
      "name": "geo_delivery_street1_raw",
      "type": "text"
    },
    {
      "id": 949,
      "name": "geo_delivery_street2_raw",
      "type": "text"
    },
    {
      "id": 950,
      "name": "geo_delivery_street_name",
      "type": "text"
    },
    {
      "id": 992,
      "name": "geo_delivery_street_number",
      "type": "text"
    },
    {
      "id": 853,
      "name": "geo_delivery_zipcode",
      "type": "text"
    },
    {
      "id": 208,
      "name": "geo_eq_all",
      "type": "boolean"
    },
    {
      "id": 207,
      "name": "geo_eq_country",
      "type": "boolean"
    },
    {
      "id": 206,
      "name": "geo_eq_place",
      "type": "boolean"
    },
    {
      "id": 204,
      "name": "geo_eq_street1",
      "type": "boolean"
    },
    {
      "id": 205,
      "name": "geo_eq_street2",
      "type": "boolean"
    },
    {
      "id": 815,
      "name": "geo_invoice_addr",
      "type": "text"
    },
    {
      "id": 1022,
      "name": "geo_invoice_admin_level1long",
      "type": "text"
    },
    {
      "id": 1023,
      "name": "geo_invoice_admin_level2long",
      "type": "text"
    },
    {
      "id": 816,
      "name": "geo_invoice_city",
      "type": "text"
    },
    {
      "id": 895,
      "name": "geo_invoice_confidence",
      "type": "text"
    },
    {
      "id": 839,
      "name": "geo_invoice_country",
      "type": "text"
    },
    {
      "id": 951,
      "name": "geo_invoice_country_area",
      "type": "float"
    },
    {
      "id": 1002,
      "name": "geo_invoice_country_borders",
      "type": "json"
    },
    {
      "id": 1003,
      "name": "geo_invoice_country_capital",
      "type": "text"
    },
    {
      "id": 714,
      "name": "geo_invoice_country_code",
      "type": "text"
    },
    {
      "id": 1078,
      "name": "geo_invoice_country_continent",
      "type": "text"
    },
    {
      "id": 1112,
      "name": "geo_invoice_country_currencies",
      "type": "json"
    },
    {
      "id": 953,
      "name": "geo_invoice_country_iso2",
      "type": "text"
    },
    {
      "id": 954,
      "name": "geo_invoice_country_iso3",
      "type": "text"
    },
    {
      "id": 1079,
      "name": "geo_invoice_country_languages",
      "type": "json"
    },
    {
      "id": 914,
      "name": "geo_invoice_country_lat",
      "type": "float"
    },
    {
      "id": 915,
      "name": "geo_invoice_country_lon",
      "type": "float"
    },
    {
      "id": 955,
      "name": "geo_invoice_country_name",
      "type": "text"
    },
    {
      "id": 1113,
      "name": "geo_invoice_country_population",
      "type": "text"
    },
    {
      "id": 916,
      "name": "geo_invoice_country_raw",
      "type": "text"
    },
    {
      "id": 993,
      "name": "geo_invoice_country_region",
      "type": "text"
    },
    {
      "id": 1080,
      "name": "geo_invoice_country_subregion",
      "type": "text"
    },
    {
      "id": 1081,
      "name": "geo_invoice_country_timezones",
      "type": "json"
    },
    {
      "id": 956,
      "name": "geo_invoice_country_wiki",
      "type": "text"
    },
    {
      "id": 193,
      "name": "geo_invoice_cty_adm1",
      "type": "text"
    },
    {
      "id": 194,
      "name": "geo_invoice_cty_adm1_adm2",
      "type": "text"
    },
    {
      "id": 195,
      "name": "geo_invoice_cty_zip",
      "type": "text"
    },
    {
      "id": 917,
      "name": "geo_invoice_cty_zip_str",
      "type": "text"
    },
    {
      "id": 801,
      "name": "geo_invoice_lat",
      "type": "float"
    },
    {
      "id": 802,
      "name": "geo_invoice_lon",
      "type": "float"
    },
    {
      "id": 870,
      "name": "geo_invoice_place_raw",
      "type": "text"
    },
    {
      "id": 918,
      "name": "geo_invoice_street1_raw",
      "type": "text"
    },
    {
      "id": 919,
      "name": "geo_invoice_street2_raw",
      "type": "text"
    },
    {
      "id": 920,
      "name": "geo_invoice_street_name",
      "type": "text"
    },
    {
      "id": 980,
      "name": "geo_invoice_street_number",
      "type": "text"
    },
    {
      "id": 841,
      "name": "geo_invoice_zipcode",
      "type": "text"
    },
    {
      "id": 746,
      "name": "invoice_time",
      "type": "text"
    },
    {
      "id": 734,
      "name": "ip_address",
      "type": "text"
    },
    {
      "id": 752,
      "name": "ip_address_01",
      "type": "text"
    },
    {
      "id": 753,
      "name": "ip_address_02",
      "type": "text"
    },
    {
      "id": 754,
      "name": "ip_address_03",
      "type": "text"
    },
    {
      "id": 755,
      "name": "ip_address_04",
      "type": "text"
    },
    {
      "id": 756,
      "name": "ip_address_05",
      "type": "text"
    },
    {
      "id": 757,
      "name": "ip_address_06",
      "type": "text"
    },
    {
      "id": 758,
      "name": "ip_address_07",
      "type": "text"
    },
    {
      "id": 759,
      "name": "ip_address_08",
      "type": "text"
    },
    {
      "id": 760,
      "name": "ip_address_09",
      "type": "text"
    },
    {
      "id": 761,
      "name": "ip_address_10",
      "type": "text"
    },
    {
      "id": 762,
      "name": "ip_address_11",
      "type": "text"
    },
    {
      "id": 240,
      "name": "ip_address_12",
      "type": "inet"
    },
    {
      "id": 764,
      "name": "ip_address_13",
      "type": "text"
    },
    {
      "id": 765,
      "name": "ip_address_14",
      "type": "text"
    },
    {
      "id": 766,
      "name": "ip_address_15",
      "type": "text"
    },
    {
      "id": 236,
      "name": "ip_address_16",
      "type": "inet"
    },
    {
      "id": 768,
      "name": "ip_address_17",
      "type": "text"
    },
    {
      "id": 769,
      "name": "ip_address_18",
      "type": "text"
    },
    {
      "id": 770,
      "name": "ip_address_19",
      "type": "text"
    },
    {
      "id": 232,
      "name": "ip_address_20",
      "type": "inet"
    },
    {
      "id": 772,
      "name": "ip_address_21",
      "type": "text"
    },
    {
      "id": 773,
      "name": "ip_address_22",
      "type": "text"
    },
    {
      "id": 774,
      "name": "ip_address_23",
      "type": "text"
    },
    {
      "id": 228,
      "name": "ip_address_24",
      "type": "text"
    },
    {
      "id": 803,
      "name": "ip_address_long",
      "type": "float"
    },
    {
      "id": 209,
      "name": "ip_as",
      "type": "text"
    },
    {
      "id": 210,
      "name": "ip_city",
      "type": "text"
    },
    {
      "id": 735,
      "name": "ip_country",
      "type": "text"
    },
    {
      "id": 214,
      "name": "ip_country_code",
      "type": "text"
    },
    {
      "id": 855,
      "name": "ip_country_continent",
      "type": "text"
    },
    {
      "id": 805,
      "name": "ip_country_iso2",
      "type": "text"
    },
    {
      "id": 806,
      "name": "ip_country_iso3",
      "type": "text"
    },
    {
      "id": 807,
      "name": "ip_country_name",
      "type": "text"
    },
    {
      "id": 215,
      "name": "ip_cty_region",
      "type": "text"
    },
    {
      "id": 216,
      "name": "ip_cty_zip",
      "type": "text"
    },
    {
      "id": 747,
      "name": "ip_is_mobile",
      "type": "boolean"
    },
    {
      "id": 739,
      "name": "ip_is_proxy",
      "type": "boolean"
    },
    {
      "id": 218,
      "name": "ip_isp",
      "type": "text"
    },
    {
      "id": 721,
      "name": "ip_lat",
      "type": "float"
    },
    {
      "id": 722,
      "name": "ip_lon",
      "type": "float"
    },
    {
      "id": 219,
      "name": "ip_org",
      "type": "text"
    },
    {
      "id": 728,
      "name": "ip_region",
      "type": "text"
    },
    {
      "id": 791,
      "name": "ip_region_name",
      "type": "text"
    },
    {
      "id": 217,
      "name": "ip_timezone",
      "type": "text"
    },
    {
      "id": 737,
      "name": "ip_zipcode",
      "type": "text"
    },
    {
      "id": 784,
      "name": "names_account",
      "type": "text"
    },
    {
      "id": 957,
      "name": "names_account_first_name",
      "type": "text"
    },
    {
      "id": 425,
      "name": "names_account_has_minus",
      "type": "boolean"
    },
    {
      "id": 958,
      "name": "names_account_has_number",
      "type": "boolean"
    },
    {
      "id": 995,
      "name": "names_account_has_specials",
      "type": "boolean"
    },
    {
      "id": 922,
      "name": "names_account_last_name",
      "type": "text"
    },
    {
      "id": 923,
      "name": "names_account_n_accents",
      "type": "float"
    },
    {
      "id": 1114,
      "name": "names_account_n_accents_gte_01",
      "type": "boolean"
    },
    {
      "id": 1115,
      "name": "names_account_n_accents_gte_02",
      "type": "boolean"
    },
    {
      "id": 1116,
      "name": "names_account_n_accents_gte_03",
      "type": "boolean"
    },
    {
      "id": 1117,
      "name": "names_account_n_accents_gte_04",
      "type": "boolean"
    },
    {
      "id": 924,
      "name": "names_account_n_letters",
      "type": "float"
    },
    {
      "id": 1118,
      "name": "names_account_n_letters_gte_01",
      "type": "boolean"
    },
    {
      "id": 1119,
      "name": "names_account_n_letters_gte_02",
      "type": "boolean"
    },
    {
      "id": 1120,
      "name": "names_account_n_letters_gte_03",
      "type": "boolean"
    },
    {
      "id": 1121,
      "name": "names_account_n_letters_gte_04",
      "type": "boolean"
    },
    {
      "id": 1122,
      "name": "names_account_n_letters_gte_05",
      "type": "boolean"
    },
    {
      "id": 1123,
      "name": "names_account_n_letters_gte_06",
      "type": "boolean"
    },
    {
      "id": 1124,
      "name": "names_account_n_letters_gte_07",
      "type": "boolean"
    },
    {
      "id": 1125,
      "name": "names_account_n_letters_gte_08",
      "type": "boolean"
    },
    {
      "id": 1126,
      "name": "names_account_n_letters_gte_09",
      "type": "boolean"
    },
    {
      "id": 461,
      "name": "names_account_n_letters_gte_10",
      "type": "boolean"
    },
    {
      "id": 1128,
      "name": "names_account_n_letters_gte_11",
      "type": "boolean"
    },
    {
      "id": 1129,
      "name": "names_account_n_letters_gte_12",
      "type": "boolean"
    },
    {
      "id": 871,
      "name": "names_account_n_lower",
      "type": "float"
    },
    {
      "id": 1024,
      "name": "names_account_n_lower_gte_02",
      "type": "boolean"
    },
    {
      "id": 1025,
      "name": "names_account_n_lower_gte_03",
      "type": "boolean"
    },
    {
      "id": 1026,
      "name": "names_account_n_lower_gte_04",
      "type": "boolean"
    },
    {
      "id": 1027,
      "name": "names_account_n_lower_gte_05",
      "type": "boolean"
    },
    {
      "id": 1028,
      "name": "names_account_n_lower_gte_06",
      "type": "boolean"
    },
    {
      "id": 1029,
      "name": "names_account_n_lower_gte_07",
      "type": "boolean"
    },
    {
      "id": 1030,
      "name": "names_account_n_lower_gte_08",
      "type": "boolean"
    },
    {
      "id": 925,
      "name": "names_account_n_numbers",
      "type": "float"
    },
    {
      "id": 1130,
      "name": "names_account_n_numbers_gte_02",
      "type": "boolean"
    },
    {
      "id": 1131,
      "name": "names_account_n_numbers_gte_03",
      "type": "boolean"
    },
    {
      "id": 959,
      "name": "names_account_n_specials",
      "type": "float"
    },
    {
      "id": 1163,
      "name": "names_account_n_specials_gte_01",
      "type": "boolean"
    },
    {
      "id": 1164,
      "name": "names_account_n_specials_gte_02",
      "type": "boolean"
    },
    {
      "id": 1165,
      "name": "names_account_n_specials_gte_03",
      "type": "boolean"
    },
    {
      "id": 1166,
      "name": "names_account_n_specials_gte_04",
      "type": "boolean"
    },
    {
      "id": 1167,
      "name": "names_account_n_specials_gte_05",
      "type": "boolean"
    },
    {
      "id": 1168,
      "name": "names_account_n_specials_gte_06",
      "type": "boolean"
    },
    {
      "id": 1169,
      "name": "names_account_n_specials_gte_07",
      "type": "boolean"
    },
    {
      "id": 1170,
      "name": "names_account_n_specials_gte_08",
      "type": "boolean"
    },
    {
      "id": 872,
      "name": "names_account_n_upper",
      "type": "float"
    },
    {
      "id": 1031,
      "name": "names_account_n_upper_gte_02",
      "type": "boolean"
    },
    {
      "id": 1032,
      "name": "names_account_n_upper_gte_03",
      "type": "boolean"
    },
    {
      "id": 1033,
      "name": "names_account_n_upper_gte_04",
      "type": "boolean"
    },
    {
      "id": 1034,
      "name": "names_account_n_upper_gte_05",
      "type": "boolean"
    },
    {
      "id": 1035,
      "name": "names_account_n_upper_gte_06",
      "type": "boolean"
    },
    {
      "id": 1036,
      "name": "names_account_n_upper_gte_07",
      "type": "boolean"
    },
    {
      "id": 1037,
      "name": "names_account_n_upper_gte_08",
      "type": "boolean"
    },
    {
      "id": 873,
      "name": "names_account_n_words",
      "type": "float"
    },
    {
      "id": 1038,
      "name": "names_account_n_words_gte_02",
      "type": "boolean"
    },
    {
      "id": 1039,
      "name": "names_account_n_words_gte_03",
      "type": "boolean"
    },
    {
      "id": 1040,
      "name": "names_account_n_words_gte_04",
      "type": "boolean"
    },
    {
      "id": 824,
      "name": "names_account_raw",
      "type": "text"
    },
    {
      "id": 856,
      "name": "names_account_sorted",
      "type": "text"
    },
    {
      "id": 792,
      "name": "names_delivery",
      "type": "text"
    },
    {
      "id": 981,
      "name": "names_delivery_first_name",
      "type": "text"
    },
    {
      "id": 533,
      "name": "names_delivery_has_minus",
      "type": "boolean"
    },
    {
      "id": 982,
      "name": "names_delivery_has_number",
      "type": "boolean"
    },
    {
      "id": 1005,
      "name": "names_delivery_has_specials",
      "type": "boolean"
    },
    {
      "id": 961,
      "name": "names_delivery_last_name",
      "type": "text"
    },
    {
      "id": 962,
      "name": "names_delivery_n_accents",
      "type": "float"
    },
    {
      "id": 1171,
      "name": "names_delivery_n_accents_gte_01",
      "type": "boolean"
    },
    {
      "id": 1172,
      "name": "names_delivery_n_accents_gte_02",
      "type": "boolean"
    },
    {
      "id": 1173,
      "name": "names_delivery_n_accents_gte_03",
      "type": "boolean"
    },
    {
      "id": 1174,
      "name": "names_delivery_n_accents_gte_04",
      "type": "boolean"
    },
    {
      "id": 963,
      "name": "names_delivery_n_letters",
      "type": "float"
    },
    {
      "id": 1175,
      "name": "names_delivery_n_letters_gte_01",
      "type": "boolean"
    },
    {
      "id": 1176,
      "name": "names_delivery_n_letters_gte_02",
      "type": "boolean"
    },
    {
      "id": 1177,
      "name": "names_delivery_n_letters_gte_03",
      "type": "boolean"
    },
    {
      "id": 1178,
      "name": "names_delivery_n_letters_gte_04",
      "type": "boolean"
    },
    {
      "id": 1179,
      "name": "names_delivery_n_letters_gte_05",
      "type": "boolean"
    },
    {
      "id": 1180,
      "name": "names_delivery_n_letters_gte_06",
      "type": "boolean"
    },
    {
      "id": 1181,
      "name": "names_delivery_n_letters_gte_07",
      "type": "boolean"
    },
    {
      "id": 1182,
      "name": "names_delivery_n_letters_gte_08",
      "type": "boolean"
    },
    {
      "id": 1183,
      "name": "names_delivery_n_letters_gte_09",
      "type": "boolean"
    },
    {
      "id": 569,
      "name": "names_delivery_n_letters_gte_10",
      "type": "boolean"
    },
    {
      "id": 1185,
      "name": "names_delivery_n_letters_gte_11",
      "type": "boolean"
    },
    {
      "id": 571,
      "name": "names_delivery_n_letters_gte_12",
      "type": "boolean"
    },
    {
      "id": 896,
      "name": "names_delivery_n_lower",
      "type": "float"
    },
    {
      "id": 1082,
      "name": "names_delivery_n_lower_gte_02",
      "type": "boolean"
    },
    {
      "id": 1083,
      "name": "names_delivery_n_lower_gte_03",
      "type": "boolean"
    },
    {
      "id": 1084,
      "name": "names_delivery_n_lower_gte_04",
      "type": "boolean"
    },
    {
      "id": 1085,
      "name": "names_delivery_n_lower_gte_05",
      "type": "boolean"
    },
    {
      "id": 1086,
      "name": "names_delivery_n_lower_gte_06",
      "type": "boolean"
    },
    {
      "id": 1087,
      "name": "names_delivery_n_lower_gte_07",
      "type": "boolean"
    },
    {
      "id": 1088,
      "name": "names_delivery_n_lower_gte_08",
      "type": "boolean"
    },
    {
      "id": 964,
      "name": "names_delivery_n_numbers",
      "type": "float"
    },
    {
      "id": 1187,
      "name": "names_delivery_n_numbers_gte_02",
      "type": "boolean"
    },
    {
      "id": 1188,
      "name": "names_delivery_n_numbers_gte_03",
      "type": "boolean"
    },
    {
      "id": 983,
      "name": "names_delivery_n_specials",
      "type": "float"
    },
    {
      "id": 1198,
      "name": "names_delivery_n_specials_gte_01",
      "type": "boolean"
    },
    {
      "id": 1199,
      "name": "names_delivery_n_specials_gte_02",
      "type": "boolean"
    },
    {
      "id": 1200,
      "name": "names_delivery_n_specials_gte_03",
      "type": "boolean"
    },
    {
      "id": 1201,
      "name": "names_delivery_n_specials_gte_04",
      "type": "boolean"
    },
    {
      "id": 1202,
      "name": "names_delivery_n_specials_gte_05",
      "type": "boolean"
    },
    {
      "id": 1203,
      "name": "names_delivery_n_specials_gte_06",
      "type": "boolean"
    },
    {
      "id": 1204,
      "name": "names_delivery_n_specials_gte_07",
      "type": "boolean"
    },
    {
      "id": 1205,
      "name": "names_delivery_n_specials_gte_08",
      "type": "boolean"
    },
    {
      "id": 897,
      "name": "names_delivery_n_upper",
      "type": "float"
    },
    {
      "id": 1089,
      "name": "names_delivery_n_upper_gte_02",
      "type": "boolean"
    },
    {
      "id": 1090,
      "name": "names_delivery_n_upper_gte_03",
      "type": "boolean"
    },
    {
      "id": 1091,
      "name": "names_delivery_n_upper_gte_04",
      "type": "boolean"
    },
    {
      "id": 1092,
      "name": "names_delivery_n_upper_gte_05",
      "type": "boolean"
    },
    {
      "id": 1093,
      "name": "names_delivery_n_upper_gte_06",
      "type": "boolean"
    },
    {
      "id": 1094,
      "name": "names_delivery_n_upper_gte_07",
      "type": "boolean"
    },
    {
      "id": 1095,
      "name": "names_delivery_n_upper_gte_08",
      "type": "boolean"
    },
    {
      "id": 898,
      "name": "names_delivery_n_words",
      "type": "float"
    },
    {
      "id": 1096,
      "name": "names_delivery_n_words_gte_02",
      "type": "boolean"
    },
    {
      "id": 1097,
      "name": "names_delivery_n_words_gte_03",
      "type": "boolean"
    },
    {
      "id": 1098,
      "name": "names_delivery_n_words_gte_04",
      "type": "boolean"
    },
    {
      "id": 829,
      "name": "names_delivery_raw",
      "type": "text"
    },
    {
      "id": 874,
      "name": "names_delivery_sorted",
      "type": "text"
    },
    {
      "id": 587,
      "name": "names_eq_account_delivery",
      "type": "boolean"
    },
    {
      "id": 586,
      "name": "names_eq_account_invoice",
      "type": "boolean"
    },
    {
      "id": 589,
      "name": "names_eq_all",
      "type": "boolean"
    },
    {
      "id": 588,
      "name": "names_eq_invoice_delivery",
      "type": "boolean"
    },
    {
      "id": 785,
      "name": "names_invoice",
      "type": "text"
    },
    {
      "id": 966,
      "name": "names_invoice_first_name",
      "type": "text"
    },
    {
      "id": 479,
      "name": "names_invoice_has_minus",
      "type": "boolean"
    },
    {
      "id": 967,
      "name": "names_invoice_has_number",
      "type": "boolean"
    },
    {
      "id": 996,
      "name": "names_invoice_has_specials",
      "type": "boolean"
    },
    {
      "id": 927,
      "name": "names_invoice_last_name",
      "type": "text"
    },
    {
      "id": 928,
      "name": "names_invoice_n_accents",
      "type": "float"
    },
    {
      "id": 1132,
      "name": "names_invoice_n_accents_gte_01",
      "type": "boolean"
    },
    {
      "id": 1133,
      "name": "names_invoice_n_accents_gte_02",
      "type": "boolean"
    },
    {
      "id": 1134,
      "name": "names_invoice_n_accents_gte_03",
      "type": "boolean"
    },
    {
      "id": 1135,
      "name": "names_invoice_n_accents_gte_04",
      "type": "boolean"
    },
    {
      "id": 929,
      "name": "names_invoice_n_letters",
      "type": "float"
    },
    {
      "id": 1136,
      "name": "names_invoice_n_letters_gte_01",
      "type": "boolean"
    },
    {
      "id": 1137,
      "name": "names_invoice_n_letters_gte_02",
      "type": "boolean"
    },
    {
      "id": 1138,
      "name": "names_invoice_n_letters_gte_03",
      "type": "boolean"
    },
    {
      "id": 1139,
      "name": "names_invoice_n_letters_gte_04",
      "type": "boolean"
    },
    {
      "id": 1140,
      "name": "names_invoice_n_letters_gte_05",
      "type": "boolean"
    },
    {
      "id": 1141,
      "name": "names_invoice_n_letters_gte_06",
      "type": "boolean"
    },
    {
      "id": 1142,
      "name": "names_invoice_n_letters_gte_07",
      "type": "boolean"
    },
    {
      "id": 1143,
      "name": "names_invoice_n_letters_gte_08",
      "type": "boolean"
    },
    {
      "id": 1144,
      "name": "names_invoice_n_letters_gte_09",
      "type": "boolean"
    },
    {
      "id": 515,
      "name": "names_invoice_n_letters_gte_10",
      "type": "boolean"
    },
    {
      "id": 1146,
      "name": "names_invoice_n_letters_gte_11",
      "type": "boolean"
    },
    {
      "id": 517,
      "name": "names_invoice_n_letters_gte_12",
      "type": "boolean"
    },
    {
      "id": 875,
      "name": "names_invoice_n_lower",
      "type": "float"
    },
    {
      "id": 1041,
      "name": "names_invoice_n_lower_gte_02",
      "type": "boolean"
    },
    {
      "id": 1042,
      "name": "names_invoice_n_lower_gte_03",
      "type": "boolean"
    },
    {
      "id": 1043,
      "name": "names_invoice_n_lower_gte_04",
      "type": "boolean"
    },
    {
      "id": 1044,
      "name": "names_invoice_n_lower_gte_05",
      "type": "boolean"
    },
    {
      "id": 1045,
      "name": "names_invoice_n_lower_gte_06",
      "type": "boolean"
    },
    {
      "id": 1046,
      "name": "names_invoice_n_lower_gte_07",
      "type": "boolean"
    },
    {
      "id": 1047,
      "name": "names_invoice_n_lower_gte_08",
      "type": "boolean"
    },
    {
      "id": 930,
      "name": "names_invoice_n_numbers",
      "type": "float"
    },
    {
      "id": 1148,
      "name": "names_invoice_n_numbers_gte_02",
      "type": "boolean"
    },
    {
      "id": 1149,
      "name": "names_invoice_n_numbers_gte_03",
      "type": "boolean"
    },
    {
      "id": 968,
      "name": "names_invoice_n_specials",
      "type": "float"
    },
    {
      "id": 1189,
      "name": "names_invoice_n_specials_gte_01",
      "type": "boolean"
    },
    {
      "id": 1190,
      "name": "names_invoice_n_specials_gte_02",
      "type": "boolean"
    },
    {
      "id": 1191,
      "name": "names_invoice_n_specials_gte_03",
      "type": "boolean"
    },
    {
      "id": 1192,
      "name": "names_invoice_n_specials_gte_04",
      "type": "boolean"
    },
    {
      "id": 1193,
      "name": "names_invoice_n_specials_gte_05",
      "type": "boolean"
    },
    {
      "id": 1194,
      "name": "names_invoice_n_specials_gte_06",
      "type": "boolean"
    },
    {
      "id": 1195,
      "name": "names_invoice_n_specials_gte_07",
      "type": "boolean"
    },
    {
      "id": 1196,
      "name": "names_invoice_n_specials_gte_08",
      "type": "boolean"
    },
    {
      "id": 876,
      "name": "names_invoice_n_upper",
      "type": "float"
    },
    {
      "id": 1048,
      "name": "names_invoice_n_upper_gte_02",
      "type": "boolean"
    },
    {
      "id": 1049,
      "name": "names_invoice_n_upper_gte_03",
      "type": "boolean"
    },
    {
      "id": 1050,
      "name": "names_invoice_n_upper_gte_04",
      "type": "boolean"
    },
    {
      "id": 1051,
      "name": "names_invoice_n_upper_gte_05",
      "type": "boolean"
    },
    {
      "id": 1052,
      "name": "names_invoice_n_upper_gte_06",
      "type": "boolean"
    },
    {
      "id": 1053,
      "name": "names_invoice_n_upper_gte_07",
      "type": "boolean"
    },
    {
      "id": 1054,
      "name": "names_invoice_n_upper_gte_08",
      "type": "boolean"
    },
    {
      "id": 877,
      "name": "names_invoice_n_words",
      "type": "float"
    },
    {
      "id": 1055,
      "name": "names_invoice_n_words_gte_02",
      "type": "boolean"
    },
    {
      "id": 1056,
      "name": "names_invoice_n_words_gte_03",
      "type": "boolean"
    },
    {
      "id": 1057,
      "name": "names_invoice_n_words_gte_04",
      "type": "boolean"
    },
    {
      "id": 825,
      "name": "names_invoice_raw",
      "type": "text"
    },
    {
      "id": 857,
      "name": "names_invoice_sorted",
      "type": "text"
    },
    {
      "id": 830,
      "name": "order_is_delivered",
      "type": "boolean"
    },
    {
      "id": 1211,
      "name": "phone_delivery1_country_continent",
      "type": "text"
    },
    {
      "id": 1212,
      "name": "phone_delivery2_country_continent",
      "type": "text"
    },
    {
      "id": 189,
      "name": "phone_eq_delivery1_delivery2",
      "type": "boolean"
    },
    {
      "id": 185,
      "name": "phone_eq_invoice1_delivery1",
      "type": "boolean"
    },
    {
      "id": 186,
      "name": "phone_eq_invoice1_delivery2",
      "type": "boolean"
    },
    {
      "id": 184,
      "name": "phone_eq_invoice1_invoice2",
      "type": "boolean"
    },
    {
      "id": 187,
      "name": "phone_eq_invoice2_delivery1",
      "type": "boolean"
    },
    {
      "id": 188,
      "name": "phone_eq_invoice2_delivery2",
      "type": "boolean"
    },
    {
      "id": 1206,
      "name": "phone_invoice1_country_continent",
      "type": "text"
    },
    {
      "id": 1207,
      "name": "phone_invoice2_country_continent",
      "type": "text"
    },
    {
      "id": 741,
      "name": "platform_id",
      "type": "text"
    },
    {
      "id": 729,
      "name": "pmeth_3ds",
      "type": "text"
    },
    {
      "id": 730,
      "name": "pmeth_bin",
      "type": "text"
    },
    {
      "id": 742,
      "name": "pmeth_brand",
      "type": "text"
    },
    {
      "id": 931,
      "name": "pmeth_country_continent",
      "type": "text"
    },
    {
      "id": 831,
      "name": "pmeth_country_iso2",
      "type": "text"
    },
    {
      "id": 832,
      "name": "pmeth_country_iso3",
      "type": "text"
    },
    {
      "id": 833,
      "name": "pmeth_country_name",
      "type": "text"
    },
    {
      "id": 794,
      "name": "pmeth_is_check",
      "type": "boolean"
    },
    {
      "id": 749,
      "name": "pmeth_origin",
      "type": "text"
    },
    {
      "id": 899,
      "name": "pmeth_payment_accepted",
      "type": "text"
    },
    {
      "id": 858,
      "name": "pmeth_validity_month",
      "type": "text"
    },
    {
      "id": 842,
      "name": "pmeth_validity_year",
      "type": "text"
    },
    {
      "id": 49,
      "name": "source_trail_len_gte_01",
      "type": "boolean"
    },
    {
      "id": 933,
      "name": "source_trail_len_gte_02",
      "type": "boolean"
    },
    {
      "id": 51,
      "name": "source_trail_len_gte_03",
      "type": "boolean"
    },
    {
      "id": 935,
      "name": "source_trail_len_gte_04",
      "type": "boolean"
    },
    {
      "id": 936,
      "name": "source_trail_len_gte_06",
      "type": "boolean"
    },
    {
      "id": 937,
      "name": "source_trail_len_gte_08",
      "type": "boolean"
    },
    {
      "id": 938,
      "name": "source_trail_len_gte_12",
      "type": "boolean"
    },
    {
      "id": 939,
      "name": "source_trail_len_gte_16",
      "type": "boolean"
    },
    {
      "id": 818,
      "name": "t_account_create",
      "type": "text"
    },
    {
      "id": 1150,
      "name": "t_account_create_is_holiday_fr",
      "type": "boolean"
    },
    {
      "id": 1214,
      "name": "t_delta_ts(t_account_create,t_invoice_create)",
      "type": "text"
    },
    {
      "id": 1215,
      "name": "t_delta_ts(t_account_create,t_payment_accepted)",
      "type": "text"
    },
    {
      "id": 1216,
      "name": "t_delta_ts(t_invoice_create,t_payment_accepted)",
      "type": "text"
    },
    {
      "id": 819,
      "name": "t_invoice_create",
      "type": "text"
    },
    {
      "id": 1151,
      "name": "t_invoice_create_is_holiday_fr",
      "type": "boolean"
    },
    {
      "id": 900,
      "name": "t_invoice_is_afternoon",
      "type": "boolean"
    },
    {
      "id": 843,
      "name": "t_invoice_is_bizday",
      "type": "boolean"
    },
    {
      "id": 859,
      "name": "t_invoice_is_evening",
      "type": "boolean"
    },
    {
      "id": 860,
      "name": "t_invoice_is_morning",
      "type": "boolean"
    },
    {
      "id": 834,
      "name": "t_invoice_is_night",
      "type": "boolean"
    },
    {
      "id": 861,
      "name": "t_invoice_is_weekend",
      "type": "boolean"
    },
    {
      "id": 844,
      "name": "t_invoice_timeofday",
      "type": "text"
    },
    {
      "id": 835,
      "name": "t_payment_accepted",
      "type": "text"
    },
    {
      "id": 1208,
      "name": "t_payment_accepted_is_holiday_fr",
      "type": "boolean"
    },
    {
      "id": 9,
      "name": "transport_mode",
      "type": "text"
    },
    {
      "id": 820,
      "name": "transport_weight",
      "type": "float"
    },
    {
      "id": 1460,
      "name": "transport_weight_in_0.2_0.3",
      "type": "boolean"
    },
    {
      "id": 1461,
      "name": "transport_weight_in_0.3_0.6",
      "type": "boolean"
    },
    {
      "id": 1462,
      "name": "transport_weight_in_0.6_1.2",
      "type": "boolean"
    },
    {
      "id": 1425,
      "name": "transport_weight_in_0_0.2",
      "type": "boolean"
    },
    {
      "id": 1463,
      "name": "transport_weight_in_1.2_2.5",
      "type": "boolean"
    },
    {
      "id": 1426,
      "name": "transport_weight_in_10_20",
      "type": "boolean"
    },
    {
      "id": 1427,
      "name": "transport_weight_in_2.5_5",
      "type": "boolean"
    },
    {
      "id": 1428,
      "name": "transport_weight_in_20_40",
      "type": "boolean"
    },
    {
      "id": 1429,
      "name": "transport_weight_in_40_80",
      "type": "boolean"
    },
    {
      "id": 1404,
      "name": "transport_weight_in_5_10",
      "type": "boolean"
    }
  ],
  "flow": "risk",
  "object": "router_data_features",
  "unsigned": "false",
  "status_code": 200,
  "query_time_ms": "86.52"
}

RouterDataGeocoding

update RouterDataGeocoding

Whether RouterDataGeocoding is active.

Parameters

id
required
The id—set it to `0`.
is_active
required
The value is either `"true"` or `"false"`.

DefinitionCopy

Example RequestCopy

list RouterDataGeocoding

List of RouterDataGeocoding.

Parameters

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031410,
  "iss": "Oriskami OÜ",
  "data": {
    "is_active": "false"
  },
  "flow": "risk",
  "object": "router_data_geocoding",
  "unsigned": "false",
  "status_code": 200,
  "query_time_ms": "50.47"
}

RouterDataGeoip

update RouterDataGeoip

Whether RouterDataGeoip is active.

Parameters

id
required
The id—set it to `0`.
is_active
required
The value is either `"true"` or `"false"`.

DefinitionCopy

Example RequestCopy

list RouterDataGeoip

List of RouterDataGeoip.

Parameters

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031406,
  "iss": "Oriskami OÜ",
  "data": {
    "is_active": "false"
  },
  "flow": "risk",
  "object": "router_data_geoip",
  "unsigned": "false",
  "status_code": 200,
  "query_time_ms": "41.21"
}

RouterDataPhone

list RouterDataPhone

List of RouterDataPhone.

Parameters

DefinitionCopy

Example RequestCopy

Example Response

{
  "iat": 1552031424,
  "iss": "Oriskami OÜ",
  "data": {
    "is_active": "false"
  },
  "flow": "risk",
  "object": "router_data_phone",
  "unsigned": "false",
  "status_code": 200,
  "query_time_ms": "51.68"
}

update RouterDataPhone

Whether RouterDataPhone is active.

Parameters

id
required
The id—set it to `0`.
is_active
required
The value is either `"true"` or `"false"`.

DefinitionCopy

Example RequestCopy

RouterFlow

Manage RouterFlows

delete RouterFlow

Delete a RouterFlow.

Parameters

id
required
The `RouterFlow` id to be deleted—starts at `0`.

DefinitionCopy

Example RequestCopy

update RouterFlow

Whether the RouterFlow is active or not.

Parameters

id
required
The id—set it to `0`.
is_active
required
Whether the `RouterFlow` is active—takes values in `{"true","false"}`.

DefinitionCopy

Example RequestCopy

list RouterFlow

List of RouterFlow.

Parameters

DefinitionCopy

Example RequestCopy

create RouterFlow

Create a new RouterFlow with a default template.

Parameters

DefinitionCopy

Example RequestCopy

RouterParameter

These set of router_parameters configures the cost-driven risk scores and the backtesting simulations.

list RouterParameter

List the RouterParameter.

Parameters

DefinitionCopy

Example RequestCopy

update RouterParameter

Parameters

th0
required
Threshold for the H0 hypothesis—risk alerts are triggered if the total sales amount is greater than `th0`—note that Oriskami Access is the alternative H1 hypothesis, which triggers alerts when lists, rules, or scores suggest a risk.
alpha_level
required
Significance level for VAR calculations—e.g., choose `0.05` (5%) to trigger alerts base on the 95% confidence interval of VAR over a long time horizon (12 months >> 6 months, the maximum time to escalate a fraud).
f_cogs
required
Gross margin, i.e., the average relative (%) cost of the goods sold—a number in `[0,1]`.
c_per_hour
required
The average labour cost per hour of risk operation analysts. Take a *total* cost estimate and bring it back per hour, e.g., include the training cost, the holidays, the team management cost, etc.—depending on your cost assumptions, the interpretation of the results will vary.
reviews_per_hour
required
The average number of reviews per hour verified by risk operation analysts—take an annual average.
c_oriskami_access_per_tx
required
The cost per transaction of Oriskami Access—cf. pricing.

DefinitionCopy

Example RequestCopy

RouterTest

This API endpoint helps manage the RouterTest.

retrieve RouterTest

A RouterTest parameter

Parameters

DefinitionCopy

Example RequestCopy

delete RouterTest

Delete an Event.

Parameters

id
required
The identifier of the `RouterTest` to be deleted.

DefinitionCopy

Example RequestCopy

create RouterTest

Retrieve the RouterTest of an Event id.

Parameters

from
required
The starting point of the `RouterTest` sequence to run.
to
required
The ending point of the `RouterTest` sequence to run—should be after or equal to `from`.
query_target
required
The *target* population is a subset of the base population—leave empty to study the whole population or use, e.g., `frauds` to use the set of frauds as target.
query_base
required
The *base* population is the set of `Event` that the *target* population is compared with—leave empty to use the total set of `Event` as the base population but if you want to study, e.g., a particular country, set to the country code of that country.
sample_size
required
The size of the data sample used to carry out the test—set to a number greater than the total to perform the test on all `Event`, to `1` to make a single test, etc.
use_cache
required
Whether cached data from external services is used when running the test—set to `true` to speed up the processing of the test and to `false` to re-process the gathering of data from external services.
test_save
required
Whether the test results are saved—`false` by default. Set to `true` if you want to keep the test results. Note that for tests involving more than `200` transactions, test results are saved and longpolling is used to retrieve the test results.
test_only
required
Whether the test results are applied to the event labels—`false` by default. Set to `true` if you want to replay a set of `Event` and update their labels.

DefinitionCopy

Example RequestCopy

list RouterTest

List a RouterTest parameters.

Parameters

DefinitionCopy

Example RequestCopy

ScrapperInfo

retrieve ScrapperInfo

Retrieve information about your service’s cursor—i.e., first and last id.

Parameters

id
required
The identifier of the `ScrapperInfo` to be retrieved (`0` by default).

DefinitionCopy

Example RequestCopy

Parsing incoming webhooks

Oriskami signs its webhooks according to the Json Web Token standard [go to JWT]. The code snippet shows how to parse incoming requests with a middleware function for express and restify.