Screen Transaction
Screen a transaction against AML data. Returns whether the transaction is flagged, its risk score/band, and the flagged participant addresses with their roles, scores, severities and categories.
Path Parameters
Represents the specific blockchain protocol name, e.g. ethereum, ethereum-classic, binance-smart-chain.
String identifier (hash) of the transaction to screen against AML data
Query Parameters
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.
Response Schema
-
200Content-Type: application/json
The transaction was screened successfully against AML data.
-
400Content-Type: application/json
400
-
401Content-Type: application/json
401
-
402Content-Type: application/json
You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.
-
403Content-Type: application/json
403
-
404Content-Type: application/json
The specified transaction has not been found on the specific blockchain.
-
409Content-Type: application/json
The data provided seems to be invalid.
-
415Content-Type: application/json
The selected Media Type is unavailable. The Content-Type header should be 'application/json'.
-
422Content-Type: application/json
Your request body for POST requests must have a structure of { data: { item: [...properties] } }
-
429Content-Type: application/json
The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.
-
500Content-Type: application/json
An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.
Whether any participant in the transaction is AML-flagged
Risk band derived from the highest score: low, medium, high, or severe
Highest AML risk score across the transaction's participants (0 = no risk, 100 = severe)
Participants of the transaction that are AML-flagged
The flagged participant address
Highest severity across the address's AML sources (critical, high, medium, low, info)
Risk band for this address: low, medium, high, or severe
AML risk score for this address (0-100)
Role in the transaction: sender, recipient, token_sender, or token_recipient
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.
insufficient_credits
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.
blockchain_data_transaction_not_found
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.
invalid_data
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.
unsupported_media_type
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.
invalid_request_body_structure
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.
request_limit_reached
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Specifies the version of the API that incorporates this endpoint.
Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.
In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.
unexpected_server_error
Specifies an error code, e.g. error 404.
Specifies the message of the error, i.e. why the error was returned, e.g. error 404 stands for “not found”.
Specifies an attribute of the error by name.
Specifies the details of an attribute as part from the error.
Credits Cost : 500000 Credits for 1 Results
API Key
-
200Content-Type: application/json
The transaction was screened successfully against AML data.
-
400Content-Type: application/json
400
-
401Content-Type: application/json
401
-
402Content-Type: application/json
You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.
-
403Content-Type: application/json
403
-
404Content-Type: application/json
The specified transaction has not been found on the specific blockchain.
-
409Content-Type: application/json
The data provided seems to be invalid.
-
415Content-Type: application/json
The selected Media Type is unavailable. The Content-Type header should be 'application/json'.
-
422Content-Type: application/json
Your request body for POST requests must have a structure of { data: { item: [...properties] } }
-
429Content-Type: application/json
The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.
-
500Content-Type: application/json
An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.
{
"apiVersion": "2024-12-12",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"data": {
"item": {
"isFlagged": true,
"riskBand": "severe",
"riskScore": 87,
"flaggedAddresses": [
{
"address": "0x7f367cc41522ce07553e823bf3be79a889debe1b",
"categories": [
"sanctions"
],
"highestSeverity": "critical",
"riskBand": "severe",
"riskScore": 87,
"role": "recipient"
}
]
}
}
}{
"apiVersion": "2024-12-12",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "uri_not_found",
"message": "The specified URI has not been found. Check the URI and try again.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2024-12-12",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "limit_greater_than_allowed",
"message": "You have reached the allowed limit. The maximum number of items for this endpoint is {limit}, please use the specific pagination attributes to get the items in portions.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2024-12-12",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "invalid_pagination",
"message": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2024-12-12",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "missing_api_key",
"message": "The specific authorization header (API Key) is missing, please check our Authorization section in our Documentation.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2024-12-12",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "invalid_api_key",
"message": "The provided API key is invalid. Please, generate a new one from your Dashboard.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2024-12-12",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "insufficient_credits",
"message": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2024-12-12",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "banned_ip_address",
"message": "This IP address has been banned. To check the reason for that, please contact our team via email.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2024-12-12",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "endpoint_not_allowed_for_plan",
"message": "This endpoint is not available for your current subscription plan, please upgrade your plan to be able to use it.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2024-12-12",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "endpoint_not_allowed_for_api_key",
"message": "This endpoint is not available for your API key.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2024-12-12",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "feature_mainnets_not_allowed_for_plan",
"message": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2024-12-12",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "blockchain_data_transaction_not_found",
"message": "The specified transaction has not been found on the specific blockchain.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2024-12-12",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "invalid_data",
"message": "The data provided seems to be invalid.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2024-12-12",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "unsupported_media_type",
"message": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2024-12-12",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "invalid_request_body_structure",
"message": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2024-12-12",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "request_limit_reached",
"message": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}{
"apiVersion": "2024-12-12",
"requestId": "601c1710034ed6d407996b30",
"context": "yourExampleString",
"error": {
"code": "unexpected_server_error",
"message": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.",
"details": [
{
"attribute": "attribute which content caused the error",
"message": "message describing the error"
}
]
}
}