Person

Person management

PERSON_CREATED

• The person API triggers PERSON_CREATED event when a person is created at person details.

• Event parameters are eventTypeCode/routing_code: ext.persons.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "personId": "string",
    "givenName": "string",
    "middleName": "string",
    "surname": "string",
    "name": "string",
    "personTypeCode": "string",
    "birthDate": "2023-07-21",
    "registrationDate": "2023-07-21",
    "statusCode": "string",
    "statusCodeReason": "string",
    "email": "string",
    "phoneCountryCode": "string",
    "phoneNumber": "string",
    "residencyCountryCode": "string",
    "countryOfBirth": "string",
    "taxResidencyCountry": "string",
    "nationality": "string",
    "language": "string",
    "intraOrgCode": "string",
    "counterpartySectorCode": "string",
    "forgotten": true,
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "usResident": true,
    "pep": true
  }
}

PERSON_UPDATED

• The person API triggers PERSON_UPDATED event when a person's status or details is changed.

• Event parameters are eventTypeCode/routing_code: ext.persons.updated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_UPDATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T13:10:54.172Z",
  "data": {
    "personId": "string",
    "givenName": "string",
    "middleName": "string",
    "surname": "string",
    "name": "string",
    "personTypeCode": "string",
    "birthDate": "2025-05-16",
    "registrationDate": "2025-05-16",
    "statusCode": "string",
    "statusCodeReason": "string",
    "email": "string",
    "phoneCountryCode": "string",
    "phoneNumber": "string",
    "residencyCountryCode": "string",
    "countryOfBirth": "string",
    "taxResidencyCountry": "string",
    "nationality": "string",
    "language": "string",
    "intraOrgCode": "string",
    "counterpartySectorCode": "string",
    "forgotten": true,
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "usResident": true,
    "pep": true,
    "pepExplanation": "string",
    "customerTypeCode": "string",
    "tenantCode": "string",
    "legalForm": "string",
    "creationDate": "2025-05-16",
    "dependantPersons": 0,
    "educationCode": "string",
    "maritalStatusCode": "string",
    "deathDate": "2025-05-16",
    "liquidationDate": "2025-05-16",
    "inactivationDate": "2025-05-16",
    "tradingName": "string",
    "webAddress": "string",
    "businessAreaCodes": [
      "string"
    ],
    "businessModelDescription": "string",
    "activityCode": "string",
    "employmentTimeCode": "string",
    "fixedEmploymentLength": "string",
    "buildingTypeCode": "string",
    "housingTypeCode": "string",
    "sex": "string",
    "moveInDate": "2025-05-16",
    "accessRestricted": true,
    "placeOfBirth": "string",
    "changedFields": [
      "string"
    ]
  }
}

PERSON_ID_NUMBER_CREATED

• The person API triggers PERSON_ID_NUMBER_CREATED event when a person's id number is created at person details.

• Event parameters are eventTypeCode/routing_code: ext.persons.id-numbers.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_ID_NUMBER_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "idNumberId": "string",
    "personId": "string",
    "idNumber": "string",
    "idCountryCode": "string",
    "primary": true
  }
}

PERSON_ID_NUMBER_CHANGED

• The person API triggers PERSON_ID_NUMBER_CHANGED event when a person's id number is changed at person details.

• Event parameters are eventTypeCode/routing_code: ext.persons.id-numbers.updated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_ID_NUMBER_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "idNumberId": "string",
    "personId": "string",
    "idNumber": "string",
    "idCountryCode": "string",
    "primary": true,
    "changedFields": [
      "string"
    ]
  }
}

Person document

PERSON_DOCUMENT_CREATED

• The person API triggers PERSON_DOCUMENT_CREATED event when a person's document is created at person documents.

• Event parameters are eventTypeCode/routing_code: ext.persons.documents.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_DOCUMENT_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "docuID": "string",
    "personId": "string",
    "documentTypeCode": "string",
    "number": "string",
    "issuingCountry": "string",
    "expiryDate": "2023-07-21"
  }
}

PERSON_DOCUMENT_UPDATED

• The person API triggers PERSON_DOCUMENT_UPDATED event when a person's document is updated at person documents.

• Event parameters are eventTypeCode/routing_code: persons.documents.updated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_DOCUMENT_UPDATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "personId": "string",
    "givenName": "string",
    "middleName": "string",
    "surname": "string",
    "name": "string",
    "personTypeCode": "string",
    "birthDate": "2023-07-21",
    "registrationDate": "2023-07-21",
    "statusCode": "string",
    "statusCodeReason": "string",
    "email": "string",
    "phoneCountryCode": "string",
    "phoneNumber": "string",
    "residencyCountryCode": "string",
    "countryOfBirth": "string",
    "taxResidencyCountry": "string",
    "nationality": "string",
    "language": "string",
    "intraOrgCode": "string",
    "counterpartySectorCode": "string",
    "forgotten": true,
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "usResident": true,
    "pep": true,
    "changedFields": [
      "string"
    ]
  }
}

PERSON_DOCUMENT_REMOVED

• The person API triggers PERSON_DOCUMENT_REMOVED event when a person's document is removed at person documents.

• Event parameters are eventTypeCode/routing_code: ext.persons.documents.deleted.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_DOCUMENT_REMOVED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "docuId": "string",
    "personId": "string"
  }
}

Person address

PERSON_ADDRESS_CREATED

• The person API triggers PERSON_ADDRESS_CREATED event when a person address is created at person details.

• Event parameters are eventTypeCode/routing_code: ext.persons.addresses.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_ADDRESS_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "addressId": "string",
    "personId": "string",
    "addressTypeCode": "string",
    "street1": "string",
    "street2": "string",
    "cityCounty": "string",
    "stateRegion": "string",
    "zip": "string",
    "countryCode": "string"
  }
}

PERSON_ADDRESS_UPDATED

• The person API triggers PERSON_ADDRESS_UPDATED event when a person address is updated at person details.

• Event parameters are eventTypeCode/routing_code: ext.persons.addresses.updated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_ADDRESS_UPDATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "addressId": "string",
    "personId": "string",
    "addressTypeCode": "string",
    "street1": "string",
    "street2": "string",
    "cityCounty": "string",
    "stateRegion": "string",
    "zip": "string",
    "countryCode": "string",
    "changedFields": [
      "string"
    ]
  }
}

PERSON_ADDRESS_REMOVED

• The person API triggers PERSON_ADDRESS_REMOVED event when a person address is deleted at person details.

• Event parameters are eventTypeCode/routing_code: ext.persons.addresses.deleted.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_ADDRESS_REMOVED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "personId": "string",
    "addressId": "string"
  }
}

Person additional contact

PERSON_ADDITIONAL_CONTACT_CREATED

• The person API triggers PERSON_ADDITIONAL_CONTACT_CREATED event when an additional contact is created at person details.

• Event parameters are eventTypeCode/routing_code: ext.persons.additional-contacts.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_ADDITIONAL_CONTACT_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "personId": "string",
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "replacedId": "string"
  }
}

PERSON_ADDITIONAL_CONTACT_UPDATED

• The person API triggers PERSON_ADDITIONAL_CONTACT_UPDATED event when an additional contact is updated at person details.

• Event parameters are eventTypeCode/routing_code: ext.persons.additional-contacts.updated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_ADDITIONAL_CONTACT_UPDATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-17T09:43:44.993Z",
  "data": {
    "personId": "string",
    "source": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "replacedId": "string"
  }
}

PERSON_ADDITIONAL_CONTACT_DELETED

• The person API triggers PERSON_ADDITIONAL_CONTACT_DELETED event when an additional contact is deleted at person details.

• Event parameters are eventTypeCode/routing_code: ext.persons.additional-contacts.deleted.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_ADDITIONAL_CONTACT_DELETED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2024-07-17T09:47:05.470Z",
  "data": {
    "personId": "string",
    "source": {
      "sourceName": "string",
      "sourceRef": "string"
    },
    "replacedId": "string"
  }
}

Person relationship

PERSON_RELATIONSHIP_CREATED

• The person API triggers PERSON_RELATIONSHIP_CREATED event when a person relationship is created at person details.

• Event parameters are eventTypeCode/routing_code: ext.persons.relationships.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_RELATIONSHIP_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "personRelationshipId": "string",
    "personId": "string",
    "parentPersonId": "string",
    "relationTypeCode": "string",
    "statusCode": "string",
    "percentageOfShares": 0,
    "percentageOfSignature": 0,
    "representingRange": {
      "startDate": "2023-07-21",
      "endDate": "2023-07-21"
    },
    "beneficiary": true
  }
}

PERSON_RELATIONSHIP_CHANGED

• The person API triggers PERSON_RELATIONSHIP_CHANGED event when a person relationship is changed at person details.

• Event parameters are eventTypeCode/routing_code: ext.persons.relationships.updated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_RELATIONSHIP_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "personRelationshipId": "string",
    "personId": "string",
    "parentPersonId": "string",
    "relationTypeCode": "string",
    "statusCode": "string",
    "percentageOfShares": 0,
    "percentageOfSignature": 0,
    "representingRange": {
      "startDate": "2023-07-21",
      "endDate": "2023-07-21"
    },
    "changedFields": [
      "string"
    ],
    "beneficiary": true
  }
}

PERSON_RELATIONSHIP_REMOVED

• The person API triggers PERSON_RELATIONSHIP_REMOVED event when a person relationship is deleted at person details.

• Event parameters are eventTypeCode/routing_code: ext.persons.relationships.deleted.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_RELATIONSHIP_REMOVED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "personRelationshipId": "string",
    "personId": "string"
  }
}

Person tax number

PERSON_TAX_NUMBER_CREATED

• The person API triggers PERSON_TAX_NUMBER_CREATED event when a person tax number is created at person details.

• Event parameters are eventTypeCode/routing_code: ext.persons.tax-numbers.updated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_TAX_NUMBER_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "taxNumberId": "string",
    "personId": "string",
    "taxNumberTypeCode": "string",
    "taxNumber": "string",
    "taxCountryCode": "string",
    "primary": true
  }
}

PERSON_TAX_NUMBER_CHANGED

• The person API triggers PERSON_TAX_NUMBER_CHANGED event when a person tax number is changed at person details.

• Event parameters are eventTypeCode/routing_code: ext.persons.tax-numbers.updated.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_TAX_NUMBER_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "taxNumberId": "string",
    "personId": "string",
    "taxNumberTypeCode": "string",
    "taxNumber": "string",
    "taxCountryCode": "string",
    "primary": true,
    "changedFields": [
      "string"
    ]
  }
}

Person group

PERSON_PERSON_GROUP_CREATED

• The person API triggers PERSON_PERSON_GROUP_CREATED event when a person group is created at person API.

• Event parameters are eventTypeCode/routing_code: ext.persons.person-groups.created.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_PERSON_GROUP_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "personId": "string",
    "personGroupId": "string",
    "personGroupCode": "string"
  }
}

PERSON_PERSON_GROUP_REMOVED

• The person API triggers PERSON_PERSON_GROUP_REMOVED event when a person group is deleted at person API.

• Event parameters are eventTypeCode/routing_code: ext.persons.person-groups.deleted.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_PERSON_GROUP_REMOVED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "personId": "string",
    "personGroupId": "string",
    "personGroupCode": "string"
  }
}

Person risk

PERSON_RISK_CREATED

• The person API triggers PERSON_RISK_CREATED event when a person risk is created at person API.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_RISK_CREATED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T13:16:42.575Z",
  "data": {
    "date": "2025-05-16",
    "personId": "string",
    "riskId": "string",
    "riskLevelCode": "string",
    "riskTypeCode": "string",
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "validityRange": {
      "startTime": "2025-05-16T13:16:42.575Z",
      "endTime": "2025-05-16T13:16:42.575Z"
    },
    "value": 0
  }
}

PERSON_RISK_DELETED

• The person API triggers PERSON_RISK_DELETED event when a person risk is deleted at person API.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_RISK_DELETED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "originalMessageDateTime": "2025-05-16T13:18:33.425Z",
  "data": {
    "date": "2025-05-16",
    "personId": "string",
    "riskId": "string",
    "riskLevelCode": "string",
    "riskTypeCode": "string",
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "validityRange": {
      "startTime": "2025-05-16T13:18:33.425Z",
      "endTime": "2025-05-16T13:18:33.425Z"
    },
    "value": 0
  }
}

Person custom field

PERSON_CUSTOM_FIELD_CHANGED

• The person API triggers PERSON_CUSTOM_FIELD_CHANGED event if a new custom field value inserted or updated.

• Event parameters are eventTypeCode/routing_code: ext.persons.custom-fields.fields.changed.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_CUSTOM_FIELD_CHANGED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "values": [
      {
        "fieldSetId": "PAYMENT_RIGHTS",
        "fieldId": "PAYMENT_SIGNATURE_WEIGHT",
        "valueType": "NUMBER",
        "fieldValue": "100"
      }
    ]
  }
}

PERSON_CUSTOM_FIELD_REMOVED

• The person API triggers PERSON_CUSTOM_FIELD_REMOVED event if a new custom field value deleted.

• Event parameters are eventTypeCode/routing_code: ext.persons.custom-fields.fields.deleted.

{
  "notificationId": "ID-9999",
  "notificationTypeCode": "PERSON_CUSTOM_FIELD_REMOVED",
  "destination": "https://hooks.slack.com/services/TQ12LTR432rfdsfsdg",
  "data": {
    "source": {
      "sourceName": "string",
      "sourceRef": "string",
      "sourceLink": "string"
    },
    "values": [
      {
        "fieldSetId": "PAYMENT_RIGHTS",
        "fieldId": "PAYMENT_SIGNATURE_WEIGHT"
      }
    ]
  }
}