Workflow Feature Configs API Reference

Use these config fields inside each item of the features array for POST /v3/workflows/ and PATCH /v3/workflows/{settings_uuid}/.

{
  "workflow_label": "Standard KYC",
  "features": [
    {
      "feature": "OCR",
      "config": {
        "documents_allowed": {
          "USA": {
            "DL": {
              "enabled": 1,
              "sides": 2
            }
          }
        }
      }
    }
  ]
}

The v3 workflow API builds a linear node-based workflow from the ordered features array. Send features in the exact execution order.

Which engine runs a feature — Didit’s own, or a third-party provider — is not one of the config fields below. It’s managed through the console’s Marketplace, which sets provider_key and fallback_to_native on the feature’s config object for you.

Validation rules

OCR defaults to all supported countries and document types when config.documents_allowed is omitted, null, or {}. If you send a custom documents_allowed object, it must contain at least one valid country and one enabled document type. Each document config can set sides to 1 for front-only capture or 2 for front-and-back capture.
QUESTIONNAIRE requires config.questionnaire_uuid.
KYB_DOCUMENTS requires config.kyb_required_document_groups.
SIGNATURE refuses signature_level: "qes" with qes_not_available until qualified signatures are available, and a new step at signature_level: "aes" with aes_not_available while signature_availability.aes is false on the workflow. Its documents must exist when a session is created: with signature_documents_source set to workflow, the step needs documents uploaded in the console, and a step with none can stay a draft but cannot go live; with session, every create call must send sign.documents.
FACE_MATCH must come after OCR in simple workflow requests.
NFC and DATABASE_VALIDATION require OCR when they appear in the same workflow. AML needs one of OCR, KYB_REGISTRY, or DOCUMENT_AI before it; with only DOCUMENT_AI in front of it the screened full_name has to be fillable - either from an upstream Document AI field already keyed full_name, which is mapped for you, or from an explicit config.aml_field_sources entry (see AML).
KYB sub-features such as KYB_DOCUMENTS and KYB_KEY_PEOPLE require KYB_REGISTRY earlier in the workflow.
A workflow is either a person (KYC) workflow or a business (KYB) workflow, never both. A workflow that uses any KYB feature (KYB_REGISTRY, KYB_DOCUMENTS, KYB_KEY_PEOPLE) may only combine it with AML, DOCUMENT_AI, QUESTIONNAIRE, PHONE_VERIFICATION, EMAIL_VERIFICATION, IP_ANALYSIS, and SIGNATURE. It cannot include person-only features such as OCR, LIVENESS, FACE_MATCH, NFC, PROOF_OF_ADDRESS, DATABASE_VALIDATION, or AGE_ESTIMATION, and a person workflow cannot include KYB features. On a business workflow DOCUMENT_AI compares any field marked is_full_name against the verified company instead of a person. To verify the people behind a company, build a separate KYC workflow and reference it from the KYB_KEY_PEOPLE node using kyb_ubo_verification_workflow, kyb_officer_verification_workflow, or kyb_shareholder_verification_workflow.
Action fields use DECLINE, REVIEW, or NO_ACTION unless the field below says it is restricted.
Score and threshold fields are numbers from 0 to 100 unless a narrower range is listed.

Common status rules

Every feature supports an optional status_rules array. Use it to override the feature status when a field condition matches.

{
  "status_rules": [
    {
      "field": "kyc.issuing_state",
      "operator": "in",
      "value": ["VEN", "IRN"],
      "status": "In Review",
      "value_type": "literal"
    },
    {
      "field": "kyc.extra_fields.profession",
      "operator": "fuzzy_match",
      "value": "Soft. Engineer",
      "score": 80,
      "status": "Declined",
      "value_type": "literal"
    },
    {
      "field": "kyc.extra_fields.dl_class_code_b_to",
      "operator": "less_than",
      "value": "2030-01-01",
      "status": "In Review",
      "value_type": "literal"
    },
    {
      "field": "kyc.extra_fields.dl_class_code_b_from",
      "operator": "less_than",
      "value": { "direction": "past", "amount": 3, "unit": "years" },
      "status": "Declined",
      "value_type": "relative_date"
    }
  ]
}

Field	Type	Description
`field`	string	Field path to check, such as `kyc.issuing_state` or `kyc.document_type`.
`operator`	string	One of `equals`, `not_equals`, `greater_than`, `greater_than_or_equals`, `less_than`, `less_than_or_equals`, `contains`, `not_contains`, `in`, `not_in`, `is_empty`, `is_not_empty`, `regex`, or `fuzzy_match`.
`value`	any	Comparison value. Omit or send `null` for operators that do not need a value.
`status`	string	One of `Approved`, `Declined`, `In Review`, or `No Action`.
`value_type`	string	Optional. `literal` by default. Use `field` to compare against another field, `list` to resolve a Didit list UUID at runtime, or `relative_date` to compare a date field against today plus/minus a duration.
`score`	number	Required for `fuzzy_match`. Minimum similarity score from `0` to `100`. The rule matches when the computed similarity is greater than or equal to this value (`similarity >= score`). For example, `Software Engineer` can match `Soft. Engineer` when the similarity is at least `80`.

Read the example above as: kyc.extra_fields.profession fuzzy matches Soft. Engineer with a minimum score of 80 → set the feature status to Declined. For ID Verification, target extracted extra_fields values such as kyc.extra_fields.profession, driver license class validity dates like kyc.extra_fields.dl_class_code_b_from and kyc.extra_fields.dl_class_code_b_to, or per-class restriction/information codes like kyc.extra_fields.dl_class_code_b_notes (column 12 of UK licences). These values come from the OCR result’s extra_fields object; they are not part of expected_details.

dl_class_code_*_from and dl_class_code_*_to are always either a valid ISO date or absent from extra_fields — Didit never returns unreadable OCR text in a date field. If the class-table cell can’t be read, the field is omitted rather than sent as a raw string, so use the is_empty operator to route unreadable class dates instead of assuming the field is always present.

For date fields, use value_type: "relative_date" with a value object shaped as { "direction": "past" | "future", "amount": number, "unit": "days" | "months" | "years" }. For example, operator: "less_than" with { "direction": "past", "amount": 3, "unit": "years" } matches dates older than three years from today.

Compare against a specific step

A graph workflow can run the same feature more than once, for example three ID Verification steps. With value_type: "field", append @<node_id> to the value to read it from one specific step. The referenced node must be a feature step that always runs before the rule’s own step, on every path that reaches it, or the rule’s own step itself. A value without the suffix is read from the rule’s own step.

{
  "status_rules": [
    {
      "field": "kyc.full_name",
      "operator": "fuzzy_match",
      "value": "kyc.full_name@ocr_1",
      "value_type": "field",
      "score": 80,
      "status": "Declined"
    }
  ]
}

Read this rule, set on the third ID Verification step, as: this step’s kyc.full_name fuzzy matches the full name read by step ocr_1 with a minimum score of 80 → set the feature status to Declined. In the console, the variable picker lists each eligible step by its number on the canvas and stores the suffix for you.

OCR / ID Verification

Feature value: OCR.

Config field	Type	Description
`documents_allowed`	object	Optional. Omit it, send `null`, or send `{}` to allow every supported country and document type. Send an ISO3 country code to document type config only when you want to restrict allowed documents. At least one custom document must have `enabled: 1`. Document configs can include `sides: 1` for front-only capture or `sides: 2` for front-and-back capture. Document types include `P`, `ID`, `DL`, `RP`, `HIC`, `TC`, `SSC`, and other country-supported values.
`methods`	object	Which of the three ID Verification methods each country may use: document capture, non-doc lookup against a government or other authoritative source, and digital ID wallets. Omit the key, a country, or a method inside a country and that country is document capture only. Every method and wallet must be marked available for the country in the capability catalog, or the save is rejected. See Methods per country below.
`document_blur_fields_by_country`	object	ISO3 country code to blur field names to redact on document images.
`image_capture_methods_allowed`	string[]	Allowed capture methods. Values include `CAMERA_SCAN` and `UPLOAD`.
`duplicated_user_action`	action	Action for a duplicated user.
`is_age_restrictions_enabled`	boolean	Enables minimum and maximum age checks.
`age_restrictions_by_country`	object	ISO3 country code to an age config with `minimum_age`, optional `maximum_age`, and optional `states`.
`minimum_age`	integer	Global minimum age, `1` to `120`.
`minimum_age_action`	action	Action when the user is below `minimum_age`.
`maximum_age`	integer	Global maximum age, `1` to `120`.
`maximum_age_action`	action	Action when the user is above `maximum_age`.
`expiration_date_not_detected_action`	action	Action when the document expiration date is missing.
`invalid_code_action`	action	Action when a barcode or machine-readable code is invalid.
`invalid_mrz_action`	action	Action when the MRZ is invalid.
`inconsistent_data_action`	action	Action when extracted document fields conflict.
`invalid_validation_action`	action	Action when document validation fails.
`expected_details_mismatch_action`	action	Action when expected user details do not match the document.
`image_too_blurry_action`	action	Action for blurry document images.
`image_too_dark_action`	action	Action for dark document images.
`image_too_bright_action`	action	Action for overexposed document images.
`unparsed_address_action`	action	Action when the document address cannot be parsed.
`address_validation_enabled`	boolean	Validates the address this step reads (printed on the identity document) against postal reference data: it confirms the address exists and normalises it, and never links it to a person. The result is the step’s `address_validation` object in the decision. Charged $0.10 per validated address; a validation that could not run (`unavailable`) is free. Off by default.
`address_not_verified_action`	action	Action when Address Validation could not confirm the address to the building (`ADDRESS_NOT_VERIFIED`: `partially_verified` or `not_verified`). Applies only while `address_validation_enabled` is on. Defaults to `NO_ACTION`, which only records the warning.
`document_or_personal_number_format_mismatch_action`	action	Action when document or personal number format does not match the expected pattern.
`critical_field_occlusion_action`	action	Action when the occlusion check reports that a critical printed field - an identity number, a name, the date of birth or the expiry date - was physically covered on the captured document. Covering an identity number is a tampering signal rather than a capture-quality one, so this defaults to `REVIEW`; the value read for a covered field is dropped from the extraction either way. Raise it to `DECLINE` where a redacted document must never reach a reviewer.
`document_without_portrait_action`	action	Action when the recognized document type never carries a portrait photo on any side (some residence permits, health cards, registration certificates, and other catalog-known portrait-less document families). Defaults to `REVIEW`. Consider `DECLINE` when Face Match anchors the workflow’s identity check.
`is_document_selfie_portrait_match_enabled`	boolean	Enables document portrait to selfie comparison.
`document_selfie_portrait_match_decline_threshold`	integer	Decline threshold for document portrait to selfie match.
`document_selfie_portrait_match_review_threshold`	integer	Review threshold for document portrait to selfie match.
`document_selfie_face_search_enabled`	boolean	Run the Face Search 1:N on the selfie taken during document capture (needs `is_document_selfie_portrait_match_enabled`): match it against the face blocklist and previously verified users. The selfie is only compared, its template is never stored. On by default. `false` skips the search and leaves the document-selfie duplicate-face actions with nothing to act on; `face_search_enabled: false` on the Liveness step skips it too, since that opt-out covers every selfie of the session.
`document_selfie_duplicated_face_action`	action	Verdict when the document-capture selfie matches, or possibly matches, the face of a user already verified in this application. Defaults to `NO_ACTION`.
`document_selfie_duplicated_face_name_mismatch_action`	action	Verdict when the document-capture selfie matches a user already verified under a different name. Can only escalate `document_selfie_duplicated_face_action`. Defaults to `REVIEW`.
`document_selfie_duplicated_face_document_mismatch_action`	action	Verdict when the document-capture selfie matches a user already verified with a different date of birth on their identity document. The same person on a different or renewed document is not flagged. Can only escalate `document_selfie_duplicated_face_action`. Defaults to `REVIEW`.
`id_verification_name_match_score_threshold`	integer	Name match threshold across multiple ID verifications.
`id_verification_max_retry_attempts`	integer	Retry limit for ID verification, `2` to `5`.
`id_document_quality_threshold`	integer	Minimum capture-quality score (`0` to `100`) a document image must reach to be accepted. The quality check always runs; only this threshold is configurable. Defaults to `20`, tuned so degraded and borderline captures (blur, motion, unreadable text) are rejected while legible documents pass; raise it for stricter capture requirements. The console presents this value on a perceptual slider where the default of `20` displays as a balanced 50%.
`cross_org_fraud_document_action`	action	Verdict when this document was flagged as fraudulent by another organization in the network.
`document_audio_recording_enabled`	boolean	Record the microphone during document capture, so a reviewer can hear the session. Off by default.
`document_liveness_portrait_replace_decline_threshold`	integer	Portrait replacement score (`0` to `100`, higher = more likely genuine) below which the session is declined. Defaults to `35`. See document liveness thresholds.
`document_liveness_portrait_replace_review_threshold`	integer	Portrait replacement score below which the session goes to In Review, when it is not already declined. At `100`, almost every session is held. Defaults to `70`. See document liveness thresholds.
`document_liveness_printed_copy_decline_threshold`	integer	Printed copy score (`0` to `100`, higher = more likely genuine) below which the session is declined. Defaults to `35`. See document liveness thresholds.
`document_liveness_printed_copy_review_threshold`	integer	Printed copy score below which the session goes to In Review, when it is not already declined. At `100`, almost every session is held. Defaults to `77`. See document liveness thresholds.
`document_liveness_screen_replay_decline_threshold`	integer	Screen capture score (`0` to `100`, higher = more likely genuine) below which the session is declined. Defaults to `30`. See document liveness thresholds.
`document_liveness_screen_replay_review_threshold`	integer	Screen capture score below which the session goes to In Review, when it is not already declined. At `100`, almost every session is held. Defaults to `70`. See document liveness thresholds.
`id_verification_injection_attack_action`	action	Verdict when the document, or the selfie taken for an ID lookup, was injected rather than captured by the device’s own camera (`INJECTION_ATTACK_DETECTED`): a software virtual camera, a camera feed generated by the page or by browser automation, a hooked camera, or an instrumentation tool attached to the app. Values: `DECLINE`, `REVIEW`, `NO_ACTION`. Defaults to `DECLINE`. Signals a genuine person can produce never raise it. On liveness and face match the risk follows `frame_injection_action` instead.
`image_quality_too_low_action`	action	Verdict when overall document image quality is below the bar.
`is_image_capture_review_screen_enabled`	boolean	Show the user a review screen after each document capture, letting them retake the photo before it is submitted. Off by default.
`is_ocr_id_verification_data_review_enabled`	boolean	Let the user review and correct the extracted identity data before the step completes. Off by default. A correction is scored against `ocr_id_verification_data_review_critical_fields`, and a disagreement takes the critical or the minor action accordingly. The review still runs when the workflow includes NFC - a later chip read simply supersedes it.
`ocr_id_verification_data_review_critical_fields`	string[]	Which extracted identity fields count as critical when the user edits the OCR result, so a mismatch takes the critical action rather than the minor one. Shape: `["first_name" \| "last_name" \| "date_of_birth" \| ...]`.
`ocr_id_verification_data_review_critical_mismatch_action`	restricted action	Verdict when the user’s edit disagrees with OCR on a critical field.
`ocr_id_verification_data_review_minor_mismatch_action`	action	Verdict when the user’s edit disagrees with OCR on a non-critical field.
`status_rules`	array	Optional custom status rules.

Document liveness is configured with the six document_liveness_* thresholds above, not with per-signal action fields. portrait_replacement_action, printed_copy_action and screen_capture_action are account-level settings and are not accepted in a workflow feature config: the API strips unknown config keys on save, so sending them there has no effect. Each signal has a decline threshold and a review threshold on a 0-100 scale where a higher score means the document is more likely to be genuine.

Example:

{
  "feature": "OCR",
  "config": {
    "documents_allowed": {
      "USA": {
        "DL": {
          "enabled": 1,
          "sides": 2
        }
      }
    },
    "duplicated_user_action": "REVIEW",
    "image_capture_methods_allowed": ["CAMERA_SCAN", "UPLOAD"]
  }
}

Methods per country

methods is keyed by ISO 3166-1 alpha-3 country code. Each country carries up to three method objects; anything you leave out takes its default.

{
  "feature": "OCR",
  "config": {
    "methods": {
      "ZAF": {
        "document": { "enabled": true },
        "id_lookup": {
          "enabled": true,
          "max_attempts": 2,
          "skip_liveness_and_face_match": true,
          "on_partial_match": "fallback_to_document",
          "on_no_match": "fallback_to_document",
          "on_provider_error": "fallback_to_document"
        },
        "wallet": { "enabled": false, "providers": [], "on_failure": "fallback_to_document" }
      },
      "DNK": {
        "document": { "enabled": true },
        "id_lookup": { "enabled": true, "on_no_match": "decline" }
      }
    }
  }
}

wallet.on_failure is fallback_to_document, decline or retry. retry (wallet only, document capture off for the country) keeps a user whose sign-in did not finish on the wallet step to try again; the session is never declined for it and stays open until they finish or it expires. The id_lookup switches take only fallback_to_document or decline. To keep documents out of the first screen and offer them only when a wallet or lookup does not land, set document.fallback_only. The example uses Finland, where the Finnish Trust Network comes first and document capture is the fallback. Finland also needs its document types enabled in documents_allowed (for example passport and ID card) so the fallback has documents to offer.

{
  "FIN": {
    "document": { "enabled": true, "fallback_only": true },
    "wallet": { "enabled": true, "providers": ["ftn"], "on_failure": "fallback_to_document" }
  }
}

Both lookups above are available in today’s catalog, so that config saves as written. The wallet block is left out of this example on purpose: a wallet saves only in a country where the catalog marks it available, and wallet.enabled: true anywhere else is rejected and takes the whole save with it, lookup configuration included. Where the catalog marks a wallet available, add it to that country:

{
  "DNK": {
    "document": { "enabled": true },
    "wallet": { "enabled": true, "providers": ["mitid"], "on_failure": "fallback_to_document" }
  }
}

Key	Type	Default	Description
`<ISO3>.document.enabled`	boolean	`true`	Whether a photographed document is accepted in this country. Which documents are accepted keeps living in `documents_allowed`.
`<ISO3>.document.fallback_only`	boolean	`false`	Keep document capture enabled but do not offer it on the first screen. Users start with the country’s wallet or ID lookup, and only users whose wallet sign-in fails, is cancelled or times out, or whose lookup does not match (per the `on_failure`, `on_partial_match`, `on_no_match` and `on_provider_error` switches set to `fallback_to_document`) are taken to document capture. With a single wallet, the user lands straight on that wallet. Without it, a wallet or lookup is shown side by side with document capture. Rejected with HTTP 400 unless `document.enabled` is `true` and at least one wallet or ID lookup in the country falls back to document capture.
`<ISO3>.id_lookup.enabled`	boolean	`false`	Offer the non-document lookup against this country’s government or other authoritative source. Rejected when the catalog does not mark the country’s source `available`.
`<ISO3>.id_lookup.max_attempts`	integer	`1`	`1` to `5`. How many answered lookups the user gets before the fallback switch fires. A number that fails the client-side format check never reaches the register, so it neither counts nor bills.
`<ISO3>.id_lookup.skip_liveness_and_face_match`	boolean	`true`	After a match against a register that returns a portrait, skip the workflow’s own Liveness and Face Match steps — the lookup already ran passive liveness on the selfie and matched it to that portrait. Normalised to `false` on save for a source that returns no portrait, where the switch would mean nothing.
`<ISO3>.id_lookup.on_partial_match`	`fallback_to_document` \| `decline`	`fallback_to_document`	What happens when the register answered but some fields did not match.
`<ISO3>.id_lookup.on_no_match`	`fallback_to_document` \| `decline`	`fallback_to_document`	What happens when the register answered and holds no matching record.
`<ISO3>.id_lookup.on_provider_error`	`fallback_to_document` \| `decline`	`fallback_to_document`	What happens when the register could not be reached. Never billed.
`<ISO3>.id_lookup.response_fields`	string[] \| null	`null`	Optional subset of the source’s response field keys. Unknown keys are rejected and the source’s required fields are always added back, so the saved value is always a valid selection. The current staging implementation applies this selection to comparison output, optional gender and retained registry portraits. Required identity fields remain. See the rollout and retention note below.
`<ISO3>.wallet.enabled`	boolean	`false`	Offer digital ID wallet sign-in in this country.
`<ISO3>.wallet.providers`	string[]	`[]`	Catalog wallet ids this country accepts — an accept-list, never a ranking. The order you send is normalised into catalog order. At least one wallet is required when `enabled` is `true`. A wallet that is not offered in the country, or that is still coming soon, is rejected.
`<ISO3>.wallet.on_failure`	`fallback_to_document` \| `decline` \| `retry`	`fallback_to_document`	What happens when the sign-in is cancelled, times out or fails. `retry` keeps the user on the wallet step to try again (wallet only); it is refused together with `document.fallback_only`.

Validation the API applies on save:

An unknown country code, an unknown key inside a country, or an unknown key inside a method is rejected — nothing is silently dropped.
A country where no method is enabled is rejected: nobody there could verify.
A wallet or lookup can only fall back to document capture when document capture is enabled for that country. fallback_to_document in a country where document.enabled is false declines at runtime, because there is nowhere to fall back to.
document.fallback_only: true is rejected with HTTP 400 unless document.enabled is true and at least one wallet or ID lookup in that country falls back to document capture.

The current staging implementation applies id_lookup.response_fields to comparison output, optional gender and retained registry portraits. Required identity fields remain part of the verification record. This is not a guarantee that every intermediate provider payload is excluded from processing. Production rollout has not been verified for this change; confirm the behavior in your target environment before relying on field selection for retention requirements.

Read the capability catalog before you write methods — through the console’s Countries tab, or with the didit_workflow_get_id_verification_methods_catalog MCP tool. Behaviour, coverage and billing are on ID Verification methods.

NFC / ePassport

Feature value: NFC.

Config field	Type	Description
`allow_nfc_skip`	boolean	Allows users to skip NFC when their document supports chip reading.
`skip_nfc_action`	action	Action when the user skips NFC.
`unverified_chip_action`	action	Action when chip verification fails.
`trust_anchor_missing_action`	action	Verdict when the chip’s data-group hashes are intact but the certificate chain cannot be verified, because the issuing country’s CSCA trust anchor is not loaded.
`jpki_request_attributes`	boolean	Japan My Number Card (JPKI, native SDKs only): also read the signature certificate, which needs the card’s signature PIN and carries the holder’s name, date of birth, sex and address, compared with the ID verification data. Default `true`. `false` reads only the user authentication certificate (4-digit PIN), which proves the card and the PIN but carries no holder data.
`jpki_certificate_invalid_action`	action	Verdict when a My Number Card certificate does not chain to the JPKI certification authority, is outside its validity period, or is not a card certificate of the requested type (`JPKI_CERTIFICATE_INVALID`). Default `DECLINE`.
`jpki_signature_invalid_action`	action	Verdict when the My Number Card’s signature over the one-time challenge does not verify, so possession of the card and knowledge of its PIN are not proven (`JPKI_SIGNATURE_INVALID`). Default `DECLINE`.
`jpki_certificate_revoked_action`	action	Verdict when the revocation check reports a My Number Card certificate revoked (`JPKI_CERTIFICATE_REVOKED`). Default `DECLINE`.
`jpki_revocation_unchecked_action`	action	Verdict when the My Number Card was verified but no revocation answer was available, so a revoked card cannot be ruled out (`JPKI_REVOCATION_UNCHECKED`). Default `REVIEW`.
`jpki_inconsistent_data_action`	action	Verdict when the name, date of birth, sex or address in the My Number Card’s signature certificate differs from the ID verification data of the same card (`JPKI_AND_OCR_DATA_NOT_SAME`). Default `REVIEW`.
`status_rules`	array	Optional custom status rules.

Liveness

Feature value: LIVENESS.

Config field	Type	Description
`face_liveness_method`	string	One of `ACTIVE_3D`, `FLASHING`, or `PASSIVE`.
`face_liveness_mode`	string	Liveness mode override.
`face_liveness_flash_mode`	string	Flash mode for the `ACTIVE_3D` and `FLASHING` methods. `"0"` (not strict, default) verifies that the colors flashed on screen reflect on the user’s face; `"1"` (strict) additionally requires the reflections to match the exact flashed color sequence — stronger against replay and video-injection attacks, but with more false rejections.
`face_liveness_score_decline_threshold`	integer	Decline threshold.
`face_liveness_score_review_threshold`	integer	Review threshold.
`face_liveness_possible_duplicated_face_action`	action	Action when the face may be duplicated.
`face_liveness_multiple_faces_action`	action	Action when multiple faces are detected.
`face_liveness_video_anomaly_action`	action	Action when the stored recording contains a repeated moving sequence. Default `NO_ACTION`; `REVIEW` and `DECLINE` can escalate a decided verification asynchronously. Sparse or repeated still frames alone do not trigger it.
`face_liveness_attack_face_match_action`	action	Action when the liveness face matches a face from an earlier session of this application of another user whose capture was judged a liveness attack with high confidence (warning `FACE_MATCHES_LIVENESS_ATTACK`). Accepts `NO_ACTION` or `REVIEW`; `DECLINE` is accepted but applied as `REVIEW`, because a genuine user can be rejected once by mistake and then pass. Defaults to `NO_ACTION`.
`race_map_similarity_thresholds`	object	Per-demographic similarity thresholds.
`face_privacy_mode_enabled`	boolean	Enables privacy mode for face assets.
`face_quality_review_threshold`	integer	Review threshold for face image quality.
`face_quality_decline_threshold`	integer	Decline threshold for face image quality. Must be less than or equal to the review threshold.
`face_luminance_min_threshold`	integer	Minimum luminance threshold. Must be lower than `face_luminance_max_threshold`.
`face_luminance_min_action`	action	Action when luminance is too low.
`face_luminance_max_threshold`	integer	Maximum luminance threshold.
`face_luminance_max_action`	action	Action when luminance is too high.
`face_liveness_max_attempts`	integer	Total liveness submissions per session, `1` to `3`. Default `3` means one initial attempt plus two retries. Setting `1` does not disable retries for capture-quality failures: when every warning on the attempt is environmental (`LOW_FACE_LUMINANCE`, `HIGH_FACE_LUMINANCE`, `LOW_FACE_QUALITY`, `HIGH_FACE_OCCLUSION`, `NO_FACE_DETECTED`) the user always gets a second attempt with actionable feedback.
`cross_org_fraud_face_action`	action	Deprecated and no longer applied. It treated a face as if it carried a fraud verdict, which a stable biometric identity cannot. Still accepted so existing workflows keep validating. Use `cross_org_identity_claim_pattern_action`.
`cross_org_identity_claim_pattern_action`	action	Verdict when other organizations in the network recorded identity-claim events for this same person in which the claimed identity did not match. Review or No action only — a Decline set here is downgraded to Review. See Cross-organization identity claims.
`external_capture_device_action`	action	Verdict when an external capture device is detected.
`face_audio_recording_enabled`	boolean	Record the microphone during the selfie capture, so a reviewer can hear the session. Off by default.
`face_search_enabled`	boolean	Run the automatic Face Search 1:N on the selfie: match it against previously verified users, the face blocklist and allowlist, and store its biometric template for later matching. On by default. `false` skips the search, keeps no face template for this step, and leaves the duplicated-face actions with nothing to act on.
`face_liveness_uncertain_retry_enabled`	boolean	Native SDK active liveness only. On, a capture whose liveness score falls strictly between `face_liveness_score_decline_threshold` and `face_liveness_score_review_threshold` is never decided, whichever verdict the engine attached to it: the person is told the result was unclear and asked to capture again, every time, outside the `face_liveness_max_attempts` budget (which still applies to captures the engine could not score). Off by default; the web flow ignores it.
`face_liveness_duplicated_face_name_mismatch_action`	action	Verdict when a duplicate face is found under a different name.
`face_liveness_duplicated_face_document_mismatch_action`	action	Verdict when a duplicate face is found and the matched user’s identity document shows a different date of birth. The same person on a different or renewed document is not flagged. Defaults to `REVIEW`.
`frame_injection_action`	action	Verdict when injected video frames are detected.
`screen_capture_action`	action	Verdict when the selfie is a photo of a screen.
`virtual_camera_action`	action	Verdict when a virtual camera feed is detected.
`status_rules`	array	Optional custom status rules.

Face Match

Feature value: FACE_MATCH.

Config field	Type	Description
`face_match_score_decline_threshold`	integer	Decline threshold.
`face_match_score_review_threshold`	integer	Review threshold.
`face_match_max_attempts`	integer	Total face-match submissions per session, `1` to `3`. Default `3` means one initial attempt plus two retries.
`face_match_not_computed_action`	restricted action	Verdict when no face-match score could be produced (missing portrait or selfie).
`face_match_eyes_covered_action`	action	Verdict when the eyes region is covered in the selfie. Defaults to `NO_ACTION`, which records the evidence without changing the Face Match result. This signal is still being calibrated, so it stays shadow-only until the region reports as calibrated: set `REVIEW` or `DECLINE` now and it takes effect from that point on.
`face_match_mouth_covered_action`	action	Verdict when the mouth region is covered in the selfie. Same `NO_ACTION` default and same calibration caveat as `face_match_eyes_covered_action`.
`face_match_face_covered_action`	action	Verdict when the face as a whole is covered in the selfie. Same `NO_ACTION` default and same calibration caveat as `face_match_eyes_covered_action`.
`status_rules`	array	Optional custom status rules.

Age Estimation

Feature value: AGE_ESTIMATION.

Config field	Type	Description
`enable_id_verification_fallback`	boolean	Runs ID Verification when age estimation lands in the borderline range.
`minimum_age_threshold`	integer	Minimum accepted age, `1` to `100`.
`borderline_minimum_age_threshold`	integer	Lower bound for the borderline range, `1` to `100`.
`borderline_maximum_age_threshold`	integer	Upper bound for the borderline range, `1` to `100`.
`face_liveness_method`	string	One of `ACTIVE_3D`, `FLASHING`, or `PASSIVE`.
`face_liveness_flash_mode`	string	Flash mode for the `ACTIVE_3D` and `FLASHING` methods. `"0"` (not strict, default) verifies that the colors flashed on screen reflect on the user’s face; `"1"` (strict) additionally requires the reflections to match the exact flashed color sequence.
`face_liveness_score_decline_threshold`	number	Decline threshold for the liveness check used by age estimation.
`face_liveness_score_review_threshold`	number	Review threshold for the liveness check used by age estimation.
`face_liveness_possible_duplicated_face_action`	action	Action when the face may be duplicated.
`face_liveness_multiple_faces_action`	action	Action when multiple faces are detected.
`face_liveness_video_anomaly_action`	action	Action when the stored recording contains a repeated moving sequence. Default `NO_ACTION`; `REVIEW` and `DECLINE` can escalate a decided verification asynchronously. Sparse or repeated still frames alone do not trigger it.
`face_liveness_attack_face_match_action`	action	Action when the liveness face matches a face from an earlier session of this application of another user whose capture was judged a liveness attack with high confidence (warning `FACE_MATCHES_LIVENESS_ATTACK`). Accepts `NO_ACTION` or `REVIEW`; `DECLINE` is accepted but applied as `REVIEW`, because a genuine user can be rejected once by mistake and then pass. Defaults to `NO_ACTION`.
`face_privacy_mode_enabled`	boolean	Enables privacy mode for face assets.
`face_quality_review_threshold`	integer	Review threshold for face quality.
`face_quality_decline_threshold`	integer	Decline threshold for face quality.
`face_luminance_min_threshold`	integer	Minimum luminance threshold.
`face_luminance_min_action`	action	Action when luminance is too low.
`face_luminance_max_threshold`	integer	Maximum luminance threshold.
`face_luminance_max_action`	action	Action when luminance is too high.
`face_liveness_max_attempts`	integer	Total liveness submissions per session, `1` to `3`. Default `3` means one initial attempt plus two retries. Setting `1` does not disable retries for capture-quality failures: when every warning on the attempt is environmental (`LOW_FACE_LUMINANCE`, `HIGH_FACE_LUMINANCE`, `LOW_FACE_QUALITY`, `HIGH_FACE_OCCLUSION`, `NO_FACE_DETECTED`) the user always gets a second attempt with actionable feedback.
`external_capture_device_action`	action	Verdict when an external capture device is detected.
`face_audio_recording_enabled`	boolean	Record the microphone during the selfie capture, so a reviewer can hear the session. Off by default.
`face_search_enabled`	boolean	Run the automatic Face Search 1:N on the selfie: match it against previously verified users, the face blocklist and allowlist, and store its biometric template for later matching. On by default. `false` skips the search, keeps no face template for this step, and leaves the duplicated-face actions with nothing to act on.
`face_liveness_uncertain_retry_enabled`	boolean	Native SDK active liveness only. On, a capture whose liveness score falls strictly between `face_liveness_score_decline_threshold` and `face_liveness_score_review_threshold` is never decided, whichever verdict the engine attached to it: the person is told the result was unclear and asked to capture again, every time, outside the `face_liveness_max_attempts` budget (which still applies to captures the engine could not score). Off by default; the web flow ignores it.
`face_liveness_duplicated_face_name_mismatch_action`	action	Verdict when a duplicate face is found under a different name.
`face_liveness_duplicated_face_document_mismatch_action`	action	Verdict when a duplicate face is found and the matched user’s identity document shows a different date of birth. The same person on a different or renewed document is not flagged. Defaults to `REVIEW`.
`frame_injection_action`	action	Verdict when injected video frames are detected.
`screen_capture_action`	action	Verdict when the selfie is a photo of a screen.
`virtual_camera_action`	action	Verdict when a virtual camera feed is detected.
`status_rules`	array	Optional custom status rules.

Phone Verification

Feature value: PHONE_VERIFICATION.

Config field	Type	Description
`code_size`	integer	OTP size, `4` to `8`.
`phone_max_retries`	integer	Maximum send retries, `1` to `5`.
`phone_max_check_attempts`	integer	Maximum OTP check attempts, `1` to `5`.
`phone_verification_countries`	object	ISO2 country code to channel config. Example: `{ "US": { "sms": { "enabled": true } } }`.
`disposable_number_action`	action	Action for disposable numbers.
`voip_number_action`	action	Action for VoIP numbers.
`duplicated_phone_number_action`	action	Action for duplicated phone numbers.
`high_risk_phone_action`	action	Action when the delivery provider blocks the OTP send. Only `DECLINE` or `REVIEW`; default `DECLINE`. Applied only when every block on the step carries `risk_factors` of exactly `["device_attribute"]`; any other risk factor, any mix including it, or no risk factors at all declines regardless of this setting.
`phone_shared_device_mode`	boolean	Allows shared-device phone verification mode.
`phone_enrichment_enabled`	boolean	Enables phone intelligence enrichment (line-type risk, trust index, carrier, porting / SIM-swap history, fraud-risk score). Charged $0.05 per verification on top of the phone verification price.
`phone_intelligence_score_action`	action	Action when the phone fraud-risk score is at or above `phone_intelligence_score_threshold`.
`phone_intelligence_score_threshold`	integer	Fraud-risk score (`0`–`100`, higher is riskier) that triggers `phone_intelligence_score_action`. Default `80`.
`phone_type_risk_action`	action	Action when the number is flagged as a high-risk phone type.
`recent_port_action`	action	Action when the number was recently ported (SIM-swap / porting signal).
`low_phone_trust_action`	action	Action when the phone trust index is at or below `phone_trust_index_threshold`.
`phone_trust_index_threshold`	integer	Trust index (`0`–`100`, lower is riskier) at or below which `low_phone_trust_action` is applied. Default `30`.
`phone_social_enabled`	boolean	Enables the social footprint check: which messaging, social, e-commerce and professional platforms the verified number is registered on. Charged $0.05 per verification on top of the phone verification price, independent of `phone_enrichment_enabled`.
`phone_no_social_presence_action`	action	Action when the social footprint check finds the number registered on none of the platforms it covers - a common synthetic-identity signal. Default `NO_ACTION`.
`cross_org_fraud_phone_action`	action	Verdict when this number was flagged as fraudulent by another organization in the network.
`status_rules`	array	Optional custom status rules.

Phone Verification is disabled until the organization completes its first top-up.

Phone intelligence enrichment is an optional add-on. When phone_enrichment_enabled is true, each completed phone verification is enriched with phone intelligence and billed $0.05 per request in addition to the standard phone verification cost. The score-based actions only take effect once the enrichment score is available; the trust-index, phone-type and porting actions apply as soon as enrichment runs.The social footprint check is a second, separate add-on. When phone_social_enabled is true, each completed phone verification also reports which online platforms the number is registered on - messaging, social media, e-commerce and professional services - and is billed $0.05 per request. It can be enabled with or without phone_enrichment_enabled: the two add-ons are priced and billed independently. A lookup that finds the number on none of the platforms it covers is a valid, billable answer and triggers phone_no_social_presence_action. Use phone.social_profiles_registered (the number of platforms the number is registered on) to branch on the result in a workflow graph.

Email Verification

Feature value: EMAIL_VERIFICATION.

Config field	Type	Description
`email_code_size`	integer	OTP size, `4` to `8`.
`email_max_retries`	integer	Maximum send retries, `1` to `5`.
`email_max_check_attempts`	integer	Maximum OTP check attempts, `1` to `5`.
`email_alphanumeric_code`	boolean	Uses alphanumeric email codes.
`breached_email_action`	action	Action for breached emails.
`disposable_email_action`	action	Action for disposable emails.
`duplicated_email_action`	action	Action for duplicated emails.
`only_corporate_emails_allowed`	boolean	Rejects non-corporate email addresses.
`email_enrichment_enabled`	boolean	Enables email intelligence enrichment (deliverability, domain reputation, data-breach exposure, fraud-risk score). Charged $0.05 per verification on top of the email verification price.
`email_intelligence_score_action`	action	Action when the email fraud-risk score is at or above `email_intelligence_score_threshold`.
`email_intelligence_score_threshold`	integer	Fraud-risk score (`0`–`100`, higher is riskier) that triggers `email_intelligence_score_action`. Default `80`.
`recent_email_breach_action`	action	Action when the email appears in a recent known data breach.
`frequent_email_breach_action`	action	Action when the email appears across many known data breaches.
`email_social_enabled`	boolean	Enables the social footprint check: which email, social, professional, e-commerce and entertainment platforms the verified address is registered on. Charged $0.05 per verification on top of the email verification price, independent of `email_enrichment_enabled`.
`email_no_social_presence_action`	action	Action when the social footprint check finds the address registered on none of the platforms it covers - a common synthetic-identity signal. Default `NO_ACTION`.
`cross_org_fraud_email_action`	action	Verdict when this address was flagged as fraudulent by another organization in the network.
`status_rules`	array	Optional custom status rules.

Email intelligence enrichment is an optional add-on. When email_enrichment_enabled is true, each completed email verification is enriched with email intelligence and billed $0.05 per request in addition to the standard email verification cost. The score-based action takes effect once the enrichment score is available; the breach actions apply as soon as enrichment runs.The social footprint check is a second, separate add-on. When email_social_enabled is true, each completed email verification also reports which online platforms the address is registered on - email providers, social media, professional, e-commerce and entertainment services - and is billed $0.05 per request. It can be enabled with or without email_enrichment_enabled: the two add-ons are priced and billed independently. A lookup that finds the address on none of the platforms it covers is a valid, billable answer and triggers email_no_social_presence_action. Use email.social_profiles_registered (the number of platforms the address is registered on) to branch on the result in a workflow graph.

Database Validation

Feature value: DATABASE_VALIDATION.

Config field	Type	Description
`database_validation_countries`	object	ISO3 country code to `{ "services": ["service_id"] }`. Use service IDs from the Database Validation catalog.
`database_validation_partial_match_action`	action	Action when database validation returns a partial match.
`database_validation_no_match_action`	action	Action when database validation returns no match.
`database_validation_not_applicable_action`	action	Action when database validation cannot run because the document does not carry the identifier the configured services require (e.g. a passport without a national ID number). Defaults to `NO_ACTION`.
`database_validation_field_sources`	object	Where to read a database input that no earlier step in the graph can fill. `source` names the producer and `key` names the value inside it: a Document AI field key for `document_ai`, a questionnaire node id for `questionnaire`, and `expected_details.<field>` or `metadata.<key>` for `expected_data`. Exact-key matches against an upstream step resolve automatically and are deliberately not persisted, so renaming a Document AI field never freezes a stale mapping into the config. A malformed entry is rejected with a `400` that names its input field. Shape: `{"<db_validation_input_field>": {"source": "document_ai"\|"questionnaire"\|"expected_data", "key": "<docai field key>\|<questionnaire node id>\|expected_details.<field>\|metadata.<key>"}}`.
`status_rules`	array	Optional custom status rules.

Example:

{
  "feature": "DATABASE_VALIDATION",
  "config": {
    "database_validation_countries": {
      "BRA": {
        "services": ["SERVICE_ID_FROM_CATALOG"]
      }
    },
    "database_validation_field_sources": {
      "tax_id": {
        "source": "expected_data",
        "key": "expected_details.document_number"
      }
    },
    "database_validation_no_match_action": "REVIEW",
    "database_validation_partial_match_action": "REVIEW"
  }
}

database_validation_countries is what makes this step do anything. A DATABASE_VALIDATION feature saved without it is accepted and then runs no check at all, so always send at least one country with at least one service ID.

A service ID the step cannot run is rejected with a 400 that names it and says why, and nothing is saved. That covers an ID that is not in the catalog, an ID that belongs to another country, a service that is not available yet, and a service offered only through the standalone POST /v3/database-validation/. A service whose inputs no earlier step provides is rejected the same way, with the missing inputs listed. A service the saved workflow already carries but can no longer run is removed when you save it again. For example, this Argentina workflow reads the DNI number and gender from ID Verification and checks them against RENAPER without a selfie:

{
  "workflow_label": "Argentina DNI check",
  "features": [
    {"feature": "OCR"},
    {
      "feature": "DATABASE_VALIDATION",
      "config": {"database_validation_countries": {"ARG": {"services": ["arg_renaper_data"]}}}
    }
  ]
}

Use arg_renaper instead, after a LIVENESS step, to also match the selfie against the photo RENAPER holds. See RENAPER for its face match score and threshold.

Bank Verification

Feature value: BANK_VERIFICATION. The user verifies a bank account, and the account holder the bank reports is compared against the identity an earlier step in the workflow established. The user does it by one of two methods: bank sign-in (open_banking), where they sign in at their bank, or the account check (account_lookup), where they type the account details and the bank confirms the name on it. bank_method_order and each country’s methods choose which methods a country offers and which comes first; see Bank verification methods. The step produces evidence - a holder-name score, the comparison that produced it, reason codes - and the bank_*_action keys turn that evidence into a status. Two things decide whether the node does anything at all. bank_countries is a whitelist, so an empty map offers no bank and runs no check. And the holder needs something to be compared against: put an OCR, DATABASE_VALIDATION or QUESTIONNAIRE step in front of it, send expected_details on session creation, or map the fields yourself with bank_field_sources. With none of those, ownership can only be unknown, which is what bank_reference_identity_missing_action decides.

Bank Verification is still rolling out, so a BANK_VERIFICATION node is only accepted on an account where it has been enabled. Everywhere else the save is rejected and says so. Which route runs the step is not configured here either: it is the provider_key and fallback_to_native pair the console’s Marketplace sets for you.

Connecting an account

Config field	Type	Description
`bank_countries`	object	Which countries a user may connect a bank in. A whitelist: an empty map means the node offers nothing and runs nothing. `institutions` narrows the picker to specific institution IDs, `"all"` offers every identity-capable bank in the country. A country no route of the node serves is kept: it offers only its fallbacks and Continue without your bank, see When the person cannot verify their bank. A code that names no country is refused on save. `methods` sets which of bank sign-in (`open_banking`) and the account check (`account_lookup`) the country offers, in order, over `bank_method_order`: the user starts on the first and is offered the second as its backup. An enabled country whose `methods` names a method no route of the node serves there is refused on save, and so is a country a route serves that `methods` leaves with none. Shape: `{"<ISO3>": {"enabled": true\|false, "institutions": ["<institution_id>", ...]\|"all", "methods"?: ["open_banking"\|"account_lookup", ...]}}`.
`bank_method_order`	string[]	Which of the two methods the step offers, and in what order, in every country that sets no `methods` of its own: `open_banking` (bank sign-in: the user signs in at their bank, and only this method reads balances, transactions and income) and `account_lookup` (the account check: no sign-in, ownership only). In each country the user starts on the first method a route serves there and is offered the other one as its backup; a method no route serves in a country is left out there. At least one method. A save that sends none gets `["open_banking", "account_lookup"]`, unless it sends `bank_open_banking_enabled` or `bank_account_lookup_enabled`, which then set it.
`bank_scopes`	object	What the user is asked to consent to sharing. `ownership` is what the product verifies and cannot be turned off. `identifiers` unmasks the IBAN or account number; `balances`, `transactions` and `income` read real financial data, are each billed separately, and are refused on save unless your application carries the financial-data entitlement. Only bank sign-in reads data: a country that offers the account check is not refused, and a user who verifies by account check passes without the data, which the result lists in `financial_data.not_collected`. A scope that is off is never requested, so the bank never shows it on its consent screen. Defaults to `ownership` only. Shape: `{"ownership": true, "identifiers": true\|false, "balances": true\|false, "transactions": true\|false, "income": true\|false}`.
`bank_eligible_account_types`	string[]	Which account types the user may pick: `checking`, `current`, `savings`, `business` or `other`. Credit cards, loans and investment accounts are never eligible - they do not establish ownership of a payment account. Defaults to current and checking.
`bank_account_selection`	string	`user` lets the user choose which of the connected accounts is verified; `auto` takes the first eligible one.
`bank_require_oauth_only`	boolean	Offer only institutions reachable over OAuth or app-to-app, never a legacy credential-capture screen. In markets where open banking already makes OAuth the only route, this changes nothing.
`bank_max_attempts`	integer	How many bank sign-in attempts the user gets, `1` to `5`; a micro-deposit or statement upload spends one too. The account check has its own `bank_account_check_max_attempts`. Once every way to verify the user is still offered, a statement upload included, has spent its attempts without a successful connection, `bank_attempts_exhausted_action` decides.
`bank_connection_timeout_minutes`	integer	How long a started connection stays open before the attempt is abandoned, `5` to `60` minutes.
`bank_allow_skip`	boolean	Retired by `bank_continue_without_bank`: the user can always continue without a bank now. Read for one release from a save that sends no `bank_continue_without_bank`: `true` sets `from_start`, anything else `when_needed`. Every save writes it back: `true` for `from_start`, `false` for `when_needed`.

When the user cannot verify

The user can always continue without a bank, and the step never leaves them stuck. See When the person cannot verify their bank.

Config field	Type	Description
`bank_continue_without_bank`	string	When the step shows Continue without your bank. `when_needed`, the default, shows it once no method works for the user’s country or bank, when their bank cannot be reached and no other method could verify them, for example because the account check could not reach the bank either, or when they say they have no online banking. `from_start` also shows it on the first screen. It cannot be turned off. A save that sends neither this key nor `bank_allow_skip` gets `when_needed`.
`bank_statement_standalone_enabled`	boolean	With `bank_statement_enabled`, also offer the statement upload when no bank attempt happened, in any country, including one no bank sign-in or account check route serves. It is then billed on its own, as `bank_statement_upload`, at USD 0.20 per evaluated statement before your contract rate or special price: see Pricing. Sandbox sessions can test it without billing. On by default.

What continuing means for the session is bank_unsupported_action, bank_attempts_exhausted_action or bank_skipped_action, depending on why the user continued, unless an attempt evaluated before it already decided the step: see Verdict actions.

Comparing the holder

Config field	Type	Description
`bank_reference_identity`	string	Which earlier step supplies the identity the holder is compared against: `kyc` (ID Verification), `database_validation`, `expected_details` (what you sent on session creation), `questionnaire`, or `auto` to use whichever one the workflow produced. The step that actually supplied it comes back on the result as `reference_identity_source`.
`bank_field_sources`	object	Where to read a reference-identity field when no earlier step in the graph can fill it. The map’s KEY is one of `full_name`, `first_name`, `last_name`, `address`; `source` names the producer and `key` names the value inside it - a Document AI field key for `document_ai`, a questionnaire node id for `questionnaire`, and `expected_details.<field>` or `metadata.<key>` for `expected_data`. A value under `expected_details.` may only name a field the session-create payload actually carries: `address`, `country`, `date_of_birth`, `first_name`, `gender`, `id_country`, `identification_number`, `ip_address`, `last_name`, `nationality` or `poa_country`. A malformed entry is refused on save, not dropped. Shape: `{"full_name"\|"first_name"\|"last_name"\|"address": {"source": "document_ai"\|"questionnaire"\|"expected_data", "key": "<docai field key>\|<questionnaire node id>\|expected_details.<field>\|metadata.<key>"}}`.
`bank_name_match_threshold`	integer	At or above this score the holder name is a match. `50` to `100`, defaults to `85`.
`bank_partial_match_floor`	integer	Below this score the holder name is a no-match. `0` to `99`, defaults to `70`. The band between the floor and the threshold is the partial match, so the floor must be strictly below the threshold or the save is refused. An explicit `null` means “use the default” here, which is why a threshold of `50` with no floor is refused: it is checked as `50` against the default floor of `70`.
`bank_require_address_match`	boolean	Also require the holder’s address to match. A name that reached the threshold but whose address scores below it drops to a partial match. An institution that returns no address waives the requirement; a session with no address of its own to compare against does not, and lands on a partial match. Off by default.
`bank_use_provider_score`	boolean	Also read the institution’s own holder-name score, and let it decide when it is higher than Didit’s or when Didit had no holder name to score at all. A result decided that way reports `provider_only` as its match method, and a connection that returned no such score records a `provider_score_unavailable` warning. On by default.
`bank_show_match_result_to_user`	boolean	Show the ownership result to the user inside the verification flow. Off means it is recorded on the session but never shown to them.

Account check

These keys apply to the account check only. Bank sign-in keeps its close matches and its own bank_max_attempts.

Config field	Type	Description
`bank_account_check_accept_close_match`	boolean	On (the default), a name the bank scores between `bank_partial_match_floor` and `bank_name_match_threshold` is a close match: the user confirms the name the bank holds when `bank_suggest_holder_name` is on, and `bank_partial_match_action` decides. Off, that close match is a no match (`OWNER_NAME_MISMATCH`, decided by `bank_no_match_action`) and spends the attempt.
`bank_account_check_max_attempts`	integer	How many account checks the user gets, `1` to `5`, `3` when unset: how many times they can type the account details for a check the bank answers. A separate count from `bank_max_attempts`. A check refused as typed (an invalid IBAN) or one the bank could not answer spends none.

Financial data

bank_expected_currencies works with the default ownership consent alone. The other three keys read real financial data, so each one needs the matching consent scope in bank_scopes and the save is refused without it.

Config field	Type	Description
`bank_expected_currencies`	string[]	ISO 4217 currencies the account is expected to be in. Empty means any; a mismatch is reported through `bank_currency_mismatch_action`.
`bank_min_balance`	number	Minimum available balance, in the account’s own currency. Below it, `bank_low_balance_action` fires. Needs the `balances` scope. `0` is a real cutoff and not the same as leaving the key out: an overdrawn account triggers the action. That action defaults to `NO_ACTION`, which leaves the verdict unchanged, so rejecting an overdrawn account also requires `bank_low_balance_action: "DECLINE"`.
`bank_transactions_history_days`	integer	How far back transaction history is read, `30` to `365` days. Defaults to `90`. Needs the `transactions` scope.
`bank_refresh_enabled`	boolean	Re-fetch the account’s financial data after the step has already been decided, for as long as the bank consent lasts. Needs at least one of the `balances`, `transactions` or `income` scopes. A consent that lapses afterwards is `bank_consent_expired_action`.

What is stored

Config field	Type	Description
`bank_store_full_identifiers`	boolean	Store the account identifiers unmasked rather than masked. Needs the `identifiers` scope. Even then the unmasked form is only returned to a caller that holds the bank-verification read permission.
`bank_store_raw_owner_data`	boolean	Keep the holder details the institution returned next to the ownership evidence. Off means only the comparison itself is retained: scores, match method and reason codes.

Verdict actions

Every key here takes DECLINE, REVIEW or NO_ACTION unless it is marked restricted, and falls back to the default below when you omit it or send null. Nothing that is not positive ownership evidence approves by default, and only demonstrable evidence against the user declines.

Config field	Type	Description
`bank_no_match_action`	restricted action	Verdict when the account holder is demonstrably not the verified person - the best name score is below `bank_partial_match_floor`. Use `DECLINE` or `REVIEW`. Defaults to `DECLINE`.
`bank_partial_match_action`	action	Verdict when the holder name lands between `bank_partial_match_floor` and `bank_name_match_threshold`. Defaults to `REVIEW`, and never approves by default.
`bank_not_verifiable_action`	action	Verdict when the institution connected but returned no holder identity to compare. Defaults to `REVIEW`.
`bank_unknown_action`	action	Verdict when the evidence could not be fetched after retries - a transient failure. Defaults to `REVIEW`.
`bank_reference_identity_missing_action`	action	Verdict when no earlier step produced an identity to compare the holder against, so ownership can only be `unknown`. Defaults to `REVIEW`.
`bank_joint_account_action`	action	Verdict when the account has more than one holder. Defaults to `NO_ACTION`.
`bank_business_account_action`	action	Verdict when the institution types the holder as a business rather than a person. Defaults to `REVIEW` on a person workflow, and to `NO_ACTION` on a business (KYB) workflow where a business holder is what the session expects to find.
`bank_unsupported_action`	action	Verdict when the user continues without a bank because no method could verify their country or bank: no bank sign-in or account check route serves the country, or the bank they picked cannot be used on this step. The result then has `continued_without_bank` true and `NOT_COVERED` in its reason codes. Defaults to `REVIEW`.
`bank_skipped_action`	restricted action	Verdict when the user chose Continue without your bank while a way to verify was there. The result then has `continued_without_bank` true and `SKIPPED` in its reason codes. Use `DECLINE` or `REVIEW`. Defaults to `REVIEW`.
`bank_attempts_exhausted_action`	restricted action	Verdict when the user spent the attempts of every way to verify they are still offered, a statement upload included (`bank_max_attempts`, and `bank_account_check_max_attempts` where the country offers the account check), without a successful connection, also when they then continue without a bank. Use `DECLINE` or `REVIEW`. Defaults to `DECLINE`.
`bank_consent_expired_action`	action	Verdict when the bank consent lapses after the step was already decided. Only meaningful with `bank_refresh_enabled`. Defaults to `NO_ACTION`.
`bank_currency_mismatch_action`	action	Verdict when the account currency is not in `bank_expected_currencies`. Defaults to `NO_ACTION`.
`bank_country_mismatch_action`	action	Verdict when the institution’s country differs from the expected or document country. Defaults to `NO_ACTION`.
`bank_low_balance_action`	action	Verdict when the available balance is below `bank_min_balance`. Needs the `balances` scope. Defaults to `NO_ACTION`.
`status_rules`	array	Optional custom status rules.

More controls

These keys are optional. Each action key takes DECLINE, REVIEW or NO_ACTION.

Config field	Type	Description
`bank_abandoned_action`	action	Verdict when the step ends without a match after the person left at their bank and never came back (an attempt timed out).
`bank_account_age_action`	action	Verdict when the account is newer than `bank_account_age_days`, a common mule pattern.
`bank_account_age_days`	integer	An account whose history starts later than this many days ago counts as new, 1 to 365, defaulting to 30. Read from the transaction history, so only with the `transactions` scope.
`bank_account_lookup_enabled`	boolean	Retired: use `bank_method_order` and `bank_countries.<ISO3>.methods`. Read for one release from a save that sends no `bank_method_order`: with `bank_open_banking_enabled`, it sets the order, the account check after bank sign-in when on, left out when off or unset. Every save writes it back as whether any country offers the account check.
`bank_account_type_action`	action	Verdict when the verified account is a savings account.
`bank_address_match_threshold`	integer	At or above this score the holder’s address matches, 50 to 100, defaulting to 70. Only read with `bank_require_address_match`.
`bank_address_mismatch_action`	action	Verdict when the holder’s address differs, which turns a match into a close match. Only with `bank_require_address_match`.
`bank_auto_add_countries`	boolean	Offer every country a route of this node can serve, also the ones added after the node was saved, apart from countries `bank_countries` turns off. Off when the key is absent, so an existing node never widens on its own.
`bank_cash_flow_action`	action	Verdict when money comes in and straight back out, or many small transfers come in (pass-through cash flow). Needs the `transactions` scope.
`bank_dob_match_enabled`	boolean	Compare the holder’s date of birth, where the bank shares one, with the verified one. A mismatch never changes the ownership result: it fires `bank_dob_mismatch_action`. On by default.
`bank_dob_match_threshold`	integer	At or above this score the date of birth matches, 50 to 100, defaulting to 70. A date is the same day or not, so it scores 100 or 0.
`bank_dob_mismatch_action`	action	Verdict when the holder’s date of birth differs. Only with `bank_dob_match_enabled`.
`bank_email_match_enabled`	boolean	Compare the email on file at the bank with the session’s verified email. A mismatch fires `bank_email_mismatch_action`. Off by default.
`bank_email_match_threshold`	integer	At or above this score the email matches, 50 to 100, defaulting to 70.
`bank_email_mismatch_action`	action	Verdict when the holder’s email differs. Only with `bank_email_match_enabled`.
`bank_evidence_retention_days`	integer	Delete the bank evidence this many days after the verdict: 30, 90, 365 or 1825. Null keeps it with the session. Deleted: the holder details, the identity they were compared against, the account identifiers, the financial data and an uploaded statement; a connection still live is revoked. The verdict, scores and reason codes stay. Deleting the session deletes everything, whichever comes first.
`bank_fallback_used_action`	action	Verdict when the account was verified with micro-deposits or a statement upload.
`bank_match_any_holder`	boolean	A joint or co-owned account matches when ANY listed holder matches the person. Off: only the first holder the bank lists can. On by default.
`bank_microdeposits_enabled`	boolean	Offer micro-deposits as a fallback: two small deposits reach the account and the person enters the amounts. Offered only in a country whose route can send them, after a charged bank verification attempt in the same session. Included at no extra charge; the customer pays the route price once. Sandbox sessions can test it without billing. The holder is the name the session verified, which the person declares the account is under, so a verified account records a `holder_declared` warning. On by default.
`bank_mule_score_action`	action	Verdict when the mule score is at or above `bank_mule_score_threshold`.
`bank_mule_score_threshold`	integer	At or above this mule score, 0 to 100, `bank_mule_score_action` fires; defaults to 70. The score combines a new account, pass-through cash flow, a drained balance and many small transfers in, read from the transaction history (the `transactions` scope).
`bank_open_banking_enabled`	boolean	Retired: use `bank_method_order` and `bank_countries.<ISO3>.methods`. Read for one release from a save that sends no `bank_method_order`: with `bank_account_lookup_enabled`, it sets the order, bank sign-in when on or unset. Every save writes it back as whether any country offers bank sign-in.
`bank_phone_match_enabled`	boolean	Compare the phone on file at the bank with the session’s verified phone. A mismatch fires `bank_phone_mismatch_action`. Off by default.
`bank_phone_match_threshold`	integer	At or above this score the phone matches, 50 to 100, defaulting to 70.
`bank_phone_mismatch_action`	action	Verdict when the holder’s phone differs. Only with `bank_phone_match_enabled`.
`bank_popular_mode`	string	`auto` (the default) orders the popular banks by what people in the country connect most; `manual` shows each country’s `popular_institutions` from `bank_countries` instead, in their order.
`bank_statement_document_checks_action`	action	Verdict when an uploaded statement carries editing or tampering evidence. Defaults to `REVIEW`.
`bank_statement_enabled`	boolean	Offer a bank statement upload as a fallback: a statement from the last 3 months, checked for tampering, whose holder name is matched like a bank’s. Included at no extra charge after a charged bank verification attempt in the same session. With `bank_statement_standalone_enabled` it is also offered with no bank attempt before it, in any country, and then billed on its own. Sandbox sessions can test it without billing. Off by default.
`bank_suggest_holder_name`	boolean	On a close match, show the person the name the bank holds the account under and ask them to confirm it is theirs or to connect another account. Their answer is recorded as `holder_confirmation`; confirming ends the step on `bank_partial_match_action`. On by default.
`fallback_to_native`	boolean	Whether a marketplace connection that cannot be established falls back to Didit’s native route. Off by default: a silent fallback would spend your Didit balance on a session you expected to run on your own provider contract. A fallback connection is recorded as `credential_source = native` and billed at the native price.
`provider_key`	string	Which route runs the step. Empty (the default) is Didit’s native Bank Verification, a provider-independent product Didit routes to the regional open-banking vendor that serves the user’s country and institution, on Didit’s contracts and billing. A value names a MARKETPLACE provider whose own credentials this application has connected - the session then runs, is billed and is revoked on your provider account, and Didit charges only the marketplace platform fee. A provider that is not connected is refused on save.

Example config object, for an account where Bank Verification is enabled and the route you selected covers the country you list:

{
  "bank_method_order": ["open_banking", "account_lookup"],
  "bank_countries": {
    "ESP": { "enabled": true, "institutions": "all" }
  },
  "bank_scopes": { "ownership": true },
  "bank_eligible_account_types": ["checking", "current"],
  "bank_name_match_threshold": 85,
  "bank_partial_match_floor": 70,
  "bank_partial_match_action": "REVIEW",
  "bank_no_match_action": "DECLINE"
}

bank_countries is what makes this step do anything, and it is checked against the route the node runs on, not against a global list. A country where that route cannot establish account ownership is rejected on save and named in the error, so read the error rather than assuming the country was accepted and will be skipped at run time.

AML

Feature value: AML. For KYC person screening, use these fields:

Config field	Type	Description
`is_aml_ongoing_monitoring_enabled`	boolean	Enables ongoing AML monitoring.
`aml_score_approve_threshold`	integer	Approve threshold.
`aml_score_review_threshold`	integer	Review threshold.
`aml_match_score_threshold`	integer	Match score threshold for possible matches.
`aml_name_weight`	integer	Name weight. If any AML weight is provided, name, DOB, and country weights must sum to `100`.
`aml_dob_weight`	integer	Date of birth weight.
`aml_country_weight`	integer	Country weight.
`create_cases_on_hit`	boolean	Open a case automatically when the screening returns a hit, instead of leaving the hit to be triaged from the session. Off by default.
`case_blueprint`	uuid	Which case blueprint the automatically-created case is built from. Only meaningful with `create_cases_on_hit`; the account default is used when unset.
`status_rules`	array	Optional custom status rules.

For KYB company screening, use these fields:

Config field	Type	Description
`kyb_score_approve_threshold`	integer	Company AML approve threshold.
`kyb_score_review_threshold`	integer	Company AML review threshold.
`kyb_enable_ongoing_monitoring`	boolean	Enables KYB ongoing AML monitoring.
`kyb_company_aml_match_score_threshold`	integer	Company AML match score threshold.
`kyb_company_aml_name_weight`	integer	Company name weight. Company AML weights must sum to `100` when provided.
`kyb_company_aml_dob_weight`	integer	Incorporation date or DOB weight.
`kyb_company_aml_country_weight`	integer	Country weight.

Screening an entity a Document AI step extracted

An AML step normally reads who it screens from the OCR step (a person) or the KYB_REGISTRY step (a company). A workflow whose only extraction step is DOCUMENT_AI - non-standardised documents such as a tax certificate or an incorporation deed - has neither, so it has to say where each screening input comes from.

Config field	Type	Description
`aml_field_sources`	object	Where to read the entity this step screens. `source` names the producer and `key` names the value inside it: a Document AI field key for `document_ai`, a questionnaire node id for `questionnaire`, and `expected_details.<field>` or `metadata.<key>` for `expected_data`. The map’s KEY is one of the four screening inputs - `full_name`, `date_of_birth`, `nationality`, `document_number` - read for a company as legal name, incorporation date, country and registration number. A Document AI field already keyed as one of those four maps automatically and is deliberately not persisted, so renaming it never freezes a stale mapping. An explicit mapping wins over both the auto-map and the ID document, and one that resolves to nothing at run time leaves the input empty rather than falling back. On a business (KYB) workflow the company a `KYB_REGISTRY` step returned is authoritative: only an explicit mapping overrides one of its inputs, the auto-map is not applied on top of a registry record, and with no registry step the mapping is the whole identity. Shape: `{"full_name"\|"date_of_birth"\|"nationality"\|"document_number": {"source": "document_ai"\|"questionnaire"\|"expected_data", "key": "<docai field key>\|<questionnaire node id>\|expected_details.<field>\|metadata.<key>"}}`.
`aml_entity_type`	string	`person` or `company`. Defaults to `person` on a person (KYC) workflow and to `company` on a business (KYB) workflow. Set `company` to screen the business named in an uploaded document without a `KYB_REGISTRY` step: the provider searches company records and the match score is scored as a company.
`aml_incomplete_data_action`	action	Verdict when the screening ran on less than a full identity (name, date of birth and country). `REVIEW` is the default. `NO_ACTION` proceeds on reduced data for a workflow that knowingly holds only a name. The screening runs either way, and the partial-data log is recorded either way - this only decides what it does to the status.

Example - screening the company named in a Mexican acta constitutiva, with no ID document anywhere in the workflow:

{
  "feature": "AML",
  "config": {
    "aml_entity_type": "company",
    "aml_field_sources": {
      "full_name": { "source": "document_ai", "key": "razon_social" },
      "document_number": { "source": "document_ai", "key": "rfc" },
      "date_of_birth": { "source": "document_ai", "key": "fecha_constitucion" },
      "nationality": { "source": "document_ai", "key": "pais" }
    },
    "aml_incomplete_data_action": "REVIEW"
  }
}

With no OCR and no KYB_REGISTRY step before it, an AML step must be able to fill full_name - there is no provider search without a name. A workflow that maps nothing, or maps a Document AI key no upstream step extracts, is rejected on save rather than saved and left screening nothing. AML precision follows directly from how many identifiers you supply: a name-only screening is what produces high false-positive volume.

Device & IP Analysis

Feature value: IP_ANALYSIS.

Config field	Type	Description
`ip_mismatch_action`	action	Action when IP geolocation does not match expected data.
`ip_location_not_determined_action`	action	Verdict when no IP address identifying the end user was recorded, so the session has no IP location at all: country, city, ISP, coordinates and time zone are unavailable, and `ip_geofencing_by_country`, the document-country comparison and the VPN/data-centre checks cannot run. Defaults to `NO_ACTION`, which keeps the `IP_LOCATION_NOT_DETERMINED` warning visible on the session without changing its verdict; set `REVIEW` or `DECLINE` if an unlocated session must not pass.
`vpn_detection_action`	action	Action when VPN or proxy usage is detected.
`expected_ip_mismatch_action`	action	Action when the IP does not match the expected IP.
`duplicated_ip_action`	action	Action when the IP is reused suspiciously.
`duplicated_device_action`	action	Action when the same persistent device fingerprint is reused across sessions from different `vendor_data` values.
`recovered_device_action`	action	Action when v2 fingerprint recovery links the session to a previously seen device with high confidence after the persistent device ID changed.
`is_ip_geofencing_enabled`	boolean	Enables IP geofencing restrictions. When `false`, `ip_geofencing_by_country` is preserved but not enforced.
`ip_geofencing_by_country`	object	Per-country IP location rules keyed by ISO-3 country code: `{"USA": {"allowed": true, "states": {"California": {"allowed": false}}}}`. State/region entries override the country flag; countries not listed are allowed.
`ip_geofencing_action`	action	Action when the session IP is located in a country or state/region that is not allowed. Defaults to `DECLINE`.
`automation_detected_action`	action	Verdict when the session looks driven by automation rather than a person.
`cross_org_fraud_device_action`	action	Verdict when this device was flagged as fraudulent by another organization in the network.
`cross_org_fraud_ip_action`	action	Verdict when this IP was flagged as fraudulent by another organization in the network.
`device_app_tampered_action`	action	Verdict when the host application binary looks tampered with.
`device_blocklist_action`	action	Verdict when the device is on the organization’s block list.
`device_debugger_action`	action	Verdict when a debugger is attached to the host application.
`device_emulator_action`	action	Verdict when the device is an emulator rather than real hardware.
`device_hooking_action`	action	Verdict when runtime hooking or instrumentation is detected.
`device_integrity_missing_action`	action	Verdict when no platform device-integrity attestation was returned.
`device_rooted_action`	action	Verdict when the device is rooted or jailbroken.
`multiple_devices_action`	action	Verdict when the session was driven from more than one device.
`device_liveness_attack_history_action`	action	Action when the same device (matched on its persistent device id) was used in an earlier session of another user whose liveness capture was judged an attack (warning `DEVICE_LINKED_TO_LIVENESS_ATTACK`). Defaults to `NO_ACTION`.
`device_model_inconsistency_action`	action	Action when the same device (matched on its persistent device id) was reported as a different device model in an earlier session (warning `DEVICE_MODEL_INCONSISTENT`). Defaults to `NO_ACTION`.
`status_rules`	array	Optional custom status rules.

Example:

{
  "feature": "IP_ANALYSIS",
  "config": {
    "vpn_detection_action": "REVIEW",
    "duplicated_device_action": "REVIEW",
    "recovered_device_action": "REVIEW",
    "is_ip_geofencing_enabled": true,
    "ip_geofencing_by_country": {
      "USA": { "allowed": true, "states": { "California": { "allowed": false } } },
      "RUS": { "allowed": false, "states": null }
    },
    "ip_geofencing_action": "DECLINE"
  }
}

Use recovered_device_action separately from duplicated_device_action when you want to monitor high-confidence recovered devices before automatically declining them. This is useful during rollout because recovered-device matches are designed for fraud-ring detection but should still be calibrated against your own traffic.

Location Verification

Feature value: GEOLOCATION. Checks where the person is while they verify, from the device position or from the connection’s IP location, against allowed and blocked areas, the IP location and the document address. See Location verification for how the step behaves and its report for the decision fields. Put it after ID Verification or Proof of Address if you want the distance to a document address, because the distance is only measured when an address is on file. With geolocation_position_source unset, the distance to the IP location needs a Device & IP Analysis step in the same workflow. Every key is optional: a step with an empty config asks the device for a position accurate to 250 m, no older than 120 seconds, gives the person 3 attempts and applies no area rule. Each finding has its own action key, and an action key you leave unset takes the default of the geolocation_preset you chose, or the per-key default listed below when you chose none. An uncertain or refused location defaults to REVIEW, never DECLINE, because a denied permission or a wide radius is not evidence of fraud. An action you set explicitly always wins over the preset. A replayed challenge (LOCATION_REPLAY_DETECTED) and a failed device attestation (LOCATION_INTEGRITY_FAILED) always decline and have no action key.

Config field	Type	Description
`geolocation_position_source`	string	Where the position comes from. `device_and_ip` asks for the device position and compares it with the IP location of the connection it is submitted from (an IP-intelligence lookup when that IP is not cached yet). Unset (the default) asks for the device position too and, as before this key existed, compares it with the IP location the session’s Device & IP Analysis step observed, so there is no distance without that step and the connection is never looked up. The exception is a node that acts on a VPN, proxy or Tor finding (its own action or its preset): it looks the connection up for that finding and compares the device with it, exactly as `device_and_ip` does. `device_only` never compares with the IP location and looks the connection up only for those findings; `ip_only` never asks the person and judges the connection’s IP location instead, city level with a 50 km radius, with no accuracy, freshness or approximate-grant rule; with `geolocation_areas` a coastal city is judged inside its country unless another country is within that radius. On a node that asks the device, an attempt with no device position is judged as the refusal or failure it is: the IP location never stands in for it.
`geolocation_preset`	string	The defaults every unset action of this node takes. `licensing`: outside an area, in a blocked area, a VPN, Tor or an emulator declines, a proxy and the other findings are reviewed, and a missing device attestation stays No action. `fraud_screening`: the same, except that what Licensing declines goes to review. Null keeps the long-standing defaults. An action set explicitly always wins.
`geolocation_accuracy_mode`	string	What the device is asked for. `precise` asks the operating system for a precise position, and a person who grants only an approximate one is asked again while attempts remain and then judged by `geolocation_approximate_action`; `approximate_allowed` accepts an approximate grant without that verdict. `geolocation_max_accuracy_radius_m` applies either way. `precise` when unset.
`geolocation_max_accuracy_radius_m`	integer	The widest uncertainty radius, in metres, a device position may have and still count. From 10 to 50000 metres; 250 when unset. A wider position, or one that reports no radius, does what `geolocation_low_accuracy_behavior` says and is judged by `geolocation_low_accuracy_action`. An `ip_only` node has no device radius and never applies it.
`geolocation_max_accuracy_radius_unit`	string	The unit the console shows `geolocation_max_accuracy_radius_m` in. Display only: the stored value is always metres, no rule depends on it, and the step data only forwards it so a client can show the same unit.
`geolocation_low_accuracy_behavior`	string	What a position wider than `geolocation_max_accuracy_radius_m`, or with no radius, does: `ask_again` (the default) asks the person to try again while attempts remain; `fail` ends the step on the first one.
`geolocation_max_age_seconds`	integer	How old, in seconds, a device position may be when the server receives it. From 5 to 3600 seconds; 120 when unset. An older one is asked again while attempts remain and then judged by `geolocation_stale_fix_action`.
`geolocation_timeout_seconds`	integer	How long, in seconds, the client lets the device look for a position on each attempt; the server forwards it in the step data and enforces nothing itself. From 5 to 120 seconds; 20 when unset. An attempt that finds no position in time is submitted as `timeout`, asked again while attempts remain and then judged by `geolocation_unavailable_action`.
`geolocation_max_attempts`	integer	How many attempts the person gets on this node. From 1 to 5 attempts; 3 when unset. An attempt the person can still change (a refusal, a wide, stale or approximate position, or an area or anonymizer finding the node acts on) asks again while attempts remain, and the last one decides the step. A mocked position, or an emulator the node acts on, ends the step on the attempt that reported it.
`geolocation_allow_qr_handoff`	boolean	Offer to continue on a phone with a QR code while the step is still open (`allow_qr_handoff` in the step data, `can_handoff` on each submit answer). Native SDKs already run on the phone and never show the code. On by default.
`geolocation_allow_skip`	boolean	Let the person go on without a location at any time, from the intro or a retry screen (`skipped: true`). The skip ends the step and is judged by `geolocation_unavailable_action`, except a skip that answers a refusal on a `continue_without_location` `geolocation_refusal_path`, which is recorded as that refusal. Off by default.
`geolocation_deep_link_enabled`	boolean	Forwarded to the client as `deep_link_enabled` in the step data: offer to open the customer’s own app instead. The server applies no rule to it. Off by default.
`geolocation_refusal_path`	string	The way forward offered when location access is refused. `retry_then_handoff` (the default) asks again while attempts remain and offers a phone hand-off; `continue_without_location` lets the person go on, recording the refusal; `end_session` ends the step and the session on the first refusal, and needs `geolocation_permission_denied_action` to be Review or Decline and a workflow with a Declined, In Review or Final decision ending. The session is decided from the steps that ran and never Approved: on a workflow that cannot end on that decision it takes the other non-approving ending (Declined for In Review, In Review for Declined).
`is_geolocation_geofencing_enabled`	boolean	Turns the area rules on: `geolocation_areas`, or the older `geolocation_geofencing_by_country`, only apply while this is true, and only then does the step data list `available_areas`. Off by default. With it on, a `geolocation_areas` list needs at least one allowed area.
`geolocation_areas`	array	Allowed and blocked areas, applied while `is_geolocation_geofencing_enabled` is true. Only a position inside an allowed area passes, and a blocked area always wins over an allowed one. A position counts by its whole accuracy circle: a circle that crosses an edge that decides the answer is undetermined, never outside. A country or region ends where other land begins, never at its coastline, and a position the outlines place on no land (a seafront or pier the simplified coastline cut away) is undetermined for every country or region within its radius plus 12 nautical miles. `id` is what branch rules and `geolocation.inside_areas` / `geolocation.blocked_areas` name; `kind` picks the shape: a whole `country` (ISO 3166-1 alpha-3 with a published outline: a territory the outlines draw as another country’s region is that `region`, such as Reunion as France’s `FR-RE` or Bonaire, Sint Eustatius and Saba as `NL-BQ1` to `NL-BQ3`), `region` (ISO 3166-2 codes of one country with published boundaries), `circle` (1 to 500 km) or `polygon` (3 to 200 points, a ring whose edges never cross or touch each other). At most 50 areas, ids unique, and at least one allowed area while geofencing is on. Cannot be combined with `geolocation_geofencing_by_country`.
`geolocation_geofencing_by_country`	object	Country and region allow/deny rules for the device’s own position, applied only while `is_geolocation_geofencing_enabled` is true. Same shape as IP Analysis’s `ip_geofencing_by_country`, except that `states` keys are ISO 3166-2 codes (`US-NJ`), not state names, because the position is resolved to a subdivision rather than to a provider’s city label. A country that is not listed is allowed. Saving a region rule for a country with no published ISO 3166-2 boundaries is rejected rather than silently ignored.
`geolocation_ip_distance_km`	integer	How far apart, in kilometres, the device position and the IP location may be, after both uncertainty radii are subtracted, before `geolocation_ip_distance_action` applies. 200 when the key is omitted; null switches the comparison off. Only a node whose `geolocation_position_source` is `device_and_ip` or unset compares; that key says which IP location it compares with.
`geolocation_ip_distance_unit`	string	The unit the console shows `geolocation_ip_distance_km` in. Display only: the stored value is always kilometres and no rule depends on it.
`geolocation_document_distance_km`	integer	How far, in kilometres, the position (the IP location on an `ip_only` node) may be from the address `geolocation_document_distance_basis` names before `geolocation_document_distance_action` applies. Unset or null (the default) is off.
`geolocation_document_distance_unit`	string	The unit the console shows `geolocation_document_distance_km` in. Display only: the stored value is always kilometres and no rule depends on it.
`geolocation_document_distance_basis`	string	Which address `geolocation_document_distance_km` is measured from: `document` (the default: the identity document’s address, then the proof of address), `proof_of_address` only, or `declared` (the `expected_details.address` given at session creation, geocoded).
`geolocation_travel_tolerance_enabled`	boolean	Excuse the distance from the address when the same person (same `vendor_data`) was seen within `geolocation_travel_usual_area_km` of it in the last `geolocation_travel_max_days` days. Never excuses a VPN, a spoofed position, a blocked area or being outside the allowed areas. Only a position the device measured counts as being seen there: a mocked or simulated fix, an emulator or a failed attestation never does.
`geolocation_travel_usual_area_km`	integer	Radius around the address that counts as the person’s usual area. From 10 to 500 km; 100 when unset.
`geolocation_travel_max_days`	integer	How long after being seen in the usual area a distant position is still travel. From 1 to 90 days; 14 when unset.
`geolocation_consecutive_mismatch_count`	integer	Raise LOCATION_CONSECUTIVE_MISMATCHES when this check and the same person’s previous checks (same `vendor_data`) were outside the allowed areas, in a blocked area or too far from the address this many times in a row. A check that compared nothing neither extends nor breaks the streak, and neither does a position the device did not measure (a mocked or simulated fix, an emulator, a failed attestation). From 2 to 10; null (the default) is off.
`geolocation_approximate_action`	action	Verdict when the user granted an approximate location while `geolocation_accuracy_mode` asks for a precise one. Defaults to `REVIEW`.
`geolocation_blocked_area_action`	action	Verdict when the position, and its whole accuracy circle, falls inside a blocked area of `geolocation_areas`. Defaults to Decline.
`geolocation_consecutive_mismatch_action`	action	Verdict when `geolocation_consecutive_mismatch_count` mismatches in a row are reached. Defaults to Review.
`geolocation_document_distance_action`	action	Verdict when the device position is further from the document address than `geolocation_document_distance_km`. The address is geocoded coarsely, so this is a weak signal. Defaults to `REVIEW`.
`geolocation_emulator_action`	action	Verdict when the app that shared the location reported running on an emulator. Browsers cannot report it. Unless it is No action, it ends the step on that attempt: checking again cannot change the device. No action unless set or a preset says otherwise.
`geolocation_geofence_undetermined_action`	action	Verdict when the position cannot be placed inside or outside the fence because its accuracy circle reaches the boundary. Uncertainty is never reported as being outside. Defaults to `REVIEW`.
`geolocation_geofencing_action`	action	Verdict when the device position, and its whole uncertainty circle, falls outside `geolocation_geofencing_by_country`. Defaults to `DECLINE`.
`geolocation_integrity_missing_action`	action	Verdict when a native client submitted a position with no device-attestation token. Defaults to No action; web clients are recorded as unsupported rather than missing, because no browser can attest.
`geolocation_ip_distance_action`	action	Verdict when the device position and the session’s IP location are further apart than `geolocation_ip_distance_km`, after both uncertainty radii are subtracted. Defaults to `REVIEW`.
`geolocation_low_accuracy_action`	action	Verdict when no attempt established the required precision: the best position has an uncertainty radius wider than `geolocation_max_accuracy_radius_m`, or it reported no radius at all. A position without a radius is never counted as meeting the limit. Defaults to `REVIEW`.
`geolocation_mock_location_action`	action	Verdict when the operating system reported the position as simulated rather than measured (Android mock provider, iOS simulated-by-software). Defaults to `REVIEW`.
`geolocation_permission_denied_action`	action	Verdict when the user declined or dismissed the location prompt on every allowed attempt. Defaults to Review: a refusal is a choice, not a fraud signal.
`geolocation_proxy_action`	action	Verdict when the connection that shared the location goes through an open, anonymous or private-relay proxy. No action unless set or a preset says otherwise.
`geolocation_stale_fix_action`	action	Verdict when the position was measured more than `geolocation_max_age_seconds` before the server received it. Defaults to `REVIEW`.
`geolocation_tor_action`	action	Verdict when the connection that shared the location is a Tor exit node. No action unless set or a preset says otherwise.
`geolocation_unavailable_action`	action	Verdict when no position could be obtained - location services off or restricted, the positioning system returned nothing, the attempt timed out, the user skipped the step, or the client is too old to support it. Defaults to `REVIEW`.
`geolocation_vpn_action`	action	Verdict when the connection that shared the location is a commercial VPN. Unless it is No action, the person is asked to turn it off and check again while attempts remain. No action unless set or a preset says otherwise.
`status_rules`	array	Optional custom status rules. You can target the `geolocation.*` fields listed in Location verification report.

Area shapes

Each item of geolocation_areas has an id (1 to 64 characters of A-Z a-z 0-9 _ -, unique in the list), an optional label (up to 80 characters), a type of allowed or blocked, and a kind that picks the shape.

`kind`	Extra fields	Meaning
`country`	`country` (ISO 3166-1 alpha-3)	A whole country that has a published outline.
`region`	`country`, `regions` (ISO 3166-2 codes of that country)	One or more subdivisions of one country with published boundaries.
`circle`	`center` (`latitude`, `longitude`), `radius_km` (1 to 500)	Every point within the radius of the centre.
`polygon`	`points` (3 to 200 items of `latitude`, `longitude`)	A closed ring whose edges never cross or touch each other.

A list holds at most 50 areas and needs at least one allowed area while is_geolocation_geofencing_enabled is true. geolocation_areas and geolocation_geofencing_by_country cannot be sent together, and geolocation_refusal_path: "end_session" needs geolocation_permission_denied_action to be REVIEW or DECLINE. The API refuses an area that could never match, such as a region of a country without published boundaries, instead of saving it. Example:

{
  "feature": "GEOLOCATION",
  "config": {
    "geolocation_position_source": "device_and_ip",
    "geolocation_preset": "licensing",
    "geolocation_max_accuracy_radius_m": 250,
    "geolocation_max_attempts": 3,
    "is_geolocation_geofencing_enabled": true,
    "geolocation_areas": [
      { "id": "spain", "label": "Spain", "type": "allowed", "kind": "country", "country": "ESP" },
      { "id": "ceuta-melilla", "type": "blocked", "kind": "region", "country": "ESP", "regions": ["ES-CE", "ES-ML"] }
    ],
    "geolocation_ip_distance_km": 200,
    "geolocation_ip_distance_action": "REVIEW",
    "geolocation_vpn_action": "DECLINE"
  }
}

Proof of Address

Feature value: PROOF_OF_ADDRESS.

Config field	Type	Description
`poa_documents_allowed`	object	ISO3 country code to POA document type config. At least one valid document type should be enabled.
`poa_languages_allowed`	object	ISO 639-1 language code to `0` or `1`. At least one language should be enabled.
`poa_name_or_address_mismatch_action`	action	Action when the name or address does not match expected data.
`poa_document_issues_action`	action	Action when the document has quality or extraction issues.
`poa_max_attempts_exceeded_action`	restricted action	Action when the user exceeds retry attempts. Use `DECLINE` or `REVIEW`.
`poa_document_authenticity_action`	restricted action	Action when authenticity checks fail. Use `DECLINE` or `REVIEW`.
`poa_document_unproven_text_replacement_action`	action	Action when a text field was blanked and re-typed in another font and the file holds no proof of whether its content changed (`POA_DOCUMENT_UNPROVEN_TEXT_REPLACEMENT`).
`poa_unsupported_document_type_action`	action	Action when the document type is unsupported.
`poa_unsupported_language_action`	action	Action when the document language is unsupported.
`poa_issuer_not_identified_action`	action	Action when the document issuer is not identified.
`poa_issue_date_not_detected_action`	action	Action when the issue date is missing.
`poa_unparsable_or_invalid_address_action`	action	Action when the address is invalid or cannot be parsed.
`address_validation_enabled`	boolean	Validates the address this step reads (printed on the proof of address; only an upload that passed the document checks is validated) against postal reference data: it confirms the address exists and normalises it, and never links it to a person. The result is the step’s `address_validation` object in the decision. Charged $0.10 per validated address; a validation that could not run (`unavailable`) is free. Off by default.
`address_not_verified_action`	action	Action when Address Validation could not confirm the address to the building (`ADDRESS_NOT_VERIFIED`: `partially_verified` or `not_verified`). Applies only while `address_validation_enabled` is on. Defaults to `NO_ACTION`, which only records the warning.
`poa_name_match_score_threshold`	integer	Name match threshold.
`poa_max_retry_attempts`	integer	Retry limit, `2` to `5`.
`status_rules`	array	Optional custom status rules.

Questionnaire

Feature value: QUESTIONNAIRE.

Config field	Type	Description
`questionnaire_uuid`	UUID	Required. Use the `questionnaire_id` returned by `POST /v3/questionnaires/`.
`review_questionnaire_manually`	boolean	Sends questionnaire responses to manual review.
`status_rules`	array	Optional custom status rules. You can target `questionnaire.answers.<question_id>` fields.

KYB Registry

Feature value: KYB_REGISTRY.

Config field	Type	Description
`kyb_accepted_countries`	object	Legacy ISO3 country allow-list for business registry lookup. Superseded by `kyb_registry_countries_config`; still readable, still derived from it for existing workflows, but no longer the way to configure new ones.
`kyb_manual_company_action`	action	Action when the company requires manual handling.
`kyb_registry_fields_config`	object	Per-field visibility and requiredness for the registry form in the hosted flow. See below.
`kyb_registry_countries_config`	object	Per-country registry routing, as `{"<ISO2>": {"enabled": bool, "tier": "basic" \| "shareholders" \| "ubo"}}`. Each enabled country picks the data tier charged when a company is selected (`basic` is the Lite tier), and only tiers the pricing endpoint marks available for that country can be enabled. At least one country must be enabled: a registry check that searches nowhere is rejected. Manually entered companies are billed separately and do not use this configuration.
`kyb_registry_monitoring_enabled`	boolean	Keep the company’s registry record under continuous monitoring after a Shareholders or UBO result: a change of status, officers, ownership, or address moves the session back to review and fires a webhook. Available only where the registry provider offers monitoring. USD 2.00 per company per year, cancellable at any time. Off by default.
`kyb_vat_invalid_action`	action	Action when the company’s VAT number fails EU VIES validation. Defaults to `REVIEW`.
`kyb_vat_unverified_action`	action	Action when the VAT number could not be validated because VIES was unavailable. Defaults to `NO_ACTION`.
`status_rules`	array	Optional custom status rules.

kyb_registry_fields_config maps each configurable field key to {"enabled": bool, "required": bool}. enabled: false hides the field, enabled: true, required: false shows it as optional, and enabled: true, required: true makes it mandatory at submit. company_name, country_code, and region are always shown and required and cannot be configured. When the object is omitted, null, or {}, the default applies: only incorporation_date is required and every other field is optional.

{
  "kyb_registry_fields_config": {
    "registration_number": { "enabled": true, "required": true },
    "incorporation_date": { "enabled": true, "required": true },
    "vat_number": { "enabled": true, "required": false },
    "control_scheme": { "enabled": false, "required": false }
  }
}

Configurable field keys: registration_number, incorporation_date, legal_address, vat_number, alternative_names, tax_number, company_type, legal_entity_identifier, location_of_registration, nature_of_business, registered_capital_amount, registered_capital_currency, website, email, phone, control_scheme. See configurable registry form fields for the end-user behavior and VAT and tax ID validation for how vat_number and tax_number are checked.

KYB Documents

Feature value: KYB_DOCUMENTS.

Config field	Type	Description
`kyb_required_document_groups`	object or array	Required. Required KYB document groups.
`kyb_document_subtype_config`	object	Per-document subtype enablement and age configuration.
`kyb_document_tampering_action`	restricted action	Action when tampering is detected. Use `DECLINE` or `REVIEW`.
`kyb_document_unproven_text_replacement_action`	action	Action when a text field of a company document was blanked and re-typed in another font and the file holds no proof of whether its content changed (`KYB_DOCUMENT_UNPROVEN_TEXT_REPLACEMENT`).
`kyb_document_critical_mismatch_action`	restricted action	Action for critical document mismatches. Use `DECLINE` or `REVIEW`.
`kyb_document_non_critical_mismatch_action`	action	Action for non-critical document mismatches.
`kyb_document_age_action`	action	Action when document age rules fail.
`kyb_document_max_retry_attempts`	integer	Retry limit for KYB documents.
`kyb_document_max_attempts_exceeded_action`	restricted action	Action when max attempts are exceeded. Use `DECLINE` or `REVIEW`.
`status_rules`	array	Optional custom status rules.

KYB Key People

Feature value: KYB_KEY_PEOPLE.

Config field	Type	Description
`kyb_ubo_ownership_threshold`	integer	UBO ownership threshold, `0` to `100`.
`kyb_shareholder_ownership_threshold`	integer	Shareholder ownership threshold, `0` to `100`. It cannot be higher than `kyb_ubo_ownership_threshold`.
`kyb_key_people_ownership_required`	boolean	Requires an ownership percentage on every submitted key person. Enforced at submission and surfaced to the hosted UI, which marks the field as required. Default `false`.
`kyb_require_ubo_kyc`	boolean	Requires UBOs to complete a person verification workflow.
`kyb_ubo_verification_workflow`	UUID	Required when `kyb_require_ubo_kyc` is `true`. Must reference a non-KYB workflow in the same application.
`kyb_require_officer_kyc`	boolean	Requires officers to complete person verification.
`kyb_shareholder_verification_workflow`	UUID	Person verification workflow for shareholders.
`kyb_officer_verification_workflow`	UUID	Person verification workflow for officers.
`kyb_require_corporate_ubo_kyb`	boolean	Requires corporate UBOs to complete KYB.
`kyb_corporate_ubo_verification_workflow`	UUID	Required when `kyb_require_corporate_ubo_kyb` is `true`. Must reference a KYB workflow in the same application.
`kyb_reject_if_ubo_rejected`	boolean	Rejects the business when a required UBO verification is rejected.
`kyb_wait_for_all_ubos`	boolean	Waits for all required UBO verifications before deciding the KYB session.
`kyb_role_config`	object or array	Per-role configuration. Each required KYC role must include a `verification_workflow`.
`kyb_reuse_verified_individuals`	boolean	Reuses already verified individuals when possible.
`kyb_notify_parties_by_email`	boolean	Sends email notifications to invited key people.
`kyb_key_people_company_fields`	object	Which company details are collected for a CORPORATE key person. Same list-of-descriptors shape and same rules as `kyb_key_people_person_fields`. Shape: `[{"key": "<field key>", "label": "<label>", "type": "text"\|"number"\|"date"\|"phone"\|"email", "required": true\|false, "custom": true\|false}]`.
`kyb_key_people_document_mismatch_action`	action	Verdict when a key person’s document disagrees with the details declared for them.
`kyb_key_people_person_fields`	object	Which personal details are collected for an individual key person, as an ORDERED LIST of field descriptors (not a map). `key` is required and non-empty; `type` must be one of text, number, date, phone or email; `custom` marks a field the customer added rather than one of the built-ins. Shape: `[{"key": "<field key>", "label": "<label>", "type": "text"\|"number"\|"date"\|"phone"\|"email", "required": true\|false, "custom": true\|false}]`.
`kyb_key_people_prefill_from_registry`	boolean	Pre-fill the key-people list from the company registry result, so the customer confirms and corrects rather than typing every officer and shareholder in.
`status_rules`	array	Optional custom status rules.

Document AI

Feature value: DOCUMENT_AI. Requests one or more documents from the user and extracts the named fields you define with a vision model. Each configured field becomes a branchable value document_ai.<key>, and the step’s outcome is document_ai.status.

Config field	Type	Description
`document_ai_documents`	array	Required. The documents to request (at most `3`). Each entry is a document object (see below).
`document_ai_unreadable_document_action`	action	Action when the document cannot be read or no data can be extracted.
`document_ai_missing_required_fields_action`	action	Action when a required field cannot be extracted.
`document_ai_document_tampering_action`	restricted action	Action when the document shows signs of manipulation. Use `DECLINE` or `REVIEW`.
`document_ai_name_mismatch_action`	action	Action when the extracted full name does not match the verified identity. Requires a field marked with `is_full_name`.
`document_ai_unsupported_file_action`	action	Action when the uploaded file type is not supported.
`document_ai_max_attempts_exceeded_action`	restricted action	Action when the user exceeds the retry attempts. Use `DECLINE` or `REVIEW`.
`document_ai_name_match_score_threshold`	integer	Minimum score (`0`–`100`) for the extracted full name to match the verified identity. Below it, `document_ai_name_mismatch_action` applies.
`document_ai_max_retry_attempts`	integer	Retry limit, `2` to `5`.
`status_rules`	array	Optional custom status rules. You can target `document_ai.<key>` fields.

Each entry in document_ai_documents is a document:

Document field	Type	Description
`document_key`	string	Required. Stable identifier for the document, unique within the step.
`title`	string	Required. Title shown to the user.
`description`	string	Required. Instructions shown to the user about what to upload.
`title_i18n`	object	Optional. Locale code to translated title (e.g. `{ "es": "Comprobante de fondos" }`).
`description_i18n`	object	Optional. Locale code to translated description.
`fields`	array	Required. The fields to extract (at least one). Field keys must be unique within the document.

Each entry in a document’s fields is a field:

Field	Type	Description
`key`	string	Required. Stable JSON key for the extracted value, unique within the document. Branch on it as `document_ai.<key>`.
`name`	string	Required. Human-readable field label.
`name_i18n`	object	Optional. Locale code to translated field name.
`instruction`	string	Optional. Instruction telling the model exactly what to extract for this field.
`type`	string	Field type: `text`, `number`, or `date`. Defaults to `text`.
`required`	boolean	Whether the field must be present. Defaults to `false`. When `true` and the value is missing, `document_ai_missing_required_fields_action` applies.
`is_full_name`	boolean	Optional, defaults to `false`. Marks the field whose value is the document holder’s full name, compared against the verified identity (the ID-verification name, or the session’s expected details). At most one field per document may set it `true`, and it is not mandatory — a document may mark none, in which case no name comparison runs for that document. Only `text` fields can be the full name.

Example:

{
  "feature": "DOCUMENT_AI",
  "config": {
    "document_ai_documents": [
      {
        "document_key": "proof_of_funds",
        "title": "Proof of Funds",
        "description": "Upload a recent bank statement.",
        "title_i18n": { "es": "Comprobante de fondos" },
        "fields": [
          {
            "key": "account_holder",
            "name": "Account holder",
            "instruction": "The full name of the account holder as printed on the statement.",
            "type": "text",
            "required": true,
            "is_full_name": true
          },
          {
            "key": "closing_balance",
            "name": "Closing balance",
            "instruction": "The closing balance amount.",
            "type": "number",
            "required": false
          }
        ]
      }
    ],
    "document_ai_missing_required_fields_action": "REVIEW",
    "document_ai_name_mismatch_action": "REVIEW",
    "document_ai_name_match_score_threshold": 80
  }
}

E-signature

Feature value: SIGNATURE. Has the verified person, or a company’s key people, sign documents, at the Simple level (default) or Advanced (AES). Put it after the steps that verify the signer: ID Verification, and Email or Phone Verification for the code. See E-signature.

Config field	Type	Description
`signature_documents`	array	The documents uploaded to this workflow in the console, in the order the signer sees them, as `[{"uuid", "title", "file_name", "pages", "size_bytes"}]`. Only the `uuid` values and their order are read; the rest comes from the stored files. Up to 20 documents and 50 MB in total. Default `[]`.
`signature_documents_source`	string	Where the documents come from: `workflow` (default), `session` (`sign.documents` on create session) or `both` (workflow documents first).
`signature_require_read_to_end`	boolean	The signer must reach the end of each document without fields before agreeing to it. Default `true`.
`signature_consent_per_document`	boolean	The signer agrees to each document without fields separately. For documents with fields, the guided fields and the final consent replace it. Default `true`.
`signature_signer`	string	Who signs: `verified_person` (default, KYC), or for KYB `legal_representative` (key people with the role `representative` or `authorized_signatory`) or `key_people` (every individual key person with a KYC session).
`signature_level`	string	`simple` (default): no ID verification, email, phone or code, the signer types their name and signs on the session link. `aes`: needs an approved ID verification and a verified email or phone, and a one-time code. `simple` is refused for `legal_representative` and `key_people` signers with `signature_simple_requires_verified_person`. While `signature_availability.aes` is `false` on the workflow, saving a new `aes` step returns `400` with `aes_not_available`. `qes` is coming soon: saving it returns `400` with `qes_not_available`.
`signature_format`	string	`pades` (default). `xades` and `cades` are refused for AES with `signature_format_not_supported`.
`signature_otp_channel`	string	Where the one-time code goes: `email` (default) or `sms`. It’s sent only to a contact verified earlier in the session.
`signature_email_signed_copy`	boolean	Email the signer a copy of the signed documents. Needs a verified email. Default `true`.
`signature_evidence_page`	boolean	Append the evidence page to each signed PDF. Default `true`.
`signature_link_validity_days`	integer	How long the signing link stays valid, `1` to `30` days from session creation. Default `7`.
`signature_declined_action`	action	Verdict when the signer declines. Nothing is charged. Default `REVIEW`.
`signature_otp_failed_action`	action	Verdict after 3 wrong codes or more than 5 codes asked for. Default `DECLINE`.
`signature_name_mismatch_action`	action	Verdict when a key person’s declared name doesn’t match their verified name. Default `DECLINE`.
`signature_identity_not_verified_action`	action	Verdict when the signer has no approved identity evidence. Default `DECLINE`.
`signature_document_changed_action`	action	Verdict when a document no longer matches the SHA-256 recorded when it was shown. Default `DECLINE`.
`status_rules`	array	Optional custom status rules. You can target `signature.status`, `signature.level` and `signature.format`.

Fields on a workflow document are placed in the console’s template editor. For session documents, send them in sign.documents[].fields, and send the values of api.<key> fields in sign.field_values. See Create session. Example, for documents sent with each session:

{
  "feature": "SIGNATURE",
  "config": {
    "signature_documents_source": "session",
    "signature_signer": "verified_person",
    "signature_level": "aes",
    "signature_otp_channel": "email",
    "signature_link_validity_days": 14,
    "signature_declined_action": "REVIEW"
  }
}

​Validation rules

​Common status rules

​Compare against a specific step

​OCR / ID Verification

​Methods per country

​NFC / ePassport

​Liveness

​Face Match

​Age Estimation

​Phone Verification

​Email Verification

​Database Validation

​Bank Verification

​Connecting an account

​When the user cannot verify

​Comparing the holder

​Account check

​Financial data

​What is stored

​Verdict actions

​More controls

​AML

​Screening an entity a Document AI step extracted

​Device & IP Analysis

​Location Verification

​Area shapes

​Proof of Address

​Questionnaire

​KYB Registry

​KYB Documents

​KYB Key People

​Document AI

​E-signature

Validation rules

Common status rules

Compare against a specific step

OCR / ID Verification

Methods per country

NFC / ePassport

Liveness

Face Match

Age Estimation

Phone Verification

Email Verification

Database Validation

Bank Verification

Connecting an account

When the user cannot verify

Comparing the holder

Account check

Financial data

What is stored

Verdict actions

More controls

AML

Screening an entity a Document AI step extracted

Device & IP Analysis

Location Verification

Area shapes

Proof of Address

Questionnaire

KYB Registry

KYB Documents

KYB Key People

Document AI

E-signature