Add encrypted PII for a party

Discloses PII you have already encrypted to a single recipient's key. Each payload is sealed to one recipient, so call this once per recipient that needs the data.

Required permission: authorize:transfer.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Used in these guides:

Path Params
string
required

Unique identifier for the transfer.

string
required

Which party to address: originator, beneficiary, merchant or customer.

Body Params
string
required

The party as IVMS-101, encrypted by you to a single recipient's key as a JWE compact string. It is passed through to that recipient without being decrypted.

ivms_encrypted_fields
array of strings | null

IVMS-101 JSON paths the operator declares are inside ivms_encrypted. Informational only; the node does not validate the payload against them.

ivms_encrypted_fields
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
202

The payload was accepted but not yet disclosed, because a compliance hold is withholding it.

204

The payload was disclosed to its recipient.

429

Too Many Requests: more than 6,000 calls in 300 seconds. Every endpoint refuses your calls for the next 10 seconds. Send the request again with a backoff, as Rate limiting explains.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json