Compliance

List all relationships registered with the travel rule provider

Pass-through proxy API to list all relationships from the travel rule provider (e.g., Notabene)

get/v1/domains/{domainId}/compliance/travel-rule/providers/{provider}/relationships

Request

Base URL
https://docs.ripple.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ripple/apis/ripple-custody-api/docs/v1/domains/:domainId/compliance/travel-rule/providers/:provider/relationships/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

domainIdstring uuid required

provider'NOTABENE' required

Query parameters

fromstring did

Filter by 'from' DID (Decentralized Identifier)

tostring did

Filter by 'to' DID (Decentralized Identifier)

custodianstring did

Filter by custodian DID (Decentralized Identifier)

Response

Relationships retrieved successfully

Example response

{
  "relationships": [
    {
      "@id": "urn:uuid:12345678-1234-1234-1234-123456789abc",
      "from": "did:web:ripple.com:test:us",
      "to": "did:web:example.com:test:counterparty",
      "custodian": "did:web:custodian.com:test:vault",
      "status": "CONFIRMED",
      "confirmedBy": "did:web:example.com:test:counterparty",
      "proofs": [
        {
          "address": "0x1234567890abcdef1234567890abcdef12345678",
          "chain": "ethereum",
          "status": "VERIFIED",
          "signature": "0xabcdef...",
          "message": "I own this address",
          "timestamp": "2026-03-10T14:30:00.0000000+00:00"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 3 revisions of this API.