Create person

Creates a new IVMS101-compliant person entity.

The payload must be either a natural or legal person structure, and must include:

Person core information

  • Name identifiers
  • National identifiers
  • Account numbers
  • Addresses

On success, this endpoint returns the full assembled PersonRecord.

Specification

See the IVMS101 standard for full field definitions and compliance details.

Validation

If the input fails schema or custom validation, returns 422.

Errors

Any database or internal failure results in a 500 error.

Body Params

IVMS101-compliant payload to create a natural or legal person

Create a natural person

account_numbers
array of objects

List of bank or wallet account numbers

account_numbers
addresses
array of objects

Physical or mailing addresses

addresses
string
enum
required
Allowed:
name_identifiers
array of objects

Official or alias names associated with this person

name_identifiers
national_identifiers
array of objects

National identifiers (e.g., passport, national ID)

national_identifiers
person
object

Core details about the natural person

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json