Sign in

v2

latestOpenAPI 3.0.12026-07-2693281951.6 KB
User Beneficiaries

Create Beneficiary

Creation of beneficiaries for a given application User.

post/users/{userId}/beneficiaries

Path parameters

userIdstring uuid required
Example:e7b7636d-a041-4013-8a1b-34dc85b7d341

Headers

sub-applicationstring uuid

The sub-application ID to which event type is being subscribed to

Request body

namestring required

name of the beneficiary

Example request

{
  "name": "John Doe",
  "accountIdentifier": {
    "identification": "DE12345123451234512345123"
  }
}

Response

OK

Example response

{
  "data": {
    "beneficiaryId": "e7b7636d-a041-4013-8a1b-34dc85b7d341",
    "details": {
      "name": "John Doe",
      "match": {
        "closeMatchName": "John Doe"
      },
      "accountIdentifier": {
        "identification": "DE12345123451234512345123"
      }
    }
  }
}