Skip to main content
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.
User statuses are uppercase everywhere. See State machines. Compare them without case.

Legacy values

These three predate the current verification flow. The status filter still accepts them, and the API can still return them for users created before that flow. Handle them if you read historical data. No new user reaches them.

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.

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.

verification_mode

How a business gets verified. You choose this when you create it, and it comes back on every read.

business_industry

The industry a business works in, as a NAICS subsector slug. A business sends it as an array of one.

business_type

The legal structure of a business.

Older spellings

These 10 are still accepted and mean the value beside them. Send the canonical value instead. Kira keeps these for integrations written before it existed.

language

The locale for the hosted verification form. It only matters when verification_mode is verification_link.

account_purpose

What the account will be used for.
A business accepts these.A person accepts these.

source_of_funds

Where the money comes from.
A business accepts these.A person accepts these.

expected_monthly_volume

How much is expected to move in a month, as a bucket. A business’s expected_monthly_payments takes the same business values.
A business accepts these.A person accepts these.

expected_transaction_count

How many payments are expected in a month, as a bucket.
A business accepts these.A person accepts these.

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.Tax, identity and registry numbers. Send the value in number. No file needed. tax_id is accepted on the business itself, not on an associated person.Business registration number. Send the value in number. It needs no file and is valid only on a business. company_registration_number is the number the company is registered under with the state or registry where it was formed. For a US company, that is the Secretary of State filing number. It is not the EIN, which goes in ein.Documents. Attach the file in documents[].Business documents. Also attached in documents[], and only valid on a business.

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.
Which of these a business needs depends on the product you are opening. Read missing_fields instead of uploading the whole set. The EIN letter, board minutes, a corporate resolution or a portfolio statement does not stand in for a registry or a certificate that missing_fields names. Whether the note in verification_link_error asks anything of you. The two always arrive together.

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.

verification_step

A step of the verification that no field you can send answers. It reaches missing_fields as verification_step:<value> when the verification is waiting on you (needs_action), next to the fields it names. Send what the other tokens ask for. If a step is the only thing left, contact support.

employment_status

What the person does for a living.

occupation

The person’s occupation, as free text or as a code. An account product can require the code: six digits from the US Bureau of Labor Statistics’ Standard Occupational Classification, 2010 edition, written without the hyphen — 15-1132 goes as 151132. Only that edition is accepted. Four more values cover a person the standard does not describe: SELFEMP (self-employed), STUDENT, RETIRED and UNEMPLO (unemployed). Free text is stored as you send it, and a common job title is matched to a code for you. An uncommon one, such as Director or Founder, is not, and an account that needs the code stays closed until the occupation carries one. Send the code when you want certainty.