Skip to main content
GET
/
v1
/
entities
/
{id}
Retrieve an entity
curl --request GET \
  --url https://api.nova.net/v1/entities/{id} \
  --header 'Authorization: Bearer <token>'
{
  "object": "entity",
  "livemode": true,
  "id": "ent_H0hdMOc5E5QMTEcGVZKegvLNCB6p",
  "name": "Jane Doe, LLC",
  "type": "individual",
  "external_reference": "entity-123",
  "payment_instructions": [
    "pmi_021wlGURMlk80cYuKBjENXqwC3OV"
  ],
  "external_type": "<string>"
}

Authorizations

​
Authorization
string
header
required

OAuth2 client_credentials grant for server-to-server access. Onboard via your Nova admin to receive a client_id and client_secret, then POST /oauth/token to exchange them for a short-lived access token. Send the token as Authorization: Bearer <access_token> on every authenticated request. Tokens expire after 3600 seconds — refresh by re-exchanging credentials.

Headers

​
X-Organization-Id
string

ID of the organization the request acts on. Optional when the access token is bound to a specific organization, or when the integration has access to exactly one organization.

Pattern: ^org_[A-Za-z0-9]+$
Example:

"org_Xk7d2pQR9m3nBwYz"

Path Parameters

​
id
string
required

ID of the entity

Pattern: ^ent_[A-Za-z0-9]+$
Example:

"ent_H0hdMOc5E5QMTEcGVZKegvLNCB6p"

Response

Entity details

​
object
enum<string>
required

Object type identifier.

Available options:
entity
Example:

"entity"

​
livemode
boolean
required

Whether this object exists in live mode (true) or test mode (false).

​
id
string
required

ID of the entity

Pattern: ^ent_[A-Za-z0-9]+$
Example:

"ent_H0hdMOc5E5QMTEcGVZKegvLNCB6p"

​
name
string
required

Legal name of the entity

Required string length: 1 - 255
Example:

"Jane Doe, LLC"

​
type
enum<string>
required
Available options:
individual,
individual_retirement_plan,
corporation,
llc,
partnership,
trust,
joint_tenants_ros,
tenants_in_common,
community_property,
registered_investment_company,
foundation,
charitable_remainder_trust,
endowment,
employee_benefit_plan,
keogh_plan,
other_entity
Example:

"individual"

​
external_reference
string | null
required

Your identifier for this entity

Example:

"entity-123"

​
payment_instructions
string[]
required

ID of the payment instructions

Pattern: ^pmi_[A-Za-z0-9]+$
​
external_type
string

Your own type for this entity