Present PII data to counterparties

post

https://api.eu1.notabene.id/entities/{entityDID}/transfers/{transferId}/policies/{policyId}/presentation

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

entityDID

string

required

^did:([a-z0-9]+):((?:(?:[a-zA-Z0-9._-]|(?:%[0-9a-fA-F]{2}))*:)*(?:[a-zA-Z0-9._-]|(?:%[0-9a-fA-F]{2}))+)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(/[^#?]*)?([?][^#]*)?(#.*)?$

The DID of the entity

transferId

uuid

required

The transfer ID

policyId

string

required

The policy ID

Query Params

skipValidation

boolean

Defaults to false

Whether to skip validation

Body Params

ivms101

object

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)

Responses

202PII presented successfully

400Bad Request - The server could not process the request due to a client error.

401Unauthorized - Authentication information is missing or invalid.

403Forbidden - The server understood the request but refuses to authorize it.

404Not Found - The requested resource could not be found.

500Internal Server Error - An unexpected condition was encountered on the server.