--- updatedAt: 2026-04-21T11:22:20.000Z agentTools: projectIndex: https://docs.lmnl.app/v2/llms.txt --- # Retrieve a Travel Rule transaction by transaction ID This API is a request to retrieve details of a specific Travel Rule transaction using its unique transaction ID. # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "API REFERENCES", "contact": {}, "version": "8" }, "servers": [ { "url": "https://api-sdk.lmnl.dev", "variables": {} } ], "tags": [ { "name": "Travel Rule transactions" } ], "paths": { "/api/travel-rule/get-transaction/:txnId": { "get": { "tags": [ "Travel Rule transactions" ], "summary": "Retrieve a Travel Rule transaction by transaction ID", "description": "This API is a request to retrieve details of a specific Travel Rule transaction using its unique transaction ID.", "operationId": "GetTravelRuleTransactionbyTxId", "parameters": [ { "name": "txnId", "in": "query", "description": "Specify the Travel Rule transaction ID.", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "1ff7945d-2390-4d2b-b122-59eb7be48812" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Retrieve-Transaction-Id-Response" } ], "example": { "success": true, "data": { "id": "98f78d4f-1341-46a4-a3ed-939fce6145ec", "status": "CANCELLED", "transactionType": "TRAVELRULE", "transactionAsset": "ETH", "transactionAmount": "1000000000000", "chargedQuantity": 0, "amountInLocalCurrency": { "currency": "SGD", "amountInLocalCurrency": 0.00248034 }, "beneficiaryAmountInLocalCurrency": null, "originatorDid": "did:ethr:0x47e86dad05141f35926af8abf4271a3b94a8298b", "beneficiaryDid": "did:ethr:0xac9aaa9e7028bdea3fe7e85537df6eaf6dd33501", "isTest": null, "originatorVASPdid": "did:ethr:0x1d4eb41bf400506fc5b77defd5ea9171652b3464", "beneficiaryVASPdid": "did:ethr:0x645fa50712c17cbeff5a52f4199b9a5e283cdea6", "transactionBlockchainInfo": { "origin": "0x75f00AE5CB223268814eEb8813F73cf99BD70fB4", "destination": "0xa345678013443645645756756" }, "ivms101": { "originator": { "accountNumber": [ "0x75f00AE5CB223268814eEb8813F73cf99BD70fB4" ], "originatorPersons": [ { "naturalPerson": { "name": [ { "nameIdentifier": [ { "primaryIdentifier": "Bruce" } ] } ], "geographicAddress": [ { "country": "GB", "addressLine": [ "main streat 101", "address line 2" ], "countrySubdivision": [ "London" ] } ], "countryOfResidence": "GB", "dateAndPlaceOfBirth": { "dateOfBirth": "2020-04-02", "placeOfBirth": "London" }, "customerIdentification": "12345", "nationalIdentification": { "countryOfIssue": "IN", "nationalIdentifier": "12345Number", "registrationAuthority": "Govt of Italy", "nationalIdentifierType": "ARNU" } } } ] }, "beneficiary": { "accountNumber": [ "123499877ace" ], "beneficiaryPersons": [ { "legalPerson": { "name": { "nameIdentifier": [ { "legalPersonName": "Microsoft" } ] }, "geographicAddress": [ { "country": "IN", "addressLine": [ "M G road" ], "countrySubdivision": [ "Bengalure" ] } ], "countryOfRegistration": "IN" } } ] } }, "ivms101Encrypted": null, "protocol": "TRLight", "protocolData": { "trLightData": { "notificationEmails": [], "accessLinks": [] } }, "originatorProof": null, "beneficiaryProof": null, "actions": [ { "hash": "e4a728a65eb31807636e9f00456e58a85172cc0b156cdb66d1aeb157b089313339faeb3a178d4bf2f38caf7db416d943cfa17bff0048088b899aaa9f00a2730d", "issuerDID": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59", "action": "cancel", "actionData": "{\"id\":\"98f78d4f-1341-46a4-a3ed-939fce6145ec\"}", "transactionId": "98f78d4f-1341-46a4-a3ed-939fce6145ec", "createdAt": "2023-08-02T09:04:03.392Z", "createdBy": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59" }, { "hash": "eec0bfc66e1dfa3f7901f642d8d387a62344a91ee8be98cabe8464798e97b52268c996241e71fcb5507aae05641bb7473c82f483536cbd043687732a0a0d616d", "issuerDID": "did:ethr:0x19b5ff8440019b635a86bbb632db854f2ea80423", "action": "update", "actionData": "{\"id\":\"98f78d4f-1341-46a4-a3ed-939fce6145ec\",\"tracked_billing\":true,\"transactionAmount\":null,\"chargedQuantity\":null,\"amountInLocalCurrency\":null,\"beneficiaryAmountInLocalCurrency\":null,\"originatorDid\":null,\"beneficiaryDid\":null,\"showToBeneficiary\":null,\"isTest\":null,\"originatorVASPdid\":null,\"beneficiaryVASPdid\":null,\"transactionBlockchainInfo\":null,\"ivms101\":null,\"ivms101Encrypted\":null,\"protocol\":null,\"protocolData\":null,\"originatorProof\":null,\"beneficiaryProof\":null,\"updatedBy\":null,\"pii\":null,\"pii_url\":null,\"updatedAt\":\"2023-05-03T17:30:00.212Z\"}", "transactionId": "98f78d4f-1341-46a4-a3ed-939fce6145ec", "createdAt": "2023-05-03T17:30:00.316Z", "createdBy": "did:ethr:0x19b5ff8440019b635a86bbb632db854f2ea80423" }, { "hash": "b5955e6edd788e17d8fd024faedcc9c6c7bb9bdb11b545430c73f338e060db1ac87c3f38df5baa0b3b27727a48546433d5e6c025e711d07c3c8c8ec204ee4cdd", "issuerDID": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59", "action": "approve", "actionData": null, "transactionId": "98f78d4f-1341-46a4-a3ed-939fce6145ec", "createdAt": "2023-05-03T17:21:00.967Z", "createdBy": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59" }, { "hash": "4ea7ce7a67f48378eb7c0e2fbda8931ebb78bfb6f47022070b61f3af67be060817af4d6e33cd019ccff6d4b6cbbd813891c35cf294981335d427a053f96045b4", "issuerDID": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59", "action": "create", "actionData": "{\"travelRuleBehavior\":false,\"transactionAsset\":\"ETH\",\"transactionAmount\":\"1000000000000\",\"originatorVASPdid\":\"did:ethr:0x1d4eb41bf400506fc5b77defd5ea9171652b3464\",\"transactionBlockchainInfo\":{\"origin\":\"0x75f00AE5CB223268814eEb8813F73cf99BD70fB4\",\"destination\":\"0xa345678013443645645756756\"},\"beneficiaryVASPname\":\"lmnl\",\"beneficiaryVASPdid\":\"did:ethr:0x645fa50712c17cbeff5a52f4199b9a5e283cdea6\",\"originatorDid\":\"did:ethr:0x47e86dad05141f35926af8abf4271a3b94a8298b\",\"beneficiaryDid\":\"did:ethr:0xac9aaa9e7028bdea3fe7e85537df6eaf6dd33501\"}", "transactionId": "98f78d4f-1341-46a4-a3ed-939fce6145ec", "createdAt": "2023-05-03T17:21:00.511Z", "createdBy": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59" } ], "createdAt": "2023-05-03T17:21:00.412Z", "createdBy": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59", "updatedAt": "2023-08-02T09:04:03.181Z", "updatedBy": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59", "pii": { "originator": { "accountNumber": [ "QmNvUm1J6ffRiBa9iHoqAU9wCTp9ZMUcdmKvPWHmiUg6LN" ], "originatorPersons": [ { "naturalPerson": { "name": [ { "nameIdentifier": [ { "primaryIdentifier": "QmeFy3zbjfYHSfmb6y4jNqavh2z3LD21sZGyFGHVCvx9DF" } ] } ], "geographicAddress": [ { "country": "QmeAwnb7iYzCu4K3R9EXbP7SM6VKv5o5d2cFQipmuGBNA9", "addressLine": [ "QmaLeKwVtcw4sK8vHzJzjLqoaAFBJNDUFv18RcwjDc9znZ", "QmXBo6VdCTYDeA7Gfs9tjr6mhRGeadF9kLBgkGKzyR9tWx" ], "countrySubdivision": [ "QmUjRyb4GV3E6c1oDJNeXWcUG2irfxvBYW6SvuBKKQVxYY" ] } ], "countryOfResidence": "QmWSv2wMx8rdUasjpPFdjx35sVFDvi5YjEaLR4Lmnn9UwX", "dateAndPlaceOfBirth": { "dateOfBirth": "QmQAwmPVBUL9nvfV147s59zCnH25Un8rjJBJ33itJzbMSF", "placeOfBirth": "Qma72nEoPcjLb912xqesNqMjQDAD6D6n6MPrfzxPrd8a5U" }, "customerIdentification": "QmVpaSmSSdhugqQVm98HKAKE7kXoTtaJVbMthfrpD3zUXb", "nationalIdentification": { "countryOfIssue": "QmdZdKnjJaGpYCM8cTxY9PSnsEL2XNozp9CESBbz9WvZWb", "nationalIdentifier": "Qmcq8BmEZHQaVYQksRCWna4EkFwBLaftdUoahPJdAYpsH8", "registrationAuthority": "QmRjegcbu4oQ9hD9JDY1VZ8wo7ubM32t1t3vrcLCNUPovd", "nationalIdentifierType": "QmT2ESherSZHkrjBab5zxBCQRferERPkBLM4Js5stpQwXF" } } } ] }, "beneficiary": { "accountNumber": [ "Qme1U4yeQcZHbdD5KZdhxgafYEeJn9D8tFcLJa6DYPMX1j" ], "beneficiaryPersons": [ { "legalPerson": { "name": { "nameIdentifier": [ { "legalPersonName": "QmR2zYTNxN7iFtUuEL2euv4KkGoApm2dq7TbNsZjxzN9sF" } ] }, "geographicAddress": [ { "country": "QmSTMA6E9ems5e8iD7cRdiRv5eixsSsnU3TVfquqJcxf9k", "addressLine": [ "QmTSoYbbxPf49D1HbEBx1tLFt37bo5mgvmBPr56wDbbrHF" ], "countrySubdivision": [ "QmQDQXvWLFf6M3zg2kRrZkSPCA3z5tVnhKDbC2LppfMuRp" ] } ], "countryOfRegistration": "QmNancBQLbpPTS9K8gjrMEctuytgK95T5v1LRXd9dX7NfA" } } ] } }, "pii_url": "https://pii.notabene.dev/", "tracked_billing": true, "integrations": [], "transactionAssetDecimals": 18, "originatorRef": null } } }, "example": { "success": true, "data": { "id": "98f78d4f-1341-46a4-a3ed-939fce6145ec", "status": "CANCELLED", "transactionType": "TRAVELRULE", "transactionAsset": "ETH", "transactionAmount": "1000000000000", "chargedQuantity": 0, "amountInLocalCurrency": { "currency": "SGD", "amountInLocalCurrency": 0.00248034 }, "beneficiaryAmountInLocalCurrency": null, "originatorDid": "did:ethr:0x47e86dad05141f35926af8abf4271a3b94a8298b", "beneficiaryDid": "did:ethr:0xac9aaa9e7028bdea3fe7e85537df6eaf6dd33501", "isTest": null, "originatorVASPdid": "did:ethr:0x1d4eb41bf400506fc5b77defd5ea9171652b3464", "beneficiaryVASPdid": "did:ethr:0x645fa50712c17cbeff5a52f4199b9a5e283cdea6", "transactionBlockchainInfo": { "origin": "0x75f00AE5CB223268814eEb8813F73cf99BD70fB4", "destination": "0xa345678013443645645756756" }, "ivms101": { "originator": { "accountNumber": [ "0x75f00AE5CB223268814eEb8813F73cf99BD70fB4" ], "originatorPersons": [ { "naturalPerson": { "name": [ { "nameIdentifier": [ { "primaryIdentifier": "Bruce" } ] } ], "geographicAddress": [ { "country": "GB", "addressLine": [ "main streat 101", "address line 2" ], "countrySubdivision": [ "London" ] } ], "countryOfResidence": "GB", "dateAndPlaceOfBirth": { "dateOfBirth": "2020-04-02", "placeOfBirth": "London" }, "customerIdentification": "12345", "nationalIdentification": { "countryOfIssue": "IN", "nationalIdentifier": "12345Number", "registrationAuthority": "Govt of Italy", "nationalIdentifierType": "ARNU" } } } ] }, "beneficiary": { "accountNumber": [ "123499877ace" ], "beneficiaryPersons": [ { "legalPerson": { "name": { "nameIdentifier": [ { "legalPersonName": "Microsoft" } ] }, "geographicAddress": [ { "country": "IN", "addressLine": [ "M G road" ], "countrySubdivision": [ "Bengalure" ] } ], "countryOfRegistration": "IN" } } ] } }, "ivms101Encrypted": null, "protocol": "TRLight", "protocolData": { "trLightData": { "notificationEmails": [], "accessLinks": [] } }, "originatorProof": null, "beneficiaryProof": null, "actions": [ { "hash": "e4a728a65eb31807636e9f00456e58a85172cc0b156cdb66d1aeb157b089313339faeb3a178d4bf2f38caf7db416d943cfa17bff0048088b899aaa9f00a2730d", "issuerDID": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59", "action": "cancel", "actionData": "{\"id\":\"98f78d4f-1341-46a4-a3ed-939fce6145ec\"}", "transactionId": "98f78d4f-1341-46a4-a3ed-939fce6145ec", "createdAt": "2023-08-02T09:04:03.392Z", "createdBy": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59" }, { "hash": "eec0bfc66e1dfa3f7901f642d8d387a62344a91ee8be98cabe8464798e97b52268c996241e71fcb5507aae05641bb7473c82f483536cbd043687732a0a0d616d", "issuerDID": "did:ethr:0x19b5ff8440019b635a86bbb632db854f2ea80423", "action": "update", "actionData": "{\"id\":\"98f78d4f-1341-46a4-a3ed-939fce6145ec\",\"tracked_billing\":true,\"transactionAmount\":null,\"chargedQuantity\":null,\"amountInLocalCurrency\":null,\"beneficiaryAmountInLocalCurrency\":null,\"originatorDid\":null,\"beneficiaryDid\":null,\"showToBeneficiary\":null,\"isTest\":null,\"originatorVASPdid\":null,\"beneficiaryVASPdid\":null,\"transactionBlockchainInfo\":null,\"ivms101\":null,\"ivms101Encrypted\":null,\"protocol\":null,\"protocolData\":null,\"originatorProof\":null,\"beneficiaryProof\":null,\"updatedBy\":null,\"pii\":null,\"pii_url\":null,\"updatedAt\":\"2023-05-03T17:30:00.212Z\"}", "transactionId": "98f78d4f-1341-46a4-a3ed-939fce6145ec", "createdAt": "2023-05-03T17:30:00.316Z", "createdBy": "did:ethr:0x19b5ff8440019b635a86bbb632db854f2ea80423" }, { "hash": "b5955e6edd788e17d8fd024faedcc9c6c7bb9bdb11b545430c73f338e060db1ac87c3f38df5baa0b3b27727a48546433d5e6c025e711d07c3c8c8ec204ee4cdd", "issuerDID": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59", "action": "approve", "actionData": null, "transactionId": "98f78d4f-1341-46a4-a3ed-939fce6145ec", "createdAt": "2023-05-03T17:21:00.967Z", "createdBy": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59" }, { "hash": "4ea7ce7a67f48378eb7c0e2fbda8931ebb78bfb6f47022070b61f3af67be060817af4d6e33cd019ccff6d4b6cbbd813891c35cf294981335d427a053f96045b4", "issuerDID": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59", "action": "create", "actionData": "{\"travelRuleBehavior\":false,\"transactionAsset\":\"ETH\",\"transactionAmount\":\"1000000000000\",\"originatorVASPdid\":\"did:ethr:0x1d4eb41bf400506fc5b77defd5ea9171652b3464\",\"transactionBlockchainInfo\":{\"origin\":\"0x75f00AE5CB223268814eEb8813F73cf99BD70fB4\",\"destination\":\"0xa345678013443645645756756\"},\"beneficiaryVASPname\":\"lmnl\",\"beneficiaryVASPdid\":\"did:ethr:0x645fa50712c17cbeff5a52f4199b9a5e283cdea6\",\"originatorDid\":\"did:ethr:0x47e86dad05141f35926af8abf4271a3b94a8298b\",\"beneficiaryDid\":\"did:ethr:0xac9aaa9e7028bdea3fe7e85537df6eaf6dd33501\"}", "transactionId": "98f78d4f-1341-46a4-a3ed-939fce6145ec", "createdAt": "2023-05-03T17:21:00.511Z", "createdBy": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59" } ], "createdAt": "2023-05-03T17:21:00.412Z", "createdBy": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59", "updatedAt": "2023-08-02T09:04:03.181Z", "updatedBy": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59", "pii": { "originator": { "accountNumber": [ "QmNvUm1J6ffRiBa9iHoqAU9wCTp9ZMUcdmKvPWHmiUg6LN" ], "originatorPersons": [ { "naturalPerson": { "name": [ { "nameIdentifier": [ { "primaryIdentifier": "QmeFy3zbjfYHSfmb6y4jNqavh2z3LD21sZGyFGHVCvx9DF" } ] } ], "geographicAddress": [ { "country": "QmeAwnb7iYzCu4K3R9EXbP7SM6VKv5o5d2cFQipmuGBNA9", "addressLine": [ "QmaLeKwVtcw4sK8vHzJzjLqoaAFBJNDUFv18RcwjDc9znZ", "QmXBo6VdCTYDeA7Gfs9tjr6mhRGeadF9kLBgkGKzyR9tWx" ], "countrySubdivision": [ "QmUjRyb4GV3E6c1oDJNeXWcUG2irfxvBYW6SvuBKKQVxYY" ] } ], "countryOfResidence": "QmWSv2wMx8rdUasjpPFdjx35sVFDvi5YjEaLR4Lmnn9UwX", "dateAndPlaceOfBirth": { "dateOfBirth": "QmQAwmPVBUL9nvfV147s59zCnH25Un8rjJBJ33itJzbMSF", "placeOfBirth": "Qma72nEoPcjLb912xqesNqMjQDAD6D6n6MPrfzxPrd8a5U" }, "customerIdentification": "QmVpaSmSSdhugqQVm98HKAKE7kXoTtaJVbMthfrpD3zUXb", "nationalIdentification": { "countryOfIssue": "QmdZdKnjJaGpYCM8cTxY9PSnsEL2XNozp9CESBbz9WvZWb", "nationalIdentifier": "Qmcq8BmEZHQaVYQksRCWna4EkFwBLaftdUoahPJdAYpsH8", "registrationAuthority": "QmRjegcbu4oQ9hD9JDY1VZ8wo7ubM32t1t3vrcLCNUPovd", "nationalIdentifierType": "QmT2ESherSZHkrjBab5zxBCQRferERPkBLM4Js5stpQwXF" } } } ] }, "beneficiary": { "accountNumber": [ "Qme1U4yeQcZHbdD5KZdhxgafYEeJn9D8tFcLJa6DYPMX1j" ], "beneficiaryPersons": [ { "legalPerson": { "name": { "nameIdentifier": [ { "legalPersonName": "QmR2zYTNxN7iFtUuEL2euv4KkGoApm2dq7TbNsZjxzN9sF" } ] }, "geographicAddress": [ { "country": "QmSTMA6E9ems5e8iD7cRdiRv5eixsSsnU3TVfquqJcxf9k", "addressLine": [ "QmTSoYbbxPf49D1HbEBx1tLFt37bo5mgvmBPr56wDbbrHF" ], "countrySubdivision": [ "QmQDQXvWLFf6M3zg2kRrZkSPCA3z5tVnhKDbC2LppfMuRp" ] } ], "countryOfRegistration": "QmNancBQLbpPTS9K8gjrMEctuytgK95T5v1LRXd9dX7NfA" } } ] } }, "pii_url": "https://pii.notabene.dev/", "tracked_billing": true, "integrations": [], "transactionAssetDecimals": 18, "originatorRef": null } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "success" ], "properties": { "success": { "type": "boolean", "description": "This indicates whether the details of the Travel Rule transaction are successfully retrieved or not.", "example": false }, "data": { "type": "object", "example": {} }, "message": { "type": "string", "description": "A short description of the error.", "example": "access_denied" }, "code": { "type": "string", "description": "The error code for the API failure.", "example": "" } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "required": [ "success" ], "properties": { "success": { "type": "boolean", "description": "This indicates whether the details of the Travel Rule transaction are successfully retrieved or not.", "example": false }, "data": { "type": "object", "example": {} }, "message": { "type": "string", "description": "A short description of the error.", "example": "fail to fetch travel rule txn" }, "code": { "type": "string", "description": "The error code for the API failure.", "example": "" } } } } } } }, "deprecated": false, "security": [ { "basic": [] } ] } } }, "components": { "schemas": { "Data58": { "title": "Data58", "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier (ID) of the transaction.", "example": "abf27e45-5ffd-4355-87c7-b1687efa2195" }, "status": { "type": "string", "description": "The current status of the transaction.", "example": "NEW" }, "transactionType": { "type": "string", "description": "The type of transaction.", "example": "TRAVELRULE" }, "transactionAsset": { "type": "string", "description": "The type of asset involved in the transaction.", "example": "XRP-TEST" }, "transactionAmount": { "type": "string", "description": "The amount of asset in the transaction.", "example": "1000000" }, "chargedQuantity": { "type": "number", "description": "The quantity charged for the transaction.", "example": 0.581357 }, "amountInLocalCurrency": { "allOf": [ { "$ref": "#/components/schemas/AmountInLocalCurrency" }, {} ] }, "beneficiaryAmountInLocalCurrency": { "description": "The local currency and amount of the beneficiary.", "allOf": [ { "$ref": "#/components/schemas/AmountInLocalCurrency" }, {} ] }, "originatorDid": { "type": "string", "description": "The unique dentifier (ID) of the transaction originator.", "example": "did:key:**************" }, "beneficiaryDid": { "type": "string", "description": "The identifier of the transaction beneficiary.", "example": "did:key:**************" }, "isTest": { "type": "string", "description": "This indicates whether the transaction is a test transaction or not. A `null` value indicates that it is not a test transaction.", "nullable": true, "example": null }, "originatorVASPdid": { "type": "string", "description": "The unique identifier (ID) of the originator's VASP.", "example": "did:ethr:**************" }, "beneficiaryVASPdid": { "type": "string", "description": "The unique identifier (ID) of the beneficiary's VASP.", "example": "did:ethr:**************" }, "transactionBlockchainInfo": { "type": "object", "properties": { "origin": { "type": "string", "example": 1.2339794881958946e+48 }, "destination": { "type": "string", "example": 6.275613666921069e+47 } } }, "ivms101": { "type": "object", "properties": { "originator": { "type": "object", "properties": { "accountNumber": { "type": "array", "items": { "type": "string", "description": "The account numbers associated with the originator.", "example": "QmRXrf4RnV57s5LKWszQoqM6ktZWDw1DH8niMoFmuYjyMN" } }, "originatorPersons": { "type": "array", "items": { "type": "object", "properties": { "naturalPerson": { "type": "object", "properties": { "name": { "type": "array", "items": { "type": "object", "properties": { "nameIdentifier": { "type": "array", "items": { "type": "object", "properties": { "primaryIdentifier": { "type": "string", "description": "The primary identifier of the originator's full name.", "example": "John" } } } } } } }, "dateAndPlaceOfBirth": { "type": "object", "properties": { "dateOfBirth": { "type": "string", "description": "The date of birth of the originator.", "example": "2020-04-02" }, "placeOfBirth": { "type": "string", "description": "The place of birth of the originator.", "example": "London" } } } } } } } } } }, "beneficiary": { "type": "object", "properties": { "accountNumber": { "type": "array", "items": { "type": "string", "description": "The account numbers associated with the beneficiary.", "example": "QmRXrf4RnV57s5LKWszQoqM6ktZWDw1DH8niMoFmuYjySK" } }, "beneficiaryPersons": { "type": "array", "items": { "type": "object", "properties": { "naturalPerson": { "type": "object", "properties": { "name": { "type": "array", "items": { "type": "object", "properties": { "nameIdentifier": { "type": "array", "items": { "type": "object", "properties": { "primaryIdentifier": { "type": "string", "description": "The primary identifier of the beneficiary's full name.", "example": "Harry" } } } } } } } } } } } } } }, "beneficiaryVASP": { "type": "object", "properties": { "beneficiaryVASP": { "type": "object", "properties": { "legalPerson": { "type": "object", "properties": { "name": { "type": "object", "properties": { "nameIdentifier": { "type": "array", "items": { "type": "object", "properties": { "legalPersonName": { "type": "string", "description": "The legal name of the beneficiary VASP.", "example": "Liminal" }, "legalPersonNameIdentifierType": { "type": "string", "description": "The beneficiary VASP's legal name identifier.", "example": "Lmnl" } } } } } } } } } } } }, "originatingVASP": { "type": "object", "properties": { "originatingVASP": { "type": "object", "properties": { "legalPerson": { "type": "object", "properties": { "name": { "type": "object", "properties": { "nameIdentifier": { "type": "array", "items": { "type": "object", "properties": { "legalPersonName": { "description": "The legal name of the originator VASP.", "example": "Liminal" }, "legalPersonNameIdentifierType": { "type": "string", "description": "The originator VASP's legal name identifier.", "example": "Lmnl" } } } } } } } } } } } } } }, "ivms101Encrypted": { "type": "string", "nullable": true, "description": "The IVMS101 information in the encrypted format.", "example": null }, "protocol": { "type": "string", "description": "The type of protocol used for the transaction.", "example": "TRLight" }, "protocolData": { "allOf": [ { "$ref": "#/components/schemas/ProtocolData" }, {} ] }, "originatorProof": { "type": "string", "nullable": true, "description": "The identity proof provided by the originator.", "example": null }, "beneficiaryProof": { "type": "string", "description": "The identity proof provided by the originator.", "nullable": true, "example": null }, "actions": { "type": "array", "items": { "$ref": "#/components/schemas/Action" }, "description": "The array of actions associated with the transaction, including details like action type, issuer, and hash." }, "createdAt": { "type": "string", "description": "The timestamp when the transaction was created.", "example": "2023-06-30T05:39:44.151Z" }, "createdBy": { "type": "string", "description": "The unique identifier of the entity that created the transaction.", "example": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59" }, "updatedAt": { "type": "string", "description": "The timestamp when the transaction was last updated.", "example": "2023-08-14T05:43:07.699Z" }, "updatedBy": { "type": "string", "description": "The unique identifier of the entity that last updated the transaction.", "example": "did:ethr:0xd3e3830e65d2f8c1bfa4ae9a0d03b112b15444a9" }, "pii": { "type": "object", "properties": { "originator": { "type": "object", "properties": { "accountNumber": { "type": "array", "items": { "type": "string", "description": "The account numbers associated with the originator.", "example": "QmRXrf4RnV57s5LKWszQoqM6ktZWDw1DH8niMoFmuYjyMN" } }, "originatorPersons": { "type": "array", "items": { "type": "object", "properties": { "naturalPerson": { "type": "object", "properties": { "name": { "type": "array", "items": { "type": "object", "properties": { "nameIdentifier": { "type": "array", "items": { "type": "object", "properties": { "primaryIdentifier": { "type": "string", "description": "The primary identifier of the originator's full name.", "example": "John" } } } } } } }, "dateAndPlaceOfBirth": { "type": "object", "properties": { "ddateOfBirth": { "type": "string", "description": "The date of birth of the originator.", "example": "2020-04-02" }, "placeOfBirth": { "type": "string", "description": "The place of birth of the originator.", "example": "London" } } } } } } } } } }, "beneficiary": { "type": "object", "properties": { "accountNumber": { "type": "array", "items": { "type": "string", "description": "The account numbers associated with the beneficiary.", "example": "QmRXrf4RnV57s5LKWszQoqM6ktZWDw1DH8niMoFmuYjySK" } }, "beneficiaryPersons": { "type": "array", "items": { "type": "object", "properties": { "naturalPerson": { "type": "object", "properties": { "name": { "type": "array", "items": { "type": "object", "properties": { "nameIdentifier": { "type": "array", "items": { "type": "object", "properties": { "primaryIdentifier": { "type": "string", "description": "The primary identifier of the beneficiary's full name.", "example": "Harry" } } } } } } } } } } } } } }, "beneficiaryVASP": { "type": "object", "properties": { "beneficiaryVASP": { "type": "object", "properties": { "legalPerson": { "type": "object", "properties": { "name": { "type": "object", "properties": { "nameIdentifier": { "type": "array", "items": { "type": "object", "properties": { "legalPersonName": { "description": "The legal name of the beneficiary VASP.", "example": "Liminal" }, "legalPersonNameIdentifierType": { "type": "string", "description": "The beneficiary VASP's legal name identifier.", "example": "Lmnl" } } } } } } } } } } } }, "originatingVASP": { "type": "object", "properties": { "originatingVASP": { "type": "object", "properties": { "legalPerson": { "type": "object", "properties": { "name": { "type": "object", "properties": { "nameIdentifier": { "type": "array", "items": { "type": "object", "properties": { "legalPersonName": { "description": "The legal name of the originator VASP.", "example": "Liminal" }, "legalPersonNameIdentifierType": { "type": "string", "description": "The originator VASP's legal name identifier.", "example": "Lmnl" } } } } } } } } } } } } } }, "pii_url": { "type": "string", "description": "The URL where PII is stored or accessed.", "example": "https://pii.notabene.dev/" }, "tracked_billing": { "type": "boolean", "description": "This indicates whether the transaction is tracked for billing purposes or not.", "example": false }, "custom_asset_price": { "type": "string", "description": "The custom asset price if applicable.", "nullable": true, "example": null }, "transactionRef": { "type": "string", "description": "The reference identifier for the transaction.", "nullable": true, "example": null }, "on_behalf_of_myself": { "type": "boolean", "description": "This indicates whether the transaction is on behalf of the user; false if not.", "example": false }, "blockchainTransactionTimestamp": { "type": "string", "description": "The timestamp of the transaction on the blockchain.", "nullable": true, "example": null }, "integrations": { "type": "array", "items": { "type": "string" }, "example": [] }, "transactionAssetDecimals": { "type": "integer", "description": "The number of decimal places used for the asset (e.g., 18 for ETH).", "example": 6 }, "originatorRef": { "type": "string", "nullable": true, "description": "The reference identifier for the originator.", "example": null } } }, "Retrieve-Transaction-Id-Response": { "title": "Retrieve-Transaction-Id-Response", "required": [ "success", "data" ], "type": "object", "properties": { "success": { "type": "boolean", "description": "This indicates whether the details of the Travel Rule transaction are successfully retrieved or not.", "example": true }, "data": { "allOf": [ { "$ref": "#/components/schemas/Data58" }, {} ] } } }, "Action": { "title": "Action", "type": "object", "properties": { "hash": { "type": "string", "description": "The credential hash of the transaction.", "example": "c6dba3976a97257b247b90768b7bc371c11c312c7d438420da61d3ba2caf463c0ec2675c90cb2970384e1a2ef53c4acb464d6e70d6a312fa2a1b9e559e6e2ae7" }, "issuerDID": { "type": "string", "description": "The decentralised identifier of the entity that issued the action.", "example": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59" }, "action": { "type": "string", "description": "The type of action executed on the transaction.", "example": "approve" }, "actionData": { "type": "string", "description": "This object contains the additional data related to the action taken.", "nullable": true }, "transactionId": { "type": "string", "description": "The unique identifier (ID) of the transaction.", "example": "679d1cfe-722c-43a4-af18-6b0e1ed24bd4" }, "createdAt": { "type": "string", "description": "The timestamp when the transaction was created.", "example": "2023-06-30T05:39:44.151Z" }, "createdBy": { "type": "string", "description": "The unique identifier of the entity that created the transaction.", "example": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59" } }, "example": { "hash": "2d619b08dcffb65e8f8a5f734bb03c51ac08da77135fe9e85c8bd979b5b408eb65711edc11ff94b0e7b2724e20fd4f0f41b0c680051d3c26358346be7642a94c", "issuerDID": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59", "action": "approve", "actionData": null, "transactionId": "679d1cfe-722c-43a4-af18-6b0e1ed24bd4", "createdAt": "2023-06-30T05:39:44.151Z", "createdBy": "did:ethr:0xafc2bd1c51888fc758e5c7a0dd49e6a82fdaac59" } }, "ProtocolData": { "title": "ProtocolData", "required": [ "trLightData" ], "type": "object", "properties": { "trLightData": { "allOf": [ { "$ref": "#/components/schemas/TrLightData" }, {} ] } }, "example": { "trLightData": { "notificationEmails": [], "accessLinks": [] } } }, "TrLightData": { "title": "TrLightData", "required": [ "notificationEmails", "accessLinks" ], "type": "object", "properties": { "notificationEmails": { "type": "array", "items": { "type": "string" }, "description": "A list of email addresses designated to receive notifications related to the transaction updates." }, "accessLinks": { "type": "array", "items": { "type": "string" }, "description": "A list of URLs that provide access to transaction details." } }, "example": { "notificationEmails": [], "accessLinks": [] } }, "AmountInLocalCurrency": { "title": "AmountInLocalCurrency", "required": [ "currency", "amountInLocalCurrency" ], "type": "object", "properties": { "currency": { "type": "string", "description": "The currency code.", "example": "SGD" }, "amountInLocalCurrency": { "type": "number", "description": "The amount in the local currency.", "example": 2.49122 } }, "example": { "currency": "SGD", "amountInLocalCurrency": 15.38742 } } }, "securitySchemes": { "basic": { "type": "http", "scheme": "basic" } } }, "security": [] } ```