Skip to main content
Search

IVMS-101 Format Guidelines

*Please note that it is necessary to have default key-value of IVMS-101, please check section Default Key-Value of IVMS.

The payload to be encrypted should look like below, the ivms101 payload is as a child inside the key name “ivms101”: { … }.

{
  "ivms101": {
    //...
  }
}

Where the required information depends on Legal Person or Natural Person to make a transaction, the following structure may help you to fill the info.

One validated IVMS structure sent from Originator requires “Originator”, “Beneficiary”, “OriginatingVASP” inside, and the case is sensitive.

Following structure overviews the structure in IVMS-101, please note that the case is sensitive and name, value type (Object or Array) is also important.

{
  "ivms101": {
    "Originator": {
      "originatorPersons": [
        // LegalPerson or NaturalPerson
      ],
      "accountNumber": ["ACCOUNT NUMBER"]
    },
    "Beneficiary": {
      "beneficiaryPersons": [
        // LegalPerson or NaturalPerson
      ],
      "accountNumber": ["ACCOUNT NUMBER"]
    },
    "OriginatingVASP": {
      "originatingVASP": {
        "legalPerson": {
          // LegalPerson
        }
      }
    },
    "BeneficiaryVASP": {
      "beneficiaryVASP": {
        "legalPerson": {
          // LegalPerson
        }
      }
    }
    // option: transferPath (IntermediaryVasp)
    // option: payloadMetadata (TransliterationMethodCode)
  }
}

About Field - Originator, Beneficiary​

We assume that you already have both originator person and beneficiary person info in your system, the verify target is beneficiary person, the travel rule verify request will focus on verify the beneficiary info.

As the OriginatingVASP, should make sure that you put the person info in beneficiary, and if the beneficiary and originator is the same person, you could directly use the same info for Originator and Beneficiary fields.

As the BeneficiaryVASP, the info in the Beneficiary field is to let you know the person who makes a transaction to your service.

Transaction target could be a natural person or legal person (company), it use the different structure in IVMS, please refer to the section:

  • Example - Natural Person
  • Example - Legal Person

About Field - OriginatingVASP​

If you initiate the Pre-transaction travel rule verify flow, that means you are OriginatingVASP, please fill your company entity info into the corresponding field.

(For initiator) The above's example struct is following:

{
  "ivms101": {
    // Your company info (Because you're an originating VASP)
    "OriginatingVASP": {
      "originatingVASP": {
        // required, you are an legal person
        "legalPerson": {
          "countryOfRegistration": "[2-Alpha Country Code]",
          // required
          "geographicAddress": [
            {
              "country": "[2-Alpha Country Code]",
              "townName": "[Town Name]",
              "addressType": "GEOG",
              "addressLine": ["[Full Address]"]
            }
          ],
          "name": {
            "nameIdentifier": [
              {
                // required
                "legalPersonName": "[Your Company Name]",
                "legalPersonNameIdentifierType": "LEGL"
              }
            ]
          },
          "nationalIdentification": {
            "countryOfIssue": "[2-Alpha Country Code]",
            "nationalIdentifier": "[ID Code]",
            "nationalIdentifierType": "LEGL",
            "registrationAuthority": "[The name who (Government,Department,Company...etc) authorized this identity number]"
          }
        }
      }
    },
    "Originator": {
      // ...
    },
    "Beneficiary": {
      // ...
    }
  }
}

Once you receive the Pre-transaction travel rule request (as receiver server), you have to put your company info to BeneficiaryVASP and encrypt it back again.

{
  "ivms101": {
    // Your company info (Because you're an beneficiary VASP)
    "BeneficiaryVASP": {
      "beneficiaryVASP": {
        // required, you are an legal person
        "legalPerson": {
          "countryOfRegistration": "[2-Alpha Country Code]",
          // required
          "geographicAddress": [
            {
              "country": "[2-Alpha Country Code]",
              "townName": "[Town Name]",
              "addressType": "GEOG",
              "addressLine": ["[Full Address]"]
            }
          ],
          "name": {
            "nameIdentifier": [
              {
                // required
                "legalPersonName": "[Your Company Name]",
                "legalPersonNameIdentifierType": "LEGL"
              }
            ]
          },
          "nationalIdentification": {
            "countryOfIssue": "[2-Alpha Country Code]",
            "nationalIdentifier": "[ID Code]",
            "nationalIdentifierType": "LEGL",
            "registrationAuthority": "[The name who (Government,Department,Company...etc) authorized this identity number]"
          }
        }
      }
    },
    "OriginatingVASP": {
      "originatingVASP": {
        // required, you are an legal person
        "legalPerson": {
          "countryOfRegistration": "[2-Alpha Country Code]",
          // required
          "geographicAddress": [
            {
              "country": "[2-Alpha Country Code]",
              "townName": "[Town Name]",
              "addressType": "GEOG",
              "addressLine": ["[Full Address]"]
            }
          ],
          "name": {
            "nameIdentifier": [
              {
                // required
                "legalPersonName": "[Your Company Name]",
                "legalPersonNameIdentifierType": "LEGL"
              }
            ]
          },
          "nationalIdentification": {
            "countryOfIssue": "[2-Alpha Country Code]",
            "nationalIdentifier": "[ID Code]",
            "nationalIdentifierType": "LEGL",
            "registrationAuthority": "[The name who (Government,Department,Company...etc) authorized this identity number]"
          }
        }
      }
    },
    "Originator": {
      // ...
    },
    "Beneficiary": {
      // ...
    }
  }
}

About Field - BeneficiaryVASP​

if you initiate a travel rule request for Post-transaction travel rule, that means you are BeneficiaryVASP, please fill your company entity info into the corresponding field.

The above's example struct is following:

{
  "ivms101": {
    // Your company info (Because you're an beneficiary VASP)
    "BeneficiaryVASP": {
      "beneficiaryVASP": {
        // required, you are an legal person
        "legalPerson": {
          "countryOfRegistration": "[2-Alpha Country Code]",
          // required
          "geographicAddress": [
            {
              "country": "[2-Alpha Country Code]",
              "townName": "[Town Name]",
              "addressType": "GEOG",
              "addressLine": ["[Full Address]"]
            }
          ],
          "name": {
            "nameIdentifier": [
              {
                // required
                "legalPersonName": "[Your Company Name]",
                "legalPersonNameIdentifierType": "LEGL"
              }
            ]
          },
          "nationalIdentification": {
            "countryOfIssue": "[2-Alpha Country Code]",
            "nationalIdentifier": "[ID Code]",
            "nationalIdentifierType": "LEGL",
            "registrationAuthority": "[The name who (Government,Department,Company...etc) authorized this identity number]"
          }
        }
      }
    },
    "Originator": {
      // ...
    },
    "Beneficiary": {
      // ...
    }
  }
}

Once you receive the Post-transaction travel rule request (as receiver server), you have to put your company info to OriginatingVASP and encrypt it back again.

{
  "ivms101": {
    // Your company info (Because you're an originating VASP)
    "OriginatingVASP": {
      "originatingVASP": {
        // required, you are an legal person
        "legalPerson": {
          "countryOfRegistration": "[2-Alpha Country Code]",
          // required
          "geographicAddress": [
            {
              "country": "[2-Alpha Country Code]",
              "townName": "[Town Name]",
              "addressType": "GEOG",
              "addressLine": ["[Full Address]"]
            }
          ],
          "name": {
            "nameIdentifier": [
              {
                // required
                "legalPersonName": "[Your Company Name]",
                "legalPersonNameIdentifierType": "LEGL"
              }
            ]
          },
          "nationalIdentification": {
            "countryOfIssue": "[2-Alpha Country Code]",
            "nationalIdentifier": "[ID Code]",
            "nationalIdentifierType": "LEGL",
            "registrationAuthority": "[The name who (Government,Department,Company...etc) authorized this identity number]"
          }
        }
      }
    },
    "BeneficiaryVASP": {
      "beneficiaryVASP": {
        // required, you are an legal person
        "legalPerson": {
          "countryOfRegistration": "[2-Alpha Country Code]",
          // required
          "geographicAddress": [
            {
              "country": "[2-Alpha Country Code]",
              "townName": "[Town Name]",
              "addressType": "GEOG",
              "addressLine": ["[Full Address]"]
            }
          ],
          "name": {
            "nameIdentifier": [
              {
                // required
                "legalPersonName": "[Your Company Name]",
                "legalPersonNameIdentifierType": "LEGL"
              }
            ]
          },
          "nationalIdentification": {
            "countryOfIssue": "[2-Alpha Country Code]",
            "nationalIdentifier": "[ID Code]",
            "nationalIdentifierType": "LEGL",
            "registrationAuthority": "[The name who (Government,Department,Company...etc) authorized this identity number]"
          }
        }
      }
    },
    "Originator": {
      // ...
    },
    "Beneficiary": {
      // ...
    }
  }
}

Default Key-Value of IVMS​

To avoiding null pointer issue, we will strongly recommend you to fill in the following key-value when you integrate IVMS-101, please check the folling empty structure, even you don't have the fields data, please fill as default.

For Natural Person Default​

{
  ...
  {
      "naturalPerson": {
        // required
        "name": {
          "localNameIdentifier": [ // at least given not-null default element
            {
              "nameIdentifierType": "LEGL",
              "primaryIdentifier": "",
              "secondaryIdentifier": ""
            }
          ],
          "nameIdentifier": [ // at least given not-null default element
            {
              "nameIdentifierType": "LEGL",
              "primaryIdentifier": "",
              "secondaryIdentifier": ""
            }
          ],
          "phoneticNameIdentifier": [] // ok to be empty
        },

        // required
        "dateAndPlaceOfBirth": {
          "placeOfBirth": "", 
          "dateOfBirth": ""
        },
        
        // optional: if you use one of field, please set default like below
        "geographicAddress": [
          // at least given not-null default element
          {
            "addressType": "GEOG",
            "townName": "",
            "addressLine": [
              // at least given not-null default element
              ""
            ], 
            "country": "",
            "postCode": ""
          }
        ],
        // optional: can leave all key unset
        "nationalIdentification": {
          "nationalIdentifier": "",
          "nationalIdentifierType": "",
          "countryOfIssue": ""
        },
        // required
        "customerIdentification": "",
        // required
        "countryOfResidence": ""
      }
  }
}
{
  ...
      {
          "legalPerson": {
            // required
            "name": {
              "nameIdentifier": [
                {
                  "legalPersonName": "",
                  "legalPersonNameIdentifierType": "LEGL"
                }
              ]
            },
            // optional: can leave all key unset
            "nationalIdentification": {
              "nationalIdentifierType": "RAID",
              "registrationAuthority": "",
              "countryOfIssue": "",
              "nationalIdentifier": "" 
            },

            // optional: if you use one of field, please set default like below
            "geographicAddress": [
              // at least given not-null default element
              {
                "addressType": "GEOG",
                "townName": "",
                "addressLine": [
                  // at least given not-null default element
                  ""
                ], 
                "country": "",
                "postCode": ""
              }
            ],
            // required
            "customerIdentification": "",
            // required
            "countryOfRegistration": "HK"
          }
        },
        // required both legalPerson (ex: CEO name) and naturalPerson
        {
          "naturalPerson": {
            // required
            "dateAndPlaceOfBirth": {
              "placeOfBirth": "",
              "dateOfBirth": ""
            },
            // required
            "name": {
              "localNameIdentifier": [
                {
                  "nameIdentifierType": "LEGL",
                  "primaryIdentifier": "",
                  "secondaryIdentifier": ""
                }
              ],
              "nameIdentifier": [
                {
                  "nameIdentifierType": "LEGL",
                  "primaryIdentifier": "",
                  "secondaryIdentifier": ""
                }
              ]
            },
            // optional: if you use one of field, please set default like below
            "geographicAddress": [
              {
                "addressType": "GEOG",
                "townName": "",
                "addressLine": [
                  // at least given not-null default element
                  ""
                ], 
                "country": "",
                "postCode": ""
              }
            ],
            // optional: can leave all key unset
            "nationalIdentification": {
              "nationalIdentifier": "",
              "nationalIdentifierType": "",
              "countryOfIssue": ""
            },

            // required
            "customerIdentification": "",
            
            // required
            "countryOfResidence": ""
          }
        }
      ],
      "accountNumber": [""]
    }
...
}

Full Example of IVMS​

The detail of structure definition is below, the following structure is a full example of IVMS-101.

{
  "ivms101": {
    "OriginatingVASP": {
      "originatingVASP": {
        // required
        "legalPerson": {
          // required, nameIdentifier*, localNameIdentifier, phoneticNameIdentifier
          "name": {
            "nameIdentifier": [
              {
                "legalPersonName": "Originator VASP Company Name - VVVV Inc.",
                "legalPersonNameIdentifierType": "LEGL" // Usually Fixed as LEGL //  for legal person: LEGL, SHRT, TRAD
              }
            ]
          },
          // required, For Company Legal Person use RAID and fill your company ID in nationalIdentifier
          "nationalIdentification": {
            // nationalIdentifierType: ISO20022, ARNU, CCPT, RAID, DRLC, FIIN, TXID, SOCS, IDCD, LEIX, MISC,
            "nationalIdentifierType": "RAID",
            // registrationAuthority: GLEIF code (i.e: 香港公司註冊處核發 Hong Kong Company Registry Approved, For more please check: https://www.gleif.org/en/about-lei/code-lists/gleif-registration-authorities-list)
            "registrationAuthority": "RA000388",
            // countryOfIssue: ISO 3166-1 alpha-2 codes
            "countryOfIssue": "HK",
            // nationalIdentifier: (i.e: Your Company ID from authroity)
            "nationalIdentifier": "38429049028390482"
          },
          // required
          "geographicAddress": [
            {
              // required
              "country": "HK", // ISO 3166-1 alpha-2 codes
              "townName": "Hong Kong",
              "addressType": "GEOG", // HOME, BIZZ, GEOG
              "addressLine": ["Please fill your address here"],
              "postCode": "TT7643",

              // optional:
              "department": "OfficeOfTheCEO",
              "subDepartment": "InternalAudit8562",
              "streetName": "SiliconAlley65",
              "buildingNumber": "J4H6",
              "buildingName": "VirtualTower200",
              "floor": "Floor94",
              "postBox": "CB842",
              "room": "BionicRoom38",
              "townLocationName": "E-Sector",
              "districtName": "BlockchainDistrict",
              "countrySubDivision": "E-Province"
            }
          ],
          // required
          "countryOfRegistration": "HK"
        }
      }
    },
    "BeneficiaryVASP": {
      "beneficiaryVASP": {
        // required
        "legalPerson": {
          // required, nameIdentifier*, localNameIdentifier, phoneticNameIdentifier
          "name": {
            "nameIdentifier": [
              {
                "legalPersonName": "Beneficiary VASP Company Name - VVVV Inc.",
                "legalPersonNameIdentifierType": "LEGL" // Usually Fixed as LEGL //  for legal person: LEGL, SHRT, TRAD
              }
            ]
          },
          // required, For Company Legal Person use RAID and fill your company ID in nationalIdentifier
          "nationalIdentification": {
            // nationalIdentifierType: ISO20022, ARNU, CCPT, RAID, DRLC, FIIN, TXID, SOCS, IDCD, LEIX, MISC,
            "nationalIdentifierType": "RAID",
            // registrationAuthority: GLEIF code (i.e: 香港公司註冊處核發 Hong Kong Company Registry Approved, For more please check: https://www.gleif.org/en/about-lei/code-lists/gleif-registration-authorities-list)
            "registrationAuthority": "RA000388",
            // countryOfIssue: ISO 3166-1 alpha-2 codes
            "countryOfIssue": "HK",
            // nationalIdentifier: (i.e: Your Company ID from authroity)
            "nationalIdentifier": "38429049028390482"
          },
          // required
          "geographicAddress": [
            {
              // required
              "country": "HK", // ISO 3166-1 alpha-2 codes
              "townName": "Hong Kong",
              "addressType": "GEOG", // HOME, BIZZ, GEOG
              "addressLine": ["Please fill your address here"],
              "postCode": "TT7643",

              // optional:
              "department": "OfficeOfTheCEO",
              "subDepartment": "InternalAudit8562",
              "streetName": "SiliconAlley65",
              "buildingNumber": "J4H6",
              "buildingName": "VirtualTower200",
              "floor": "Floor94",
              "postBox": "CB842",
              "room": "BionicRoom38",
              "townLocationName": "E-Sector",
              "districtName": "BlockchainDistrict",
              "countrySubDivision": "E-Province"
            }
          ],
          // required
          "countryOfRegistration": "HK"
        }
      }
    },
    "Originator": {
      // required, the user wallet address
      "accountNumber": [
        "1GURHee2JsCkdpxVisjbjAeNhbDbGub8R4" // Max 100 text, ^[a-zA-Z0-9' ]{1,100}$
      ],
      "originatorPersons": [
        {
          "naturalPerson": {
            // required
            "dateAndPlaceOfBirth": {
              "placeOfBirth": "US", // ISO-3166-1 alpha-2 codes
              "dateOfBirth": "1986-11-21"
            },
            // required
            "name": {
              // have: nameIdentifier (required), localNameIdentifier (required), phoneticNameIdentifier (optional)
              "localNameIdentifier": [
                {
                  // nameIdentifierType: Usually Fixed as LEGL // for natural person: ALIA, BIRT, MAID, LEGL, MISC
                  "nameIdentifierType": "LEGL",
                  // primaryIdentifier: lastname, or lastname + firstname
                  "primaryIdentifier": "サトシ",
                  // primaryIdentifier: firstname, or leave empty if cannot recognize
                  "secondaryIdentifier": "ナカモト"
                }
              ],
              "nameIdentifier": [
                {
                  "nameIdentifierType": "LEGL",
                  "primaryIdentifier": "Satoshi",
                  "secondaryIdentifier": "Nakamoto"
                }
              ],
              // optional
              "phoneticNameIdentifier": [
                {
                  "nameIdentifierType": "LEGL",
                  "primaryIdentifier": "Satoshi",
                  "secondaryIdentifier": "Nakamoto"
                }
              ]
            },
            // optional
            "geographicAddress": [
              {
                // required (if have):
                "addressType": "GEOG", // HOME, BIZZ, GEOG
                // townName can also be city / town
                "townName": "VirtualTown",
                "addressLine": ["Line489", "Line762"],
                "country": "US", // ISO-3166-1 alpha-2 codes
                "postCode": "TT7643",

                // optional:
                "department": "OfficeOfTheCEO",
                "subDepartment": "InternalAudit8562",
                "streetName": "SiliconAlley65",
                "buildingNumber": "J4H6",
                "buildingName": "VirtualTower200",
                "floor": "Floor94",
                "postBox": "CB842",
                "room": "BionicRoom38",
                "townLocationName": "E-Sector",
                "districtName": "BlockchainDistrict",
                // countrySubDivision is also a country state
                "countrySubDivision": "E-Province"
              }
            ],
            // optional
            "nationalIdentification": {
              // nationalIdentifier, for example Passport number (CCPT), ^[a-zA-Z0-9' ]{1,35}$
              "nationalIdentifier": "1032903940290499SDF3-40DA024",
              // CCPT: Passport, ISO20022, ARNU, CCPT, RAID, DRLC, FIIN, TXID, SOCS, IDCD, LEIX, MISC
              "nationalIdentifierType": "CCPT",
              // registrationAuthority 不填寫，外交部發行的不是法人單位，是政府單位。 don't fill the registrationAuthority, the identity approved by immigration affairs is government department, not legal person
              "countryOfIssue": "HK"
            },
            // required, (i.e: customer id from originator service)
            "customerIdentification": "10929392485393",
            // required
            "countryOfResidence": "US"
          }
        }
      ]
    },
    "Beneficiary": {
      "beneficiaryPersons": [
        // required: naturalPerson or legalPerson
        // NOTE: if you send to legalPerson, please fill [{naturalPerson:{}},{legalPerson:{}}] both, the natural person only need to given [{naturalPerson}]
        {
          "legalPerson": {
            // required, nameIdentifier*, localNameIdentifier, phoneticNameIdentifier
            "name": {
              "nameIdentifier": [
                {
                  "legalPersonName": "Paycase Inc",
                  "legalPersonNameIdentifierType": "LEGL" // Usually Fixed as LEGL // for legal person: LEGL, SHRT, TRAD
                }
              ]
            },
            // optional, For Company Legal Person use RAID and fill your company ID in nationalIdentifier
            "nationalIdentification": {
              // RAID is means nationalIdentifier is company ID in authority coutnry
              "nationalIdentifierType": "RAID", // ISO20022, ARNU, CCPT, RAID, DRLC, FIIN, TXID, SOCS, IDCD, LEIX, MISC
              // GLEIF code (i.e: 香港公司註冊處核發 Hong Kong Company Registry Approved, For more please check: https://www.gleif.org/en/about-lei/code-lists/gleif-registration-authorities-list)
              "registrationAuthority": "RA000388",
              "countryOfIssue": "HK",
              // (i.e: Your Company ID from authroity)
              "nationalIdentifier": "38429049028390482" // ^[a-zA-Z0-9' ]{1,35}$
            },
            // optional
            "geographicAddress": [
              // SAME AS Originator's geographicAddress
            ],
            // required,  (i.e: customer id from originator service)
            "customerIdentification": "0x3E9181d09E56AdEF3bbc8BAb664Ce6B268Bf6e62",
            // required
            "countryOfRegistration": "HK" // ISO-3166-1 alpha-2 codes
          }
        },
        // required both legalPerson (ex: CEO name) and naturalPerson
        {
          // example fields below, please refer to above naturalPerson structure
          "naturalPerson": {
            // required
            "dateAndPlaceOfBirth": {
              "placeOfBirth": "US",
              "dateOfBirth": "1986-11-21"
            },
            // required
            "name": {
              "localNameIdentifier": [
                {
                  "nameIdentifierType": "LEGL",
                  "primaryIdentifier": "サトシ",
                  "secondaryIdentifier": "ナカモト"
                }
              ],
              "nameIdentifier": [
                {
                  "nameIdentifierType": "LEGL",
                  "primaryIdentifier": "Satoshi",
                  "secondaryIdentifier": "Nakamoto"
                }
              ]
            },
            // optional
            "geographicAddress": [
              {
                "addressType": "GEOG",
                "streetName": "Potential Street",
                "buildingNumber": "123",
                "buildingName": "Cheese Hut",
                "postCode": "91361",
                "townName": "Thousand Oaks",
                "countrySubDivision": "California",
                "country": "US"
              }
            ],
            // optional
            "nationalIdentification": {
              "nationalIdentifier": "1032903940290499SDF3-40DA024",
              "nationalIdentifierType": "CCPT",
              "countryOfIssue": "HK"
            },
            // required
            "customerIdentification": "10929392485393",
            // required
            "countryOfResidence": "US"
          }
        }
      ],
      "accountNumber": ["1GURHee2JsCkdpxVisjbjAeNhbDbGub8R4"]
    }
  }
}

Parameters Description​

  • The nameIdentifierType is commonly set to 'LEGL'.
  • primaryIdentifier is lastName, secondaryIdentifier is firstName.
  • For primaryIdentifier, secondaryIdentifier. If the name cannot be separated, please fill firstName and lastName together (1. firstName 2. lastName).
  • firstName: givenName, lastName: familyName.
  • For the current version of IVMS specification, only the root level has first capital naming (e.g: Beneficiary, BeneficiaryVASP, Originator, OriginatingVASP).

In addition:

registrationAuthority

nameIdentifierType (naturalPersonNameType)

  • ALIA (Alias name): A name other than the legal name by which a natural person is also known.
  • BIRT (Name at birth): The name given to a natural person at birth.
  • MAID (Maiden name): The original name of a natural person who has changed their name after marriage.
  • LEGL (Legal name): The name that identifies a natural person for legal, official or administrative purposes.
  • MISC (Unspecified): A name by which a natural person may be known but which cannot otherwise be categorized or the category of which the sender is unable to determine.

legalPersonNameIdentifierType (legalPersonNameType)

  • LEGL (Legal name): Official name under which an organisation is registered.
  • SHRT (Short name): Specifies the short name of the organisation.
  • TRAD (Trading name): Name used by a business for commercial purposes, although its registered legal name, used for contracts and other formal situations, may be another.

nationalIdentifierType

  • ARNU: Alien registration number (a number issued by the government to foreigners to identify them)
  • CCPT: passport number
  • RAID: (body corporate only) Business registration number provided by the authority
  • DRLC: Driver's License Number
  • FIIN: Foreign Investor Number (number assigned to foreign investors)
  • TXID: Number given by the tax authority
  • SOCS: Social Security Number or National Identification Number
  • IDCD: Identity card number assigned by a state agency
  • LEIX: (Legal entities only) Global legal entity identification number, LEI code assigned in accordance with the ISO 17442 standard
  • MISC: ID card number from other countries

Others

Other fields for more over,these are not necessary for the payloads:

  1. localNameIdentifier: for non-English name of identity person, full name separated into primary and secondary identifier using local characters.

    {
      "primaryIdentifier": "김",
      "secondaryIdentifier": "김지수",
      "nameIdentifierType": "LEGL" // IVMS101: ALIA, BIRT, MAID, LEGL, MISC
    }

  2. phoneticNameIdentifier: Alternate representation of a name that corresponds to the manner the name is pronounced.

    {
      "primaryIdentifier": "Kim",
      "secondaryIdentifier": "Jisoo",
      "nameIdentifierType": "LEGL" // IVMS101: ALIA, BIRT, MAID, LEGL, MISC
    }

  3. transferPath (IntermediaryVasp): The transfer path refers to the intermediary VASP(s) participating in a serial chain that receive(s) and retransmit(s) a VA transfer on behalf of the originating VASP and the beneficiary VASP, or another intermediary VASP, together with their corresponding sequence number.

    {
      "transferPath": [
        // IntermediaryVasp
        {
          "intermediaryVasp": {
            // legalPerson of vasp },
            "sequence": 0 // count from 0 to 9007199254740991L
          }
        }
      ]
    }

  4. payloadMetadata (TransliterationMethodCode): Data describing the contents of the payload. TransliterationMethodCode is the method used to map from a national system of writing to Latin script.

    {
      "payloadMetadata": [
        "kore" // ISO 15924, arab, aran, armn, cyrl, deva, geor, grek, hani, hebr, kana, kore, thai, othr
      ]
    }

For ISO 15924, the available enum is: arab, aran, armn, cyrl, deva, geor, grek, hani, hebr, kana, kore, thai, othr.

  • arab, Arabic (Arabic language) ISO 233-2:1993
  • aran, Arabic (Persian language) ISO 233-3:1999
  • armn, Armenian ISO 9985:1996
  • cyrl, Cyrillic ISO 9:1995
  • deva, Devanagari & related Indic ISO 15919:2001
  • geor, Georgian ISO 9984:1996
  • grek, Greek ISO 843:1997
  • hani, Han (Hanzi, Kanji, Hanja) ISO 7098:2015
  • hebr, Hebrew ISO 259-2:1994
  • kana, Kana ISO 3602:1989
  • kore, Korean Revised Romanization of Korean
  • thai, Thai ISO 11940-2:2007
  • othr, Script other than those listed above Unspecified

For example: 한국어 (hangug-eo), the method is "kore".