Overview

  • Introduction
  • Authentication
  • Errors
  • External IDs

Endpoints

  • postCreate a user
  • postSearch users
  • getRetrieve a user
  • patchUpdate a user
  • patchUpdate user statuses
  • patchUpdate a user's vault
  • postValidate a vault data update
  • postDecrypt data from a user's vault
  • getCheck presence of data in a user's vault
  • deleteDelete data from a user's vault
  • postUpload a large file to a user's vault
  • postOnboard onto a playbookPreview
  • getGet an onboardingPreview
  • postCreate a manual decision for a userPreview
  • getList all decisions for a userPreview
  • getList all onboardings for a user
  • getGet an onboarding for a user
  • getList all risk signals for a user and onboarding
  • getList all users with duplicate attributesPreview
  • getList the documents for a user
  • postSet the label for a user
  • getGet the label for a user
  • postAdd a tag for a user
  • getList tags for a user
  • deleteDelete a tag for a user
  • postSet the label for a business
  • getGet the label for a business
  • postAdd a tag for a business
  • getList tags for a business
  • deleteDelete a tag for a business
  • postCreate a client vaulting token
  • patchUpdate the vault
  • postValidate a vault data update
  • postDecrypt data from the vault
  • getDownload a file stored in the vault
  • postUpload a large file to the vault
  • postCreate a business client vaulting token
  • patchUpdate the business vault
  • postCreate a business
  • getRetrieve a business
  • patchUpdate a business
  • patchUpdate business statuses
  • patchUpdate a business's vault
  • postValidate a vault data update
  • postDecrypt data from a business's vault
  • getCheck presence of data in a business's vault
  • deleteDelete data from a business's vault
  • postCreate a manual decision for a businessPreview
  • getList all decisions for a businessPreview
  • getList all onboardings for a business
  • getList all risk signals for a businessPreview
  • getList all risk signals for a business and onboarding
  • postLink a business owner
  • getList all owners of a business
  • getList all businesses a user owns
  • getList the documents for a business
  • getGet an onboarding for a business
  • postIssue a request to a preconfigured proxy
  • postIssue a just-in-time request
  • postReflect raw decrypted data
  • getList all risk signalsPreview
  • postCreate an Alpaca account
  • postForward CIP information to Alpaca
  • postExport CIP information for ApexPreview
  • getGet all bank links and associated user idsPreview
  • postCreate a bank link from an intentPreview
  • getGet a list of a user's bank account linksPreview
  • getGet a specific bank account linkPreview
  • getGet a user's bank transactionsPreview
  • getGet transactions for a specific bank linkPreview
  • getSync transactions for a bank linkPreview
  • getGet a user's bank accountsPreview
  • getGet accounts for a specific bank linkPreview
  • getGet investment transactions for a bank linkPreview
  • getGet investment holdings for a bank linkPreview
  • postRefresh bank link dataPreview
  • postImport a bank linkPreview
  • postImport transactions for a bank linkPreview
  • deleteDelete a bank linkPreview
  • postReset a bank linkPreview
  • postTrigger a test webhook event

Client vaulting

These APIs collect additional information from your users and businesses straight from your client.

Your backend creates a short-lived token that gives your client temporary permission to vault and/or decrypt data. The client-side vaulting guide walks through the flow.

Endpoints

  • post/users/{fp_id}/client_tokenCreate a client vaulting token
  • patch/users/vaultUpdate the vault
  • post/users/vault/validateValidate a vault data update
  • post/users/vault/decryptDecrypt data from the vault
  • get/users/vault/decrypt/{token}Download a file stored in the vault
  • post/users/vault/{identifier}/uploadUpload a large file to the vault
  • post/businesses/{fp_bid}/client_tokenCreate a business client vaulting token
  • patch/businesses/vaultUpdate the business vault

On this page

  • Client vaulting
  • Endpoints