List Entities

Retrieves all entities for the authenticated user.

curl --request GET \
  --url https://api.nuvion.tech/entities \
  --header 'Authorization: <authorization>'

{
  "message": "Entities retrieved successfully",
  "status": 200,
  "data": [
    {
      "entity": {
        "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F3",
        "type": "business",
        "status": "approved",
        "name": "Acme Corporation",
        "is_root": true,
        "parent_entity": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
        "parent_relationship": "subsidiary",
        "business_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
        "user_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
        "creation_context": "user",
        "risk_score": null,
        "sanctions_status": null,
        "created": "2025-09-12T12:00:00.000Z",
        "updated": "2025-09-12T12:00:00.000Z"
      },
      "business": {
        "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
        "legal_name": "Acme Corporation LLC",
        "trade_name": "Acme",
        "registration_number": "REG123456789",
        "industry": "Technology",
        "website": "https://acmecorp.com",
        "type": "LLC",
        "description": "A leading provider of innovative technology solutions",
        "incorporation_meta": {
          "year": 2020,
          "month": 4,
          "country": "US",
          "state": "California"
        },
        "created": "2025-09-12T12:00:00.000Z",
        "updated": "2025-09-12T12:00:00.000Z"
      }
    },
    {
      "entity": {
        "id": "01HJ5G6R7MXW5ZK2QD6YA8N9G7",
        "type": "business",
        "status": "approved",
        "name": "Globex Corporation",
        "is_root": false,
        "parent_entity": null,
        "parent_relationship": null,
        "business_id": "01HJ5G6R7MXW5ZK2QD6YA8N9G8",
        "user_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
        "creation_context": "user",
        "risk_score": null,
        "sanctions_status": null,
        "created": "2025-09-10T14:30:00.000Z",
        "updated": "2025-09-10T14:30:00.000Z"
      },
      "business": {
        "id": "01HJ5G6R7MXW5ZK2QD6YA8N9G8",
        "legal_name": "Globex Corporation Inc",
        "trade_name": "Globex",
        "registration_number": "REG987654321",
        "industry": "Manufacturing",
        "website": "https://globexcorp.com",
        "type": "Corporation",
        "description": "International manufacturing and distribution company",
        "incorporation_meta": {
          "year": 2018,
          "month": 7,
          "country": "US",
          "state": "New York"
        },
        "created": "2025-09-10T14:30:00.000Z",
        "updated": "2025-09-10T14:30:00.000Z"
      }
    }
  ],
  "meta": {
    "pagination": {
      "cursor": "eyJpZCI6IjAxSEo1RzZSN01YVzVaSzJRRDZZQThOOUc3In0=",
      "has_more": true,
      "limit": 20
    },
    "filters_applied": {
      "type": "business",
      "status": "approved",
      "user_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6"
    }
  }
}

GET

entities

Retrieves all entities for the authenticated user.

curl --request GET \
  --url https://api.nuvion.tech/entities \
  --header 'Authorization: <authorization>'

{
  "message": "Entities retrieved successfully",
  "status": 200,
  "data": [
    {
      "entity": {
        "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F3",
        "type": "business",
        "status": "approved",
        "name": "Acme Corporation",
        "is_root": true,
        "parent_entity": "01HJ5G6R7MXW5ZK2QD6YA8N9F4",
        "parent_relationship": "subsidiary",
        "business_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
        "user_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
        "creation_context": "user",
        "risk_score": null,
        "sanctions_status": null,
        "created": "2025-09-12T12:00:00.000Z",
        "updated": "2025-09-12T12:00:00.000Z"
      },
      "business": {
        "id": "01HJ5G6R7MXW5ZK2QD6YA8N9F5",
        "legal_name": "Acme Corporation LLC",
        "trade_name": "Acme",
        "registration_number": "REG123456789",
        "industry": "Technology",
        "website": "https://acmecorp.com",
        "type": "LLC",
        "description": "A leading provider of innovative technology solutions",
        "incorporation_meta": {
          "year": 2020,
          "month": 4,
          "country": "US",
          "state": "California"
        },
        "created": "2025-09-12T12:00:00.000Z",
        "updated": "2025-09-12T12:00:00.000Z"
      }
    },
    {
      "entity": {
        "id": "01HJ5G6R7MXW5ZK2QD6YA8N9G7",
        "type": "business",
        "status": "approved",
        "name": "Globex Corporation",
        "is_root": false,
        "parent_entity": null,
        "parent_relationship": null,
        "business_id": "01HJ5G6R7MXW5ZK2QD6YA8N9G8",
        "user_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6",
        "creation_context": "user",
        "risk_score": null,
        "sanctions_status": null,
        "created": "2025-09-10T14:30:00.000Z",
        "updated": "2025-09-10T14:30:00.000Z"
      },
      "business": {
        "id": "01HJ5G6R7MXW5ZK2QD6YA8N9G8",
        "legal_name": "Globex Corporation Inc",
        "trade_name": "Globex",
        "registration_number": "REG987654321",
        "industry": "Manufacturing",
        "website": "https://globexcorp.com",
        "type": "Corporation",
        "description": "International manufacturing and distribution company",
        "incorporation_meta": {
          "year": 2018,
          "month": 7,
          "country": "US",
          "state": "New York"
        },
        "created": "2025-09-10T14:30:00.000Z",
        "updated": "2025-09-10T14:30:00.000Z"
      }
    }
  ],
  "meta": {
    "pagination": {
      "cursor": "eyJpZCI6IjAxSEo1RzZSN01YVzVaSzJRRDZZQThOOUc3In0=",
      "has_more": true,
      "limit": 20
    },
    "filters_applied": {
      "type": "business",
      "status": "approved",
      "user_id": "01HJ5G6R7MXW5ZK2QD6YA8N9F6"
    }
  }
}

Headers

Authorization

string

required

Authorization header: Bearer {jwt or Secretkey}

Query Parameters

parent_id

string

Filter entities by parent entity ID

type

string

Filter entities by type

status

string

Filter entities by status

name

string

Filter entities by name (case-insensitive partial match)

risk_score_min

number

Filter entities by minimum risk score

risk_score_max

number

Filter entities by maximum risk score

sanctions_status

string

Filter entities by sanctions status

created_from

number

Filter entities created after this timestamp (Unix milliseconds)

created_to

number

Filter entities created before this timestamp (Unix milliseconds)

verification_status

string

Filter entities by verification status

limit

number

Maximum number of results to return

cursor

string

Pagination cursor for fetching next page of results

sort

string

Sort direction for results

Response

Successful operation

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

List of entity records

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

data.entity.is_root

boolean

required

Indicates if this is a root entity

data.entity.business_id

string

required

ID of the associated business

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

string

required

Timestamp when the entity was created

data.entity.updated

string

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.business

object

required

Business-specific information

Show child attributes

data.business.id

string

required

Unique identifier for the business

data.business.legal_name

string

required

Legal registered name of the business

data.business.registration_number

string

required

Official registration number

data.business.industry

string

required

Industry sector of the business

data.business.type

string

required

Type of business entity

data.business.incorporation_meta

object

required

Information about business incorporation

Show child attributes

data.business.incorporation_meta.year

number

required

Year of incorporation

data.business.incorporation_meta.month

number

required

Month of incorporation

data.business.incorporation_meta.country

string

required

Country of incorporation

data.business.incorporation_meta.state

string

State or province of incorporation

data.business.created

string

required

Timestamp when the business record was created

data.business.updated

string

required

Timestamp when the business record was last updated

data.business.trade_name

string

Trading or doing-business-as name

data.business.website

string

Website URL of the business

data.business.description

string

Description of the business

Business Entities

Individual Entities

Entities

Documents

Entity Documents

Accounts

Accounts Details

Counterparties

Counterparty Lookup

Bank Transfers

Mobile Money Transfers

Issuers

Headers

Query Parameters

Response