Sign in

v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB
Transfers

Append PII data to a transfer

Appends IVMS101 PII (Personally Identifiable Information) data to an existing transfer. The PII data is validated against the transfer's presentation definition (if set) and encrypted before storage. All arrays in the IVMS101 structure are limited to 25 items to prevent unbounded payload attacks.

post/entities/{entityDID}/tx/{transferId}/append

Path parameters

entityDIDstring did required

Decentralized Identifier (DID)

Example:did:web:vasps.id:jxnl0411:at

The DID of the entity

transferIdstring uuid required
Example:01f09c55-9de0-42c5-874f-237dcb51fd9f

The transfer ID

Request body

Example request

{
  "ivms101": {
    "originator": {
      "originatorPerson": [
        {
          "naturalPerson": {
            "name": {
              "nameIdentifier": [
                {
                  "primaryIdentifier": "Smith",
                  "secondaryIdentifier": "John",
                  "naturalPersonNameIdentifierType": "LEGL"
                }
              ]
            },
            "dateAndPlaceOfBirth": {
              "dateOfBirth": "1990-01-15"
            }
          },
          "accountNumber": [
            "DE89370400440532013000"
          ]
        }
      ]
    },
    "beneficiary": {
      "beneficiaryPerson": [
        {
          "legalPerson": {
            "name": {
              "nameIdentifier": [
                {
                  "legalPersonName": "Recipient Corp",
                  "legalPersonNameIdentifierType": "LEGL"
                }
              ]
            }
          },
          "accountNumber": [
            "DE89370400440532013001"
          ]
        }
      ]
    }
  },
  "originator": {
    "@id": "originator-ref-123"
  },
  "beneficiary": {
    "@id": "beneficiary-ref-456"
  }
}

Response

Transfer PII data appended successfully

messagestring

Example response

{
  "message": "Transfer appended successfully with encrypted PII"
}