NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Rize connects to a Nagent workspace with an API key. Once it is connected, agents can call 8 Rize actions, such as "Create API Key", "Create Card" and "Create Cardholder". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Rize, with input parameters and output schema.
RIZE_CREATE_API_KEYCreate a new API key for the partner. Use this action when you need to generate a new API key for authentication with the Rize API. The API key is created server-side and returned in the response. Note: This action does not require any input parameters. Simply call execute with an empty request body to generate a new API key.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
RIZE_CREATE_CARDCreates a new card in the Rize system. Use this action when you need to create a new card for a cardholder. The card will be associated with the specified partner financial account. Card creation is irreversible once processed — ensure all parameters are correct before execution.
Input parameters
The name to be displayed on the card.
The type of card to create. Use 'VIRTUAL' for virtual cards or 'PHYSICAL' for physical cards.
Additional notes or comments about the card.
The ID of the cardholder associated with this card.
The partner financial account ID to link with this card.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
RIZE_CREATE_CARDHOLDERCreates a new cardholder in the Rize system. Use this action when you need to register a new cardholder with their personal information, addresses, and tax identification. This action is irreversible once processed.
Input parameters
Cardholder's Tax Identification Number
Cardholder's last name
Cardholder's first name
Cardholder's occupation
Cardholder's middle name
Cardholder's phone number in international format
Cardholder's date of birth in YYYY-MM-DD format
Cardholder's email address
Cardholder's mailing address
Cardholder's physical address
ISO 3166-1 alpha-2 country code indicating citizenship
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
RIZE_CREATE_COUNTERPARTYCreates a new Counterparty in the Rize system. A counterparty represents an external party (such as a vendor, supplier, or business partner) that can receive transfers from your account. Use when setting up external payment recipients or business transfer partners. This action is idempotent based on the external_uid. If a counterparty with the same external_uid already exists, the existing record may be returned.
Input parameters
ACH bank account details for the counterparty.
A unique identifier you define to represent the counterparty. Useful for tracking and matching with your internal systems.
The name on the bank account for the counterparty. This is typically the name of the business or individual that owns the account.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
RIZE_CREATE_PARTNER_FINANCIAL_ACCOUNTCreate a new financial account for an existing partner in the Rize admin API. Use this action when you need to provision a new financial account (such as a bank account) for a partner organization that already exists in the Rize platform. This action creates the financial account on the partner record. The account will be associated with the specified financial provider.
Input parameters
The unique identifier of the partner to create a financial account for.
The financial provider to use for the account. Common values include 'TREASURY_PRIME'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
RIZE_CREATE_USERCreates a new user in the Rize system. Use this action when you need to register a new user with their email, name, and role. Optionally, cardholder information can be provided to associate a cardholder profile with the user.
Input parameters
User role determining permissions
User's email address
User's last name
Cardholder information for user creation.
User's first name
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
RIZE_GET_CARDHOLDERRetrieve detailed information about a specific cardholder using their unique identifier. Use this action when you need to fetch cardholder profile data including name, contact information, addresses, and demographic details.
Input parameters
The unique identifier of the cardholder to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
RIZE_GET_VIRTUAL_CARD_IMAGERetrieves the virtual card image asset. Returns the image representation of a virtual debit card which can be displayed in mobile or web applications. Use this action when you need to fetch the visual representation of a virtual debit card for display purposes. This action is read-only and does not modify any card data.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 8 Rize actions on Nagent, including "Create API Key", "Create Card" and "Create Cardholder". Create API Key: Create a new API key for the partner. Each action is listed on this page with its input parameters and its output.
Rize connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
It returns data, error and successful.