Submit Travel Rule information

POST

/transactions/:id/travel-rule/information

POST

/api/v1/transactions/:id/travel-rule/information

curl -X POST https://sandbox-api.toden.co/api/v1/transactions/id/travel-rule/information \
     -H "Idempotency-Key: Idempotency-Key" \
     -H "Authorization: Bearer <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "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
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired1-200 characters

Request

This endpoint expects an object.

originatorobjectOptional

beneficiaryobjectOptional

counterpartyVaspobjectOptional

Response

Success

assessmentobject

effectiveDecisionenumOptional

Allowed values:

replayedbooleanOptional

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

413

Content Too Large Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

502

Bad Gateway Error

503

Service Unavailable Error

Authentication

Path parameters

Headers

Request

Response

Errors