Create an Individual Entity

Creates a new individual entity for the authenticated user or entity.

curl --request POST \
  --url https://api.nuvion.tech/individual-entities \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John Doe",
  "person": {
    "first_name": "John",
    "last_name": "Doe",
    "middle_name": "Robert",
    "date_of_birth": "1990-05-15",
    "email": "[email protected]",
    "nationality": "US",
    "gender": "m"
  },
  "address": {
    "line_1": "123 Main Street",
    "line_2": "Apt 4B",
    "city": "New York",
    "state": "NY",
    "postal_code": "10001",
    "country_code": "US"
  },
  "identification": {
    "national_id": {
      "type": "SSN",
      "value": "123-45-6789"
    },
    "drivers_license": {
      "number": "DL12345678",
      "issuing_country": "US",
      "issue_date": "2020-01-15",
      "expiry_date": "2028-01-14"
    }
  },
  "parent_entity": "01HJ5G6R7MXW5ZK2QD6YA8N9F3",
  "parent_relationship": "employee"
}
'

{
  "message": "Individual entity created successfully",
  "status": 201,
  "data": {
    "entity": {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F3",
      "type": "individual",
      "status": "approved",
      "name": "John Doe",
      "is_root": true,
      "parent_entity": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "parent_relationship": "employee",
      "person_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "user_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
      "creation_context": "user",
      "risk_score": null,
      "sanctions_status": null,
      "created": 1694520000000,
      "updated": 1694520000000
    },
    "person": {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "first_name": "John",
      "last_name": "Doe",
      "middle_name": "Robert",
      "date_of_birth": "1990-05-15",
      "email": "[email protected]",
      "nationality": "US",
      "gender": "m",
      "is_pep": false,
      "status": "approved",
      "created": 1694520000000,
      "updated": 1694520000000
    },
    "address": {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F7",
      "line_1": "123 Main Street",
      "line_2": "Apt 4B",
      "line_3": null,
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country_code": "US",
      "owner_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "owner_type": "person",
      "created": 1694520000000,
      "updated": 1694520000000
    },
    "identification": {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F8",
      "person_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "national_id": {
        "type": "SSN",
        "value": "***6789",
        "verification_status": "pending"
      },
      "drivers_license": {
        "number": "***5678",
        "issuing_country": "US",
        "issue_date": "2020-01-15",
        "expiry_date": "2028-01-14",
        "verification_status": "pending"
      },
      "verification_status": "pending",
      "created": 1694520000000,
      "updated": 1694520000000
    }
  }
}

POST

individual-entities

Creates a new individual entity for the authenticated user or entity.

curl --request POST \
  --url https://api.nuvion.tech/individual-entities \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John Doe",
  "person": {
    "first_name": "John",
    "last_name": "Doe",
    "middle_name": "Robert",
    "date_of_birth": "1990-05-15",
    "email": "[email protected]",
    "nationality": "US",
    "gender": "m"
  },
  "address": {
    "line_1": "123 Main Street",
    "line_2": "Apt 4B",
    "city": "New York",
    "state": "NY",
    "postal_code": "10001",
    "country_code": "US"
  },
  "identification": {
    "national_id": {
      "type": "SSN",
      "value": "123-45-6789"
    },
    "drivers_license": {
      "number": "DL12345678",
      "issuing_country": "US",
      "issue_date": "2020-01-15",
      "expiry_date": "2028-01-14"
    }
  },
  "parent_entity": "01HJ5G6R7MXW5ZK2QD6YA8N9F3",
  "parent_relationship": "employee"
}
'

{
  "message": "Individual entity created successfully",
  "status": 201,
  "data": {
    "entity": {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F3",
      "type": "individual",
      "status": "approved",
      "name": "John Doe",
      "is_root": true,
      "parent_entity": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
      "parent_relationship": "employee",
      "person_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "user_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
      "creation_context": "user",
      "risk_score": null,
      "sanctions_status": null,
      "created": 1694520000000,
      "updated": 1694520000000
    },
    "person": {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "first_name": "John",
      "last_name": "Doe",
      "middle_name": "Robert",
      "date_of_birth": "1990-05-15",
      "email": "[email protected]",
      "nationality": "US",
      "gender": "m",
      "is_pep": false,
      "status": "approved",
      "created": 1694520000000,
      "updated": 1694520000000
    },
    "address": {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F7",
      "line_1": "123 Main Street",
      "line_2": "Apt 4B",
      "line_3": null,
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country_code": "US",
      "owner_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "owner_type": "person",
      "created": 1694520000000,
      "updated": 1694520000000
    },
    "identification": {
      "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F8",
      "person_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
      "national_id": {
        "type": "SSN",
        "value": "***6789",
        "verification_status": "pending"
      },
      "drivers_license": {
        "number": "***5678",
        "issuing_country": "US",
        "issue_date": "2020-01-15",
        "expiry_date": "2028-01-14",
        "verification_status": "pending"
      },
      "verification_status": "pending",
      "created": 1694520000000,
      "updated": 1694520000000
    }
  }
}

Headers

Authorization

string

required

Authorization header: Bearer {jwt or Secretkey}

Body

application/json

name

string

required

The name of the individual entity

person

object

required

Details of the person associated with this entity

Show child attributes

person.first_name

string

required

First name of the person

person.last_name

string

required

Last name of the person

person.date_of_birth

string

required

Date of birth in ISO format

person.email

string

required

Email address of the person

person.nationality

string

required

Nationality of the person

person.gender

string

required

Gender of the person

person.middle_name

string

Middle name of the person

address

object

Address of the person

Show child attributes

address.line_1

string

required

Address line 1

address.city

string

required

City

address.state

string

required

State or province

address.postal_code

string

required

Postal or ZIP code

address.country_code

string

required

Country code

address.line_2

string

Address line 2

address.line_3

string

Address line 3

identification

object

Identification documents of the person

Show child attributes

identification.national_id

object

National ID details

Show child attributes

identification.national_id.type

string

required

Type of national ID

identification.national_id.value

string

required

National ID value

identification.international_passport

object

International passport details

Show child attributes

identification.international_passport.number

string

required

Passport number

identification.international_passport.issuing_country

string

required

Country that issued the passport

identification.international_passport.issue_date

string

required

Date of issue in ISO format

identification.international_passport.expiry_date

string

required

Date of expiry in ISO format

identification.drivers_license

object

Driver's license details

Show child attributes

identification.drivers_license.number

string

required

License number

identification.drivers_license.issuing_country

string

required

Country that issued the license

identification.drivers_license.issue_date

string

required

Date of issue in ISO format

identification.drivers_license.expiry_date

string

required

Date of expiry in ISO format

parent_entity

string

The ULID of the parent entity

parent_relationship

string

The relationship with the parent entity

Response

Created successfully

message

string

required

A descriptive message indicating the result of the operation

status

string

required

The status of the API operation (successful, error, failed, pending)

data

object

required

Container for the created individual entity data

Show child attributes

data.entity

object

required

Core entity information

Show child attributes

data.entity.id

string

required

Unique identifier for the entity

data.entity.type

string

required

Type of entity

data.entity.status

string

required

Current status of the entity

data.entity.name

string

required

Name of the entity (full name of individual)

data.entity.is_root

boolean

required

Indicates if this is a root entity

data.entity.person_id

string

required

ID of the associated person

data.entity.user_id

string

required

ID of the user who created the entity

data.entity.creation_context

string

required

Context in which the entity was created

data.entity.created

number

required

Timestamp when the entity was created

data.entity.updated

number

required

Timestamp when the entity was last updated

data.entity.parent_entity

string

ID of the parent entity if applicable

data.entity.parent_relationship

string

Type of relationship with the parent entity

data.entity.risk_score

number

Risk assessment score for the entity

data.entity.sanctions_status

string

Status of sanctions checks

data.person

object

required

Personal information for the individual

Show child attributes

data.person.id

string

required

Unique identifier for the person

data.person.first_name

string

required

First name of the person

data.person.last_name

string

required

Last name of the person

data.person.date_of_birth

string

required

Date of birth of the person

data.person.email

string

required

Email address of the person

data.person.nationality

string

required

Nationality of the person

data.person.is_pep

boolean

required

Indicates if the person is politically exposed

data.person.status

string

required

Current status of the person record

data.person.created

number

required

Timestamp when the person record was created

data.person.updated

number

required

Timestamp when the person record was last updated

data.person.middle_name

string

Middle name of the person

data.person.gender

string

Gender of the person

data.address

object

required

Address information for the individual

Show child attributes

data.address.id

string

required

Unique identifier for the address

data.address.line_1

string

required

First line of the address

data.address.city

string

required

City name

data.address.state

string

required

State or province

data.address.postal_code

string

required

Postal or ZIP code

data.address.country_code

string

required

Two-letter country code

data.address.owner_id

string

required

ID of the entity that owns this address

data.address.owner_type

string

required

Type of entity that owns this address

data.address.created

number

required

Timestamp when the address was created

data.address.updated

number

required

Timestamp when the address was last updated

data.address.line_2

string

Second line of the address

data.address.line_3

string

Third line of the address

data.identification

object

required

Identification information for the individual

Show child attributes

data.identification.id

string

required

Unique identifier for the identification record

data.identification.person_id

string

required

ID of the associated person

data.identification.verification_status

string

required

Overall verification status for identification

data.identification.created

number

required

Timestamp when the identification record was created

data.identification.updated

number

required

Timestamp when the identification record was last updated

data.identification.national_id

object

National identification details

Show child attributes

data.identification.national_id.type

string

required

Type of national ID

data.identification.national_id.value

string

required

Value of the national ID (may be partially masked)

data.identification.national_id.verification_status

string

required

Status of verification for this ID

data.identification.drivers_license

object

Driver's license details

Show child attributes

data.identification.drivers_license.number

string

required

License number (may be partially masked)

data.identification.drivers_license.issuing_country

string

required

Country that issued the license

data.identification.drivers_license.issue_date

string

required

Date when the license was issued

data.identification.drivers_license.expiry_date

string

required

Date when the license expires

data.identification.drivers_license.verification_status

string

required

Status of verification for this license

Update a Business Entity Update an Individual Entity

⌘I

Business Entities

Individual Entities

Entities

Documents

Entity Documents

Accounts

Accounts Details

Counterparties

Counterparty Lookup

Bank Transfers

Mobile Money Transfers

Issuers

Create an Individual Entity

Headers

Body

Response