Moov · Schema

CreateAccountRequest

Request body for creating a new Moov account.

BankingEmbedded FinanceFinancial InfrastructureMoney MovementPaymentsTransfers

Properties

Name Type Description
accountType string Whether the account is for an individual or a business.
profile object
metadata object Custom key-value metadata to attach to the account.
termsOfService object Terms of service acceptance details.
foreignID string External identifier from your system to associate with this account.
View JSON Schema on GitHub

JSON Schema

moov-createaccountrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateAccountRequest",
  "title": "CreateAccountRequest",
  "type": "object",
  "description": "Request body for creating a new Moov account.",
  "required": [
    "accountType",
    "profile"
  ],
  "properties": {
    "accountType": {
      "type": "string",
      "description": "Whether the account is for an individual or a business.",
      "enum": [
        "individual",
        "business"
      ]
    },
    "profile": {
      "$ref": "#/components/schemas/AccountProfile"
    },
    "metadata": {
      "type": "object",
      "description": "Custom key-value metadata to attach to the account.",
      "additionalProperties": {
        "type": "string"
      }
    },
    "termsOfService": {
      "type": "object",
      "description": "Terms of service acceptance details.",
      "properties": {
        "token": {
          "type": "string",
          "description": "Token obtained from the /tos-token endpoint."
        }
      }
    },
    "foreignID": {
      "type": "string",
      "description": "External identifier from your system to associate with this account."
    }
  }
}