Create a new entity (person or business)

post

https://megsapp-nova-stg.85.group/api/v1/entities

Creates a new entity. Duplicate person ID numbers are rejected by this endpoint.

Access: Auth methods: JWT bearer or API key. Allowed user types: MVNO, PARTNER. Requires permissions: entity:write.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

entityType

string

enum

required

Entity type being RICA/FICA captured.

Allowed:

idType

string

enum

Required when entityType=PERSON.

Allowed:

idNumber

string

Required when entityType=PERSON. Identification number. Duplicate person ID numbers are rejected by the generic Entity create endpoint.

firstName

string

Required when entityType=PERSON.

lastName

string

Required when entityType=PERSON.

dateOfBirth

string

Required when entityType=PERSON.

nationality

string

Required when entityType=PERSON.

companyName

string

Required when entityType=BUSINESS.

registrationNumber

string

Required when entityType=BUSINESS.

representativeEntityId

string

Required when entityType=BUSINESS. UUID of the natural-person representative for the business.

string

phoneNumber

string

phoneNumber

addressLine1

string

required

Required address line 1.

addressLine2

string

addressLine2

suburb

string

required

Required suburb.

city

string

required

Required city.

province

string

required

Required province.

postalCode

string

required

Required postal code.

country

string

required

Required country.

Responses

400

Invalid input data

409

A person with this ID number already exists

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Entity created successfully