Enums
Many of the APIs define and use enumerations of available strings.
Enums are case-sensitive (ALL CAPS) unless otherwise indicated for an individual API method.
New values may be added to an enum as needed, without requiring an API version change. To ensure your integration remains stable through updates, you should always handle unknown enum values gracefully.
Available Enumerations
| Enum | Description |
|---|---|
| ACCOUNT_DOCUMENT_TYPE_STATUSES | Statuses for account document type configurations |
| ACCOUNT_PROVISIONING_ENTITY_STATUSES | Lifecycle states of account provisioning entities |
| ACCOUNT_PROVISIONING_OPERATION_STATUSES | Current status of provisioning operations (pending, success, failed) |
| ACCOUNT_PROVISIONING_OPERATIONS | Types of provisioning operations (onboarding, document sync) |
| ACCOUNT_PROVISIONING_SPONSORS | External payment processing partners that sponsor merchant accounts |
| BANK_ACCOUNT_OWNERSHIP_TYPES | Types of entities that can own bank accounts (business, individual) |
| BANK_ACCOUNT_PURPOSES | Purposes a bank account serves for a business (primary, settlement, etc.) |
| BANK_ACCOUNT_TYPES | Types of bank accounts (checking, savings, general ledger) |
| BENEFICIAL_OWNERSHIP_TYPES | Types of ownership a person has over a business |
| BUSINESS_ADDRESS_TYPES | Types of addresses associated with a business (legal, mailing) |
| BUSINESS_PERSON_POSITIONS | Positions a person can hold within a business |
| BUSINESS_REGISTRATION_TYPES | Ways a business can be registered legally |
| CARD_BRANDS | Brands of credit cards |
| COUNTRIES | ISO 3166-1 alpha-2 country codes |
| CURRENCIES | ISO 4217 three-letter codes for currencies |
| DEFENSE_DOCUMENT_STATUSES | Lifecycle states of defense document generation process |
| DOCUMENT_EVENT_NAMES | Event names for document lifecycle tracking |
| DOCUMENT_FILE_TYPES | Accepted file extensions for document uploads |
| DOCUMENT_TYPE_CODES | Standard document type classification codes |
| DOCUMENT_UPLOAD_STATUSES | Upload progress statuses for document files |
| FULFILLMENT_DECISION_STATUSES | Review outcome statuses for document submissions |
| FULFILLMENT_STATUSES | Statuses for document fulfillment requirements |
| INDUSTRY_CODE_TYPES | Types of industry classification codes (MCC, etc.) |
| PERSON_ADDRESS_TYPES | Types of addresses associated with a person |
| PROPAY_MISSING_REQUIREMENTS | Validation requirement codes for Propay account provisioning |
| MBTRUST_MISSING_REQUIREMENTS | Validation requirement codes for MBTrust account provisioning |
| MCC_CARD_BRANDS | Card brands with merchant category code systems |
| LOCATION_BANK_ACCOUNT_PURPOSES | Purposes a bank account serves for a location (fees, settlement) |
| LOCATION_OWNER_TYPES | Indicates the type of owner for a location |
| LOCATION_TYPES | Indicates the type of a location |
| REQUIRED_DOCUMENT_CATEGORIES | Categories for required documents (requirement, additional) |
| REQUIRED_DOCUMENT_MISSING_REQUIREMENTS | Missing requirement types for required document calculation |
| REQUIRED_DOCUMENT_STATUSES | Fulfillment statuses for required documents |
| SALES_AMOUNT_TYPES | The statistic type in capturing sales related information |
| SOCIAL_NETWORKS | Social media platforms for business presence |
| STATES | US state and territory codes |
| SUBJECT_RECORD_TYPES | Types of entity records |
| WEBHOOK_KEY_STATUSES | Status of a webhook key |
| WORKFLOW_MISSING_REQUIREMENTS | Missing requirement codes returned during workflow validation |
| WORKFLOW_STATES | States in a workflow's lifecycle |
| WORKFLOW_TYPES | Types of workflows available in the system |
Updated 3 months ago