> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kirafin.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# User values
> Every value set a user field accepts or returns, and what each value means.
The values each enumerated field on a user takes. Check it when you are branching on a field's value or building a form that has to offer the right options.
## `status`
The user's lifecycle status. It comes back on every user object, and you can filter a listing by it.
Compare status values **case-insensitively**. User statuses are uppercase everywhere — see [State machines](/lifecycles/states).
| Value | Description |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `CREATED` | The user exists and verification has not started. A user stays here while its field set is incomplete — `missing_fields` tells you what is outstanding. |
| `VERIFYING` | The user was submitted for verification, which is in progress. |
| `REVIEW` | Held for manual review by a Kira operator. `verification_status` reads `in_review`. |
| `VERIFIED` | Verification passed. Products can now report the user as eligible. |
| `REJECTED` | Verification failed. This is terminal, and a `user.verification.failed` webhook fires. |
#### Legacy values
These three predate the current verification flow. They are still accepted as a filter and can still be returned by users created before it, so handle them if you read historical data — but no new user reaches them.
| Value | Description |
| ----------- | --------------------------------------------------------- |
| `ACTIVE` | Legacy. The equivalent of `VERIFIED` in the earlier flow. |
| `INACTIVE` | Legacy. The user was disabled. |
| `SUSPENDED` | Legacy. The user was suspended. |
## `type`
Whether the user is a company or a person. It comes back on every user object, and you can filter a listing by it.
| Value | Description |
| ------------ | ---------------------------------------------------------------------------------------------------------------- |
| `business` | A company. This is the only type you can create. |
| `individual` | A person. Only on users that already exist — new ones are not accepted. These keep working and reading normally. |
## `verification_status`
The result of the user's identity or business check. It comes back on every user object, and you can filter a listing by it.
| Value | Description |
| -------------- | ----------------------------------------------------------------------------------------------- |
| `unverified` | No result yet. This is the starting value. |
| `started` | The check was submitted and is running. |
| `in_review` | Someone at Kira is reviewing the case by hand. |
| `verified` | The check passed. |
| `rejected` | The check failed. |
| `needs_action` | The check cannot finish until something is supplied — usually a missing or unreadable document. |
## `verification_mode`
How a business gets verified. You choose this when you create it, and it comes back on every read.
| Value | Description |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `automatic` | The default. Verification runs as soon as the business is complete, and you receive `user.*` webhooks. |
| `verification_link` | Kira keeps only what it needs and answers with a hosted form for someone to fill in. The other fields hold placeholders until that form is done. |
## `business_industry`
The industries a business works in, as NAICS subsector slugs. A business takes an array of them.
| Value | | |
| -------------------------------------------------------- | ------------------------------------------- | -------------------------------------------------------- |
| `crop_production` | `animal_production` | `forestry_logging` |
| `fishing_hunting_trapping` | `support_activities_agriculture_forestry` | `oil_gas_extraction` |
| `mining_except_oil_gas` | `support_activities_mining` | `utilities` |
| `construction_of_buildings` | `heavy_civil_engineering_construction` | `specialty_trade_contractors` |
| `food_manufacturing` | `beverage_tobacco_product_manufacturing` | `textile_mills` |
| `textile_product_mills` | `apparel_manufacturing` | `leather_allied_product_manufacturing` |
| `wood_product_manufacturing` | `paper_manufacturing` | `printing_related_support_activities` |
| `petroleum_coal_products_manufacturing` | `chemical_manufacturing` | `plastics_rubber_products_manufacturing` |
| `nonmetallic_mineral_product_manufacturing` | `primary_metal_manufacturing` | `fabricated_metal_product_manufacturing` |
| `machinery_manufacturing` | `computer_electronic_product_manufacturing` | `electrical_equipment_appliance_component_manufacturing` |
| `transportation_equipment_manufacturing` | `furniture_related_product_manufacturing` | `miscellaneous_manufacturing` |
| `merchant_wholesalers_durable_goods` | `merchant_wholesalers_nondurable_goods` | `wholesale_electronic_markets_agents_brokers` |
| `motor_vehicle_parts_dealers` | `furniture_home_furnishings_stores` | `electronics_appliance_stores` |
| `building_material_garden_equipment_supplies_dealers` | `food_beverage_stores` | `health_personal_care_stores` |
| `gasoline_stations` | `clothing_accessories_stores` | `sporting_goods_hobby_book_music_stores` |
| `general_merchandise_stores` | `miscellaneous_store_retailers` | `nonstore_retailers` |
| `air_transportation` | `rail_transportation` | `water_transportation` |
| `truck_transportation` | `transit_ground_passenger_transportation` | `pipeline_transportation` |
| `scenic_sightseeing_transportation` | `support_activities_transportation` | `postal_service` |
| `couriers_messengers` | `warehousing_storage` | `publishing_industries` |
| `motion_picture_sound_recording_industries` | `broadcasting` | `internet_publishing_broadcasting` |
| `telecommunications` | `data_processing_hosting_related_services` | `other_information_services` |
| `monetary_authorities_central_bank` | `credit_intermediation_related_activities` | `securities_commodity_contracts_financial_investments` |
| `insurance_carriers_related_activities` | `funds_trusts_other_financial_vehicles` | `real_estate` |
| `rental_leasing_services` | `lessors_nonfinancial_intangible_assets` | `professional_scientific_technical` |
| `management_of_companies` | `administrative_support_services` | `waste_management_remediation_services` |
| `educational_services` | `ambulatory_health_care_services` | `hospitals` |
| `nursing_residential_care_facilities` | `social_assistance` | `performing_arts_spectator_sports` |
| `museums_historical_sites` | `amusement_gambling_recreation_industries` | `accommodation` |
| `food_services_drinking_places` | `repair_maintenance` | `personal_laundry_services` |
| `religious_grantmaking_civic_professional_organizations` | `private_households` | `public_administration` |
## `business_type`
The legal structure of a business.
| Value |
| ------------------------------- |
| `limited_liability_company` |
| `corporation` |
| `general_partnership` |
| `limited_liability_partnership` |
| `sole_proprietor` |
| `non_profit` |
| `trust` |
| `government_organization` |
| `publicly_traded_company` |
#### Older spellings
These 10 are still accepted and mean the value beside them. Send the canonical value instead — these are kept for integrations written before it existed.
| Send this | It means |
| ----------------- | ------------------------------- |
| `llc` | `limited_liability_company` |
| `sole_prop` | `sole_proprietor` |
| `nonprofit` | `non_profit` |
| `government` | `government_organization` |
| `publicly_traded` | `publicly_traded_company` |
| `llp` | `limited_liability_partnership` |
| `partnership` | `general_partnership` |
| `sa_de_cv` | `corporation` |
| `ltda` | `limited_liability_company` |
| `cooperative` | `non_profit` |
## `language`
The locale for the hosted verification form. It only matters when `verification_mode` is `verification_link`.
| Value | Description |
| ----- | ----------- |
| `en` | English. |
| `es` | Spanish. |
## `account_purpose`
What the account will be used for.
**A business accepts these.**
| Value | |
| ----------------------------------------- | ----------------------------- |
| `charitable_donations` | `ecommerce_retail_payments` |
| `investment_purposes` | `purchase_goods_and_services` |
| `receive_payments_for_goods_and_services` | `internal_treasury` |
| `third_party_money_transmission` | `operating_a_company` |
**A person accepts these.**
| Value | |
| --------------------------------- | -------------------------------------- |
| `receive_payments` | `manage_professional_income` |
| `make_payments` | `manage_personal_funds` |
| `investment_trading` | `receive_salary` |
| `receive_payment_for_freelancing` | `payments_to_friends_or_family_abroad` |
| `personal_or_living_expenses` | `protect_wealth` |
## `source_of_funds`
Where the money comes from.
**A business accepts these.**
| Value | |
| ----------------------------- | --------------------- |
| `business_loans` | `inter_company_funds` |
| `investment_proceeds` | `owners_capital` |
| `sales_of_goods_and_services` | `tax_refund` |
| `third_party_funds` | `treasury_reserves` |
| `company_funds` | `investments_loans` |
**A person accepts these.**
| Value | |
| ---------------------------- | ------------------------ |
| `salary` | `self_employment_income` |
| `savings_inheritance_gift` | `gifts` |
| `inheritance` | `pension_retirement` |
| `sale_of_assets_real_estate` | `savings` |
| `someone_elses_funds` | |
## `expected_monthly_volume`
How much is expected to move in a month, as a bucket.
**A business accepts these.**
| Value | |
| -------------------- | --------------------- |
| `less_than_50000` | `50000_to_100000` |
| `100000_to_500000` | `500000_to_1000000` |
| `1000000_to_5000000` | `5000000_to_10000000` |
| `more_than_10000000` | |
**A person accepts these.**
| Value | |
| ----------------- | ------------------ |
| `less_than_10000` | `10000_to_49999` |
| `50000_to_199999` | `200000_to_999999` |
| `1000000_or_more` | |
## `expected_transaction_count`
How many payments are expected in a month, as a bucket.
**A business accepts these.**
| Value | |
| -------------- | --------------- |
| `less_than_10` | `10_to_25` |
| `26_to_50` | `51_to_100` |
| `101_to_500` | `more_than_500` |
**A person accepts these.**
| Value | |
| ----------- | --------------- |
| `1_to_10` | `11_to_50` |
| `51_to_200` | `more_than_200` |
## `identifying_information` types
What kind of record you are sending. The kind decides where its value goes: an identifier goes in `number`, a file goes in `documents[]`.
**Government photo IDs.** Send the number in `number` and the images in `documents[]`. Every one of these needs a `front` and a `back`, except `passport` and `visa`.
| Value |
| ------------------------ |
| `passport` |
| `national_id` |
| `drivers_license` |
| `matriculate_id` |
| `military_id` |
| `permanent_residency_id` |
| `state_or_provincial_id` |
| `visa` |
**Tax and identity numbers.** Send the value in `number`. No file needed. `tax_id` is accepted on the business itself, not on an associated person.
| Value |
| -------- |
| `ssn` |
| `itin` |
| `ein` |
| `curp` |
| `rfc` |
| `cpf` |
| `cnpj` |
| `tin` |
| `nuip` |
| `nit` |
| `tax_id` |
**Documents.** Attach the file in `documents[]`.
| Value |
| -------------------- |
| `proof_of_address` |
| `business_formation` |
| `source_of_wealth` |
**Business documents.** Also attached in `documents[]`, and only valid on a business.
| Value |
| ------------------------------ |
| `ein_letter` |
| `bylaws` |
| `corporate_resolution` |
| `certificate_of_registration` |
| `certificate_of_good_standing` |
| `board_minutes` |
| `portfolio_statement` |
## `documents` types
What a file is within the record it belongs to. Three of these are the images of an identity document; the rest are supporting paperwork.
| Value | Description |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `front` | The front of an identity document. |
| `back` | The back of it. Required on every photo ID except `passport` and `visa`. |
| `selfie` | A face photo. Send it next to the ID and Kira has the provider match it against the ID portrait; on a pass the biometric report is attached to the user with no interactive session. |
| Value | Description |
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `file_proof_of_address` | Proof of residence. Asked of a business and of its owners alike. |
| `file_business_formation` | The document that formed the company. |
| `file_source_of_wealth` | Evidence of where the money comes from. |
| `file_ein_letter` | The tax-id letter issued to the company. |
| `file_bylaws` | The company's bylaws. |
| `file_corporate_resolution` | The resolution authorising the account. |
| `file_certificate_of_registration` | The registration certificate. |
| `file_certificate_of_good_standing` | The certificate of good standing. |
| `file_board_minutes` | Minutes of the board meeting. |
| `file_portfolio_statement` | A portfolio statement. |
| `file_fatca` | The signed tax self-certification (W-9 or W-8BEN). Kira cannot produce this for you — the form asks for a federal tax classification that is not derivable from what you send. |
| `file_company_fiscal_registration` | The tax-registration certificate. |
Which of these a business needs depends on the product you are opening. Read `missing_fields` instead of uploading the whole set.
## liveness `subject`
Who a liveness link is for. A business gets one link per beneficial owner, so you need this to route them.
| Value | Description |
| ------ | ------------------------------------------------------------------------------------------ |
| `user` | The user themselves. This is what an individual gets. |
| `ubo` | A beneficial owner of a business. The entry also carries `person_reference_id` and `name`. |
## liveness `code`
Why a liveness link could not be minted. It comes back on the `422`, and it is what to branch on.
| Value | Description |
| ------------------------------------ | ------------------------------------------------------------------------------------------ |
| `liveness_applicant_missing` | The person has no identity check to attach the result to. Verify them first. |
| `liveness_company_applicant_missing` | The business has not submitted its verification yet. |
| `liveness_ubos_missing` | The business has no beneficial owners on file to check. |
| `liveness_ubos_unresolved` | The business has beneficial owners, but none of them can be checked yet. |
| `liveness_provider_unsupported` | This user was verified by a route that cannot issue a liveness link. |
| `liveness_provider_missing` | Nothing is configured on your account to run the check. Ask your Kira contact. |
| `liveness_redirect_unconfigured` | You sent a `redirect` but your account has no allowlist yet. |
| `liveness_redirect_url_not_allowed` | The `redirect` URL is not HTTPS, its host is not allowlisted, or `success_url` is missing. |
## `verification_link_error_severity`
Whether the note in `verification_link_error` asks anything of you. The two always arrive together.
| Value | Description |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `deferred` | Nothing is wrong. The move is waiting on something expected, or a rule skipped it because the user is already held to a stricter standard. You do not need to act. |
| `failed` | The move hit a real problem. The note says which of two things to do: send the same request again, or contact support because retrying will not help. |
## `unsupported_reason`
Why a product is closed to a user when no data can change it. It replaces that product's `missing_fields` — the two never appear together.
| Value | Description |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `enhanced_due_diligence_required` | The business works in an industry that needs enhanced due diligence, which Kira does not support yet. Opening a virtual account for it answers `422` with the same explanation. |
## `employment_status`
What the person does for a living.
| Value | Description |
| --------------- | -------------------------------------------------------------- |
| `employed` | Works for someone else. Send `current_employer` with this one. |
| `self_employed` | Works for themselves. |
| `unemployed` | Not working. |
| `retired` | Retired. |
| `student` | Studying. |