API documentation

Authentication

After creating an account, issue an API key from the API Keys section and include it in the header of every request.

1. Sign up or sign in to the user panel.
2. Open API Keys and create a new key.
3. Send the key value in the X-API-Key header.

Base URL: https://api.aryacrypto.net

Pricing

The amounts below are loaded from the pricing service and update automatically when tariffs change.

For programmatic access, call GET /v1/pricing.

Balance

Returns the account token balance. Requires the X-API-Key header and does not debit credits.

Alias path: GET /v1/balance

curl -s "https://api.aryacrypto.net/v1/account/balance" \
  -H "X-API-Key: ak_live_..."

Response fields

Response language

Set message and report language with the locale parameter in the query string or request body. Ten languages are supported.

Allowed values

Supported networks

Active networks available through the API. For address checks, send the network symbol in the asset parameter.

Loading…

Address and transaction check

The supported report mode is Pro. Submit a check with POST /v1/check; the response is typically pending and includes a uid. Retrieve the completed result with POST /v1/checks/status, or register an address-check webhook to be notified automatically when analysis finishes.

Cost per check request: 1 token(s).

Procedure

1. Send POST /v1/check with the X-API-Key header and the asset and hash parameters.
2. Store data.uid from the response. The initial status is typically pending.
3. Poll POST /v1/checks/status with the uid until data.status is success — or register a webhook via the API Keys page / API so we POST the same result when done (events check.completed / check.failed, signed with X-AML-Signature).

Submit request

Content-Type: application/json · multipart/form-data · application/x-www-form-urlencoded

Parameters

chain may be used instead of asset, and input instead of hash. The supported flow value is pro. Body may be JSON or form-data / x-www-form-urlencoded (Postman form-data is supported).

Request example

curl -s -X POST "https://api.aryacrypto.net/v1/check" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: ak_live_..." \
  -d '{"asset":"BTC","hash":"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh","locale":"fa"}'

data.status values

Submit response fields

Retrieve result

Repeat the status request while data.status is pending. After success, Pro report fields are returned in data. Status polling does not consume additional credits. If you have an enabled webhook, you can wait for the delivery POST instead of continuous polling.

Equivalent GET method: GET /v1/checks/status?uid=...

Parameters

Status request example

curl -s -X POST "https://api.aryacrypto.net/v1/checks/status" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: ak_live_..." \
  -d '{"uid":"00481233","locale":"fa"}'

Pro report fields (after success)

After processing completes, the following fields are returned in data.

When available, the PDF URL is provided in data.pdfReport.

Address-check webhooks (AML)

When Pro analysis finishes (success or permanent failure), we POST JSON to your registered URL so you do not need to keep polling /v1/checks/status. This webhook is for address checks, not KYC.

You can manage the webhook from the API Keys page in the user panel.

What we POST to you

After a successful finish (including pdfReport when ready) or a permanent analysis failure, we POST to your enabled URL with Content-Type: application/json. The body matches the status envelope, plus an event field.

Delivery payload fields

Fields we send to your endpoint:

{
  "event": "check.completed",
  "result": true,
  "balance": 42.5,
  "flow": "pro",
  "data": {
    "uid": "00481233",
    "status": "success",
    "asset": "BTC",
    "network": "BTC",
    "address": "bc1q...",
    "hasBlackListFlag": false,
    "riskscore": 0.12,
    "pdfReport": "/v1/reports/pdf/...",
    "timestamp": "2026-07-25 12:00:00",
    "flow": "pro"
  }
}

Signature verification

If you set a secret for the webhook in the panel, the X-AML-Signature header is the hex-encoded HMAC-SHA256 of the raw request body using that secret. Verify the signature on your server before processing.

# X-AML-Signature = hex(HMAC-SHA256(request_body, secret))
# Verify with the raw POST body bytes and your webhook secret from the panel.

Automatic monitoring (KYT)

Periodic address monitoring. After registration, use the monitor identifier to retrieve details and snapshots.

Approximate cost per automatic run: 0.2 token(s).

Single registration

curl -s -X POST "https://api.aryacrypto.net/v1/kyt/monitors" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: ak_live_..." \
  -d '{"chain":"tron","address":"TXYZ...","label":"Hot wallet","interval_hours":6}'

Bulk registration

Submit multiple addresses in the items array. The response includes created, failed, and skipped counts.

List, detail, and delete

Use the monitor identifier to list, inspect, retrieve snapshots, or delete monitors.

Identity verification (KYC)

B2B identity verification: create a business in the panel with a callback URL to get an 8-digit business_code, create a request via API, send verification_url to the end user, and receive the result on your callback.

Each request costs approximately 5 token(s) under the active tariff (charged on a final state: completed, cancelled, or expired).

Flow

1. In the panel KYC section, create a business (name + callback_url) and store the business_code.
2. POST /v1/kyc-service/requests with X-API-Key and give the returned verification_url to the end user.
3. The user has 30 minutes to submit documents in the verification web app.
4. When finished (accept, reject, review, cancel, or expiry), we POST JSON to your business callback_url.

Create request and link

Content-Type: application/json

Parameters

curl -s -X POST "https://api.aryacrypto.net/v1/kyc-service/requests" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: ak_live_..." \
  -d '{"business_code":"90593008","external_ref":"user-42","doc_type":"id_card","return_url":"https://example.com/kyc/done"}'

Create response

The response includes the request object and verification_url. Credits are not deducted at create time; they are charged on a final state.

{
  "request": {
    "id": "a1b2c3d4-....",
    "status": "pending",
    "external_ref": "user-42",
    "doc_type": "id_card",
    "expires_at": "2026-07-27T13:00:00Z",
    "cost_credits": 10
  },
  "verification_url": "https://kyc.aryacrypto.net/v/a1b2c3d4-...."
}

Status and cancel

Fetch request status with GET, or cancel with POST cancel from the business side (cancel is also billable).

Result webhook (callback)

When the request reaches a final state, we POST to the business callback_url with Content-Type: application/json.

{
  "event": "kyc.completed",
  "request_id": "a1b2c3d4-....",
  "external_ref": "user-42",
  "status": "completed",
  "decision": "reject",
  "match_score": 62,
  "risk_score": 95,
  "risk_level": "high",
  "screening": {
    "risk_score": 95,
    "risk_level": "high",
    "lists_available": true,
    "hit_count": 1,
    "hits": [
      {
        "source": "OFAC",
        "category": "sanction",
        "matched_name": "VLADIMIR PETROV",
        "score": 95
      }
    ]
  },
  "completed_at": "2026-07-27T12:45:00Z"
}

If the business has a callback secret, X-AML-Signature is the hex-encoded HMAC-SHA256 of the raw body.

Business verification (KYB)

KYB verification service: create a business with a callback in the panel, create a request via API, submit company/UBO data directly, and receive the result via webhook.

Each request is charged on a final status (approved, rejected, or cancelled) at about 25 tokens (kyb_verify tariff).

How it works

1. In the panel under «Business verification KYB», create a business (name + callback_url) and store the business_code.
2. With X-API-Key, POST /v1/kyb-service/requests and share form_url with the company representative (or include company_name and ubos in the same request).
3. The public form is valid for up to 7 days; after submit, international screening runs and status becomes review.
4. Approve or reject with POST review; then event=kyb.completed is sent to your callback and tokens are deducted.

Create request / form link

Content-Type: application/json

curl -s -X POST "https://api.aryacrypto.net/v1/kyb-service/requests" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: ak_live_..." \
  -d '{"business_code":"90593008","external_ref":"corp-42","return_url":"https://example.com/kyb/done"}'

Create response

{
  "request": { "id": "....", "status": "pending", "cost_credits": 25, "expires_at": "..." },
  "form_url": "https://my.aryacrypto.net/kyb/form/...."
}

Track, report, review, cancel

KYB result webhook

On a final status we POST event=kyb.completed to your callback_url.

{
  "event": "kyb.completed",
  "request_id": "....",
  "external_ref": "corp-42",
  "status": "approved",
  "decision": "clear",
  "risk_score": 18,
  "edd_required": false,
  "company_name": "Acme Ltd",
  "lei": "....",
  "completed_at": "2026-07-29T12:00:00Z"
}

When callback_secret is set, X-AML-Signature is the hex HMAC-SHA256 of the raw body.

Error codes

On failure, the response is typically JSON containing an error field.