Transaction Analysis

This endpoint allows you to register a transaction and initiate the analysis process to ensure regulatory compliance.

URL: https://app.rillis.io/api/v1/verification/send

Method: POST

Request

Authentication Properties

Parameter	Type	Required	Description
client_id	String	Yes	Your unique client identifier.
client_secret	String	Yes	Your secret key for API authentication.

Transaction Properties

Parameter	Type	Required	Description
client_transaction_id	String	Yes	A unique identifier for the transaction, assigned by your system.
transaction_type	Enum	Yes	Transaction type: "fiat" or "crypto".
sending_dollar_amount	Number	Yes	Amount in US dollars.
sending_amount	Number	Yes	Amount to be sent by the sender.
sending_currency	String	Yes	Currency to be sent by the sender (e.g., "USD", "EUR", "BTC").
receiving_amount	Number	Yes	Amount to be received by the beneficiary.
receiving_currency	String	Yes	Currency to be received by the beneficiary (e.g., "USD", "EUR", "BTC").
crypto_network	String	For crypto	Type of cryptocurrency network (e.g., "Bitcoin", "Ethereum"). Required for crypto transactions.
crypto_asset	String	For crypto	Type of asset (e.g., "BTC", "ETH"). Required for crypto transactions.
sending_wallet	String	For crypto	Sender's wallet address. Required for crypto transactions.
receiving_wallet	String	For crypto	Beneficiary's wallet address. Required for crypto transactions.

Example Request (Fiat Transaction)

{
  "client_id": "your_client_id",
  "client_secret": "your_client_secret",
  "client_transaction_id": "transaction_12345",
  "transaction_type": "fiat",
  "sending_dollar_amount": 100,
  "sending_amount": 100,
  "sending_currency": "USD",
  "receiving_amount": 92,
  "receiving_currency": "EUR"
}

Example Request (Crypto Transaction)

{
  "client_id": "your_client_id",
  "client_secret": "your_client_secret",
  "client_transaction_id": "transaction_67890",
  "transaction_type": "crypto",
  "sending_dollar_amount": 1000,
  "sending_amount": 0.05,
  "sending_currency": "BTC",
  "receiving_amount": 1000,
  "receiving_currency": "USD",
  "crypto_network": "Bitcoin",
  "crypto_asset": "BTC",
  "sending_wallet": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
  "receiving_wallet": "3J98t1WpEZ73CNmQviecrnyiWrnqRhWNLy"
}

Response

A successful request will return a JSON response with the following properties:

Parameter	Type	Description
success	Boolean	Indicates whether the request was successful.
message	String	A message describing the result of the operation.
transaction_id	String	The unique identifier for the transaction in the Rillis system.
client_transaction_id	String	The unique identifier for the transaction provided in the request.
status	Enum	Current status of the transaction: "PENDING", "IN_PROGRESS", "COMPLETED", "REJECTED", or "MANUAL_REVIEW".

Example Response

{
  "success": true,
  "message": "Transaction registered successfully",
  "transaction_id": "rillis_tx_12345",
  "client_transaction_id": "transaction_12345",
  "status": "PENDING"
}

Error Responses

In case of an error, the API will return an appropriate HTTP status code along with a JSON response containing error details:

Status Code	Description
400	Bad Request - The request was invalid or cannot be processed.
401	Unauthorized - Authentication credentials are missing or invalid.
403	Forbidden - The client does not have permission to access the requested resource.
429	Too Many Requests - The client has sent too many requests in a given amount of time.
500	Internal Server Error - An error occurred on the server.

Example Error Response

{
  "success": false,
  "error": "Invalid transaction type",
  "error_code": "INVALID_PARAMETER",
  "details": "Transaction type must be either 'fiat' or 'crypto'"
}

Notes

The analysis process typically takes approximately 30 seconds to complete.

You can check the status of a transaction using the Transaction Status endpoint.

If you have configured a webhook, you will receive a notification when the transaction status changes.

Each client_transaction_id must be unique across all your transactions.

Rate Limits

Maximum of 100 requests per minute.

Maximum of 1,000 requests per hour.

Maximum of 10,000 requests per day.

Exceeding these limits will result in a 429 Too Many Requests response.

Transaction Analysis

Request#

Authentication Properties#

Transaction Properties#

Example Request (Fiat Transaction)#

Example Request (Crypto Transaction)#

Response#

Example Response#

Error Responses#

Example Error Response#

Notes#

Rate Limits#