Person file

The JSON file for the person data is structured as follows:

Person file

  {
      "externalPersonId": "IM-P-00023",
      "source": {
        "sourceName": "external",
        "sourceRef": "1",
        "sourceLink": "string"
      },
      "personTypeCode": "P",
      "givenName": "Peter",
      "middleName": "Alexander",
      "surname": "Schmidt",
      "name": "string",
      "statusCode": "ACTIVE",
      "birthDate": "1980-12-01",
      "email": "[email protected]",
      "phoneNumber": "0901820",
      "phoneNumberCountryCode": "+493",
      "sex": "M",
      "nationality": "DE",
      "dependantPersons": 0,
      "educationCode": "HIGHER_EDUCATION",
      "activityCode": "SPECIALIST",
      "housingTypeCode": "PRIVATE",
      "buildingTypeCode": "PRIVATE_HOUSE",
      "businessAreaCodes": ["LEGAL"],
      "counterpartySectorCode": "MARRIED",
      "maritalStatusCode": "MARRIED",
      "employmentTimeCode": "MORE_4_YEAR",
      "customerTypeCode": "string",
      "placeOfBirth": "Berlin",
      "countryOfBirth": "DE",
      "residencyCountryCode": "DE",
      "language": "DE",
      "taxResidencyCountryCode": "DE",
      "fixedEmploymentLength": 0,
      "identificationNumbers": [
        {
          "idNumber": "12123456A123",
          "idCountryCode": "DE",
          "primary": true,
        }
      ],
      "taxNumbers": [
        {
          "taxNumber": "12123456A123",
          "taxNumberTypeCode": "VAT_NUMBER",
          "taxCountryCode": "DE",
          "primary": true,
        }
      ],
      "pep": false,
      "pepExplanation": "string",
      "usResident": false,
      "tenantCode": "string",
      "addresses": [
        {
          "addressTypeCode": "R",
          "street1": "Fennstrasse 4",
          "street2": "string",
          "cityCounty": "Berlin",
          "stateRegion": "string",
          "zip": "13347",
          "countryCode": "DE",
          "moveInDate": "2023-02-15",
          "validityRange": {
            "startTime": "2023-02-15T14:26:28.741Z",
            "endTime": "2023-02-15T14:26:28.741Z"
          }
        }
      ],
      "relationships": [
        {
          "idNumber": "string",
          "idCountryCode": "string",
          "relationTypeCode": "string",
          "statusCode": "string",
          "representingRange": {
            "startDate": "2023-02-15",
            "endDate": "2023-02-15"
          },
          "additionalData": "string",
          "validityRange": {
            "startTime": "2023-02-15T14:26:28.741Z",
            "endTime": "2023-02-15T14:26:28.741Z"
          },
          "beneficiary": true
        }
      ],
      "document": {
        "documentTypeCode": "PASSPORT",
        "issuingCountryCode": "DE",
        "number": "0124R5M1P5",
        "expiryDate": "2029-02-15",
        "validityRange": {
          "startTime": "2023-02-15T14:26:28.741Z",
          "endTime": "2023-02-15T14:26:28.741Z"
        }
      },
      "additionalContacts": [
        {
          "contactTypeCode": "FRAUD_CONTACT",
          "description": "Contacts for fraud department",
          "email": "[email protected]",
          "phoneNumber": "0901000",
          "phoneCountryCode": "+493",
          "preferredMethodOfContact": true,
          "validityRange": {
            "startTime": "2023-04-18T06:10:49.445Z",
            "endTime": "2027-04-18T06:10:49.445Z"
          }
        }
      ],
      "personGroupCodes": [
        "string"
      ],
      "legalEntityIdentifier": {
        "leiCode": "724500VKKSH9QOLTFR81",
        "localOperatingUnit": "KELER LTD",
        "registrationDate": "2020-02-20",
        "lastUpdateDate": "2021-02-20",
        "validityRange": {
          "startTime": "2023-04-18T06:10:49.445Z",
          "endTime": "2027-04-18T06:10:49.445Z"
        }
      },
      "risks": [
        {
          "riskTypeCode": "TOTAL",
          "riskLevelCode": "GREEN",
          "value": 3.8,
          "date": "1980-12-01",
          "source": {
            "sourceName": "string",
            "sourceRef": "string",
            "sourceLink": "string"
          },
          "validityRange": {
            "startTime": "2023-04-18T06:10:49.445Z",
            "endTime": "2023-04-18T06:10:49.445Z"
          }
        }
      ],
      "customFields": {
        "additionalProp1": {},
        "additionalProp2": {},
        "additionalProp3": {}
      }
    }
  ],

When migrating a person, the following parameters must be included in the data import JSON file:

Parameter name	Description	Allowed values
externalPersonId	The unique person reference from the external system.	The value is limited to the id of the person in the external system.
source: sourceName	The external source name.	The name of the source cannot be longer than 50 characters.
source: sourceRef	The external source reference.	The source reference cannot be longer than 50 characters.
personTypeCode	The person type.	P - for a private person, L - for a legal person - business entity.
identificationNumbers	The (social security number) SSN in case of private persons, or the registration number in case of a business entity.	At least one must be included in the array, with the primary set to true. And the following identification numbers should have the primary set to false.

• The values for parameters of the identificationNumbers, addresses, relationships and document, additionalContacts, personGroupCodes, legalEntityIdentifier, risks objects become required only when the corresponding objects are included in the JSON file.

• To find the description of the non-mandatory parameters, refer to the person object parameters.

Attach the person file to the request body of the data import API call as shown below.

--form 'persons=@"/path/to/file"