Saving KYC data for custodying customer wallets.

Request

Path

customer-idstring, (uuid)required

Customer id.

Body

Data.

titlestring or null, [ 0 .. 64 ] characters

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

salutationstring or null

Salutation such as "Herr", "Frau", "Mr.", "Ms.", 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.

placeOfBirthstring, [ 0 .. 100 ] charactersrequired

Place of birth denoted in the used identification document of the investor.

dateOfBirthstring, (date-time)required

Date of birth is a regulatory requirement for the KYC process.

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

The email which the investor used to register. You can re-use the same input as from customer creation.

phoneNumberstring or null

Phone number of the investor.

taxIdstring or null

TaxID of the investor.

nonPepPersonbooleanrequired

Relates to the political exposure of the person. Indicates whether the person is NOT a Politically Exposed Person (PEP).

highCorruptionIndexbooleanrequired

Relates to the country of residence. You can always send "false" if your KYC provider performs these checks automatically.

nonSanctionedCountrybooleanrequired

Indicates the investor is NOT residing in a sanctioned country. You can always send "true" if your KYC provider performs these checks automatically.

nonUsTaxPersonbooleanrequired

We do not accept persons subjected to US tax. Always set to "true" (if the person is not subject to taxes in the USA).

identVerifiedbooleanrequired

Only send KYC data of customers that have been verified already. Hence, always set this field to "true".

identVerifiedTypestring, (int32)(IdentVerifiedType)

Enum:"NotSet""Normal""Plain"

tanganyIdentVerifiedTypestring, (int32)(TanganyIdentVerifiedType)

Enum:"Video_ident""Id_copy""Auto_ident""In_person""Eid""Post_ident""Qes_bankident"

eulaAgreedbooleanrequired

Refers to the Smart Registry terms of use. Ensure that your end users always have to agree to the terms as part of their onboarding process, then always set to "true".

addressobject(KycAddressDto)required

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"

tanganyLegalPersonobject(TanganyLegalPersonDto)

custodyProviderstring, (int32)(CustodyProvider)

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

documentobject(TanganyCustomerKycDocumentDto)

The document which was used for verification. Note that a document is required for all verification methods except for in_person

moneriumobject(MoneriumGanymedeDto)

curl -i -X POST \
  'https://api.nyala.de/api/external/v1/customers/{customer-id}/kyc' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "string",
    "salutation": "string",
    "firstname": "string",
    "lastname": "string",
    "placeOfBirth": "string",
    "dateOfBirth": "2019-08-24T14:15:22Z",
    "email": "user@example.com",
    "phoneNumber": "string",
    "taxId": "string",
    "nonPepPerson": true,
    "highCorruptionIndex": true,
    "nonSanctionedCountry": true,
    "nonUsTaxPerson": true,
    "identVerified": true,
    "identVerifiedType": "NotSet",
    "tanganyIdentVerifiedType": "Video_ident",
    "eulaAgreed": true,
    "address": {
      "street": "string",
      "streetNo": "string",
      "postalCode": "string",
      "town": "string",
      "countryCodeIso2": "st"
    },
    "company": {
      "name": "string",
      "registerNumber": "string",
      "fullAddress": "string",
      "email": "user@example.com"
    },
    "nationalityIso": "string",
    "gender": "NotSet",
    "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",
    "document": {
      "nationality": "st",
      "country": "st",
      "number": "string",
      "issuedBy": "string",
      "issueDate": "2019-08-24",
      "validUntil": "2019-08-24",
      "type": "Id_card",
      "iban": "string",
      "reference": "string"
    },
    "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"
      }
    }
  }'

Responses

Bodyapplication/json

errorMessageCodesArray of strings or nullread-only

errorsArray of objects or null(Error)read-only

databooleanread-only

Response

{
  "errorMessageCodes": [
    "string"
  ],
  "errors": [
    { … }
  ],
  "data": true
}