Compliance

Create a relationship with the travel rule provider

Pass-through proxy API to create a relationship with the travel rule provider (e.g., Notabene)

post/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/post.ts
A function with typed inputs. Its response is checked against the schema.

domainIdstring uuid required

provider'NOTABENE' required

fromstring did

The DID of the source entity. Defaults to the entityDID from the domain credentials.

tostring did required

The DID of the target entity.

{
  "from": "did:web:ripple.com:test:us",
  "to": "did:web:example.com:test:counterparty"
}

Relationship created successfully

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