Retrieve Entity

Use /entity/:id (GET) to retrieve a single entity by its ID. This endpoint returns full entity details including entity-specific information.

Returned Fields:

  • id - The entity's unique identifier
  • entityName - The legal name of the entity/business
  • email - The entity's email address
  • phoneNumber - The entity's phone number
  • address - The entity's physical address
  • locale - The entity's locale preference
  • isArchived - Whether the entity is archived
  • dateArchived - When the entity was archived (if applicable)
  • archiveReason - The reason for archiving (if applicable)
  • cip - CIP (Customer Identification Program) status and details
  • clientUserId - Your internal identifier for the entity
  • createdAt - When the entity was created
  • idNumber - The entity's EIN (masked)
  • idType - The type of ID (typically US_EIN for entities)
  • linkedUsers - Users linked to this entity (e.g., beneficial owners)
  • entityDetails - Additional entity information (website, categories, legal structure, beneficial owners, etc.)
Path Params
string
required

Pass in the Spidr entity ID

Query Params
string
enum

Include finalized ZTM risk levels for the create action and referenced ad-hoc IDV actions under the CIP object

Allowed:
Responses

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