ALVIERE

ALVIERE Accounts API

This section outlines the integration with Alviere to create and manage your customers and users, and to perform KYC and Identity Verification on them. A user account is a representation of a customer of your program, which is required for the following Alviere products: * **FBO Accounts** - Alviere provides FDIC-insured bank accounts through its banking partners so you can provide full banking services to your customers. The funds are held *for benefit of* your customers and Alviere manages all day-to-day activities of the banking program, so you can focus on further extending your business offering. * **Stored Value Accounts** - Alviere provides e-wallet / stored value accounts through its banking partners. This means any user account can store money in an e-wallet and easily transfer it from e-wallet to e-wallet, or to/from payment methods. * **Direct Deposit Accounts** - With Alviere's FDIC-insured FBOs and/or stored value account services, you can provide your customers with a DDA routing number where they can deposit their salaries or receive ACH payments from external sources, giving you another touchpoint for promotional and revenue opportunities. User accounts are created and validated in the Alviere platform in stages. Each stage provides different permissions to what actions the user can perform within the Alviere platform. ### KYC and Identity Verification KYC and Identity Verification within the Alviere platform is a multi-stage process and is, by nature, the validations that need to be performed as an asynchronous process. During this process the user account will transition between several statuses. Please check the **[User Status](#section/User-Status)** section for more details. When submitting a request for a new user account, you must provide all of the relevant information that is defined for your program, including name, date of birth, address, email address, phone number, and Social Security Number, depending on the products you are enabling through the Alviere platform. This information must be present on the payload of your user creation API request. ### User Status The user `status` field indicates the current status of your users in the Alviere platform. Some statuses are internal and represent the current stage in the identity verification process, while other statuses represent the need to obtain additional information from the customer or that a manual review of the identity is required. The following statuses are possible for users in the Alviere platform: | Status | Description | |--------|-------------| | **CREATED** | Prior to KYC and Identity Verification checks, this is the status of a user account once you submit a successful user creation request. | | **ACTIVE** | If the user is fully active in the system, their status will be `ACTIVE`. In some cases, the active status does not mean that the user will have full access to all the products provided by Alviere. | | **INACTIVE** | This status indicates that all permissions to access the system are currently revoked and the user will not be able to perform any actions in the Alviere platform until you choose to reactivate the user account. | | **PROCESSING** | This status indicates that identity verification is in progress; no action is required while the user account is in this status. | | **PENDING_USER** | This status indicates that further action is required from the user. This status could occur due to missing or incorrect data on the user's profile such as an address or Social Security Number. For more information, see the Pending User Status Reasons section below. | | **MANUAL_REVIEW** | This status indicates that the user account is currently under manual review by an operator. The `stage` property will indicate why the user account is under manual review (e.g. if `stage: "FRAUD"` this means that the account_abuse score was too high and needs to be validated by the operator) | | **REJECTED** | This status indicates the user account has been rejected by the platform, either manually or automatically. The reason for the rejection will be returned on the `reason` property of the user. | | **DELETED** | This status indicates the user account has been deleted and removed from the platform. The user account data will still be present in the system, but the accout cannot be reinstated. If you wish to temporarily remove access to a user account, you should change the status to `INACTIVE` instead | #### Processing Stages The status of pending verification applies to users that have not yet been completely identified. The possible status reason for the pending verification `stage` property are: | Stage | Description | |-------|-------------| | **FRAUD** | This stage indicates that the fraud check internal process is in progress. | | **ADDRESS** | This stage indicates that the address provided by the user is being validated. | | **IDENTITY** | This stage indicates that the identity verification process is being performed. Information such as the date of birth, address, and/or Social Security Number are being matched against public and platform-private records for accuracy. | | **DOCUMENT** | This stage indicates that the photo identification, provided by the user to validate their identity, is being processed. | | **SANCTIONS** | This stage indicates that the internal process of Sanctions and Negative News screening is not complete. | | (empty) | This stage indicates that the user has not started the KYC validation or is on-boarded and there's no more stages to execute. | #### User Status Reasons The `status_reason` field provides a descriptive reason for the current `status` of the user. If the status is `PENDING_USER`, it means more information is required from the user in order to proceed with the Identity Verification process. The following status reasons can occur for this status: | Status Reason | Description | |---------------|-------------| | **INVALID_NAME** | The first and/or last name provided are not valid and one or both need to be re-submitted. | | **INVALID_DOB** | The provided date of birth is not valid; this could happen for programs where there is a minimum age requirement or the date of birth does not match the public record information on the user. | | **INVALID_ADDRESS** | The user has provided an address that is invalid and needs to be re-submitted. | | **INVALID_PHONE** | The user has provided a phone that is invalid and needs to be re-submitted. | | **INVALID_LAST_4_SSN** | The user has provided the last 4 digits of their Social Security Number that could not be matched against public and platform-private records. This will generally result in the user account being placed in `status_reason: 'REQUIRES_FULL_SSN'`. *Note: This status is only valid for US consumers.* | | **INVALID_SSN** | The user has provided their Social Security Number that could not be matched against public and platform-private records. This will generally result in the user account being placed in `status_reason: 'REQUIRES_FULL_SSN'`. *Note: This status is only valid for US consumers.* | | **REQUIRES_LAST_4_SSN** | The user is required to provide the last 4 digits of their Social Security Number in order to proceed with the identity verification process. This status usually happens when it was not possible to lookup the last 4 digits of their SSN from public records. *Note: This status is only valid for US consumers.* | | **REQUIRES_FULL_SSN** | The user is required to provide their full 9-digit Social Security Number in order to proceed with the identity verification process. This status usually happens when it was not possible to lookup the full SSN from public records. *Note: This status is only valid for US consumers.* | | **INVALID_DOSSIER** | The user has provided a dossier that is invalid and needs to be re-submitted. | | **EXPIRED_DOCUMENT** | The user has provided a document that is expired. A valid document needs to be submitted to proceed with the identity verification process. | If the status is `REJECTED`, the user account either failed some automated checks or was manually rejected by an Operator from the Alviere platform. The following status reasons can occur for this status: | Status Reason | Description | |---------------|-------------| | **NO_IDENTITY_MATCH** | The user has failed to provide information to validate their identity.| | **SANCTIONED_USER** | The user has been positively identified with OFAC Sanctions or Negative News.| | **FRAUD** | The user has been marked fraudulent; for example, a Chargeback was filed for this account and the operator has marked it as fraud. | | **CUSTOM** | The user was rejected and the operator has provided a custom description for the rejection. | #### Dossiers The dossier structure of the User Account is an essential part of Identity Management. In most programs enabled by Alviere, documental identification might be required to enable the full set of services for end users. When a document is required in order to proceed, the Pending User Status will be `REQUIRES_PHOTO_ID`. Dossiers need to be validated through external partners of Alviere; this process is also asynchronous. The following dossier statuses are applied: | Dossier Status | Description | |----------------|-------------| | **CREATED** | This is the status of a dossier once it has been submitted through the API indicating that the dossier is created. | | **PENDING** | This status indicates that the dossier is under verification. | | **MANUAL_REVIEW** | This status indicates that the dossier is under manual verification. | | **VERIFIED** | This status indicates that the dossier has been approved by the system and the user has been positively identified. | | **REJECTED** | This status indicates that the dossier has been rejected. Possible causes range from false documents to bad quality of photos. | | **FAILED** | This status indicates that the dossier has been failed. This happens when the documents format is invalid. | | **EXPIRED** | This status indicates that the dossier submitted has expired and the user account has been placed back in `PENDING_USER` status in order for the user to submit documentation with a valid expiration date. | | **DELETED** | This status indicates that the dossier is deleted. |

GitHub OpenAPI

Operations 21

POST /v1/accounts Add Account #
GET /v1/accounts/{account_uuid} Get Account #
PATCH /v1/accounts/{account_uuid} Update Account #
DELETE /v1/accounts/{account_uuid} Delete Account #
PUT /v1/accounts/{account_uuid}/activate Activate Account #
PUT /v1/accounts/{account_uuid}/inactivate Inactivate Account #
POST /v1/accounts/{account_uuid}/addresses Add Address #
GET /v1/accounts/{account_uuid}/addresses Get Addresses #
PATCH /v1/accounts/{account_uuid}/addresses/{address_uuid} Update Address #
DELETE /v1/accounts/{account_uuid}/addresses/{address_uuid} Delete Address #
POST /v1/accounts/{account_uuid}/contacts Add Contact #
GET /v1/accounts/{account_uuid}/contacts Get Contacts #
PATCH /v1/accounts/{account_uuid}/contacts/{contact_uuid} Update Contact #
DELETE /v1/accounts/{account_uuid}/contacts/{contact_uuid} Delete Contact #
POST /v1/accounts/{account_uuid}/dossiers Add Dossier #
GET /v1/accounts/{account_uuid}/dossiers Get Dossiers #
GET /v1/accounts/{account_uuid}/dossiers/{dossier_uuid} Get Dossier #
PATCH /v1/accounts/{account_uuid}/dossiers/{dossier_uuid} Update Dossier #
PUT /v1/accounts/{account_uuid}/dossiers/{dossier_uuid} Replace Dossier #
DELETE /v1/accounts/{account_uuid}/dossiers/{dossier_uuid} Delete Dossier #
GET /v1/accounts/payments/{account_uuid} Get Payment Methods #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/alviere/refs/heads/main/openapi/alviere-accounts-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/alviere:alviere-accounts-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

alviere-accounts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 0.0.3
  title: Alviere Accounts API
  contact:
    email: support@alviere.com
    url: http://alviere.com/
  x-logo:
    url: img/alviere-logo.svg
  description: '# Introduction


    Welcome to Alviere!


    This page provides developer API documentation for integrating into the Alviere platform.


    ### Notes


    * All times are in UTC time standard

    * All date fields use the RFC 3339 version of the ISO-8601 standard format'
servers:
- url: https://api.snd.alviere.com
  description: Alviere API
tags:


# --- truncated at 32 KB (301 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/alviere/refs/heads/main/openapi/alviere-accounts-api-openapi.yml