# Velmie Documentation

> Documentation for Velmie

Append .md to any documentation page URL to get its markdown version.

## API Reference
- [Welcome to Velmie API Documentation](https://api.velmie.com/reference/welcome-to-velmie-api-documentation.md)
- [Get GeoIP data for current IP.](https://api.velmie.com/reference/get_geoip-v1-lookup.md): This endpoint is used to get location information of a client based on its IP address.
- [Show identity profile.](https://api.velmie.com/reference/get_identities-v1-profile.md): This endpoint is used to get information about identity profile and identifiers. The endpoint expects a session token either in "Authorization Bearer" or through a cookie, the name of which is set in the session.cookie.name configuration, which defaults to "irssession". A CSRF token must also be provided if the session was issued by setting a cookie. To provide the CSRF token, pass it in the X-IRS-CSRF-Token header.
- [Search identities.](https://api.velmie.com/reference/get_identities-v1-search.md): Returns a paginated list of identities filtered by identity columns or metadata buckets. Filters use the `filter[<source>.<path>]` syntax where source is `identity`, `public`, or `admin`. The `filter[query]` parameter enables a configurable "universal search" across multiple fields (operator: contains). Predicates are specified as `<operator>:<value>`. Supported operators: eq, neq, in, lt, le, ge, startswith, endswith, contains, null, notnull. The endpoint expects a session token either in "Authorization Bearer" or the configured session cookie. Provide the X-IRS-CSRF-Token header when the session cookie is used.
- [Completes the OIDC process by exchanging the authCode for an ID token.](https://api.velmie.com/reference/get_irs-oidc-v1-flows-callback.md): This endpoint is used to complete the OIDC process where the server exchanges the authCode for an ID token. The OIDC provider redirects to this endpoint (/irs/oidc/v1/flows/callback), which retrieves the token data and provides it for the flow in the context of which the communication process with the provider was initiated. Afterwards, this endpoint performs a redirect to one of the client-selected URLs that were previously selected during the consentUrl request. A url query parameter "flowId" is added to the redirect, which can be used to get a response from the flow (see /self-service/v1/responses/flows/{id})
- [Completes the OIDC process by exchanging the authCode for an ID token. (POST handler)](https://api.velmie.com/reference/post_irs-oidc-v1-flows-callback.md): This endpoint is used to complete the OIDC process where the server exchanges the authCode for an ID token. The OIDC provider redirects to this endpoint (/irs/oidc/v1/flows/callback), which retrieves the token data and provides it for the flow in the context of which the communication process with the provider was initiated. Afterwards, this endpoint performs a redirect to one of the client-selected URLs that were previously selected during the consentUrl request. A url query parameter "flowId" is added to the redirect, which can be used to get a response from the flow (see /self-service/v1/responses/flows/{id})
- [Returns a new flow for a specified identity type, flow class, and flow Token](https://api.velmie.com/reference/get_self-service-v1-flows-identitytype-flowclass-flowid.md): Returns a new flow for a specified identity type, flow class, and flow Token
- [Retrieves a response after service completed a task that required a redirect for OIDC process.](https://api.velmie.com/reference/get_self-service-v1-responses-flows-id.md): Retrieves a response after service completed a task that required a redirect for OIDC process. This endpoint is used when the service performed a job that required a redirect for the OIDC process. The response is saved and can be retrieved using this endpoint. Please note, the response can be retrieved only once and will no longer be accessible afterwards.
- [Updates the specified base flow advancing it towards completion.](https://api.velmie.com/reference/patch_self-service-v1-flows-id-generics.md): Updates the specified base flow advancing it towards completion. The format of the request data depends on the specific configuration of the flow and its current state.
- [Updates the specified login flow advancing it towards completion.](https://api.velmie.com/reference/patch_self-service-v1-flows-id-logins.md): Updates the specified login flow advancing it towards completion. The format of the request data depends on the specific configuration of the flow and its current state.
- [Updates the specified recovery flow advancing it towards completion.](https://api.velmie.com/reference/patch_self-service-v1-flows-id-recoveries.md): Updates the specified recovery flow advancing it towards completion. The format of the request data depends on the specific configuration of the flow and its current state.
- [Updates the specified registration flow advancing it towards completion.](https://api.velmie.com/reference/patch_self-service-v1-flows-id-registrations.md): Updates the specified registration flow advancing it towards completion. The format of the request data depends on the specific configuration of the flow and its current state.
- [Updates the specified SCA flow advancing it towards completion.](https://api.velmie.com/reference/patch_self-service-v1-flows-id-scas.md): Updates the specified SCA flow advancing it towards completion. The format of the request data depends on the specific configuration of the flow and its current state.
- [Resends the verification code to the user's email or phone.](https://api.velmie.com/reference/post_self-service-v1-flows-id-verifications.md): Resends the verification code to the user's email or phone. This endpoint is used when the user needs to receive the code again, e.g. if it was not received or lost.
- [Confirms the verification code sent to the user's email or phone.](https://api.velmie.com/reference/patch_self-service-v1-flows-id-verifications.md): Confirms the verification code sent to the user's email or phone. This endpoint is used when the user has received the code and needs to confirm it.
- [Show the list of sessions.](https://api.velmie.com/reference/get_sessions-v1-sessions.md): This endpoint is used to get information about user's list of sessions. It's used to validate and view session details such as the authenticated user's data. The endpoint expects a session token either in "Authorization Bearer" or through a cookie, the name of which is set in the session.cookie.name configuration, which defaults to "irssession". A CSRF token must also be provided if the session was issued by setting a cookie. To provide the CSRF token, pass it in the X-IRS-CSRF-Token header.
- [Retrieves information about the last login and the IP address from which the login was made.](https://api.velmie.com/reference/get_sessions-v1-sessions-last-login.md): This endpoint is used to get public information of the current session. It's used to validate and view session details such as the authenticated user's data. The endpoint expects a session token either in "Authorization Bearer" or through a cookie, the name of which is set in the session.cookie.name configuration, which defaults to "irssession". A CSRF token must also be provided if the session was issued by setting a cookie. To provide the CSRF token, pass it in the X-IRS-CSRF-Token header.
- [Retrieves the public view of the current session.](https://api.velmie.com/reference/get_sessions-v1-sessions-whoami.md): This endpoint is used to get public information of the current session. It's used to validate and view session details such as the authenticated user's data. The endpoint expects a session token either in "Authorization Bearer" or through a cookie, the name of which is set in the session.cookie.name configuration, which defaults to "irssession". A CSRF token must also be provided if the session was issued by setting a cookie. To provide the CSRF token, pass it in the X-IRS-CSRF-Token header.
- [Show session by ID.](https://api.velmie.com/reference/get_sessions-v1-sessions-sessionid.md): This endpoint is used to get information about user's session by ID. It's used to validate and view session details such as the authenticated user's data. The endpoint expects a session token either in "Authorization Bearer" or through a cookie, the name of which is set in the session.cookie.name configuration, which defaults to "irssession". A CSRF token must also be provided if the session was issued by setting a cookie. To provide the CSRF token, pass it in the X-IRS-CSRF-Token header.
- [Logout process from the session.](https://api.velmie.com/reference/delete_sessions-v1-sessions-sessionid.md): This is a simple logout process from the current session. To logout from the current session, the word “current” can be used as an ID. Also to logout from the user's session, can use the session ID. The endpoint expects a session token either in "Authorization Bearer" or through a cookie, the name of which is set in the session.cookie.name configuration, which defaults to "irssession". A CSRF token must also be provided if the session was issued by setting a cookie. To provide the CSRF token, pass it in the X-IRS-CSRF-Token header.
- [Export transactions history to CSV](https://api.velmie.com/reference/get_business-users-private-export-transactions-history.md): Export user's transactions history to CSV file with filtering by purpose. This endpoint proxies to the accounts service and returns the same CSV format. Requires either 'view_business_transactions_for_accessible_accounts' or 'view_all_accounts_details_balance' permission.
- [Export transactions report to CSV](https://api.velmie.com/reference/get_business-users-private-export-transactions-report.md): Export user's transactions to CSV file in a simple report format. This endpoint proxies to the accounts service and returns transaction data in CSV format. Requires either 'view_business_transactions_for_accessible_accounts' or 'view_all_accounts_details_balance' permission.
- [Shows list of transactions for current user](https://api.velmie.com/reference/get_business-users-private-transactions.md): Get list of transactions for the authenticated user with filters, sorting and pagination. Requires either 'view_business_transactions_for_accessible_accounts' or 'view_all_accounts_details_balance' permission. NOTE: This endpoint proxies to the accounts service and returns the response with transaction data and navigation links (first, last, prev, next).
- [Shows history of transactions for user](https://api.velmie.com/reference/get_business-users-private-transactions-history.md): Get transactions history for the authenticated user with filters, sorting and pagination. Requires either 'view_business_transactions_for_accessible_accounts' or 'view_all_accounts_details_balance' permission. NOTE: This endpoint proxies to the accounts service. Response includes enhanced pagination metadata (totalCount, page, pageSize, pagination object with total/count/perPage/currentPage/totalPages) and navigation links (first, last, prev, next).
- [Fetch transaction by id](https://api.velmie.com/reference/get_business-users-private-transactions-id.md): Get details of a specific transaction with optional includes for nested resources (account, card, revenueAccount details). Requires either 'view_all_accounts_details_balance' permission for any transaction, or 'view_business_transactions_for_accessible_accounts' permission for transactions from user's accessible accounts only.
- [Get list of accounts for current user](https://api.velmie.com/reference/get_private-v1-accounts.md): Get paginated list of accounts available to the authenticated user. Requires either 'view_all_accounts_details_balance' permission to view all business accounts, or ANY of the following permissions to view accessible accounts only: - view_balance_details_of_accessible_accounts - make_currency_exchanges_between_accessible_accounts - make_payment_from_accessible_accounts - manage_scheduled_payments_from_accessible_accounts - view_business_transactions_for_accessible_accounts - add_edit_delete_team_members - view_scheduled_payments_for_accessible_accounts
- [Create a new account with label and account type](https://api.velmie.com/reference/post_private-v1-accounts.md): Creates a new account for the authenticated user. The account is created within the business owner's context. Requires 'open_accounts' permission.
- [Get account details by ID](https://api.velmie.com/reference/get_private-v1-accounts-id.md): Retrieves detailed information about a specific account including id, number, label, balance, available amount, and account type details. Requires either 'view_all_accounts_details_balance' permission to view any account, or ANY of the following permissions to view accessible accounts only: - view_balance_details_of_accessible_accounts - make_currency_exchanges_between_accessible_accounts - make_payment_from_accessible_accounts - manage_scheduled_payments_from_accessible_accounts - view_business_transactions_for_accessible_accounts - view_scheduled_payments_for_accessible_accounts
- [Update account label](https://api.velmie.com/reference/put_private-v1-accounts-id.md): Updates the label of an existing account owned by the authenticated user. Requires 'open_accounts' permission.
- [Block account by ID](https://api.velmie.com/reference/put_private-v1-accounts-id-block.md): Blocks a specific account using the accounts service. Requires 'block_accounts' permission.
- [Get list of account types](https://api.velmie.com/reference/get_private-v1-short-account-types.md): Retrieves a paginated list of account types with support for filtering, sorting, and field selection. This endpoint supports the same query parameters as the accounts service account-types endpoint.
- [Get short list of accounts with balance and currency information](https://api.velmie.com/reference/get_private-v1-short-accounts.md): Get short list of fiat accounts available to the business owner. Includes account number, balance, currency code and currency type. Available to any authenticated user within the business (no specific permission required).
- [Show a list of invitations.](https://api.velmie.com/reference/get_private-v1-invitations.md): Get a paginated list of invitations with filtering, sorting, and related resources. Requires 'view_and_manage_invitations' permission.
- [Create a new invitation.](https://api.velmie.com/reference/post_private-v1-invitations.md): Create a new invitation to invite a team member to join the business. Requires 'add_edit_delete_team_members' permission.
- [Show an invitation.](https://api.velmie.com/reference/get_private-v1-invitations-id.md): Get details of a specific invitation by ID with optional related resources. Requires 'view_and_manage_invitations' permission.
- [Revoke an invitation.](https://api.velmie.com/reference/delete_private-v1-invitations-id.md): Revoke a pending invitation, preventing the invitee from accepting it. Requires 'view_and_manage_invitations' permission.
- [Resend an invitation.](https://api.velmie.com/reference/patch_private-v1-invitations-id.md): Resend the invitation email to the invitee. Optionally update firstName and lastName before resending. Requires 'view_and_manage_invitations' permission.
- [Send a reminder.](https://api.velmie.com/reference/post_private-v1-invitations-id-reminder.md): Send a reminder email to the invitee for a pending invitation. Requires 'view_and_manage_invitations' permission.
- [Show a list of permissions.](https://api.velmie.com/reference/get_private-v1-permissions.md)
- [Show a list of positions.](https://api.velmie.com/reference/get_private-v1-positions.md): Get a list of all positions for the current user's business. Requires one of the following permissions: 'view_all_positions', 'add_edit_delete_team_members', or 'view_team_members_and_details'.
- [Create a new position.](https://api.velmie.com/reference/post_private-v1-positions.md): Create a new position with specified name, description, and permission keys for the business. Requires 'add_edit_positions' permission.
- [Show a position.](https://api.velmie.com/reference/get_private-v1-positions-id.md): Get details of a specific position by ID or 'current' for the authenticated user's position. Users can always view their own position ('current' ID). For viewing other positions, requires one of the following permissions: 'view_all_positions', 'view_and_manage_invitations', or 'add_edit_delete_team_members'.
- [Update a position.](https://api.velmie.com/reference/put_private-v1-positions-id.md): Update an existing position's name, description, and/or permission keys. Requires 'add_edit_positions' permission.
- [Delete a position.](https://api.velmie.com/reference/delete_private-v1-positions-id.md): Delete a custom position from the business. Requires 'delete_custom_positions' permission.
- [Get short positions list for current user's business.](https://api.velmie.com/reference/get_private-v1-short-positions.md): Get a simplified list of positions (ID and name only) for the current user's business. Available to any authenticated user within the business (no specific permission required).
- [Show a list of users.](https://api.velmie.com/reference/get_private-v1-users.md): Get a paginated list of users with filtering, sorting, and related resources. Requires either 'view_team_members_and_details' or 'view_and_manage_invitations' permission.
- [Show a user permissions.](https://api.velmie.com/reference/get_private-v1-users-permissions.md): Get the current user's role, position, and a map of all permissions. Available to any authenticated user to view their own permissions.
- [Show user details with accounts](https://api.velmie.com/reference/get_private-v1-users-id.md): Get detailed information about a specific user including their profile and associated accounts. If the accounts array in the response is empty, the user has access to all business accounts. If specific account IDs are returned, the user only has access to those accounts. Requires either 'view_team_members_and_details' or 'view_and_manage_invitations' permission.
- [Update a user.](https://api.velmie.com/reference/put_private-v1-users-id.md): Update user's position and/or assigned accounts. If the accounts array is empty or not provided, the user will have access to all business accounts. If specific account IDs are provided, the user will only have access to those accounts. Requires 'add_edit_delete_team_members' permission.
- [Change user's status.](https://api.velmie.com/reference/patch_private-v1-users-id-status.md): Update the status of a specific user in the business. Requires 'add_edit_delete_team_members' permission.
- [Get net worth for current user](https://api.velmie.com/reference/get_private-v2-networth.md): Retrieves the net worth for the current authenticated user, including asset distribution and total value. With 'view_all_accounts_details_balance' permission, returns net worth for all business owner's accounts. Otherwise, returns net worth for user's accessible accounts only (requires ANY of the following permissions): - view_balance_details_of_accessible_accounts - make_currency_exchanges_between_accessible_accounts - make_payment_from_accessible_accounts - manage_scheduled_payments_from_accessible_accounts - view_business_transactions_for_accessible_accounts - view_scheduled_payments_for_accessible_accounts
- [Show a list of account products](https://api.velmie.com/reference/get_private-v1-account-products.md)
- [Show an account product by key](https://api.velmie.com/reference/get_private-v1-account-products-key.md)
- [Create an account.](https://api.velmie.com/reference/post_private-v1-accounts-1.md)
- [Show a list of products](https://api.velmie.com/reference/get_private-v1-card-products.md)
- [Show a product by key](https://api.velmie.com/reference/get_private-v1-card-products-key.md)
- [Show a list of cards.](https://api.velmie.com/reference/get_private-v1-cards.md)
- [Issue a card.](https://api.velmie.com/reference/post_private-v1-cards.md)
- [Show a card.](https://api.velmie.com/reference/get_private-v1-cards-id.md)
- [Change card status.](https://api.velmie.com/reference/patch_private-v1-cards-id.md)
- [Show a card balance.](https://api.velmie.com/reference/get_private-v1-cards-id-balance.md)
- [Show card limits.](https://api.velmie.com/reference/get_private-v1-cards-id-limits.md)
- [Update card limits.](https://api.velmie.com/reference/put_private-v1-cards-id-limits.md)
- [Reissue a card.](https://api.velmie.com/reference/post_private-v1-cards-id-reissue.md)
- [Generate an iFrame.](https://api.velmie.com/reference/post_private-v1-iframe.md)
- [Show a list of KYC Attempt records.](https://api.velmie.com/reference/get_private-v1-kyc-attempts.md)
- [Show KYC Attempt details.](https://api.velmie.com/reference/get_private-v1-kyc-attempts-id.md)
- [Init KYC](https://api.velmie.com/reference/post_private-v1-kyc-level.md)
- [Show a list of KYC records.](https://api.velmie.com/reference/get_private-v1-kycs.md)
- [Show KYC details.](https://api.velmie.com/reference/get_private-v1-kycs-id.md): Show KYC details by ID or for the current user.  **Error codes for 404 responses:** - `KYC_NOT_FOUND_CURRENT` - returned when 'current' is used as ID and no KYC exists for the current user - `NOT_FOUND` - returned when a specific KYC ID is not found
- [Show a list of transactions.](https://api.velmie.com/reference/get_private-v1-transactions.md)
- [Show a transaction.](https://api.velmie.com/reference/get_private-v1-transactions-id.md)