# Saving KYC data for custodying customer wallets.

Endpoint: POST /api/external/v1/customers/{customer-id}/kyc
Version: v1

## Path parameters:

  - `customer-id` (string, required)
    Customer id.

## Request fields (application/json):

  - `title` (string,null)
    Title such as "Dr.", "Prof.", etc.

  - `salutation` (string,null)
    Salutation such as "Herr", "Frau", "Mr.", "Ms.", etc.

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

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

  - `placeOfBirth` (string, required)
    Place of birth denoted in the used identification document of the investor.

  - `dateOfBirth` (string, required)
    Date of birth is a regulatory requirement for the KYC process.

  - `email` (string, required)
    The email which the investor used to register. You can re-use the same input as from customer creation.

  - `phoneNumber` (string,null)
    Phone number of the investor.

  - `nonPepPerson` (boolean, required)
    Relates to the political exposure of the person. Indicates whether the person is NOT a Politically Exposed Person (PEP).

  - `highCorruptionIndex` (boolean, required)
    Relates to the country of residence. You can always send "false" if your KYC provider performs these checks automatically.

  - `nonSanctionedCountry` (boolean, required)
    Indicates the investor is NOT residing in a sanctioned country. You can always send "true" if your KYC provider performs these checks automatically.

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

  - `identVerified` (boolean, required)
    Only send KYC data of customers that have been verified already. Hence, always set this field to "true".

  - `identVerifiedType` (string)
    Enum: "NotSet", "Normal", "Plain"

  - `tanganyIdentVerifiedType` (string)
    Enum: "Video_ident", "Id_copy", "Auto_ident", "In_person", "Eid", "Post_ident", "Qes_bankident"

  - `eulaAgreed` (boolean, required)
    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".

  - `address` (object, required)

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

  - `address.streetNo` (string, required)
    The street number where the investor resides.

  - `address.postalCode` (string, required)
    The postal code where the investor resides.

  - `address.town` (string, required)
    The town in which the investor resides. When sending values with accents, send in UTF-8 charset.

  - `address.countryCodeIso2` (string, required)
    ISO country codes (e.g. "DE").

  - `company` (object)
    Only required when the account type is LegalEntity.

  - `company.name` (string, required)

  - `company.registerNumber` (string, required)

  - `company.fullAddress` (string, required)

  - `company.email` (string, required)

  - `nationalityIso` (string,null)
    The nationality ISO of the investor. Use ISO 3166-1 alpha-2 country codes.

  - `gender` (string)
    Enum: "NotSet", "Male", "Female", "Other"

  - `tanganyLegalPerson` (object)

  - `tanganyLegalPerson.id` (string,null)
    Not required in case of creating new Tangany legal person

  - `tanganyLegalPerson.name` (string, required)
    The name of the company. You can re-use the value from company.name.

  - `tanganyLegalPerson.legalForm` (string, required)
    Legal form of company. E.g. "AG", "GmbH".

  - `tanganyLegalPerson.commercialRegister` (string,null)
    You may leave it blank. Legally speaking, only the register number is required.

  - `tanganyLegalPerson.leiCode` (string,null)
    LEI code of the company.

  - `tanganyLegalPerson.taxId` (string,null)
    Tax ID of the company.

  - `tanganyLegalPerson.vatId` (string,null)
    Vat ID of the company.

  - `tanganyLegalPerson.isinCode` (string,null)
    ISIN code of the company.

  - `tanganyLegalPerson.legalJurisdiction` (string,null)
    ISO country code (e.g. "DE") where the legal entity is registered. Not mandatory, as this data is captured within the legalAddress object.

  - `tanganyLegalPerson.legalAddress` (object, required)

  - `tanganyLegalPerson.legalAddress.country` (string, required)
    ISO country code (e.g. "DE") where the company is registered.

  - `tanganyLegalPerson.legalAddress.city` (string, required)
    City where company is registered.

  - `tanganyLegalPerson.legalAddress.postcode` (string, required)
    Post code where company is registered.

  - `tanganyLegalPerson.legalAddress.streetName` (string, required)
    Street name where company is registered.

  - `tanganyLegalPerson.legalAddress.streetNumber` (string, required)
    Street number where company is registered.

  - `tanganyLegalPerson.postalAddress` (object)

  - `tanganyLegalPerson.kyc` (object)

  - `tanganyLegalPerson.kyc.businessDescription` (string, required)
    You can always send the following value: "Investor".

  - `tanganyLegalPerson.kyc.isCreAvailable` (boolean, required)
    You can always set this field to false.

  - `tanganyLegalPerson.related` (array, required)

  - `tanganyLegalPerson.related.entityId` (string,null)
    The legal requirement is to create one per beneficial owner of the company (even if they do not have to go through the KYC process).

  - `tanganyLegalPerson.related.position` (string,null)
    Position of the beneficial owner in the company.

  - `tanganyLegalPerson.related.isFictitiousBeneficialOwner` (boolean, required)
    Indicates if this is a fictitious beneficial owner.

  - `tanganyLegalPerson.related.isUltimateBeneficialOwner` (boolean, required)
    Indicates if this is the ultimate beneficial owner.

  - `tanganyLegalPerson.related.sharePercentage` (string,null)
    Share percentage of ownership.

  - `tanganyLegalPerson.related.naturalPerson` (object)

  - `tanganyLegalPerson.related.naturalPerson.id` (string, required)
    Customer ID received after creating a customer in NYALA's system.

  - `tanganyLegalPerson.related.naturalPerson.firstName` (string, required)
    First name of the investor. When sending values with accents (e.g. É, ç, ñ), send the values in UTF-8 charset.

  - `tanganyLegalPerson.related.naturalPerson.lastName` (string, required)
    Last name of the investor. When sending values with accents (e.g. É, ç, ñ), send the values in UTF-8 charset.

  - `tanganyLegalPerson.related.naturalPerson.birthDate` (string, required)
    Date of birth is a regulatory requirement for the KYC process.

  - `tanganyLegalPerson.related.naturalPerson.birthPlace` (string, required)
    Place of birth denoted in the used identification document of the investor.

  - `tanganyLegalPerson.related.naturalPerson.title` (string,null)
    Titles such as "Dr.", "Prof.", etc.

  - `tanganyLegalPerson.related.naturalPerson.birthCountry` (string,null)
    Country of birth using two-letter country code (ISO 3166-1 alpha-2)

  - `tanganyLegalPerson.related.naturalPerson.birthName` (string,null)

  - `tanganyLegalPerson.related.naturalPerson.nationality` (string,null)
    ISO country codes (e.g. "DE").

  - `tanganyLegalPerson.related.naturalPerson.selfDeclaredAsPep` (boolean)
    Indicates whether the investor has self-declared as a Politically Exposed Person (PEP).

  - `tanganyLegalPerson.related.legalPerson` (object)

  - `custodyProvider` (string)
    Enum: "HADC", "Tangany", "TanganyExternal", "Iris"

  - `document` (object)
    The document which was used for verification. Note that a document is required for all verification methods except for in_person

  - `document.nationality` (string,null)
    Stated nationality. Must be a ISO 3166-1 Alpha-2 country code. Additionally "XX" is allowed for unknown states.

  - `document.country` (string,null)
    Document issuing country. Must be a ISO 3166-1 Alpha-2 country code. Additionally "XX" is allowed for unknown states. Nullable only for QES_bankident method - has to be set to null or removed from the object

  - `document.number` (string,null)
    ID of the document. Nullable only for eID and QES_bankident methods - has to be set to null or removed from the object

  - `document.issuedBy` (string,null)
    Name of the document issuer. Nullable only for eID and QES_bankident methods - has to be set to null or removed from the object

  - `document.issueDate` (string,null)
    Date of issuance in the format YYYY-MM-DD. Must be >= 1900-01-01. If not provided, can be set to n/a. Nullable only for QES_bankident method - has to be set to null or removed from the object

  - `document.validUntil` (string,null)
    Stated expiration date of the document in the YYYY-MM-DD format. Must be >= 1900-01-01. Nullable only for QES_bankident method - has to be set to null or removed from the object

  - `document.type` (string)
    Type of the document. Nullable only for QES_bankident method - has to be set to null or removed from the object
    Enum: "Id_card", "Passport", "Other"

  - `document.iban` (string,null)
    International Bank Account Number comprised of 34 characters, letters and numbers. Nullable for all methods except QES_bankident

  - `document.reference` (string,null)
    Reference or purpose of a transfer containing any characters. Nullable for all methods except QES_bankident

  - `monerium` (object)

  - `monerium.profileDocument` (object)

  - `monerium.profileDocument.number` (string, required)

  - `monerium.profileDocument.kind` (string, required)
    The type of ID document. Passports, National ID cards, and driving licenses are supported.
    Enum: "passport", "drivingLicense", "nationalIdentityCard"

  - `monerium.corporate` (object)

  - `monerium.corporate.registrationNumber` (string, required)

  - `monerium.corporate.representatives` (array, required)

  - `monerium.corporate.representatives.firstname` (string, required)

  - `monerium.corporate.representatives.lastname` (string, required)

  - `monerium.corporate.representatives.country` (string, required)

  - `monerium.corporate.representatives.nationality` (string, required)

  - `monerium.corporate.representatives.birthDay` (string, required)

  - `monerium.corporate.representatives.postalCode` (string, required)

  - `monerium.corporate.representatives.city` (string, required)

  - `monerium.corporate.representatives.countryState` (string,null)

  - `monerium.corporate.representatives.idDocument` (object, required)

  - `monerium.corporate.finalBeneficiaries` (array,null)

  - `monerium.corporate.finalBeneficiaries.ownershipPercentage` (string,null)

  - `monerium.corporate.directors` (array,null)

## Response 200 fields (application/json):

  - `errorMessageCodes` (array,null)

  - `errors` (array,null)

  - `errors.code` (string,null)

  - `errors.message` (string,null)

  - `errors.field` (string,null)

  - `data` (boolean)