---
title: "Present PII data to counterparties"
method: POST
path: "/entities/{entityDID}/transfers/{transferId}/policies/{policyId}/presentation"
tags: ["PII", "Transfers"]
---

# Present PII data to counterparties

`POST /entities/{entityDID}/transfers/{transferId}/policies/{policyId}/presentation`

## Request

- Base URL: `https://api.eu1.notabene.id`
- URL: `https://api.eu1.notabene.id/entities/{entityDID}/transfers/{transferId}/policies/{policyId}/presentation`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/notabene/apis/notabene-api/docs/entities/:entityDID/transfers/:transferId/policies/:policyId/presentation/post.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `entityDID` string, did, required: Decentralized Identifier (DID)
- `transferId` string, uuid, required
- `policyId` string, required

## Query parameters

- `skipValidation` boolean

## Request body

- PresentPIIRequest
  - `ivms101` IVMS101, required: IVMS101 compliant data structure for originator and beneficiary information. This structure is compliant with the official standard IVMS 101.2023. **Geographic Address Structure - Use ONE of these patterns:** **Pattern 1 (with addressLine):** - addressType (required) - addressLine (array of strings, required) - townName (required) - country (required - ISO-3166 Alpha-2 format, e.g., US, GB, XX) - postCode (optional) **Pattern 2 (with streetName/buildingNumber):** - addressType (required) - streetName (required if not using addressLine) - buildingNumber (required if not using addressLine) - townName (required) - country (required - ISO-3166 Alpha-2 format, e.g., US, GB, XX) - postCode (optional)
    - `originator` object
      - `originatorPerson` object[]
        - `naturalPerson` object
          - `name` object, required
            - `nameIdentifier` object[], required
              - …
          - `geographicAddress` object[]
            - `addressType` string, required: Type of address
            - `addressLine` string[]: Full address line(s) - use this OR streetName/buildingNumber
            - `streetName` string: Street name - required if addressLine not provided
            - `buildingNumber` string: Building number - required if addressLine not provided
            - `postCode` string: Postal code (optional)
            - `townName` string, required: Town or city name
            - `country` string, required: Two alphabetic characters representing an ISO-3166 Alpha-2 country code. Includes the code 'XX' to represent 'an indicator for unknown States, other entities or organisations'. Examples: US, GB, DE, FR, XX
          - `nationalIdentification` object
            - `nationalIdentifier` string, required: National identifier number
            - `nationalIdentifierType` string, required: Type of national identifier
            - `registrationAuthority` string: Authority that issued the identifier (optional)
            - `countryOfIssue` string: Country that issued the identifier (optional, ISO-3166 Alpha-2)
          - `customerIdentification` string: Customer identification number
          - `dateAndPlaceOfBirth` object
            - `dateOfBirth` string, date, required: Date of birth in YYYY-MM-DD format
            - `placeOfBirth` string, required: Place of birth
        - `legalPerson` object
          - `name` object, required
            - `nameIdentifier` object[], required
              - …
          - `geographicAddress` object[]
            - `addressType` string, required: Type of address
            - `addressLine` string[]: Full address line(s) - use this OR streetName/buildingNumber
            - `streetName` string: Street name - required if addressLine not provided
            - `buildingNumber` string: Building number - required if addressLine not provided
            - `postCode` string: Postal code (optional)
            - `townName` string, required: Town or city name
            - `countrySubDivision` string: State, province, or region
            - `country` string, required: Two alphabetic characters representing an ISO-3166 Alpha-2 country code. Includes the code 'XX' to represent 'an indicator for unknown States, other entities or organisations'. Examples: US, GB, DE, FR, XX
          - `nationalIdentification` object
            - `nationalIdentifier` string, required: National identifier number
            - `nationalIdentifierType` string, required: Type of national identifier
            - `registrationAuthority` string: Authority that issued the identifier
          - `customerIdentification` string: Customer identification number
        - `accountNumber` string[]: Account numbers
    - `beneficiary` object
      - `beneficiaryPerson` object[]
        - `naturalPerson` object
          - `name` object, required
            - `nameIdentifier` object[], required
              - …
          - `geographicAddress` object[]
            - `addressType` string, required: Type of address
            - `addressLine` string[]: Full address line(s) - use this OR streetName/buildingNumber
            - `streetName` string: Street name - required if addressLine not provided
            - `buildingNumber` string: Building number - required if addressLine not provided
            - `postCode` string: Postal code (optional)
            - `townName` string, required: Town or city name
            - `country` string, required: Two alphabetic characters representing an ISO-3166 Alpha-2 country code. Includes the code 'XX' to represent 'an indicator for unknown States, other entities or organisations'. Examples: US, GB, DE, FR, XX
          - `nationalIdentification` object
            - `nationalIdentifier` string, required: National identifier number
            - `nationalIdentifierType` string, required: Type of national identifier
            - `registrationAuthority` string: Authority that issued the identifier (optional)
            - `countryOfIssue` string: Country that issued the identifier (optional, ISO-3166 Alpha-2)
          - `customerIdentification` string: Customer identification number
          - `dateAndPlaceOfBirth` object
            - `dateOfBirth` string, date, required: Date of birth in YYYY-MM-DD format
            - `placeOfBirth` string, required: Place of birth
        - `legalPerson` object
          - `name` object, required
            - `nameIdentifier` object[], required
              - …
          - `geographicAddress` object[]
            - `addressType` string, required: Type of address
            - `addressLine` string[]: Full address line(s) - use this OR streetName/buildingNumber
            - `streetName` string: Street name - required if addressLine not provided
            - `buildingNumber` string: Building number - required if addressLine not provided
            - `postCode` string: Postal code (optional)
            - `townName` string, required: Town or city name
            - `country` string, required: Two alphabetic characters representing an ISO-3166 Alpha-2 country code. Includes the code 'XX' to represent 'an indicator for unknown States, other entities or organisations'. Examples: US, GB, DE, FR, XX
          - `nationalIdentification` object
            - `nationalIdentifier` string, required: National identifier number
            - `nationalIdentifierType` string, required: Type of national identifier
            - `registrationAuthority` string, required: Authority that issued the identifier
          - `customerIdentification` string: Customer identification number
        - `accountNumber` string[]: Account numbers

## Response `202`

PII presented successfully

- PresentPIIResponse
  - `message` string: Success message

## Other responses

- `400`: Bad Request - The server could not process the request due to a client error.
- `401`: Unauthorized - Authentication information is missing or invalid.
- `403`: Forbidden - The server understood the request but refuses to authorize it.
- `404`: Not Found - The requested resource could not be found.
- `500`: Internal Server Error - An unexpected condition was encountered on the server.

---

[API](https://skmtc.dev/notabene/apis/notabene-api.md) - [All operations](https://skmtc.dev/notabene/apis/notabene-api/llms.txt) - [OpenAPI document](https://skmtc.dev/notabene/apis/notabene-api/revisions/70056745a433?raw)