Resource commands

Identities

Use the Blnk CLI to list and create identities on your Core instance.

Use the identities command to list people and organizations on Core, inspect one profile by ID, and register new identities interactively. Link identities to balances when you need a customer or counterparty on a ledger.

Command	Alias	Description
list	l	Browse and filter identities; add `--id` for one record
create	c	Register an individual or organization via prompts

`list`

Search and page through individuals and organizations on Core. Filter on indexed profile fields (email, first name, last name, and others) to find the identity_id you will use when linking balances.

blnk identities list [options]

Options

Option	Type	Default	Description
`--{field}`	string	-	Filter by any indexed field (for example `--email-address jane@example.com`).
`-p, --page`	integer	`1`	Page number.
`--per-page`	integer	`10`	Results per page.
`-h, --help`	boolean	-	Show help for this command.

Usage

List all identities

Run the command to view a paginated table of identities:

blnk identities list

Filter and paginate:

blnk identities list --page 2 --per-page 20
blnk identities list --email-address jane@example.com
blnk identities list --first-name Jane --last-name Doe

┌────────────────   ──────────   ──────────   ─────────────────────────────────   ───────────────────────────┐
│ Identity ID      │ First Name │ Last Name  │ Email Address                     │ Created At                  │
| ---------------- | ---------- | ---------- | --------------------------------- | --------------------------- |
│ idt_8ff119a1...  │ N/A        │ N/A        │ contact@northwind-traders.example │ 2026-05-23T13:42:16.547035Z │
│ idt_9f21736f...  │ N/A        │ N/A        │ accounts@pacific-rim.example      │ 2026-05-23T13:42:15.344356Z │
│ idt_20e8d4f3...  │ Wei        │ Lin        │ wei.lin@example.com               │ 2026-05-23T13:42:14.258165Z │
└────────────────   ──────────   ──────────   ─────────────────────────────────   ───────────────────────────┘
20 results found
Page 1/2

`list --id`

Fetch one identity by identity_id with type, contact fields, and timestamps in a summary block. Pass --json to include address fields, phone, and full meta_data in the output.

blnk identities list --id <identity-id> [options]

Options

Option	Type	Required	Description
`--id`	string	Yes	Identity ID to fetch (for example `idt_8ff119a1-9103-487c-ae07-1449583fb126`).
`--json`	boolean	No	Print the full API object as JSON instead of a formatted summary.
`-h, --help`	boolean	No	Show help for this command.

Usage

Get one identity

Run the command with an identity ID:

blnk identities list --id idt_8ff119a1-9103-487c-ae07-1449583fb126

Identity details:
  identity_id: idt_8ff119a1-9103-487c-ae07-1449583fb126
  identity_type: organization
  first_name: N/A
  last_name: N/A
  email_address: contact@northwind-traders.example
  created_at: 2026-05-23T13:42:16Z

{
  "identity_id": "idt_8ff119a1-9103-487c-ae07-1449583fb126",
  "identity_type": "organization",
  "email_address": "contact@northwind-traders.example",
  "phone_number": "+47 22 12 34 56",
  "city": "Oslo",
  "country": "NO",
  "created_at": "2026-05-23T13:42:16.547035Z",
  "meta_data": {
    "seed_batch": "table_screenshot_20260523"
  }
}

`create`

Register a new individual or organization through interactive prompts for type, name, email, and optional metadata. Use this for manual onboarding or smoke tests. The fields mirror what you send to the Core identities API.

blnk identities create [options]

Arguments

The CLI prompts for these values. They are not passed on the command line.

Argument	Type	Required	Description
`identity_type`	string	Yes	Identity type (for example `individual` or `organization`). Prompt: `identity type >`
`first_name`	string	Yes	First name. Prompt: `first name >`
`last_name`	string	Yes	Last name. Prompt: `last name >`
`email_address`	string	Yes	Email address. Prompt: `email >`
`meta_data`	object	No	Optional metadata as JSON. Prompt: `metadata (json) >`. Press Enter to skip.

Options

Option	Type	Description
`--json`	boolean	After a successful create, print the full API response as JSON.
`-h, --help`	boolean	Show help for this command.

Usage

Create new identity

Run the command:

blnk identities create

The CLI prompts for each argument:

identity type >
first name >
last name >
email >
metadata (json) >

Press Enter at the metadata prompt to leave it empty.

Read the created identity

Identity created:
  identity_id: idt_3b63c8da-af29-4cc3-ad38-df17d87456e6
  identity_type: individual
  first_name: Jane
  last_name: Doe
  email_address: jane@example.com
  created_at: 2026-05-23T17:07:49Z

{
  "identity_id": "idt_3b63c8da-af29-4cc3-ad38-df17d87456e6",
  "identity_type": "individual",
  "first_name": "Jane",
  "last_name": "Doe",
  "email_address": "jane@example.com",
  "created_at": "2026-05-23T17:07:49.876192Z",
  "meta_data": {}
}