Creates a new customer inside the institution.

Request

Body

Data.

salutationstring or null

Salutation such as "Herr", "Frau", "Mr.", "Ms.", etc.

titlestring or null, [ 0 .. 64 ] characters

Title such as "Dr.", "Prof.", etc.

firstnamestring, [ 0 .. 64 ] charactersrequired

First name of the investor. When sending values with accents (e.g. É, ç, ñ), send the values in UTF-8 charset.

lastnamestring, [ 0 .. 64 ] charactersrequired

Last name of the investor. When sending values with accents (e.g. É, ç, ñ), send the values in UTF-8 charset.

birthDatestring or null, (date-time)

Date of birth not required at customer creation, but necessary for the KYC process.

phoneNumberstring or null, (tel), [ 0 .. 64 ] characters

Phone number of the investor.

typestring, (int32)(AccountTypes)required

Enum:"Unknown""Person""LegalEntity"

streetstring, [ 1 .. 100 ] charactersrequired

The street name where the investor resides. When sending values with accents (e.g. É, ç, ñ), send the values in UTF-8 charset.

streetNostring, [ 1 .. 100 ] charactersrequired

The street number where the investor resides.

postalCodestring, [ 1 .. 100 ] charactersrequired

The postal code where the investor resides.

townstring, [ 1 .. 100 ] charactersrequired

The town in which the investor resides. When sending values with accents (e.g. É, ç, ñ), send the values in UTF-8 charset.

countryIsostring, = 2 charactersrequired

The country ISO code in which the investor resides. Use ISO 3166-1 alpha-2 country codes.

companyobject(CustomerCompanyDetailDto)

Only required when the account type is LegalEntity.

nationalityIsostring or null

The nationality ISO of the investor. Use ISO 3166-1 alpha-2 country codes.

genderstring, (int32)(GenderTypes)

Enum:"NotSet""Male""Female""Other"

moneriumobject(MoneriumGanymedeDto)

tanganyLegalPersonobject(TanganyLegalPersonDto)

custodyProviderstring, (int32)(CustodyProvider)

Enum:"HADC""Tangany""TanganyExternal""Iris"

emailstring, (email), [ 0 .. 64 ] charactersrequired

The email which the investor used to register. This must be unique and cannot be reused by other investors.

hadcCustomerIdstring or null, (uuid)

idstring or null, (uuid)

If not provided, it will be auto-generated.

curl -i -X POST \
  https://api.nyala.de/api/external/v1/customers \
  -H 'Content-Type: application/json' \
  -d '{
    "salutation": "string",
    "title": "string",
    "firstname": "string",
    "lastname": "string",
    "birthDate": "2019-08-24T14:15:22Z",
    "phoneNumber": "string",
    "type": "Unknown",
    "street": "string",
    "streetNo": "string",
    "postalCode": "string",
    "town": "string",
    "countryIso": "st",
    "company": {
      "name": "string",
      "registerNumber": "string",
      "fullAddress": "string",
      "email": "user@example.com"
    },
    "nationalityIso": "string",
    "gender": "NotSet",
    "monerium": {
      "profileDocument": {
        "number": "string",
        "kind": "passport"
      },
      "corporate": {
        "name": "string",
        "registrationNumber": "string",
        "representatives": [
          {
            "firstname": "string",
            "lastname": "string",
            "country": "string",
            "nationality": "string",
            "birthDay": "2019-08-24",
            "address": "string",
            "postalCode": "string",
            "city": "string",
            "countryState": "string",
            "idDocument": {
              "number": "string",
              "kind": "passport"
            }
          }
        ],
        "finalBeneficiaries": [
          {
            "firstname": "string",
            "lastname": "string",
            "country": "string",
            "nationality": "string",
            "birthDay": "2019-08-24",
            "ownershipPercentage": "string"
          }
        ],
        "directors": [
          {
            "firstname": "string",
            "lastname": "string",
            "country": "string",
            "nationality": "string",
            "birthDay": "2019-08-24"
          }
        ],
        "address": "string",
        "postalCode": "string",
        "city": "string",
        "country": "string",
        "countryState": "string"
      }
    },
    "tanganyLegalPerson": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "legalForm": "string",
      "commercialRegister": "string",
      "leiCode": "string",
      "taxId": "string",
      "vatId": "string",
      "isinCode": "string",
      "legalJurisdiction": "st",
      "legalAddress": {
        "country": "st",
        "city": "string",
        "postcode": "string",
        "streetName": "string",
        "streetNumber": "string"
      },
      "postalAddress": {
        "country": "st",
        "city": "string",
        "postcode": "string",
        "streetName": "string",
        "streetNumber": "string"
      },
      "kyc": {
        "businessDescription": "string",
        "isCreAvailable": true
      },
      "related": [
        {
          "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
          "position": "string",
          "isFictitiousBeneficialOwner": true,
          "isUltimateBeneficialOwner": true,
          "sharePercentage": "string",
          "naturalPerson": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "firstName": "string",
            "lastName": "string",
            "birthDate": "2019-08-24",
            "birthPlace": "string",
            "title": "string",
            "gender": "M",
            "birthCountry": "st",
            "birthName": "string",
            "nationality": "st",
            "address": {
              "country": "st",
              "city": "string",
              "postcode": "string",
              "streetName": "string",
              "streetNumber": "string"
            },
            "email": "string",
            "selfDeclaredAsPep": true,
            "kyc": {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "date": "2019-08-24T14:15:22Z",
              "method": "Video_ident",
              "document": {
                "nationality": "st",
                "country": "st",
                "number": "string",
                "issuedBy": "string",
                "issueDate": "2019-08-24",
                "validUntil": "2019-08-24",
                "type": "Id_card",
                "iban": "string",
                "reference": "string"
              }
            }
          },
          "legalPerson": {}
        }
      ]
    },
    "custodyProvider": "HADC",
    "email": "user@example.com",
    "hadcCustomerId": "6f3ba510-55ec-488e-ac0c-6ea3b582f9ed",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }'

Responses

Bodyapplication/json

errorMessageCodesArray of strings or nullread-only

errorsArray of objects or null(Error)read-only

datastring, (uuid)read-only

Response

{
  "errorMessageCodes": [
    "string"
  ],
  "errors": [
    { … }
  ],
  "data": "808ac6e4-93ed-4040-85a5-6c71a2444e90"
}