Evaluate policy

POST

/v2/compliance/evaluate

• Staging
• Development

Evaluate a policy decision using Open Policy Agent (OPA) rules against provided subject, organization, request, transaction, and environment data.

Authorizations

• X-API-Key
• X-API-Secret

Parameters

Header Parameters

X-API-Key

string

API Key

X-API-Secret

string

API Secret

Request Body ^required

object

subject

required

The subject of the policy - user or api key

object

id

required

Subject ID

string

e271bc5c-f870-44cd-8462-54280d0411f6

name

required

Subject name

string

John Doe

scopes

required

Subject scopes and claims

object

kycStatus

required

KYC verification status

string

Allowed values: NOT_STARTED PENDING IN_PROGRESS UNDER_REVIEW APPROVED REJECTED FLAGGED EXPIRED CANCELLED VERIFIED

PENDING

organisation

required

The organization of the policy

object

id

required

Organisation ID

string

e271bc5c-f870-44cd-8462-54280d0411f6

name

required

Organisation name

string

ACME Corp

scopes

required

Organisation scopes

Array<string>

[
  "read",
  "write"
]

kycStatus

required

KYB verification status

string

Allowed values: NOT_STARTED PENDING IN_PROGRESS UNDER_REVIEW APPROVED REJECTED FLAGGED EXPIRED CANCELLED VERIFIED

NOT_STARTED

request

required

The request details

object

context

required

Request context

object

event

required

Event name

string

io.fsco.payment.initiated

service

required

Service name

string

payment

function

required

Function name

string

transfer

jurisdiction

required

Jurisdiction

string

US

transaction

required

The transaction details

object

source

required

Transaction source

object

destination

required

Transaction destination

object

execution

required

Transaction execution details

object

corridor

Transaction corridor

string

US-EU

environment

required

The environment of the policy execution

object

stage

required

Environment stage

string

production

region

required

Region

string

us-east-1

provider

Provider

string

aws

version

Version

string

1.0.0

Responses

201

The policy evaluation result with allow/deny decision and detailed rulings.

object

request

required

The original request

object

subject

required

The subject of the policy - user or api key

object

id

required

Subject ID

string

e271bc5c-f870-44cd-8462-54280d0411f6

name

required

Subject name

string

John Doe

scopes

required

Subject scopes and claims

object

kycStatus

required

KYC verification status

string

Allowed values: NOT_STARTED PENDING IN_PROGRESS UNDER_REVIEW APPROVED REJECTED FLAGGED EXPIRED CANCELLED VERIFIED

PENDING

organisation

required

The organization of the policy

object

id

required

Organisation ID

string

e271bc5c-f870-44cd-8462-54280d0411f6

name

required

Organisation name

string

ACME Corp

scopes

required

Organisation scopes

Array<string>

[
  "read",
  "write"
]

kycStatus

required

KYB verification status

string

Allowed values: NOT_STARTED PENDING IN_PROGRESS UNDER_REVIEW APPROVED REJECTED FLAGGED EXPIRED CANCELLED VERIFIED

NOT_STARTED

request

required

The request details

object

context

required

Request context

object

event

required

Event name

string

io.fsco.payment.initiated

service

required

Service name

string

payment

function

required

Function name

string

transfer

jurisdiction

required

Jurisdiction

string

US

transaction

required

The transaction details

object

source

required

Transaction source

object

destination

required

Transaction destination

object

execution

required

Transaction execution details

object

corridor

Transaction corridor

string

US-EU

environment

required

The environment of the policy execution

object

stage

required

Environment stage

string

production

region

required

Region

string

us-east-1

provider

Provider

string

aws

version

Version

string

1.0.0

response

required

The evaluation response

object

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error