Get a fraud rule by ID - Lerian

Get a fraud rule by ID

curl --request GET \
  --url https://tracer.sandbox.lerian.net/v1/rules/{id} \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://tracer.sandbox.lerian.net/v1/rules/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://tracer.sandbox.lerian.net/v1/rules/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "action": "DENY",
  "createdAt": "2021-01-01T00:00:00Z",
  "expression": "transaction.amount > 1000 && account.type == 'checking'",
  "name": "Block high-value checking transactions",
  "ruleId": "00000000-0000-0000-0000-000000000000",
  "scopes": [
    {
      "accountId": "00000000-0000-0000-0000-000000000000",
      "merchantId": "00000000-0000-0000-0000-000000000000",
      "portfolioId": "00000000-0000-0000-0000-000000000000",
      "segmentId": "00000000-0000-0000-0000-000000000000",
      "subType": "purchase",
      "transactionType": "CARD"
    }
  ],
  "status": "ACTIVE",
  "updatedAt": "2021-01-01T00:00:00Z",
  "activatedAt": "2021-01-01T00:00:00Z",
  "deactivatedAt": "2021-01-01T00:00:00Z",
  "deletedAt": "2021-01-01T00:00:00Z",
  "description": "Denies transactions over $1000 from checking accounts"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

GET

/

v1

/

rules

/

{id}

Get a fraud rule by ID

curl --request GET \
  --url https://tracer.sandbox.lerian.net/v1/rules/{id} \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://tracer.sandbox.lerian.net/v1/rules/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://tracer.sandbox.lerian.net/v1/rules/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "action": "DENY",
  "createdAt": "2021-01-01T00:00:00Z",
  "expression": "transaction.amount > 1000 && account.type == 'checking'",
  "name": "Block high-value checking transactions",
  "ruleId": "00000000-0000-0000-0000-000000000000",
  "scopes": [
    {
      "accountId": "00000000-0000-0000-0000-000000000000",
      "merchantId": "00000000-0000-0000-0000-000000000000",
      "portfolioId": "00000000-0000-0000-0000-000000000000",
      "segmentId": "00000000-0000-0000-0000-000000000000",
      "subType": "purchase",
      "transactionType": "CARD"
    }
  ],
  "status": "ACTIVE",
  "updatedAt": "2021-01-01T00:00:00Z",
  "activatedAt": "2021-01-01T00:00:00Z",
  "deactivatedAt": "2021-01-01T00:00:00Z",
  "deletedAt": "2021-01-01T00:00:00Z",
  "description": "Denies transactions over $1000 from checking accounts"
}

{
  "code": "ERR-0001",
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example",
  "upstream": {
    "code": "E4001",
    "message": "account not found at provider"
  }
}

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

id

string

required

Rule ID (UUID)

Response

OK

action

string

required

Example:

"DENY"

createdAt

string<date-time>

required

Example:

"2021-01-01T00:00:00Z"

expression

string

required

Example:

"transaction.amount > 1000 && account.type == 'checking'"

name

string

required

Maximum string length: 255

Example:

"Block high-value checking transactions"

ruleId

string<uuid>

required

Example:

"00000000-0000-0000-0000-000000000000"

scopes

object[] | null

required

Show child attributes

status

string

required

Example:

"ACTIVE"

updatedAt

string<date-time>

required

Example:

"2021-01-01T00:00:00Z"

activatedAt

string<date-time>

Example:

"2021-01-01T00:00:00Z"

deactivatedAt

string<date-time>

Example:

"2021-01-01T00:00:00Z"

deletedAt

string<date-time>

Example:

"2021-01-01T00:00:00Z"

description

string

Example:

"Denies transactions over $1000 from checking accounts"