v1
latestOpenAPI 3.1.02026-07-2685154311.7 KBPII
Transfers
Present PII data to counterparties
Used to present PII data to counterparties in a transfer. This endpoint is used for sharing PII between entities and can optionally skip validation with skipValidation=true parameter.
post/entities/{entityDID}/transfers/{transferId}/policies/{policyId}/presentation
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
policyIdstring required
The policy ID
Query parameters
skipValidationboolean
Whether to skip validation
Request body
Example request
{
"ivms101": {
"originator": {
"originatorPerson": [
{
"naturalPerson": {
"name": {
"nameIdentifier": [
{
"primaryIdentifier": "John Smith",
"secondaryIdentifier": "Dr.",
"naturalPersonNameIdentifierType": "LEGL"
}
]
},
"geographicAddress": [
{
"addressType": "HOME",
"addressLine": [
"123 Main Street"
],
"postCode": "10001",
"townName": "New York",
"countrySubDivision": "NY",
"country": "US"
}
],
"nationalIdentification": {
"nationalIdentifier": "123-45-6789",
"nationalIdentifierType": "SOCS",
"registrationAuthority": "US-SSA",
"countryOfIssue": "US"
},
"customerIdentification": "CUST123456789",
"dateAndPlaceOfBirth": {
"dateOfBirth": "1980-01-01",
"placeOfBirth": "New York, USA"
}
},
"legalPerson": {
"name": {
"nameIdentifier": [
{
"legalPersonName": "Smith Enterprises LLC",
"legalPersonNameIdentifierType": "LEGL"
}
]
},
"geographicAddress": [
{
"addressType": "BIZZ",
"addressLine": [
"456 Business Avenue"
],
"postCode": "10002",
"townName": "New York",
"country": "US"
}
],
"nationalIdentification": {
"nationalIdentifier": "87-1234567",
"nationalIdentifierType": "TXID",
"registrationAuthority": "US-IRS"
},
"customerIdentification": "CORP123456789"
},
"accountNumber": [
"1234567890"
]
}
]
},
"beneficiary": {
"beneficiaryPerson": [
{
"naturalPerson": {
"name": {
"nameIdentifier": [
{
"primaryIdentifier": "Jane Doe",
"secondaryIdentifier": "Ms.",
"naturalPersonNameIdentifierType": "LEGL"
}
]
},
"geographicAddress": [
{
"addressType": "HOME",
"addressLine": [
"789 Residential Lane"
],
"postCode": "SW1A 1AA",
"townName": "London",
"countrySubDivision": "Greater London",
"country": "GB"
}
],
"nationalIdentification": {
"nationalIdentifier": "AB123456C",
"nationalIdentifierType": "NIDN",
"registrationAuthority": "GB-HMRC",
"countryOfIssue": "GB"
},
"customerIdentification": "CUST987654321",
"dateAndPlaceOfBirth": {
"dateOfBirth": "1985-05-15",
"placeOfBirth": "London, UK"
}
},
"legalPerson": {
"name": {
"nameIdentifier": [
{
"legalPersonName": "Doe Investments Ltd",
"legalPersonNameIdentifierType": "LEGL"
}
]
},
"geographicAddress": [
{
"addressType": "BIZZ",
"addressLine": [
"101 Financial Street"
],
"postCode": "EC2V 7PH",
"townName": "London",
"countrySubDivision": "Greater London",
"country": "GB"
}
],
"nationalIdentification": {
"nationalIdentifier": "12345678",
"nationalIdentifierType": "RAID",
"registrationAuthority": "GB-COH"
},
"customerIdentification": "CORP987654321",
"countryOfRegistration": "GB"
},
"accountNumber": [
"0987654321"
]
}
]
}
}
}Response
PII presented successfully