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.
| 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. |
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.
| 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. |
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.
| 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. |
| Option | Type | Description |
|---|---|---|
--json | boolean | After a successful create, print the full API response as JSON. |
-h, --help | boolean | Show help for this command. |