{"templateId":"markdown","versions":[{"version":"v1.43","label":"v1.43 LTS","link":"/products/custody/compliance/travel-rule/outgoing-with-pii","default":true,"active":false,"folderId":"c15a2701"},{"version":"v1.42","label":"v1.42 STS","link":"/products/custody/v1.42/compliance/travel-rule/outgoing-with-pii","default":false,"active":true,"folderId":"c15a2701"},{"version":"v1.41","label":"v1.41 STS","link":"/products/custody/v1.41/compliance/travel-rule/outgoing-with-pii","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.34","label":"v1.34 LTS","link":"/products/custody/v1.34/compliance/travel-rule/outgoing-with-pii","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.26","label":"v1.26 LTS","link":"/products/custody/v1.26/compliance/travel-rule/outgoing-with-pii","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.19","label":"v1.19 LTS","link":"/products/custody/v1.19/compliance/travel-rule/outgoing-with-pii","default":false,"active":false,"folderId":"c15a2701"},{"version":"v1.15","label":"v1.15 LTS","link":"/products/custody/v1.15/compliance/travel-rule/outgoing-with-pii","default":false,"active":false,"folderId":"c15a2701"}],"sharedDataIds":{"sidebar":"sidebar-products/custody/@v1.15/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Send assets with PII","description":"User guides, API reference, and support resources.","siteUrl":"https://docs.ripple.com","lang":"en-US"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"send-assets-with-pii","__idx":0},"children":["Send assets with PII"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This workflow covers outgoing transfers where you must submit PII (Personally Identifiable Information). You create the Travel Rule message, collect PII from your end user, submit it through the API, and then create the transfer intent with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["suggestedIntentId"]}," the message returns."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Creating the message first is the only supported entry path. ","Ripple Custody"," doesn't create a Notabene transfer from a transfer intent on its own."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.42/compliance/travel-rule/setup"},"children":["Travel Rule setup"]}," complete."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Wallet addresses registered with Notabene. ","Ripple Custody"," registers them automatically when you connect your Notabene account and when you create new wallets."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"process-flow","__idx":2},"children":["Process flow"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"sequenceDiagram\n participant Customer\n participant EndUser as End User\n participant Custody\n participant Notabene\n participant Blockchain\n\n Customer->>Custody: 1. Create Travel Rule message\n Custody->>Notabene: Forward to Notabene\n Notabene-->>Custody: Return transfer details\n Custody-->>Customer: Return suggestedIntentId, complianceTravelRuleId,
transfer details (including travelRulePolicyId)\n\n Customer->>Custody: 2. Get transfer status (check PII requirements)\n Custody-->>Customer: Return isTravelRule, presentationDefinitionUrl\n\n Customer->>EndUser: 3. Request PII\n EndUser-->>Customer: Provide PII\n\n Customer->>Custody: 4. Submit PII via API\n Custody->>Notabene: Forward PII\n Notabene-->>Custody: PII attached\n Custody-->>Customer: Confirmed\n\n Customer->>Custody: 5. Create Transfer Order Intent (using suggestedIntentId)\n\n Custody->>Custody: 6. Screen risk (if configured)\n alt Screening failed\n Custody->>Custody: AUTO_REJECTED (no Travel Rule check)\n else Screening passed or not configured\n Custody->>Notabene: 7. Travel Rule check\n end\n\n Custody->>Custody: 8. Compliance decision\n\n alt AUTO_APPROVED\n Custody->>Blockchain: 9. Execute transaction\n Custody->>Notabene: Notify settlement\n else AUTO_REJECTED\n Custody->>Notabene: Notify rejection\n end\n","diagramHtml":"BlockchainNotabeneCustodyEnd UserCustomerBlockchainNotabeneCustodyEnd UserCustomeralt[Screening failed][Screening passed or notconfigured]alt[AUTO_APPROVED][AUTO_REJECTED]1. Create Travel Rule messageForward to NotabeneReturn transfer detailsReturn suggestedIntentId, complianceTravelRuleId,transfer details (including travelRulePolicyId)2. Get transfer status (check PII requirements)Return isTravelRule, presentationDefinitionUrl3. Request PIIProvide PII4. Submit PII via APIForward PIIPII attachedConfirmed5. Create Transfer Order Intent (using suggestedIntentId)6. Screen risk (if configured)AUTO_REJECTED (no Travel Rule check)7. Travel Rule check8. Compliance decision9. Execute transactionNotify settlementNotify rejection","diagramHtmlDark":"BlockchainNotabeneCustodyEnd UserCustomerBlockchainNotabeneCustodyEnd UserCustomeralt[Screening failed][Screening passed or notconfigured]alt[AUTO_APPROVED][AUTO_REJECTED]1. Create Travel Rule messageForward to NotabeneReturn transfer detailsReturn suggestedIntentId, complianceTravelRuleId,transfer details (including travelRulePolicyId)2. Get transfer status (check PII requirements)Return isTravelRule, presentationDefinitionUrl3. Request PIIProvide PII4. Submit PII via APIForward PIIPII attachedConfirmed5. Create Transfer Order Intent (using suggestedIntentId)6. Screen risk (if configured)AUTO_REJECTED (no Travel Rule check)7. Travel Rule check8. Compliance decision9. Execute transactionNotify settlementNotify rejection"},"children":["sequenceDiagram\n participant Customer\n participant EndUser as End User\n participant Custody\n participant Notabene\n participant Blockchain\n\n Customer->>Custody: 1. Create Travel Rule message\n Custody->>Notabene: Forward to Notabene\n Notabene-->>Custody: Return transfer details\n Custody-->>Customer: Return suggestedIntentId, complianceTravelRuleId,
transfer details (including travelRulePolicyId)\n\n Customer->>Custody: 2. Get transfer status (check PII requirements)\n Custody-->>Customer: Return isTravelRule, presentationDefinitionUrl\n\n Customer->>EndUser: 3. Request PII\n EndUser-->>Customer: Provide PII\n\n Customer->>Custody: 4. Submit PII via API\n Custody->>Notabene: Forward PII\n Notabene-->>Custody: PII attached\n Custody-->>Customer: Confirmed\n\n Customer->>Custody: 5. Create Transfer Order Intent (using suggestedIntentId)\n\n Custody->>Custody: 6. Screen risk (if configured)\n alt Screening failed\n Custody->>Custody: AUTO_REJECTED (no Travel Rule check)\n else Screening passed or not configured\n Custody->>Notabene: 7. Travel Rule check\n end\n\n Custody->>Custody: 8. Compliance decision\n\n alt AUTO_APPROVED\n Custody->>Blockchain: 9. Execute transaction\n Custody->>Notabene: Notify settlement\n else AUTO_REJECTED\n Custody->>Notabene: Notify rejection\n end\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1-create-travel-rule-message","__idx":3},"children":["Step 1: Create Travel Rule message"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a Travel Rule message with counterparty information:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"POST /v1/domains/{domainId}/compliance/travel-rule/providers/NOTABENE/messages\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Notabene is the only supported Travel Rule provider, so the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["provider"]}," path segment is always ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NOTABENE"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body"]},":"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["originator"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Originator identifier (contains ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@id"]}," - DID or identifier for the party)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["beneficiary"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Beneficiary identifier (contains ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@id"]}," - DID or identifier for the party)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["asset"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Asset identifier (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bip122:000000000019d6689c085ae165831e93/slip44:0"]},"). See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://devx.notabene.id/docs/supported-assets"},"children":["Notabene asset registry"]}," for supported formats."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transfer amount"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ref"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reference identifier for the transfer"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["agents"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Agents involved in the transfer. Each agent has ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["for"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["role"]}," (values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VASP"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Custodian"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SettlementAddress"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SourceAddress"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Gateway"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Unknown"]},")"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]},":"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createTransfer201Response.transfer"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transfer details from Notabene. If the beneficiary VASP attached a Notabene policy to the transfer, the details include that policy's ID. Use it as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{travelRulePolicyId}"]}," in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#option-c-present-encrypted-pii-for-a-specific-policy-stored-on-receiver-side-only"},"children":["Step 4, Option C"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["suggestedIntentId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string (uuid)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The intent ID to use when creating the transfer intent"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["complianceTravelRuleId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string (uuid)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ID of this Travel Rule record in ","Ripple Custody",". Use it as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{travelRuleId}"]}," in the status and PII endpoints."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-check-pii-requirements","__idx":4},"children":["Step 2: Check PII requirements"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get the transfer to check whether Notabene requires PII and what the counterparty requests:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"GET /v1/domains/{domainId}/compliance/travel-rule/providers/NOTABENE/messages/{travelRuleId}\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["complianceTravelRuleId"]}," from Step 1 as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{travelRuleId}"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key response fields"]},":"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transfer.isTravelRule"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the transfer requires Travel Rule compliance."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transfer.presentationDefinitionUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["URL of the presentation definition that lists the PII the counterparty requires."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transfer.status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Notabene transfer status."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fetch the document at ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["presentationDefinitionUrl"]},". A presentation definition is a JSON document, in the Presentation Exchange format, that lists the IVMS-101 fields the beneficiary VASP's jurisdiction requires. Notabene publishes one per jurisdiction."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-3-collect-pii-from-end-user","__idx":5},"children":["Step 3: Collect PII from end user"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Collect required PII from your end user according to the IVMS-101 standard and the requirements in the presentation definition from Step 2."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-4-submit-pii-via-api","__idx":6},"children":["Step 4: Submit PII via API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Notabene offers two ways to attach PII to a transfer, and ","Ripple Custody"," exposes both:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Append"]}," (Option A). You submit plaintext IVMS-101 data. Notabene encrypts it with keys that Notabene manages and stores the encrypted PII on both your Notabene entity and the beneficiary's. Notabene can decrypt it, which lets Notabene run checks such as name screening on it."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Present"]}," (Options B and C). You encrypt the IVMS-101 data yourself before you submit it. Notabene can't read the payload and forwards it to the beneficiary VASP. Only the beneficiary side stores the PII. Your Notabene entity and the Notabene platform don't store it."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In all cases, ","Ripple Custody"," forwards the PII to Notabene without storing it."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"how-end-to-end-encryption-works","__idx":7},"children":["How end-to-end encryption works"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For Options B and C, you produce the encrypted payload. Notabene's end-to-end encryption uses ECDH-ES (RFC 7518) key agreement on the P-256 curve with the beneficiary VASP's public key, which the beneficiary publishes in its DIDdoc, and AES-256-GCM for content encryption. The encrypted payload is a compact JWE string. You publish your own public key in your DIDdoc so that counterparties can encrypt PII for you in the same way. For details and reference implementations, see Notabene's ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://devx.notabene.id/docs/pii-encryption-guide"},"children":["PII encryption guide"]}," and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://devx.notabene.id/docs/self-encryption"},"children":["Encryption managed by the customer"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"option-a-append-pii-stored-on-both-sides","__idx":8},"children":["Option A: Append PII (stored on both sides)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this option when both sender and receiver need access to the PII. You submit the PII in plaintext IVMS-101 format and Notabene encrypts it."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"POST /v1/domains/{domainId}/compliance/travel-rule/providers/NOTABENE/messages/{travelRuleId}/pii\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body"]},":"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ivms101"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["IVMS-101 formatted PII data"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["originator"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Originator details"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["beneficiary"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Beneficiary details"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"option-b-present-encrypted-pii-stored-on-receiver-side-only","__idx":9},"children":["Option B: Present encrypted PII (stored on receiver side only)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this option for end-to-end encrypted PII that Notabene can't read."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"POST /v1/domains/{domainId}/compliance/travel-rule/providers/NOTABENE/messages/{travelRuleId}/encrypted-pii\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Query parameters"]},":"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Default"},"children":["Default"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skipValidation"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Corresponds to Notabene's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skipValidation"]}," option. When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},", Notabene skips validation of the PII against the jurisdiction's requirements, which allows an incomplete submission."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body"]},":"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ivms101"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["End-to-end encrypted IVMS-101 data"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202 Accepted"]}," (asynchronous processing)"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"option-c-present-encrypted-pii-for-a-specific-policy-stored-on-receiver-side-only","__idx":10},"children":["Option C: Present encrypted PII for a specific policy (stored on receiver side only)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The policies in this endpoint are Notabene authorization requirements, not ","Ripple Custody"," governance policies. The beneficiary VASP defines them in Notabene to state what it needs before it authorizes an incoming transfer, for example a Travel Rule message with originator PII. Each policy references the presentation definition that satisfies it."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this option to fulfill one specific policy that the beneficiary VASP attached to the transfer. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["travelRulePolicyId"]}," is the ID of that Notabene policy. Notabene returns it in the transfer details in the response to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#step-1-create-travel-rule-message"},"children":["Step 1"]},", so you don't need to call Notabene directly to get it."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"POST /v1/domains/{domainId}/compliance/travel-rule/providers/NOTABENE/messages/{travelRuleId}/policies/{travelRulePolicyId}/encrypted-pii\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Query parameters and request body:"]}," Same as Option B."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202 Accepted"]}," (asynchronous processing)"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Options B and C carry PII that you encrypted with the beneficiary VASP's public key. Notabene can't read the payload and doesn't store it on your Notabene entity or on the Notabene platform. Only the beneficiary side holds it."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-5-create-transfer-order-intent","__idx":11},"children":["Step 5: Create Transfer Order intent"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create the Transfer Order intent using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["suggestedIntentId"]}," returned in Step 1."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Transfer Order intent payload"]},":"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payload.accountId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string (uuid)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Source account ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payload.ledgerId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ledger identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payload.parameters.operation"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Transfer operation details including ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["destination"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["amount"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["payload.type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["v0_CreateTransferOrder"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Critical"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["suggestedIntentId"]}," from Step 1 when creating the intent. This links the compliance check to your transaction."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-6-risk-screening","__idx":12},"children":["Step 6: Risk screening"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If transaction screening is configured (Chainalysis or Elliptic), ","Ripple Custody"," screens the transaction first."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["If screening fails"]}," (high risk score): The transaction is immediately rejected. No Travel Rule check occurs."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["If screening passes"]},": The workflow proceeds to the Travel Rule check."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-7-travel-rule-check","__idx":13},"children":["Step 7: Travel Rule check"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Notabene verifies counterparty information and PII."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-8-compliance-decision","__idx":14},"children":["Step 8: Compliance decision"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ripple Custody"," evaluates the results:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Screening Result"},"children":["Screening Result"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Travel Rule Result"},"children":["Travel Rule Result"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Decision"},"children":["Decision"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Approved"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Approved"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUTO_APPROVED"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rejected"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUTO_REJECTED"]}," (Travel Rule skipped)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Approved"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rejected"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUTO_REJECTED"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Inconclusive"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Inconclusive"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NEED_EXPLICIT_DECISION"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the decision is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["NEED_EXPLICIT_DECISION"]},", manual review is required in ","Ripple Custody","."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If only one check is configured (screening only or Travel Rule only), the decision is based on that single check."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-9-execution-and-settlement","__idx":15},"children":["Step 9: Execution and settlement"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUTO_APPROVED"]},": Transaction executes on blockchain, then Notabene is notified of settlement."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AUTO_REJECTED"]},": Intent closes, then Notabene is notified of rejection."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If the intent expires before execution (30 days by default): ","Ripple Custody"," automatically rejects the Travel Rule transfer on Notabene."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"verify-transfer-status","__idx":16},"children":["Verify transfer status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Poll the Travel Rule transfer status to confirm successful execution:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"GET /v1/domains/{domainId}/compliance/travel-rule/providers/NOTABENE/messages/{travelRuleId}\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key response fields"]},":"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transfer.status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Notabene transfer status (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SETTLED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REJECTED"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transfer.direction"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OUTGOING"]}," for this workflow"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":17},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.42/compliance/travel-rule/outgoing-no-pii"},"children":["Send without PII"]}," — When PII is not required"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/products/custody/v1.42/compliance/travel-rule/incoming"},"children":["Receive assets"]}," — Handle incoming Travel Rule transfers"]}]}]},"headings":[{"value":"Send assets with PII","id":"send-assets-with-pii","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Process flow","id":"process-flow","depth":2},{"value":"Step 1: Create Travel Rule message","id":"step-1-create-travel-rule-message","depth":2},{"value":"Step 2: Check PII requirements","id":"step-2-check-pii-requirements","depth":2},{"value":"Step 3: Collect PII from end user","id":"step-3-collect-pii-from-end-user","depth":2},{"value":"Step 4: Submit PII via API","id":"step-4-submit-pii-via-api","depth":2},{"value":"How end-to-end encryption works","id":"how-end-to-end-encryption-works","depth":4},{"value":"Option A: Append PII (stored on both sides)","id":"option-a-append-pii-stored-on-both-sides","depth":3},{"value":"Option B: Present encrypted PII (stored on receiver side only)","id":"option-b-present-encrypted-pii-stored-on-receiver-side-only","depth":3},{"value":"Option C: Present encrypted PII for a specific policy (stored on receiver side only)","id":"option-c-present-encrypted-pii-for-a-specific-policy-stored-on-receiver-side-only","depth":3},{"value":"Step 5: Create Transfer Order intent","id":"step-5-create-transfer-order-intent","depth":2},{"value":"Step 6: Risk screening","id":"step-6-risk-screening","depth":2},{"value":"Step 7: Travel Rule check","id":"step-7-travel-rule-check","depth":2},{"value":"Step 8: Compliance decision","id":"step-8-compliance-decision","depth":2},{"value":"Step 9: Execution and settlement","id":"step-9-execution-and-settlement","depth":2},{"value":"Verify transfer status","id":"verify-transfer-status","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"seo":{"title":"Send assets with PII"}},"lastModified":"2026-10-23T14:40:24.020Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/custody/v1.42/compliance/travel-rule/outgoing-with-pii","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}