{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/payments-odl/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"RippleNet addressing scheme","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com/products/custody","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"ripplenet-addressing-scheme","__idx":0},"children":["RippleNet addressing scheme"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["RippleNet addresses are allocated by the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["RippleNet Committee"]}," to institutions based on the following agreed format and are consistent with the open Interledger Protocol (ILP) ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://interledger.org/rfcs/0015-ilp-addresses/#global-allocation-scheme"},"children":["global allocation scheme"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Warning:"]}," RippleNet addresses must be allocated by the RippleNet Committee before use on RippleNet."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Caution:"]}," You cannot change your RippleNet address after peering with a partner."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"ripplenet-address-scheme-and-requirements","__idx":1},"children":["RippleNet address scheme and requirements"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["RippleNet addresses follow a scheme based on the following agreed format:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{NETWORK_ALLOCATION}_{COUNTRY_CODE}_{INSTITUTION}_{NODE_ADDRESS}"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each segment MUST contain one or more of the following characters:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Alphanumeric characters, upper or lower case. (Addresses are case-sensitive so that they can contain data encoded in formats such as base64url.)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Underscore (_)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Tilde (~)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Hyphen (-)"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"network-allocation-scheme","__idx":2},"children":["Network allocation scheme"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["RippleNet supports the following ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["network allocation schemes"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uat."]}," (User Acceptance Testing)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["test."]}," (Customer Development and System Integration Testing)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rn."]}," (Production)"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," In production, RippleNet uses the prefix ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rn."]}," and not ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["g."]}," as defined by ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://interledger.org/rfcs/0015-ilp-addresses/#global-allocation-scheme"},"children":["ILP"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"country-code","__idx":3},"children":["Country code"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["country code"]}," must be in ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3"},"children":["ISO3166-1-Alpha-3"]}," format to ensure correct routing."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following entries are examples of valid ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["ISO3166-1-Alpha-3"]}," country codes:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["usa."]}," (United States)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gbr."]}," (Great Britain)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tha."]}," (Thailand)"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," For Customer Development and System Integration Testing (SIT) instances hosted on AWS or EKS, the country code is substituted with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".cloud."]}," infix."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"institution","__idx":4},"children":["Institution"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["institution"]}," entry must be approved by the RippleNet Committee to confirm that it is unique, and there is no conflict with an existing network partner."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following entries are examples of valid example institution scheme components."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["north_bank."]}," (North Bank)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["south_bank."]}," (South Bank)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mighty_bank."]},"  (Mighty Bank)"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," A testing partner to a Customer Development and SIT instance should have ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-testpeer"]}," added to its institution infix. For example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["test.cloud.north_bank-testpeer"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"node-address-optional","__idx":5},"children":["Node address (optional)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["node address"]}," (of the installed Ripple software) may be allocated as required by the partner institution to identify branches and services. They can include child nodes."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example-rnthamighty_bankregionaleast","__idx":6},"children":["Example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rn.tha.mighty_bank.regional.east"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The string ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rn.tha.mighty_bank.regional.east"]}," is an example of a well-formed RippleNet address name that could refer to an address with the following traits:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Network allocation scheme"]},": A production RippleNet network allocation."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Country code"]},": Based in Thailand."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Institution"]},": Operated by the Mighty Bank."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Node address (optional)"]},": Referring to the regional instance for remittance services."]}]}]},"headings":[{"value":"RippleNet addressing scheme","id":"ripplenet-addressing-scheme","depth":1},{"value":"RippleNet address scheme and requirements","id":"ripplenet-address-scheme-and-requirements","depth":2},{"value":"Network allocation scheme","id":"network-allocation-scheme","depth":3},{"value":"Country code","id":"country-code","depth":3},{"value":"Institution","id":"institution","depth":3},{"value":"Node address (optional)","id":"node-address-optional","depth":3},{"value":"Example: rn.tha.mighty_bank.regional.east","id":"example-rnthamighty_bankregionaleast","depth":2}],"frontmatter":{"seo":{"title":"RippleNet addressing scheme"}},"lastModified":"2025-10-03T17:57:05.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/payments-odl/api-docs/ripplenet/resources/ripplenet-addressing-scheme","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}