IVMS101 plaintext examples
Build natural-person and legal-person payloads before encryption.
Use these examples to prepare the plaintext for Partner-to-CryptoSwift messages. The API request itself carries an encrypted base64 string, never these plaintext objects.
Wrap the plaintext
Before calling POST /partners/transactions, first create the plaintext IVMS101 payload with the required Originator and Beneficiary personal data. The plaintext object that gets encrypted must be wrapped inside an ivms101 root object:
{
"ivms101": {
"Originator": {
"...": "..."
},
"Beneficiary": {
"...": "..."
}
}
}
Encrypt this whole wrapper object, not only the inner Originator and Beneficiary values. The encrypted output is then base64 encoded and sent as the top-level ivms101 string in the Travel Rule message request.
Example: Natural Persons
{
"ivms101": {
"Originator": {
"originatorPersons": [
{
"naturalPerson": {
"name": {
"nameIdentifier": [
{
"primaryIdentifier": "Coleman",
"secondaryIdentifier": "Thomas",
"nameIdentifierType": "LEGL"
}
]
},
"dateAndPlaceOfBirth": {
"dateOfBirth": "1964-05-13",
"placeOfBirth": "US"
},
"customerIdentification": "AB9876521",
"countryOfResidence": "US"
}
}
],
"accountNumber": [
"0x3e069aeac00a0b098fcf1310eea3ea9a940325d3"
]
},
"Beneficiary": {
"beneficiaryPersons": [
{
"naturalPerson": {
"name": {
"nameIdentifier": [
{
"primaryIdentifier": "Coins",
"secondaryIdentifier": "Linda",
"nameIdentifierType": "LEGL"
}
]
},
"dateAndPlaceOfBirth": {
"dateOfBirth": "1998-11-01",
"placeOfBirth": "DE"
},
"customerIdentification": "DE52327832",
"countryOfResidence": "DE"
}
}
],
"accountNumber": [
"0x05ff6964D21e5dAE3b1010D5AE0465b3c450F381"
]
}
}
}
Example: Legal Persons
{
"ivms101": {
"Originator": {
"originatorPersons": [
{
"legalPerson": {
"name": {
"nameIdentifier": [
{
"legalPersonName": "Coleman Digital Assets Inc.",
"legalPersonNameIdentifierType": "LEGL"
}
]
},
"nationalIdentification": {
"nationalIdentifier": "5493001KJTIIGC8Y1R12",
"nationalIdentifierType": "LEIX"
},
"customerIdentification": "AB9876521",
"countryOfRegistration": "US"
}
},
{
"naturalPerson": {
"name": {
"nameIdentifier": [
{
"primaryIdentifier": "Coleman",
"secondaryIdentifier": "Thomas",
"nameIdentifierType": "LEGL"
}
]
}
}
}
],
"accountNumber": [
"0x3e069aeac00a0b098fcf1310eea3ea9a940325d3"
]
},
"Beneficiary": {
"beneficiaryPersons": [
{
"legalPerson": {
"name": {
"nameIdentifier": [
{
"legalPersonName": "Coins Treasury GmbH",
"legalPersonNameIdentifierType": "LEGL"
}
]
},
"nationalIdentification": {
"nationalIdentifier": "529900T8BM49AURSDO55",
"nationalIdentifierType": "LEIX"
},
"customerIdentification": "DE52327832",
"countryOfRegistration": "DE"
}
},
{
"naturalPerson": {
"name": {
"nameIdentifier": [
{
"primaryIdentifier": "Coins",
"secondaryIdentifier": "Linda",
"nameIdentifierType": "LEGL"
}
]
}
}
}
],
"accountNumber": [
"0x05ff6964D21e5dAE3b1010D5AE0465b3c450F381"
]
}
}
}
When the Originator or Beneficiary is a legal person, include a related natural person as well. This is usually the person initiating or receiving the transaction on behalf of the company, or a company representative such as a director or CEO, depending on the use case.
Because the originating and beneficiary VASPs are known to both networks and their public keys are shared separately, you do not need to include OriginatorVASP or BeneficiaryVASP objects inside the wrapped IVMS101 plaintext. You can include those objects optionally when your internal data model requires them, but CryptoSwift does not require them for this Partner API flow.
Use the IVMS101 data model for the complete plaintext field definitions.
Encrypt before sending
Encrypt the entire wrapper, base64 encode the encrypted output, and place the string in the request's top-level ivms101 field. originatorVaspPubKey must correspond to the sender private key used for encryption.
Follow the Message Encryption Protocol for key conversion, nonce handling, and the Node.js/TypeScript helper. Use the messaging API examples for the final encrypted request and response.