About person

The person API is designed to create and manage customer records within the Tuum environment, where a customer is referred to as a person.

Person types

There are two types of persons:

  • Private person - an actual physical person. Private Persons typically represent themselves, but they may represent others if authorised through consents or mandates.

  • Legal person - any organisation, such as a business or nonprofit entity. Legal Persons are always represented by private persons.

Person API settings

You have two configuration options available for the person API to choose from.

  1. If the system configuration modular.kyc.enabled=false, the person will be set to ACTIVE status immediately after creation.

  2. If the system configuration modular.kyc.enabled=true, all newly created persons are created in PENDING status and require activation.

This section provides information on creating, updating, and deleting person data and related entities in the person API.

Last updated

Was this helpful?