CBRE Client
  1. Schemas
CBRE Client
  • Client - Projects & Reactives
  • Client Backend Tool
  • File Manager
  • Schemas
    • Reply
    • ErrorReply
    • FieldErrors
    • PageInfo
    • APIAuthentication
    • LoginReply
    • ReauthenticateRequest
    • Account
    • AccountForm
    • AccountSummary
    • AccountList
    • CryptoAddress
    • CryptoAddressList
    • CryptoAddressForm
    • Counterparty
    • CounterpartyForm
    • CounterpartySummary
    • CounterpartyList
    • Transaction
    • TransactionForm
    • TransactionList
    • SecureEnvelope
    • SecureEnvelopeSummary
    • Envelope
    • EnvelopeSummary
    • EnvelopeList
    • Rejection
    • Repair
    • Prepare
    • Prepared
    • IdentityPayload
    • Originator
    • Beneficiary
    • OriginatingVASP
    • BeneficiaryVASP
    • TransferPath
    • IntermediaryVASP
    • PayloadMetadata
    • Person
    • LegalPerson
    • LegalPersonName
    • LegalPersonNameID
    • LocalLegalPersonNameID
    • LegalPersonNameTypeCode
    • NaturalPerson
    • NaturalPersonName
    • NaturalPersonNameID
    • LocalNaturalPersonNameID
    • NaturalPersonNameTypeCode
    • Address
    • AddressTypeCode
    • DateAndPlaceOfBirth
    • NationalIdentification
    • NationalIdentifierTypeCode
    • TransactionPayload
    • PendingPayload
    • TRISAError
    • PublicKeySignature
    • TransferState
    • User
    • UserForm
    • UserList
    • UserPassword
    • APIKey
    • APIKeyForm
    • APIKeyCreated
    • APIKeyList
    • StatusReply
    • TravelAddress
  • Response Schema
  1. Schemas

Envelope(Envelope)

An envelope is a decrypted version of a secure envelope and is used either to allow the Envoy node to perform decryption on behalf of the API client or for the API client to send data to the Envoy node for conversion into a secure envelope. The envelope will either contain an Error (is_error=True) or it will contain a Payload (is_error=false) consisting of the identity, sent_at, and received_at timestamps and either the transaction or pending payload (not both).

{
    "id": "01J6S9G7GDGNKETY6YDJQC3Z47",
    "envelope_id": "cb9a92a3-dfa6-4ecc-a4cc-c1f8fa94d3fe",
    "direction": "in",
    "remote": "trisa.example.jp",
    "reply_to": "01J6S9RJ2APF7C6M10C8NTYVGX",
    "is_error": false,
    "identity": {
        "originator": {
            "originatorPersons": [
                {
                    "naturalPerson": {
                        "name": {
                            "nameIdentifier": [
                                {
                                    "primaryIdentifier": "Bond",
                                    "secondaryIdentifier": "James",
                                    "nameIdentifierType": "LEGL"
                                }
                            ]
                        },
                        "geographicAddress": [
                            {
                                "addressType": "HOME",
                                "streetName": "High Street",
                                "buildingNumber": "7b",
                                "townName": "London",
                                "postCode": "SE1 2QH",
                                "country": "GB"
                            }
                        ],
                        "nationalIdentification": {
                            "nationalIdentifierType": "DRLC",
                            "nationalIdentifier": "BOND9211110JA9OB",
                            "countryOfIssue": "GB"
                        },
                        "customerIdentification": "01J6DJ9F691CF8E9H0V3ET0M0E",
                        "dateAndPlaceOfBirth": {
                            "dateOfBirth": "1920-11-11",
                            "placeOfBirth": "Wattenscheid, Germany"
                        },
                        "countryOfResidence": "GB"
                    }
                }
            ],
            "accountNumber": [
                "mvr5YZBdAuV8sgexCHL4CRkbCvTV7odT1i"
            ]
        },
        "beneficiary": {
            "beneficiaryPersons": [
                {
                    "naturalPerson": {
                        "name": {
                            "nameIdentifier": [
                                {
                                    "primaryIdentifier": "Miura",
                                    "secondaryIdentifier": "Kentaro",
                                    "nameIdentifierType": "LEGL"
                                }
                            ],
                            "localNameIdentifier": [
                                {
                                    "primaryIdentifier": "三浦",
                                    "secondaryIdentifier": "建太郎",
                                    "nameIdentifierType": "LEGL"
                                }
                            ]
                        },
                        "geographicAddress": [
                            {
                                "addressType": "HOME",
                                "streetName": "Shimohirakawa",
                                "buildingNumber": "1536-2",
                                "townName": "菊川市",
                                "countrySubDivision": "静岡県",
                                "postCode": "437-1514",
                                "country": "JP"
                            }
                        ],
                        "nationalIdentification": {
                            "nationalIdentifierType": "SOCS",
                            "nationalIdentifier": "0537-73-2271",
                            "countryOfIssue": "JP"
                        },
                        "customerIdentification": "01J6QNPGSKN2HZGC2F33F3QQRF",
                        "dateAndPlaceOfBirth": {
                            "dateOfBirth": "1979-02-14",
                            "placeOfBirth": "Tokyo, Japan"
                        },
                        "countryOfResidence": "JP"
                    }
                }
            ],
            "accountNumber": [
                "mtLmjWt1DDxjGhMRmnxcgQqPNGPUzXuDHw"
            ]
        },
        "originatingVASP": {
            "originatingVASP": {
                "legalPerson": {
                    "name": {
                        "nameIdentifier": [
                            {
                                "legalPersonName": "High Street Capital Management, LTD",
                                "legalPersonNameIdentifierType": "LEGL"
                            },
                            {
                                "legalPersonName": "PubCoin",
                                "legalPersonNameIdentifierType": "TRAD"
                            }
                        ]
                    },
                    "geographicAddress": [
                        {
                            "addressType": "BIZZ",
                            "streetName": "Abbey St.",
                            "buildingNumber": "51",
                            "townName": "Nottingham",
                            "postCode": "NG7 2NZ",
                            "country": "GB"
                        }
                    ],
                    "nationalIdentification": {
                        "nationalIdentifier": "GKUH00AIM6DCRXGXVU75",
                        "nationalIdentifierType": "LEIX"
                    },
                    "countryOfRegistration": "GB"
                }
            }
        },
        "beneficiaryVASP": {
            "beneficiaryVASP": {
                "legalPerson": {
                    "name": {
                        "nameIdentifier": [
                            {
                                "legalPersonName": "Nippon Crypto Exchange, KK",
                                "legalPersonNameIdentifierType": "LEGL"
                            }
                        ],
                        "localNameIdentifier": [
                            {
                                "legalPersonName": "日本仮想通貨取引所株式会社",
                                "legalPersonNameIdentifierType": "LEGL"
                            }
                        ],
                        "phoneticNameIdentifier": [
                            {
                                "legalPersonName": "Nihon kasō tsūka torihikisho kabushikigaisha",
                                "legalPersonNameIdentifierType": "LEGL"
                            }
                        ]
                    },
                    "geographicAddress": [
                        {
                            "addressType": "BIZZ",
                            "addressLine": [
                                "滋賀県大津市水明1-34-2",
                                "520-0531"
                            ],
                            "country": "JP"
                        },
                        {
                            "addressType": "BIZZ",
                            "addressLine": [
                                "1-34-2 SUIMEI OTSU SHI SHIGA KEN",
                                "520-0531 JAPAN"
                            ],
                            "country": "JP"
                        }
                    ],
                    "nationalIdentification": {
                        "nationalIdentifier": "84-1234567",
                        "nationalIdentifierType": "TXID",
                        "registrationAuthority": "RA777777"
                    },
                    "countryOfRegistration": "JP"
                }
            }
        }
    },
    "transaction": {
        "txid": "44e25bc0ed840f9bf0e58d6227db15192d5b89e79ba4304da16b09703f68ceaf",
        "originator": "mvr5YZBdAuV8sgexCHL4CRkbCvTV7odT1i",
        "beneficiary": "mtCoa72PhLznu2dw639xXfBjC8SUCpyrTv",
        "amount": 0.46602501,
        "network": "BTC",
        "timestamp": "2024-09-01T16:22:41-05:00",
        "extra_json": "eyJ2YWx1ZV93aGVuX3RyYW5zYWN0ZWQiOiAiVVNEICQzMiwzODYuNjEifQ=="
    },
    "sent_at": "2024-09-01T16:22:41-05:00",
    "received_at": "2024-09-06T07:14:29-05:00",
    "timestamp": "2024-09-06T07:14:30-05:00",
    "public_key_signature": "SHA256:n/iTnE9b0sP1DQkaDMricHqPKYj0n00IjiaJ7lUmcAs",
    "transfer_state": "STARTED",
    "secure_envelope": {
        "id": "01J6S9G7GDGNKETY6YDJQC3Z47",
        "envelope_id": "cb9a92a3-dfa6-4ecc-a4cc-c1f8fa94d3fe",
        "direction": "out",
        "remote": "api.alice.vaspbot.net",
        "reply_to": "01J6S9RJ2APF7C6M10C8NTYVGX",
        "payload": "Omjx7x69RRFOcheWgESMKph5befzbENJoFXjgno74FCrCeZx5EoR3w515lR76X0pOqghaXErNir14/GisfSKuyZnwD4re7hbFrQn3nIjqqirKvkFRKf4QIOQv/0DfK/ofc8/3+OLN5YP9Js/5vMp3DcFWqYzB8AvCDGC6AtcNh+7Y6arHlCCXzQfxeI1BZeMN5QGeMSL8Ad3od6Nqy92KVCeSksNv858x7XDiYKTh72Rn/z+11UVw5wc4cKdf536vZQ87v38SNV3k7ASfmT+a8+19HnE2aPy/bYtmEQd94Q2w0+JPF4lB9C8DooMS7ctnOUDSIiY++v4xX4Ty40iOFQOns77E9itfAYQwYyVHoLXJVA9SR5aBYDJse0mhRlJ5KHf0cY7CPQlvtcCRu+rwdYu7U2XFXYXCjYS2a6mB+ozUaZMepcPst1XPqQRW2ZMKP8Q9sCa/0r2XIO9yHksaPt3AbbjfHczEvl44f2NkdpfBAtTYYGUfO441EBieO3NhE6XTWbAHaj8Sxo4DUpvibaENbIuMNksme3WCM6ZJRHJ70us+9PJSA9VEiGRHR64YbZn95iBcH7HAVWPJdPAmfSuRQ0i4LbdFdq33LZG33uJWLP0sK6ncFM+0e1G1S6hRN3hXEEdFhHxuOOq90Vq29mQHbgzrZiHgIKqasutXYU/Tbxcqi1oUZdRAMXIySfAVFVT9672DsQpAoFalKGeSu3kbNTfYTYBpvDFVFxJI/cvn/D64AOzg8feo/9KtJgSPG9QijCyD1hbkii75/ssu1Z8X9mj0Y4kRxS41EimihmQzTE47dxYjGy+W3X9s0H8AMyDmlvTU++5x8qyxLht9s6R83L8sXH+J9/4mLebgIccaaKYqJQZ7pWJoqrujuO1InYBWCUGPdRpHPlKmuMHjhc13j8PhGOrc4ylanOfdxUumUI4nLNlluKpijAZ/lwpNnixNbAu/ZpZUXLGcpgOZgqgBljcLOWq+PKteLhH2SIxt9+bIO8HoWzfpkVRWumuTi1xKQmkrOHW140uYez831Mz0ZDwB4u6aiHouSAu+MAGp/VzA0DmfjTGqD8KccxYZg+Cxye2e2CXJe6xw+AgUTg5bSeAIgwEafZU56BlV5tjdYMrXlcchS4ORGUV1ysMGBc0KIxYuvmciV17aD7R6wUbvgntvSGfvPvcbFqTY06sECgcWVVs8QB5avB7v4nYCDYnTay6Zc6ETE6EO9t+94bKljvAto3RefiFQeCfDnkbFWKHY37ofsTn3Crc+iesMmAzGJvOPkzgcxEjhpoFV7XYPiG0ke31dNFOrb9cZpTZJfi80XZjE6Z/ugQYWrfKjXauPYRbJWAts7TAaz28PxpjTjbdCO3wMCzKlYKnk+yCYwZe2c1Hdz4VEmNFNe30Uf7AH3dW2Q5tjKzn/ghj/zVeVI2bQLwfSKaEQI78Sqg5gXETwgkMCuzjp2850AMndNaep5W1JQ4PcWkLEonMPcdZF9CMIX7WaYFHRkbOuJC5ncC3icnyD0qEC/XWsvEQTR6rzY4vTIIZOgDMbKoZDK4C5kOj5pewohNOuYySQwB6A5hcNtW6Z/uJ4V9vGX+EPzwjTaHbe8GDj++NlzG+FQi1GozS+6vqJU5FCTdhTMzelg5blkozihiUGkkABFsMcn8R2uMvjJ/WebjkeQC3pkRkc+qfyAH+Q2uhSASfVAsKkalBFh3Y9uwwuY1Tl4aHMvmAWvBpbIpP/PI90JhW",
        "encryption_key": "vSdEaKmbQUA4hUfbpx2LAi7rfYK3YwVPMt7w0M0wHWI6sPTlLI863Bgagja7pP3TAq6dTuwXnT0jxbW/I6i2LYshvUbkHJIl/6nddGbJiJzJNboFvVZNFlNYCRDm2T/lOx0PPcuuficHQpVrqZUTT8g9jB3gwkSvCQMVt41g4aKnNGmxze1nVLi3LlmILNfownTxWRkPP4ASbBVZ204qi4c/1EA3AKI0vuSB1I4Sjk2D77/Ui67QTVc5xqdk+AGUON/hkFAa4RSC0DXmNqKBLobPkY3RhK1n1SqmCifjGBsqMdpXPnfAZlibxeB5UssZKK+1Lcj2viKY3FUPZFCNm5GgUhzxyXH5BCHgpgbpS4JQ9+8uyiUxyG5MpRZrdRowz252b1QiZ12u5lnxDO6RKQGcwRvs2mEst6ikkTHIIoZ13q4aZHsW7VWP3+ogZj/o3EnLxcYJO2PNkoHhLcQya6NSvxxgA8x6oRDObOLnzspavNw7tHf2LwORrd3PYJylNgllpoFK1qUIIdYulESkLuE6jqURIgP8WYUZ3nhMEAaHJbB4G66KoDGam0cmxTKiHGG11QU8SUNVdU8w/eb1NmR5ZSQIJdQA7RyREklZdjsW+mmcHgygxynHjzBe7kiXBNYBWz2CVQxGE+TySIi4ZHE2rxLpSCFAKl3KtLIVG4o=",
        "encryption_algorithm": "AES256-GCM",
        "valid_hmac": true,
        "hmac": "HBzhe6ltfH0cfJ4rQCl8G6LX/eD6aJShh+9mYJ4ExHU=",
        "hmac_secret": "KxPZDbLAu7c5ASYiuOLWQwnQi2r7L7925x0MBuNaNQs1vcGa79y3+IF6uprD9MwwYIqZ/5CBaAJusUuVXJ9KXSWVu4SD8yGv6M1HkEPzic7pvywcH6zqjBYupjhWGcit9IfB1oWGMPG7T7s7Ctl7eBLpVyfSI2veXLFYViFoXlUPNovcQ1MgnPNAVaIuAlmHsEC6JIeSsHb1uhpYxapBWvZPYT9g/QKWggyCZDQWohYrscRq+iPa1YpMuJJ77R6Bb3hJzDwE9onZwz8Vnl3V2uY7JNw1WSyGu/chpBO4yMrTvYcvThsoo+lWbnoSmImWX3jHbVK/6+hxlyEnQJ+9YnZHk7a7b21UXOB/lmm58InK5FEaB2wotDSlrwJB7wLT5Y2PtqyamqRYlOtc14owfrfbHcSWe7RoGOhKzRILqgV8zFZv0sg/+uZU5dYm5ef/mRDeLBpfs4qbOHSsNm1CVQSK64SrEyv0wdFL+OSS5l9Vq/CEEgYG7Q7qz+m/ahCurI2o6GoIDvkEfA+5TfoJ3ZUU/l1DGlUiJx5YxQClktVoWfL2W790D5u5uHrI+Qzy00lJ/o/ffx4cgCZiJF+E4xuxNi7ZPByiftciNpXk2a1nyTE9HuB90UULBLwnr8mVzFrwfgkMbof4XlgAxOIsTv6PUPkyOq7Ol4H6B4zY27s=",
        "hmac_algorithm": "HMAC-SHA256",
        "is_error": false,
        "timestamp": "2024-09-02T07:12:34-05:00",
        "sealed": true,
        "public_key_signature": "SHA256:n/iTnE9b0sP1DQkaDMricHqPKYj0n00IjiaJ7lUmcAs",
        "transfer_state": "STARTED",
        "original": "CiQwNTFlZTQyMC0wMzM3LTQ4YWUtYjBkNS1kMjIxMmUzYjViZjESzQlsHjY9lq6eVOJg8/OtKrK0VA3ygKlA2P0KSVc0aaABx6Oe4MvyAfpal00476dZi6ucjsOc/BI5GXxsPbEdwVDXRymHuc86hTgVn7oB0W8G+kXu0mtb7PH1erAqJSot1CxgqXWSnhNUo0w50NAJ/d+5itt/Pw0vZ7mTlEi0fL8Aa1/f8EOBUrMwWAqSBme2l5dJFomMN8fdpo8gm0+rU6g1cOGTM+ZBbrcXHfQuPGq4FueQEensEXXYh6U11z/mtixXZiJMAxLF3CVe517BlRV8dhLU4xtoNcXa2auVYhzRb/hefEEbUFqS7kDwnZjn7D4AqQ9Li9Xh6sSBUBIaSg6AhAs4qRF0Hlbvaz1oXeOnCb8GXe1DrCFPbzEgJ/fpu5/2i8HRtADmqbjo5+tkYhw2kY8vBYh3aRRtkgfztX4gLFwKRKqIV2+X2MY6h0r0KF/2UhsVp8SN0ZJsnjt6sMRtMPefwKHgsyMxGBH9aa0EeSYCDT5m0/0hn50gnSM9Wj5SiF0SmN/p1N8NMdDiibn7IyeQXPGLaoRzdVd+aEakVvIRyTzJS7UUkeBKKMjeaYMsYY4IQPb4uO3hMiB4U7PyqEo/40r9o8jWcauu1xtnDdhg3nAMDMwLnnH1+7eid59BByG4cyySe5Fhlmp3zLAWqBj2prGCXAZK0rh5ay6wb+SjoG9w9+VtlkNOcrjw9TUuV481pdBTXeVOAyV0Y0iXf1InyygkqPt3JyCAIgRihENhYqh8X++PCojXtho7nu3H2Lp+s8TEFUVUjB+9DfsNckws0d2jm8a/auboeun0PP/GBNKzGTjrMdA7P9AROdyG6cwMph3KGBJx9/y0NsqKLS74n7Bw4Ljmr9CAZhXFAwOC7ksZkcMAFcScqubYxWuPPOyqkAIF/gbMmMkKrRIr859Bx2JwUIZ9+BleeDDEasTBrz3o2LAagyPby52kidea+VPlZzS1J/7uwmtRE5oyvak/rYCjFWoo+d81de5y56XMUv5joHuNlWO7hBsRPT7o8XnoqSuwzFe5Xle/ftLGr5JNeg+BHVWFkELbh7i49chi3hx/darruTYcaerjeW03ahgCEYLbafz99ru+MQNeNgUGDmlkJXcyDE1+aB+VBTXiEs3SN2DIVmVC3MLUWLv4o4jZySxXu9D+BDDMjBnrdVpcpGDZSMw2NjIT8nVkME6ADAV5IB1gRM6so5XJgIl4EQI4GZR1/A2THoaJvhdptuvAHjnqY+mbVJa2ZqLfKTlic9FyMOjq+UlNeEjdDNfkO9egy5Hg0uutWVpQBRZsymX9WeKPOsVNnIoKXjNEj4xc4XnGB/x1DW9B2Gq4skZJ6JIjjDx2XiDuXadljoKTyHAn0IDKbo96sP89ujGNAMpXF61beaQb2jwXhJxva2sfxgANoT+iCb5xxM8/uppC95LIPTtWBv2+/be5C+G+PadjY8mFjEnHM2eEtLEgnmN/2nzd8i1wigRedC9CjxjM8/HuhT5MS+UTTFRJNAKJc/gh0EVfTNgp+Wm1a52SgpQqTSHA9lMD7+nyaLUp8evE8q6V5sYN7LqtbgG3b77uGJWNpWtAeCktqt7LJaO3AVmESUNoIzIzo/c2yHqM5calIjwHisjaNXqKRt2z0BqABHANAo7Ayo3xyGeOqZOb7urckMB0jf8RvxQJXtSRkhQbEdjYFLgYcZFopdDAyTOJVgYTgZKWMRkpXljYqcuhEmcG26dHfVW59Y5ZzprW/UZALHmU8kVAFT3KIMecFI1caXVEufgqO9YEeiHqpBX1K2iQrtGics0hUOAV+EGPRleLJD6ChVX8D6f6olr7+bq6g0VK9hibZCdzDmZ36JXZMzbiNy/a0VJ/3oRq2mpPNpXx4Bgt8RoikxtQRWCXnO1+9p00DMMvja9TV1E02ijC+D4IkyPoVZe97J8ZW9OaFKXLiaqP+PvnJREDEPLGDzHDO/T8K7Zd+1tpPFNqGmDkJrav1dYH+UV8HGc9O+MVAQeF6E1HmZS6nafZBsW3Bs7PMxJNC63vdOrx+AndwiZWCH91Cjru1opmqA70/8Q2qAqkAX23iX4d3JlTx9xqXt+jE8q6SFT1wl4tq1xsi/GoRq87EWFWqinWRP82RdJbIbvtLJOyG9WceTG07wuEuYLTtk3dCMr9AL3fqIKnEnojO896crOh2QtCkK1u9KM0DhK7TkBTU+ANhTeCl3sXwM2ZCLaT93zgfJQqA7i6iSkNAtIpEBf8rgG/5e98ocJY9gTC0+7/oDClNxnrVjAWsvg13YrtZVhg5abGqRfoYKcAuGJbaD5lcIsHaiI0pHF7hVkHIgpBRVMyNTYtR0NNKiDiMXIASpCARn3lD+CWUVrOc3tlVxer1MUzautyr7Vr4TKABHW0IhgLaJjYFvUqHCsxJxf31VOQfS+NiZOLbX+oTKkPIGknxsUvoohRnEcau/azIl5Iz3wEjD7OFnsm38N524IRW0326y4GN1JPb0PlrtcdN6gJZOeckuBBbfmB5uL0wD0YSfaQ38VWobAvT6ew0R2gsOQ927BEnb1adKeyNktzQbkGFpEjcdxhegFcl/pIqVkWONUEbYEVC1ycHeHk+WImTSodywJKxPk81/GIKEda5HJwoD2vqtPErtKqh6qHXDtHX1RIm1B2qmcQdYMa+UwW0HqndseIQ/XM4W/9xtlj+lUlnBaoukj8i2TSxNJzpWokWD5X5BZUzUj4ZHEhOgFianasrcTgHqO722E+REz3UlBR6YtAt8HUkAvq+DFKGkmv9FjIQ+4fwOTJZd7Rji6ztzY3b6oIAkNihwySgn7H+xDLDr/GbasMtghyibN4IHT3Pbh+Imp8iGPlXQosYRrI5Le00OR3f6xBC6JL80FYiRj8oiG+rCVevBwpOUmKvVOhRoncYuToK3QN1PdQq6NZGN1KQ7N2unOQBX5kexsjgReSa5U/wXOihVDD59g6BHgoZeYTP2dsComzwm/KMnke2MhOxnZ6MKrN/VTyZ3Ofso82bdGfVbslm5+oUTfExU1VH/oB0UHAVrzN6f8Ixd6td7oUY1QltQQgaWKpNTwzOgtITUFDLVNIQTI1NlIeMjAyNC0wOC0yNVQwOTo0MjowOS4zNTcwMTQ0NjdaWAFiMlNIQTI1NjorQk5WYnBKQUxXQnpsUUlEbytROEdjMmNSL3RRNXcvNEZLckdJK3BDOUJraAI="
    }
}
Built with