> Toden documentation. For the full index fetch /llms.txt. Every page is available as Markdown by appending .md to its URL. Identity verification uses /api/kyc, Risk Intelligence uses /api/v1; they are separate contracts with different error shapes. Never invent an endpoint, field or enum value: read the API reference page for the operation first.

# Get Travel Rule assessment

GET https://sandbox-api.toden.co/api/v1/transactions/{id}/travel-rule

Reference: https://docs.toden.co/api-reference/risk-intelligence/travel-rule/get-get-travel-ruleassessment

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://sandbox-api.toden.co/api/v1` (Sandbox, default)
- `https://api.toden.co/api/v1` (Production)

## Request

### Path parameters

- `id` (string, required)

### Headers

- `X-Request-Id` (string, optional)

## Response

### 200

Success

- `assessment` (TravelRuleAssessmentResponseAssessment, required)
- `effectiveDecision` (enum, optional)
  - Allowed values: `allow`, `review`, `block`
- `replayed` (boolean, optional)

## Errors

### 400 Bad Request Error

HTTP 400

- `error` (ErrorEnvelopeError, required)

### 401 Unauthorized Error

HTTP 401

- `error` (ErrorEnvelopeError, required)

### 402 Payment Required Error

HTTP 402

- `error` (ErrorEnvelopeError, required)

### 403 Forbidden Error

HTTP 403

- `error` (ErrorEnvelopeError, required)

### 404 Not Found Error

HTTP 404

- `error` (ErrorEnvelopeError, required)

### 409 Conflict Error

HTTP 409

- `error` (ErrorEnvelopeError, required)

### 413 Content Too Large Error

HTTP 400

- `error` (ErrorEnvelopeError, required)

### 422 Unprocessable Entity Error

HTTP 400

- `error` (ErrorEnvelopeError, required)

### 429 Too Many Requests Error

HTTP 429

- `error` (ErrorEnvelopeError, required)

### 500 Internal Server Error

HTTP 500

- `error` (ErrorEnvelopeError, required)

### 502 Bad Gateway Error

HTTP 503

- `error` (ErrorEnvelopeError, required)

### 503 Service Unavailable Error

HTTP 503

- `error` (ErrorEnvelopeError, required)

## Types

### TravelRuleAssessmentResponseAssessment

- `id` (string, required)
- `transactionId` (string, required)
- `state` (enum, required)
  - Allowed values: `not_required`, `pending`, `complete`, `failed`
- `applicability` (enum, required)
  - Allowed values: `not_applicable`, `required`, `unknown`
- `status` (enum, required)
  - Allowed values: `pending`, `complete`, `failed`
- `validationGeneration` (integer, required)
- `decision` (enum, required)
  - Allowed values: `allow`, `review`, `block`
- `transferRecommendation` (enum, required)
  - Allowed values: `proceed`, `hold`, `stop`
- `summary` (TravelRuleAssessmentResponseAssessmentSummary, required)
- `why` (list of string, required)
- `actions` (list of string, required)
- `fields` (TravelRuleAssessmentResponseAssessmentFields, required)
- `issues` (list of TravelRuleAssessmentResponseAssessmentIssuesItems, required)
- `parties` (list of TravelRuleAssessmentResponseAssessmentPartiesItems, required)
- `counterpartyVasp` (TravelRuleAssessmentResponseAssessmentCounterpartyVasp, required)
- `screeningEvidence` (list of TravelRuleAssessmentResponseAssessmentScreeningEvidenceItems, required)
- `failure` (TravelRuleAssessmentResponseAssessmentFailure, required, nullable)
- `policy` (TravelRuleAssessmentResponseAssessmentPolicy, required)
- `informationAttempts` (integer, required)
- `createdAt` (datetime, required)
- `completedAt` (datetime, required, nullable)
- `failedAt` (datetime, required, nullable)

### ErrorEnvelopeError

- `type` (enum, required)
  - Allowed values: `AUTHENTICATION_ERROR`, `PERMISSION_ERROR`, `VALIDATION_ERROR`, `NOT_FOUND`, `CONFLICT`, `IDEMPOTENCY_CONFLICT`, `INSUFFICIENT_CREDIT`, `RATE_LIMITED`, `SERVICE_UNAVAILABLE`, `INTERNAL_ERROR`
- `code` (string, required)
- `message` (string, required)
- `request_id` (string, required, nullable)
- `details` (any, optional)

### TravelRuleAssessmentResponseAssessmentSummary

- `outcome` (enum, required)
  - Allowed values: `information_required`, `review_required`, `blocked`, `ready_to_proceed`, `not_required`, `validation_failed`
- `title` (string, required)
- `description` (string, required)
- `transferStatus` (enum, required)
  - Allowed values: `proceed`, `hold`, `stop`
- `missingInformation` (list of TravelRuleAssessmentResponseAssessmentSummaryMissingInformationItems, required)
- `checks` (TravelRuleAssessmentResponseAssessmentSummaryChecks, required)
- `nextAction` (TravelRuleAssessmentResponseAssessmentSummaryNextAction, required)

### TravelRuleAssessmentResponseAssessmentFields

- `required` (list of string, required)
- `received` (list of string, required)
- `missing` (list of string, required)
- `baseRequired` (list of string, optional) — Always-required fields when the pinned policy also permits alternatives.
- `alternatives` (list of TravelRuleAssessmentResponseAssessmentFieldsAlternativesItems, optional)

### TravelRuleAssessmentResponseAssessmentIssuesItems

- `code` (string, required)
- `severity` (enum, required)
  - Allowed values: `medium`, `high`, `critical`
- `field` (string, required, nullable)
- `role` (string, required, nullable)
- `detectedAt` (datetime, required)

### TravelRuleAssessmentResponseAssessmentPartiesItems

- `role` (enum, required)
  - Allowed values: `originator`, `beneficiary`, `counterparty_vasp`
- `type` (enum, required)
  - Allowed values: `individual`, `business`, `unknown`
- `subject` (TravelRulePartySubject, required, nullable)
- `receivedFields` (list of string, required)

### TravelRuleAssessmentResponseAssessmentCounterpartyVasp

- `linked` (boolean, required)
- `verified` (boolean, required)
- `verifiedAt` (datetime, required, nullable)
- `verificationSource` (enum, required)
  - Allowed values: `entity_kyb`
- `conflictingEvidence` (boolean, required)
- `observedAt` (datetime, required, nullable)
- `id` (string, required, nullable)

### TravelRuleAssessmentResponseAssessmentScreeningEvidenceItems

- `attemptId` (string, required)
- `type` (string, required, nullable)
- `status` (string, required, nullable)
- `outcome` (string, required, nullable)

### TravelRuleAssessmentResponseAssessmentFailure

- `attribution` (enum, required)
  - Allowed values: `provider`, `system`
- `code` (string, required, nullable)

### TravelRuleAssessmentResponseAssessmentPolicy

- `version` (integer, required)

### TravelRuleAssessmentResponseAssessmentSummaryMissingInformationItems

- `key` (string, required)
- `party` (string, required)
- `field` (string, required)
- `label` (string, required)

### TravelRuleAssessmentResponseAssessmentSummaryChecks

- `passed` (integer, required)
- `needsReview` (integer, required)
- `failed` (integer, required)
- `pending` (integer, required)

### TravelRuleAssessmentResponseAssessmentSummaryNextAction

- `type` (enum, required)
  - Allowed values: `submit_information`, `review_transaction`, `retry_validation`, `none`
- `label` (string, required)

### TravelRuleAssessmentResponseAssessmentFieldsAlternativesItems

- `id` (string, required)
- `role` (enum, required)
  - Allowed values: `originator`, `beneficiary`
- `anyOf` (list of list of string, required) — Supply every field in any one group. Paths are fully role-qualified.

### TravelRulePartySubject

- `type` (string, required)
- `id` (string, required)

## Examples

**Response**

```json
{
  "assessment": {
    "id": "string",
    "transactionId": "string",
    "state": "not_required",
    "applicability": "not_applicable",
    "status": "pending",
    "validationGeneration": 1,
    "decision": "allow",
    "transferRecommendation": "proceed",
    "summary": {
      "outcome": "information_required",
      "title": "string",
      "description": "string",
      "transferStatus": "proceed",
      "missingInformation": [
        {
          "key": "string",
          "party": "string",
          "field": "string",
          "label": "string"
        }
      ],
      "checks": {
        "passed": 1,
        "needsReview": 1,
        "failed": 1,
        "pending": 1
      },
      "nextAction": {
        "type": "submit_information",
        "label": "string"
      }
    },
    "why": [
      "string"
    ],
    "actions": [
      "string"
    ],
    "fields": {
      "required": [
        "string"
      ],
      "received": [
        "string"
      ],
      "missing": [
        "string"
      ],
      "baseRequired": [
        "string"
      ],
      "alternatives": [
        {
          "id": "string",
          "role": "originator",
          "anyOf": [
            [
              "string"
            ]
          ]
        }
      ]
    },
    "issues": [
      {
        "code": "string",
        "severity": "medium",
        "field": "string",
        "role": "string",
        "detectedAt": "2024-01-15T09:30:00Z"
      }
    ],
    "parties": [
      {
        "role": "originator",
        "type": "individual",
        "subject": {
          "type": "string",
          "id": "string"
        },
        "receivedFields": [
          "string"
        ]
      }
    ],
    "counterpartyVasp": {
      "linked": true,
      "verified": true,
      "verifiedAt": "2024-01-15T09:30:00Z",
      "verificationSource": "entity_kyb",
      "conflictingEvidence": true,
      "observedAt": "2024-01-15T09:30:00Z",
      "id": "string"
    },
    "screeningEvidence": [
      {
        "attemptId": "string",
        "type": "string",
        "status": "string",
        "outcome": "string"
      }
    ],
    "failure": {
      "attribution": "provider",
      "code": "string"
    },
    "policy": {
      "version": 1
    },
    "informationAttempts": 1,
    "createdAt": "2024-01-15T09:30:00Z",
    "completedAt": "2024-01-15T09:30:00Z",
    "failedAt": "2024-01-15T09:30:00Z"
  },
  "effectiveDecision": "allow",
  "replayed": true
}
```

**SDK Code**

```python
import requests

url = "https://sandbox-api.toden.co/api/v1/transactions/id/travel-rule"

headers = {"Authorization": "Bearer <apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://sandbox-api.toden.co/api/v1/transactions/id/travel-rule';
const options = {method: 'GET', headers: {Authorization: 'Bearer <apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://sandbox-api.toden.co/api/v1/transactions/id/travel-rule"

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

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

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://sandbox-api.toden.co/api/v1/transactions/id/travel-rule")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://sandbox-api.toden.co/api/v1/transactions/id/travel-rule")
  .header("Authorization", "Bearer <apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://sandbox-api.toden.co/api/v1/transactions/id/travel-rule', [
  'headers' => [
    'Authorization' => 'Bearer <apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://sandbox-api.toden.co/api/v1/transactions/id/travel-rule");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://sandbox-api.toden.co/api/v1/transactions/id/travel-rule")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```