@didit-protocol/mcp-server 5.1.36 → 5.1.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. package/README.md +131 -29
  2. package/dist/app-api-key.d.ts +5 -0
  3. package/dist/app-api-key.d.ts.map +1 -0
  4. package/dist/app-api-key.js +108 -0
  5. package/dist/app-api-key.js.map +1 -0
  6. package/dist/auth/cached-verifier.d.ts +38 -0
  7. package/dist/auth/cached-verifier.d.ts.map +1 -0
  8. package/dist/auth/cached-verifier.js +82 -0
  9. package/dist/auth/cached-verifier.js.map +1 -0
  10. package/dist/auth/introspection-verifier.d.ts +12 -0
  11. package/dist/auth/introspection-verifier.d.ts.map +1 -1
  12. package/dist/auth/introspection-verifier.js +40 -14
  13. package/dist/auth/introspection-verifier.js.map +1 -1
  14. package/dist/chatgpt-app.d.ts +1 -0
  15. package/dist/chatgpt-app.d.ts.map +1 -1
  16. package/dist/chatgpt-app.js +2 -0
  17. package/dist/chatgpt-app.js.map +1 -1
  18. package/dist/config.d.ts +8 -3
  19. package/dist/config.d.ts.map +1 -1
  20. package/dist/config.js +24 -7
  21. package/dist/config.js.map +1 -1
  22. package/dist/http.d.ts.map +1 -1
  23. package/dist/http.js +43 -1
  24. package/dist/http.js.map +1 -1
  25. package/dist/index.d.ts.map +1 -1
  26. package/dist/index.js +294 -33
  27. package/dist/index.js.map +1 -1
  28. package/dist/investigator-agent.d.ts +4 -0
  29. package/dist/investigator-agent.d.ts.map +1 -0
  30. package/dist/investigator-agent.js +10 -0
  31. package/dist/investigator-agent.js.map +1 -0
  32. package/dist/permissions.d.ts.map +1 -1
  33. package/dist/permissions.js +18 -3
  34. package/dist/permissions.js.map +1 -1
  35. package/dist/schema/feature-config-schema.json +941 -28
  36. package/dist/security.js +2 -2
  37. package/dist/security.js.map +1 -1
  38. package/dist/signature-download.d.ts +31 -0
  39. package/dist/signature-download.d.ts.map +1 -0
  40. package/dist/signature-download.js +122 -0
  41. package/dist/signature-download.js.map +1 -0
  42. package/dist/tools/billing.d.ts +1 -0
  43. package/dist/tools/billing.d.ts.map +1 -1
  44. package/dist/tools/billing.js +5 -3
  45. package/dist/tools/billing.js.map +1 -1
  46. package/dist/tools/compliance.d.ts.map +1 -1
  47. package/dist/tools/compliance.js +37 -0
  48. package/dist/tools/compliance.js.map +1 -1
  49. package/dist/tools/investigator.d.ts +19 -0
  50. package/dist/tools/investigator.d.ts.map +1 -0
  51. package/dist/tools/investigator.js +449 -0
  52. package/dist/tools/investigator.js.map +1 -0
  53. package/dist/tools/observability.d.ts +6 -0
  54. package/dist/tools/observability.d.ts.map +1 -1
  55. package/dist/tools/observability.js +11 -3
  56. package/dist/tools/observability.js.map +1 -1
  57. package/dist/tools/search.d.ts.map +1 -1
  58. package/dist/tools/search.js +89 -5
  59. package/dist/tools/search.js.map +1 -1
  60. package/dist/tools/session-explain-levers.d.ts +6 -0
  61. package/dist/tools/session-explain-levers.d.ts.map +1 -1
  62. package/dist/tools/session-explain-levers.js +40 -7
  63. package/dist/tools/session-explain-levers.js.map +1 -1
  64. package/dist/tools/sessions.d.ts +18 -0
  65. package/dist/tools/sessions.d.ts.map +1 -1
  66. package/dist/tools/sessions.js +155 -2
  67. package/dist/tools/sessions.js.map +1 -1
  68. package/dist/tools/standalone.d.ts +5 -0
  69. package/dist/tools/standalone.d.ts.map +1 -1
  70. package/dist/tools/standalone.js +18 -2
  71. package/dist/tools/standalone.js.map +1 -1
  72. package/package.json +1 -1
@@ -1,5 +1,5 @@
1
1
  {
2
- "checksum": "sha256:a2c413a50107faf3ea47fa187089a930ac17d3d04893e24176f494a58470e982",
2
+ "checksum": "sha256:b5ff2371c2a41779d8421cf1333fd50706cb78f9eaa320656b0c30bdb7875226",
3
3
  "features": {
4
4
  "AGE_ESTIMATION": {
5
5
  "description": "Configuration for Age Estimation feature.",
@@ -40,6 +40,17 @@
40
40
  "required": false,
41
41
  "type": "boolean"
42
42
  },
43
+ "face_liveness_attack_face_match_action": {
44
+ "description": "Verdict when the liveness face matches (above the duplicate-face similarity bar) a face from an earlier session of this application whose own capture the liveness engine judged an attack (risk FACE_MATCHES_LIVENESS_ATTACK), another user's session only and only a confident attack verdict. Review or no action only - a decline set here is downgraded to review, because a genuine user can be rejected once by mistake and then pass. Defaults to NO_ACTION (evidence is recorded, the verdict is unchanged).",
45
+ "enum": [
46
+ "DECLINE",
47
+ "REVIEW",
48
+ "NO_ACTION"
49
+ ],
50
+ "nullable": true,
51
+ "required": false,
52
+ "type": "string"
53
+ },
43
54
  "face_liveness_duplicated_face_document_mismatch_action": {
44
55
  "description": "Verdict when a duplicate face is found on a user verified with a different date of birth. Another document of the same person (a passport after an identity card, a renewal, a document of a second country) is not flagged.",
45
56
  "enum": [
@@ -336,7 +347,7 @@
336
347
  "type": "string"
337
348
  },
338
349
  "aml_field_sources": {
339
- "description": "Where this node reads the entity it screens, when the workflow has no ID Verification or KYB Registry step to supply it - a Document AI workflow over non-standardised documents (a tax certificate, an acta constitutiva). Same contract as `database_validation_field_sources`: `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 AML 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 a mapping that resolves to nothing at runtime leaves the input empty rather than falling back. With no ID Verification and no KYB Registry upstream, `full_name` must be fillable or the graph is rejected on save: there is no search without a name.",
350
+ "description": "Where this node reads the entity it screens, when the workflow has no ID Verification or KYB Registry step to supply it - a Document AI workflow over non-standardised documents (a tax certificate, an acta constitutiva). Same contract as `database_validation_field_sources`: `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 AML 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 a mapping that resolves to nothing at runtime leaves that input empty rather than falling back. The screened name is the exception on a person node: when the ID Verification step already named the person, that name stands in rather than leaving the node with no search to run. With no ID Verification and no KYB Registry upstream, `full_name` must be fillable or the graph is rejected on save: there is no search without a name.",
340
351
  "example": {
341
352
  "full_name": {
342
353
  "key": "razon_social",
@@ -540,6 +551,56 @@
540
551
  "BANK_VERIFICATION": {
541
552
  "description": "Configuration for Bank Verification feature.",
542
553
  "fields": {
554
+ "bank_abandoned_action": {
555
+ "description": "Verdict when the step ends without a match after the person left at their bank and never came back (an attempt timed out).",
556
+ "enum": [
557
+ "DECLINE",
558
+ "REVIEW",
559
+ "NO_ACTION"
560
+ ],
561
+ "nullable": true,
562
+ "required": false,
563
+ "type": "string"
564
+ },
565
+ "bank_account_age_action": {
566
+ "description": "Verdict when the account is newer than `bank_account_age_days`, a common mule pattern.",
567
+ "enum": [
568
+ "DECLINE",
569
+ "REVIEW",
570
+ "NO_ACTION"
571
+ ],
572
+ "nullable": true,
573
+ "required": false,
574
+ "type": "string"
575
+ },
576
+ "bank_account_age_days": {
577
+ "description": "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.",
578
+ "maximum": 365,
579
+ "minimum": 1,
580
+ "nullable": true,
581
+ "required": false,
582
+ "type": "integer"
583
+ },
584
+ "bank_account_check_accept_close_match": {
585
+ "description": "Account check only. On (the default), a name the bank scores between `bank_partial_match_floor` and `bank_name_match_threshold` is a close match: the person 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 sign-in keeps its close matches either way.",
586
+ "nullable": true,
587
+ "required": false,
588
+ "type": "boolean"
589
+ },
590
+ "bank_account_check_max_attempts": {
591
+ "description": "How many account checks the user gets, 1 to 5 (3 when unset): how many times the person 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 provider could not answer spends none.",
592
+ "maximum": 5,
593
+ "minimum": 1,
594
+ "nullable": true,
595
+ "required": false,
596
+ "type": "integer"
597
+ },
598
+ "bank_account_lookup_enabled": {
599
+ "description": "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; off when unset), and written back on every save as whether any country offers the account check.",
600
+ "nullable": true,
601
+ "required": false,
602
+ "type": "boolean"
603
+ },
543
604
  "bank_account_selection": {
544
605
  "description": "Whether the user picks which of the connected accounts is verified (`user`) or the first eligible one is taken (`auto`).",
545
606
  "enum": [
@@ -550,14 +611,44 @@
550
611
  "required": false,
551
612
  "type": "string"
552
613
  },
614
+ "bank_account_type_action": {
615
+ "description": "Verdict when the verified account is a savings account.",
616
+ "enum": [
617
+ "DECLINE",
618
+ "REVIEW",
619
+ "NO_ACTION"
620
+ ],
621
+ "nullable": true,
622
+ "required": false,
623
+ "type": "string"
624
+ },
625
+ "bank_address_match_threshold": {
626
+ "description": "At or above this score the holder's address matches, 50 to 100, defaulting to 70. Only read with `bank_require_address_match`.",
627
+ "maximum": 100,
628
+ "minimum": 50,
629
+ "nullable": true,
630
+ "required": false,
631
+ "type": "integer"
632
+ },
633
+ "bank_address_mismatch_action": {
634
+ "description": "Verdict when the holder's address differs, which turns a match into a close match. Only with `bank_require_address_match`.",
635
+ "enum": [
636
+ "DECLINE",
637
+ "REVIEW",
638
+ "NO_ACTION"
639
+ ],
640
+ "nullable": true,
641
+ "required": false,
642
+ "type": "string"
643
+ },
553
644
  "bank_allow_skip": {
554
- "description": "Let the user skip the step instead of connecting a bank. A skip is then decided by `bank_skipped_action`.",
645
+ "description": "Retired by `bank_continue_without_bank`: still accepted, and written back from it on every save. A save that sends only this key gets `from_start` for `true` and `when_needed` otherwise. The person can always continue without a bank now.",
555
646
  "nullable": true,
556
647
  "required": false,
557
648
  "type": "boolean"
558
649
  },
559
650
  "bank_attempts_exhausted_action": {
560
- "description": "Verdict when the user spent `bank_max_attempts` without a successful connection.",
651
+ "description": "Verdict when the user spent the attempts of every method the country offers (`bank_max_attempts`, and `bank_account_check_max_attempts` where it offers the account check) without a successful connection, also when they then continue without a bank.",
561
652
  "enum": [
562
653
  "DECLINE",
563
654
  "REVIEW"
@@ -566,6 +657,12 @@
566
657
  "required": false,
567
658
  "type": "string"
568
659
  },
660
+ "bank_auto_add_countries": {
661
+ "description": "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.",
662
+ "nullable": true,
663
+ "required": false,
664
+ "type": "boolean"
665
+ },
569
666
  "bank_business_account_action": {
570
667
  "description": "Verdict when the institution types the holder as a business rather than a person.",
571
668
  "enum": [
@@ -577,6 +674,17 @@
577
674
  "required": false,
578
675
  "type": "string"
579
676
  },
677
+ "bank_cash_flow_action": {
678
+ "description": "Verdict when money comes in and straight back out, or many small transfers come in (pass-through cash flow). Needs the `transactions` scope.",
679
+ "enum": [
680
+ "DECLINE",
681
+ "REVIEW",
682
+ "NO_ACTION"
683
+ ],
684
+ "nullable": true,
685
+ "required": false,
686
+ "type": "string"
687
+ },
580
688
  "bank_connection_timeout_minutes": {
581
689
  "description": "How long a started connection stays open before the attempt is abandoned, 5 to 60 minutes.",
582
690
  "maximum": 60,
@@ -596,17 +704,35 @@
596
704
  "required": false,
597
705
  "type": "string"
598
706
  },
707
+ "bank_continue_without_bank": {
708
+ "description": "When the bank step shows \"Continue without your bank\". `when_needed` (the default) shows it once no method works for the person's country or bank (also when their bank cannot be reached and no other bank sign-in or account check could verify them), or when they say they have no online banking. `from_start` also shows it on the first screen. It cannot be turned off: the person can always continue, and the session then follows `bank_unsupported_action` when nothing could verify their country or bank, `bank_attempts_exhausted_action` when every attempt is spent, and `bank_skipped_action` otherwise. A failed attempt that spends the last one does not wait for the person: the step ends on its own with `bank_attempts_exhausted_action`. Every save writes it.",
709
+ "enum": [
710
+ "when_needed",
711
+ "from_start"
712
+ ],
713
+ "nullable": true,
714
+ "required": false,
715
+ "type": "string"
716
+ },
599
717
  "bank_countries": {
600
- "description": "Which countries a user may connect a bank in - a WHITELIST, so an empty map means the node offers nothing and runs nothing. `institutions` narrows the picker to specific provider institution ids; `\"all\"` offers every identity-capable bank in the country. Coverage belongs to the route the node selected in `provider_key`: a country the native route or the connected marketplace provider cannot establish account ownership in is REFUSED on save rather than dropped, because connecting to a bank that returns no holder identity spends an attempt and a charge to end at `not_verifiable`.",
718
+ "description": "Which countries a user may connect a bank in - a WHITELIST, so an empty map means the node offers nothing and runs nothing (unless `bank_auto_add_countries` is on), and a map whose countries are all off is refused. `institutions` narrows the picker to specific provider institution ids; `\"all\"` offers every identity-capable bank in the country. `hidden_institutions` leaves banks out of the suggestions and the search; with `bank_popular_mode: manual`, `popular_institutions` are the banks shown as popular, in order. A bank is never both hidden and popular. Coverage belongs to the route the node selected in `provider_key`: the native route (a registered native route with an approved price) or the connected marketplace provider. A country no route of the node can establish account ownership in is KEPT on save, because the step is never a dead end: it offers no bank sign-in or account check there, only its fallbacks (a statement upload where the node offers one, micro-deposits where a route sends them) and Continue without a bank (`bank_continue_without_bank`). A code that names no country Didit verifies is refused on save. A statement-only country is refused when the organization's contract does not price the statement upload. `methods` sets which of bank sign-in (`open_banking`) and the account check (`account_lookup`) the country offers and in what order, over the step's `bank_method_order`: the person starts on the first one and is offered the second as its backup. A country a route serves whose `methods` leave it nothing, and any country whose `methods` name a method no route of the node serves there, are refused on save.",
601
719
  "example": {
602
- "ESP": {
720
+ "GBR": {
603
721
  "enabled": true,
604
722
  "institutions": "all"
723
+ },
724
+ "MEX": {
725
+ "enabled": true,
726
+ "institutions": "all",
727
+ "methods": [
728
+ "account_lookup",
729
+ "open_banking"
730
+ ]
605
731
  }
606
732
  },
607
733
  "nullable": true,
608
734
  "required": false,
609
- "shape": "{\"<ISO3>\": {\"enabled\": true|false, \"institutions\": [\"<institution_id>\", ...] | \"all\"}}",
735
+ "shape": "{\"<ISO3>\": {\"enabled\": true|false, \"institutions\": [\"<institution_id>\", ...] | \"all\", \"popular_institutions\"?: [\"<institution_id>\", ...], \"hidden_institutions\"?: [\"<institution_id>\", ...], \"methods\"?: [\"open_banking\"|\"account_lookup\", ...]}}",
610
736
  "type": "json"
611
737
  },
612
738
  "bank_country_mismatch_action": {
@@ -631,6 +757,31 @@
631
757
  "required": false,
632
758
  "type": "string"
633
759
  },
760
+ "bank_dob_match_enabled": {
761
+ "description": "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.",
762
+ "nullable": true,
763
+ "required": false,
764
+ "type": "boolean"
765
+ },
766
+ "bank_dob_match_threshold": {
767
+ "description": "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.",
768
+ "maximum": 100,
769
+ "minimum": 50,
770
+ "nullable": true,
771
+ "required": false,
772
+ "type": "integer"
773
+ },
774
+ "bank_dob_mismatch_action": {
775
+ "description": "Verdict when the holder's date of birth differs. Only with `bank_dob_match_enabled`.",
776
+ "enum": [
777
+ "DECLINE",
778
+ "REVIEW",
779
+ "NO_ACTION"
780
+ ],
781
+ "nullable": true,
782
+ "required": false,
783
+ "type": "string"
784
+ },
634
785
  "bank_eligible_account_types": {
635
786
  "description": "Which account types the user may pick. Credit cards, loans and investment accounts are never eligible - they do not establish ownership of a payment account. Defaults to current/checking.",
636
787
  "example": [
@@ -653,6 +804,39 @@
653
804
  "required": false,
654
805
  "type": "array"
655
806
  },
807
+ "bank_email_match_enabled": {
808
+ "description": "Compare the email on file at the bank with the session's verified email. A mismatch fires `bank_email_mismatch_action`. Off by default.",
809
+ "nullable": true,
810
+ "required": false,
811
+ "type": "boolean"
812
+ },
813
+ "bank_email_match_threshold": {
814
+ "description": "At or above this score the email matches, 50 to 100, defaulting to 70.",
815
+ "maximum": 100,
816
+ "minimum": 50,
817
+ "nullable": true,
818
+ "required": false,
819
+ "type": "integer"
820
+ },
821
+ "bank_email_mismatch_action": {
822
+ "description": "Verdict when the holder's email differs. Only with `bank_email_match_enabled`.",
823
+ "enum": [
824
+ "DECLINE",
825
+ "REVIEW",
826
+ "NO_ACTION"
827
+ ],
828
+ "nullable": true,
829
+ "required": false,
830
+ "type": "string"
831
+ },
832
+ "bank_evidence_retention_days": {
833
+ "description": "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.",
834
+ "maximum": 1825,
835
+ "minimum": 30,
836
+ "nullable": true,
837
+ "required": false,
838
+ "type": "integer"
839
+ },
656
840
  "bank_expected_currencies": {
657
841
  "description": "ISO 4217 currencies the account is expected to be in. Empty means any; a mismatch is reported through `bank_currency_mismatch_action`.",
658
842
  "example": [
@@ -668,8 +852,19 @@
668
852
  "required": false,
669
853
  "type": "array"
670
854
  },
855
+ "bank_fallback_used_action": {
856
+ "description": "Verdict when the account was verified with micro-deposits or a statement upload.",
857
+ "enum": [
858
+ "DECLINE",
859
+ "REVIEW",
860
+ "NO_ACTION"
861
+ ],
862
+ "nullable": true,
863
+ "required": false,
864
+ "type": "string"
865
+ },
671
866
  "bank_field_sources": {
672
- "description": "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`. An `expected_details.<field>` VALUE 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.",
867
+ "description": "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`, `date_of_birth`, `phone`, `email`; `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`. An `expected_details.<field>` VALUE 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.",
673
868
  "example": {
674
869
  "full_name": {
675
870
  "key": "expected_details.first_name",
@@ -678,7 +873,7 @@
678
873
  },
679
874
  "nullable": true,
680
875
  "required": false,
681
- "shape": "{\"full_name\"|\"first_name\"|\"last_name\"|\"address\": {\"source\": \"document_ai\"|\"questionnaire\"|\"expected_data\", \"key\": \"<docai field key>|<questionnaire node id>|expected_details.<expected_details field>|metadata.<key>\"}}",
876
+ "shape": "{\"full_name\"|\"first_name\"|\"last_name\"|\"address\"|\"date_of_birth\"|\"phone\"|\"email\": {\"source\": \"document_ai\"|\"questionnaire\"|\"expected_data\", \"key\": \"<docai field key>|<questionnaire node id>|expected_details.<expected_details field>|metadata.<key>\"}}",
682
877
  "type": "json"
683
878
  },
684
879
  "bank_joint_account_action": {
@@ -703,14 +898,46 @@
703
898
  "required": false,
704
899
  "type": "string"
705
900
  },
901
+ "bank_match_any_holder": {
902
+ "description": "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.",
903
+ "nullable": true,
904
+ "required": false,
905
+ "type": "boolean"
906
+ },
706
907
  "bank_max_attempts": {
707
- "description": "How many connection attempts the user gets, 1 to 5. Spending them all without a successful connection is `bank_attempts_exhausted_action`.",
908
+ "description": "How many bank sign-in attempts the user gets, 1 to 5; a micro-deposit or statement fallback spends one too. The account check has its own `bank_account_check_max_attempts`. The step ends once every method the country offers has spent its attempts, which without a successful connection is `bank_attempts_exhausted_action`.",
708
909
  "maximum": 5,
709
910
  "minimum": 1,
710
911
  "nullable": true,
711
912
  "required": false,
712
913
  "type": "integer"
713
914
  },
915
+ "bank_method_order": {
916
+ "description": "Which of the two methods the step offers and in what order, for every country that sets no `methods` of its own in `bank_countries`: `open_banking` is bank sign-in (the person signs in at their bank and shares the account holder, plus balances, transactions and income when the step asks for them), `account_lookup` is the account check (no sign-in: the person types the account details, an IBAN, a sort code and account number, a CLABE..., and the bank confirms the name on it; ownership only). In each country the person starts on the first method a route serves there, and is offered the other one as its backup under \"Other ways to verify\"; where a country offers both, the account check also stands in for a bank whose sign-in is degraded or down. A method no route serves in a country is left out there. At least one method; a save that names none gets `[\"open_banking\", \"account_lookup\"]`, unless it sends `bank_open_banking_enabled` or `bank_account_lookup_enabled`, which then set it. The account check is billed once per check the provider answers (a match, a close match, a no match, an account it could not verify or did not find); an account refused before the check bills nothing.",
917
+ "example": [
918
+ "open_banking",
919
+ "account_lookup"
920
+ ],
921
+ "items": {
922
+ "enum": [
923
+ "open_banking",
924
+ "account_lookup"
925
+ ],
926
+ "nullable": false,
927
+ "required": true,
928
+ "type": "string"
929
+ },
930
+ "nullable": true,
931
+ "required": false,
932
+ "shape": "[\"open_banking\"|\"account_lookup\", ...]",
933
+ "type": "array"
934
+ },
935
+ "bank_microdeposits_enabled": {
936
+ "description": "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.",
937
+ "nullable": true,
938
+ "required": false,
939
+ "type": "boolean"
940
+ },
714
941
  "bank_min_balance": {
715
942
  "description": "Minimum available balance, in the account's own currency. Below it `bank_low_balance_action` fires. Needs the `balances` scope and the save is refused without it. 0 is a real cutoff - it triggers the action for an overdrawn account - but the action defaults to `NO_ACTION`, so the verdict is unchanged unless another action is configured. This is not the same as leaving the key out.",
716
943
  "minimum": 0,
@@ -718,6 +945,25 @@
718
945
  "required": false,
719
946
  "type": "number"
720
947
  },
948
+ "bank_mule_score_action": {
949
+ "description": "Verdict when the mule score is at or above `bank_mule_score_threshold`.",
950
+ "enum": [
951
+ "DECLINE",
952
+ "REVIEW",
953
+ "NO_ACTION"
954
+ ],
955
+ "nullable": true,
956
+ "required": false,
957
+ "type": "string"
958
+ },
959
+ "bank_mule_score_threshold": {
960
+ "description": "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).",
961
+ "maximum": 100,
962
+ "minimum": 0,
963
+ "nullable": true,
964
+ "required": false,
965
+ "type": "integer"
966
+ },
721
967
  "bank_name_match_threshold": {
722
968
  "description": "At or above this score the holder name is a match. 50 to 100, defaults to 85.",
723
969
  "maximum": 100,
@@ -747,6 +993,12 @@
747
993
  "required": false,
748
994
  "type": "string"
749
995
  },
996
+ "bank_open_banking_enabled": {
997
+ "description": "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, which is the default), and written back on every save as whether any country offers bank sign-in.",
998
+ "nullable": true,
999
+ "required": false,
1000
+ "type": "boolean"
1001
+ },
750
1002
  "bank_partial_match_action": {
751
1003
  "description": "Verdict when the holder name lands between `bank_partial_match_floor` and `bank_name_match_threshold`. Never approves by default.",
752
1004
  "enum": [
@@ -759,15 +1011,50 @@
759
1011
  "type": "string"
760
1012
  },
761
1013
  "bank_partial_match_floor": {
762
- "description": "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 `bank_name_match_threshold` or the save is refused. An explicit null means \"use the default\" here too, which is why a threshold of 50 with no floor is refused: it is checked against the default floor of 70.",
1014
+ "description": "The close-match value: 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 `bank_name_match_threshold` or the save is refused. An explicit null means \"use the default\" here too, which is why a threshold of 50 with no floor is refused: it is checked against the default floor of 70.",
763
1015
  "maximum": 99,
764
1016
  "minimum": 0,
765
1017
  "nullable": true,
766
1018
  "required": false,
767
1019
  "type": "integer"
768
1020
  },
1021
+ "bank_phone_match_enabled": {
1022
+ "description": "Compare the phone on file at the bank with the session's verified phone. A mismatch fires `bank_phone_mismatch_action`. Off by default.",
1023
+ "nullable": true,
1024
+ "required": false,
1025
+ "type": "boolean"
1026
+ },
1027
+ "bank_phone_match_threshold": {
1028
+ "description": "At or above this score the phone matches, 50 to 100, defaulting to 70.",
1029
+ "maximum": 100,
1030
+ "minimum": 50,
1031
+ "nullable": true,
1032
+ "required": false,
1033
+ "type": "integer"
1034
+ },
1035
+ "bank_phone_mismatch_action": {
1036
+ "description": "Verdict when the holder's phone differs. Only with `bank_phone_match_enabled`.",
1037
+ "enum": [
1038
+ "DECLINE",
1039
+ "REVIEW",
1040
+ "NO_ACTION"
1041
+ ],
1042
+ "nullable": true,
1043
+ "required": false,
1044
+ "type": "string"
1045
+ },
1046
+ "bank_popular_mode": {
1047
+ "description": "`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.",
1048
+ "enum": [
1049
+ "auto",
1050
+ "manual"
1051
+ ],
1052
+ "nullable": true,
1053
+ "required": false,
1054
+ "type": "string"
1055
+ },
769
1056
  "bank_reference_identity": {
770
- "description": "Which earlier step supplies the identity the account holder is compared against: `kyc` (ID Verification), `database_validation`, `expected_details` (the session-create payload), `questionnaire`, or `auto` to use whichever one the workflow produced. The step that actually supplied it is recorded on the result as `reference_identity_source`.",
1057
+ "description": "Which earlier step supplies the identity the account holder is compared against: `kyc` (ID Verification), `database_validation`, `expected_details` (the session-create payload), `questionnaire`, or `auto` to use whichever one the workflow produced. The step that actually supplied the compared name is recorded on the result as `reference_identity_source`: a name mapped in `bank_field_sources` records where it was mapped from (`document_ai` among them), and a business session records `kyb`.",
771
1058
  "enum": [
772
1059
  "auto",
773
1060
  "kyc",
@@ -797,7 +1084,7 @@
797
1084
  "type": "boolean"
798
1085
  },
799
1086
  "bank_require_address_match": {
800
- "description": "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.",
1087
+ "description": "Also require the holder's address to match. A name that reached the threshold but whose address scores below `bank_address_match_threshold` drops to a close match decided by `bank_address_mismatch_action`. 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 close match decided by `bank_partial_match_action`. Off by default.",
801
1088
  "nullable": true,
802
1089
  "required": false,
803
1090
  "type": "boolean"
@@ -809,7 +1096,7 @@
809
1096
  "type": "boolean"
810
1097
  },
811
1098
  "bank_scopes": {
812
- "description": "What the user is asked to consent to sharing. `ownership` is what the product verifies and cannot be turned off. `identifiers` unmasks the IBAN / account number; `balances`, `transactions` and `income` read real financial data, are each billed separately, and are refused on save unless the application carries the `bank_financial_data` entitlement. A scope that is off is never requested from the provider, so the bank never shows it on its consent screen.",
1099
+ "description": "What the user is asked to consent to sharing. `ownership` is what the product verifies and cannot be turned off. `identifiers` unmasks the IBAN / account number; `balances`, `transactions` and `income` read real financial data, are each billed separately, and are refused on save unless the application carries the `bank_financial_data` entitlement. On a node that can run on Didit's own routes, each of them is also refused when a country the node offers has no route that reads it with bank sign-in: only bank sign-in reads data, so the data must come from the person's bank (the console offers only the scopes every country reads). A country that offers only the account check is not refused: a person 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 from the provider, so the bank never shows it on its consent screen.",
813
1100
  "example": {
814
1101
  "ownership": true
815
1102
  },
@@ -825,7 +1112,7 @@
825
1112
  "type": "boolean"
826
1113
  },
827
1114
  "bank_skipped_action": {
828
- "description": "Verdict when the user skipped the step. Only reachable with `bank_allow_skip`.",
1115
+ "description": "Verdict when the person chose \"Continue without your bank\" while a way to verify was there. Defaults to `REVIEW`. The bank result then has `continued_without_bank` true and `SKIPPED` in its reason codes.",
829
1116
  "enum": [
830
1117
  "DECLINE",
831
1118
  "REVIEW"
@@ -834,6 +1121,29 @@
834
1121
  "required": false,
835
1122
  "type": "string"
836
1123
  },
1124
+ "bank_statement_document_checks_action": {
1125
+ "description": "Verdict when an uploaded statement carries editing or tampering evidence. Defaults to `REVIEW`.",
1126
+ "enum": [
1127
+ "DECLINE",
1128
+ "REVIEW",
1129
+ "NO_ACTION"
1130
+ ],
1131
+ "nullable": true,
1132
+ "required": false,
1133
+ "type": "string"
1134
+ },
1135
+ "bank_statement_enabled": {
1136
+ "description": "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. Sandbox sessions can test it without billing. Off by default.",
1137
+ "nullable": true,
1138
+ "required": false,
1139
+ "type": "boolean"
1140
+ },
1141
+ "bank_statement_standalone_enabled": {
1142
+ "description": "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. Charged on its own as `bank_statement_upload`, USD 0.20 per evaluated statement at list price, with the organization's contract rate or special price applying as for any add-on; not offered where the contract does not price it. Sandbox sessions can test it without billing. On by default.",
1143
+ "nullable": true,
1144
+ "required": false,
1145
+ "type": "boolean"
1146
+ },
837
1147
  "bank_store_full_identifiers": {
838
1148
  "description": "Store the account identifiers unmasked rather than masked. Needs the `identifiers` scope and the save is refused without it. Even then the unmasked form is only served to a caller holding the bank-verification read permission.",
839
1149
  "nullable": true,
@@ -846,8 +1156,14 @@
846
1156
  "required": false,
847
1157
  "type": "boolean"
848
1158
  },
1159
+ "bank_suggest_holder_name": {
1160
+ "description": "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.",
1161
+ "nullable": true,
1162
+ "required": false,
1163
+ "type": "boolean"
1164
+ },
849
1165
  "bank_transactions_history_days": {
850
- "description": "How far back transaction history is read, 30 to 365 days, defaulting to 90. Needs the `transactions` scope and the save is refused without it.",
1166
+ "description": "How far back transaction history is read, 30 to 365 days, defaulting to 90. Needs the `transactions` scope and the save is refused without it. A node that may run on Didit's native route (no `provider_key`, or `fallback_to_native`) reads 30 or 90 days only: anything else is refused, because the native transactions add-on is priced for those two windows.",
851
1167
  "maximum": 365,
852
1168
  "minimum": 30,
853
1169
  "nullable": true,
@@ -866,7 +1182,7 @@
866
1182
  "type": "string"
867
1183
  },
868
1184
  "bank_unsupported_action": {
869
- "description": "Verdict when the user's bank is not supported and the node does not allow skipping.",
1185
+ "description": "Verdict when the person 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. Defaults to `REVIEW`. The bank result then has `continued_without_bank` true and `NOT_COVERED` in its reason codes.",
870
1186
  "enum": [
871
1187
  "DECLINE",
872
1188
  "REVIEW",
@@ -974,7 +1290,7 @@
974
1290
  "description": "Configuration for Database Validation feature.",
975
1291
  "fields": {
976
1292
  "database_validation_countries": {
977
- "description": "The databases to check, per country - this node runs NOTHING until at least one country carries at least one service id. Service ids come from the country's live catalog (e.g. `bra_cpf` for BRA); ids that do not belong to the named country, and countries with no live service, are dropped on save. The legacy `{\"<ISO3>\": \"one_by_one\"|\"two_by_two\"|\"not_enabled\"}` shape is still accepted and auto-expanded to that country's live services.",
1293
+ "description": "The databases to check, per country - this node runs NOTHING until at least one country carries at least one service id. Service ids come from the country's live catalog (e.g. `bra_cpf` for BRA). An unknown id, an id that belongs to another country, and a service no workflow can run (not live yet, or offered only through the standalone `POST /v3/database-validation/`) are rejected with a 400 that names the service; a service the saved workflow already carries but can no longer run is removed on save. The legacy `{\"<ISO3>\": \"one_by_one\"|\"two_by_two\"|\"not_enabled\"}` shape is still accepted and auto-expanded to that country's live services.",
978
1294
  "example": {
979
1295
  "BRA": {
980
1296
  "services": [
@@ -988,7 +1304,7 @@
988
1304
  "type": "json"
989
1305
  },
990
1306
  "database_validation_field_sources": {
991
- "description": "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`. The two halves speak different vocabularies: the map's KEY is a Database Validation input field (`tax_id`, `document_number`, ...), while an `expected_details.<field>` VALUE 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`. Anything else under `expected_details.` is rejected on save; `metadata.<key>` takes any non-empty whitespace-free customer key. 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 dropped on save rather than rejected, which un-satisfies its service and drops it from the selection.",
1307
+ "description": "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`. The two halves speak different vocabularies: the map's KEY is a Database Validation input field (`tax_id`, `document_number`, ...), while an `expected_details.<field>` VALUE 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`. Anything else under `expected_details.` is rejected on save; `metadata.<key>` takes any non-empty whitespace-free customer key. 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.",
992
1308
  "example": {
993
1309
  "tax_id": {
994
1310
  "key": "expected_details.identification_number",
@@ -1717,6 +2033,7 @@
1717
2033
  "description": "Configuration for the Precise Location (GEOLOCATION) feature. Every threshold is bounded here rather than in the client: the browser and the native SDKs are told what to collect by the step data this config produces, and a value the server would refuse must never reach a user as a request their device cannot satisfy. The action keys all default to Review rather than Decline. A denied permission, a wide radius or a stale fix is not evidence of fraud, and a default that declined them would make the step a conversion trap.",
1718
2034
  "fields": {
1719
2035
  "geolocation_accuracy_mode": {
2036
+ "description": "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.",
1720
2037
  "enum": [
1721
2038
  "precise",
1722
2039
  "approximate_allowed"
@@ -1726,11 +2043,13 @@
1726
2043
  "type": "string"
1727
2044
  },
1728
2045
  "geolocation_allow_qr_handoff": {
2046
+ "description": "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.",
1729
2047
  "nullable": true,
1730
2048
  "required": false,
1731
2049
  "type": "boolean"
1732
2050
  },
1733
2051
  "geolocation_allow_skip": {
2052
+ "description": "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.",
1734
2053
  "nullable": true,
1735
2054
  "required": false,
1736
2055
  "type": "boolean"
@@ -1746,13 +2065,46 @@
1746
2065
  "required": false,
1747
2066
  "type": "string"
1748
2067
  },
1749
- "geolocation_deep_link_enabled": {
2068
+ "geolocation_areas": {
2069
+ "description": "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`.",
2070
+ "example": [
2071
+ {
2072
+ "country": "ESP",
2073
+ "id": "spain",
2074
+ "kind": "country",
2075
+ "label": "Spain",
2076
+ "type": "allowed"
2077
+ },
2078
+ {
2079
+ "country": "ESP",
2080
+ "id": "ceuta-melilla",
2081
+ "kind": "region",
2082
+ "label": "Ceuta and Melilla",
2083
+ "regions": [
2084
+ "ES-CE",
2085
+ "ES-ML"
2086
+ ],
2087
+ "type": "blocked"
2088
+ },
2089
+ {
2090
+ "center": {
2091
+ "latitude": 36.14,
2092
+ "longitude": -5.35
2093
+ },
2094
+ "id": "gibraltar-border",
2095
+ "kind": "circle",
2096
+ "label": "Gibraltar border",
2097
+ "radius_km": 25,
2098
+ "type": "blocked"
2099
+ }
2100
+ ],
1750
2101
  "nullable": true,
1751
2102
  "required": false,
1752
- "type": "boolean"
2103
+ "shape": "[{\"id\": \"<1-64 of A-Z a-z 0-9 _ ->\", \"label\"?: \"<text>\", \"type\": \"allowed\"|\"blocked\", \"kind\": \"country\", \"country\": \"<ISO3>\"} | {..., \"kind\": \"region\", \"country\": \"<ISO3>\", \"regions\": [\"<ISO 3166-2>\", ...]} | {..., \"kind\": \"circle\", \"center\": {\"latitude\": <num>, \"longitude\": <num>}, \"radius_km\": <1-500>} | {..., \"kind\": \"polygon\", \"points\": [{\"latitude\": <num>, \"longitude\": <num>}, ...]}]",
2104
+ "type": "json"
1753
2105
  },
1754
- "geolocation_document_distance_action": {
1755
- "description": "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.",
2106
+ "geolocation_blocked_area_action": {
2107
+ "description": "Verdict when the position, and its whole accuracy circle, falls inside a blocked area of `geolocation_areas`. Defaults to Decline.",
1756
2108
  "enum": [
1757
2109
  "DECLINE",
1758
2110
  "REVIEW",
@@ -1762,11 +2114,57 @@
1762
2114
  "required": false,
1763
2115
  "type": "string"
1764
2116
  },
1765
- "geolocation_document_distance_km": {
1766
- "minimum": 0,
2117
+ "geolocation_consecutive_mismatch_action": {
2118
+ "description": "Verdict when `geolocation_consecutive_mismatch_count` mismatches in a row are reached. Defaults to Review.",
2119
+ "enum": [
2120
+ "DECLINE",
2121
+ "REVIEW",
2122
+ "NO_ACTION"
2123
+ ],
1767
2124
  "nullable": true,
1768
2125
  "required": false,
1769
- "type": "integer"
2126
+ "type": "string"
2127
+ },
2128
+ "geolocation_consecutive_mismatch_count": {
2129
+ "description": "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.",
2130
+ "nullable": true,
2131
+ "required": false,
2132
+ "type": "integer"
2133
+ },
2134
+ "geolocation_deep_link_enabled": {
2135
+ "description": "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.",
2136
+ "nullable": true,
2137
+ "required": false,
2138
+ "type": "boolean"
2139
+ },
2140
+ "geolocation_document_distance_action": {
2141
+ "description": "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.",
2142
+ "enum": [
2143
+ "DECLINE",
2144
+ "REVIEW",
2145
+ "NO_ACTION"
2146
+ ],
2147
+ "nullable": true,
2148
+ "required": false,
2149
+ "type": "string"
2150
+ },
2151
+ "geolocation_document_distance_basis": {
2152
+ "description": "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).",
2153
+ "enum": [
2154
+ "document",
2155
+ "declared",
2156
+ "proof_of_address"
2157
+ ],
2158
+ "nullable": true,
2159
+ "required": false,
2160
+ "type": "string"
2161
+ },
2162
+ "geolocation_document_distance_km": {
2163
+ "description": "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.",
2164
+ "minimum": 0,
2165
+ "nullable": true,
2166
+ "required": false,
2167
+ "type": "integer"
1770
2168
  },
1771
2169
  "geolocation_document_distance_unit": {
1772
2170
  "description": "The unit the console shows `geolocation_document_distance_km` in. Display only: the stored value is always kilometres and no rule depends on it.",
@@ -1778,6 +2176,17 @@
1778
2176
  "required": false,
1779
2177
  "type": "string"
1780
2178
  },
2179
+ "geolocation_emulator_action": {
2180
+ "description": "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.",
2181
+ "enum": [
2182
+ "DECLINE",
2183
+ "REVIEW",
2184
+ "NO_ACTION"
2185
+ ],
2186
+ "nullable": true,
2187
+ "required": false,
2188
+ "type": "string"
2189
+ },
1781
2190
  "geolocation_geofence_undetermined_action": {
1782
2191
  "description": "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.",
1783
2192
  "enum": [
@@ -1840,6 +2249,7 @@
1840
2249
  "type": "string"
1841
2250
  },
1842
2251
  "geolocation_ip_distance_km": {
2252
+ "description": "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.",
1843
2253
  "minimum": 0,
1844
2254
  "nullable": true,
1845
2255
  "required": false,
@@ -1866,7 +2276,18 @@
1866
2276
  "required": false,
1867
2277
  "type": "string"
1868
2278
  },
2279
+ "geolocation_low_accuracy_behavior": {
2280
+ "description": "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.",
2281
+ "enum": [
2282
+ "ask_again",
2283
+ "fail"
2284
+ ],
2285
+ "nullable": true,
2286
+ "required": false,
2287
+ "type": "string"
2288
+ },
1869
2289
  "geolocation_max_accuracy_radius_m": {
2290
+ "description": "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.",
1870
2291
  "nullable": true,
1871
2292
  "required": false,
1872
2293
  "type": "integer"
@@ -1882,11 +2303,13 @@
1882
2303
  "type": "string"
1883
2304
  },
1884
2305
  "geolocation_max_age_seconds": {
2306
+ "description": "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`.",
1885
2307
  "nullable": true,
1886
2308
  "required": false,
1887
2309
  "type": "integer"
1888
2310
  },
1889
2311
  "geolocation_max_attempts": {
2312
+ "description": "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.",
1890
2313
  "nullable": true,
1891
2314
  "required": false,
1892
2315
  "type": "integer"
@@ -1913,6 +2336,49 @@
1913
2336
  "required": false,
1914
2337
  "type": "string"
1915
2338
  },
2339
+ "geolocation_position_source": {
2340
+ "description": "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.",
2341
+ "enum": [
2342
+ "device_and_ip",
2343
+ "device_only",
2344
+ "ip_only"
2345
+ ],
2346
+ "nullable": true,
2347
+ "required": false,
2348
+ "type": "string"
2349
+ },
2350
+ "geolocation_preset": {
2351
+ "description": "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.",
2352
+ "enum": [
2353
+ "licensing",
2354
+ "fraud_screening"
2355
+ ],
2356
+ "nullable": true,
2357
+ "required": false,
2358
+ "type": "string"
2359
+ },
2360
+ "geolocation_proxy_action": {
2361
+ "description": "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.",
2362
+ "enum": [
2363
+ "DECLINE",
2364
+ "REVIEW",
2365
+ "NO_ACTION"
2366
+ ],
2367
+ "nullable": true,
2368
+ "required": false,
2369
+ "type": "string"
2370
+ },
2371
+ "geolocation_refusal_path": {
2372
+ "description": "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).",
2373
+ "enum": [
2374
+ "retry_then_handoff",
2375
+ "continue_without_location",
2376
+ "end_session"
2377
+ ],
2378
+ "nullable": true,
2379
+ "required": false,
2380
+ "type": "string"
2381
+ },
1916
2382
  "geolocation_stale_fix_action": {
1917
2383
  "description": "Verdict when the position was measured more than `geolocation_max_age_seconds` before the server received it.",
1918
2384
  "enum": [
@@ -1925,6 +2391,36 @@
1925
2391
  "type": "string"
1926
2392
  },
1927
2393
  "geolocation_timeout_seconds": {
2394
+ "description": "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`.",
2395
+ "nullable": true,
2396
+ "required": false,
2397
+ "type": "integer"
2398
+ },
2399
+ "geolocation_tor_action": {
2400
+ "description": "Verdict when the connection that shared the location is a Tor exit node. No action unless set or a preset says otherwise.",
2401
+ "enum": [
2402
+ "DECLINE",
2403
+ "REVIEW",
2404
+ "NO_ACTION"
2405
+ ],
2406
+ "nullable": true,
2407
+ "required": false,
2408
+ "type": "string"
2409
+ },
2410
+ "geolocation_travel_max_days": {
2411
+ "description": "How long after being seen in the usual area a distant position is still travel. From 1 to 90 days; 14 when unset.",
2412
+ "nullable": true,
2413
+ "required": false,
2414
+ "type": "integer"
2415
+ },
2416
+ "geolocation_travel_tolerance_enabled": {
2417
+ "description": "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.",
2418
+ "nullable": true,
2419
+ "required": false,
2420
+ "type": "boolean"
2421
+ },
2422
+ "geolocation_travel_usual_area_km": {
2423
+ "description": "Radius around the address that counts as the person's usual area. From 10 to 500 km; 100 when unset.",
1928
2424
  "nullable": true,
1929
2425
  "required": false,
1930
2426
  "type": "integer"
@@ -1940,7 +2436,19 @@
1940
2436
  "required": false,
1941
2437
  "type": "string"
1942
2438
  },
2439
+ "geolocation_vpn_action": {
2440
+ "description": "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.",
2441
+ "enum": [
2442
+ "DECLINE",
2443
+ "REVIEW",
2444
+ "NO_ACTION"
2445
+ ],
2446
+ "nullable": true,
2447
+ "required": false,
2448
+ "type": "string"
2449
+ },
1943
2450
  "is_geolocation_geofencing_enabled": {
2451
+ "description": "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.",
1944
2452
  "nullable": true,
1945
2453
  "required": false,
1946
2454
  "type": "boolean"
@@ -2121,6 +2629,28 @@
2121
2629
  "required": false,
2122
2630
  "type": "string"
2123
2631
  },
2632
+ "device_liveness_attack_history_action": {
2633
+ "description": "Verdict when the same device (matched on its persistent device id) was used in an earlier session of another user whose liveness capture the liveness engine judged an attack (risk DEVICE_LINKED_TO_LIVENESS_ATTACK). Defaults to NO_ACTION (evidence is recorded, the verdict is unchanged).",
2634
+ "enum": [
2635
+ "DECLINE",
2636
+ "REVIEW",
2637
+ "NO_ACTION"
2638
+ ],
2639
+ "nullable": true,
2640
+ "required": false,
2641
+ "type": "string"
2642
+ },
2643
+ "device_model_inconsistency_action": {
2644
+ "description": "Verdict when the same device (matched on its persistent device id) was reported as a different device model in an earlier session (risk DEVICE_MODEL_INCONSISTENT), which points at a spoofed device model or a copied device identifier. Generic model strings (for example `iPhone` or the reduced user agent `K`) are never compared. Defaults to NO_ACTION (evidence is recorded, the verdict is unchanged).",
2645
+ "enum": [
2646
+ "DECLINE",
2647
+ "REVIEW",
2648
+ "NO_ACTION"
2649
+ ],
2650
+ "nullable": true,
2651
+ "required": false,
2652
+ "type": "string"
2653
+ },
2124
2654
  "device_rooted_action": {
2125
2655
  "description": "Verdict when the device is rooted or jailbroken.",
2126
2656
  "enum": [
@@ -2401,6 +2931,17 @@
2401
2931
  "required": false,
2402
2932
  "type": "string"
2403
2933
  },
2934
+ "kyb_document_unproven_text_replacement_action": {
2935
+ "description": "Verdict 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`). Other editing evidence on the same document stays under `kyb_document_tampering_action`; when both apply, the stricter action decides.",
2936
+ "enum": [
2937
+ "NO_ACTION",
2938
+ "REVIEW",
2939
+ "DECLINE"
2940
+ ],
2941
+ "nullable": true,
2942
+ "required": false,
2943
+ "type": "string"
2944
+ },
2404
2945
  "kyb_required_document_groups": {
2405
2946
  "description": "The company paperwork to collect, as a list of document-GROUP codes - each group is satisfied by any one of the document types it covers. The KYB Documents feature refuses to save with an empty list: a node that requires nothing is the same as not having the node.",
2406
2947
  "example": [
@@ -2894,6 +3435,17 @@
2894
3435
  "required": false,
2895
3436
  "type": "boolean"
2896
3437
  },
3438
+ "face_liveness_attack_face_match_action": {
3439
+ "description": "Verdict when the liveness face matches (above the duplicate-face similarity bar) a face from an earlier session of this application whose own capture the liveness engine judged an attack (risk FACE_MATCHES_LIVENESS_ATTACK), another user's session only and only a confident attack verdict. Review or no action only - a decline set here is downgraded to review, because a genuine user can be rejected once by mistake and then pass. Defaults to NO_ACTION (evidence is recorded, the verdict is unchanged).",
3440
+ "enum": [
3441
+ "DECLINE",
3442
+ "REVIEW",
3443
+ "NO_ACTION"
3444
+ ],
3445
+ "nullable": true,
3446
+ "required": false,
3447
+ "type": "string"
3448
+ },
2897
3449
  "face_liveness_duplicated_face_document_mismatch_action": {
2898
3450
  "description": "Verdict when a duplicate face is found on a user verified with a different date of birth. Another document of the same person (a passport after an identity card, a renewal, a document of a second country) is not flagged.",
2899
3451
  "enum": [
@@ -3185,6 +3737,67 @@
3185
3737
  "required": false,
3186
3738
  "type": "boolean"
3187
3739
  },
3740
+ "jpki_certificate_invalid_action": {
3741
+ "description": "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. Default DECLINE.",
3742
+ "enum": [
3743
+ "NO_ACTION",
3744
+ "REVIEW",
3745
+ "DECLINE"
3746
+ ],
3747
+ "nullable": true,
3748
+ "required": false,
3749
+ "type": "string"
3750
+ },
3751
+ "jpki_certificate_revoked_action": {
3752
+ "description": "Verdict when the revocation check reports a My Number Card certificate revoked. Default DECLINE.",
3753
+ "enum": [
3754
+ "NO_ACTION",
3755
+ "REVIEW",
3756
+ "DECLINE"
3757
+ ],
3758
+ "nullable": true,
3759
+ "required": false,
3760
+ "type": "string"
3761
+ },
3762
+ "jpki_inconsistent_data_action": {
3763
+ "description": "Verdict when the name, date of birth, sex or address in the My Number Card's signature certificate differs from the OCR data of the same card. Default REVIEW.",
3764
+ "enum": [
3765
+ "NO_ACTION",
3766
+ "REVIEW",
3767
+ "DECLINE"
3768
+ ],
3769
+ "nullable": true,
3770
+ "required": false,
3771
+ "type": "string"
3772
+ },
3773
+ "jpki_request_attributes": {
3774
+ "description": "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 OCR data. Default true; false reads only the user authentication certificate (4-digit PIN), which proves the card and PIN but carries no attributes.",
3775
+ "nullable": true,
3776
+ "required": false,
3777
+ "type": "boolean"
3778
+ },
3779
+ "jpki_revocation_unchecked_action": {
3780
+ "description": "Verdict when the My Number Card was verified but its revocation status could not be checked. Default REVIEW.",
3781
+ "enum": [
3782
+ "NO_ACTION",
3783
+ "REVIEW",
3784
+ "DECLINE"
3785
+ ],
3786
+ "nullable": true,
3787
+ "required": false,
3788
+ "type": "string"
3789
+ },
3790
+ "jpki_signature_invalid_action": {
3791
+ "description": "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. Default DECLINE.",
3792
+ "enum": [
3793
+ "NO_ACTION",
3794
+ "REVIEW",
3795
+ "DECLINE"
3796
+ ],
3797
+ "nullable": true,
3798
+ "required": false,
3799
+ "type": "string"
3800
+ },
3188
3801
  "skip_nfc_action": {
3189
3802
  "description": "Verdict when the user skips the NFC chip read (only reachable with `allow_nfc_skip`).",
3190
3803
  "enum": [
@@ -3295,6 +3908,23 @@
3295
3908
  "OCR": {
3296
3909
  "description": "Configuration for OCR/ID Verification feature.",
3297
3910
  "fields": {
3911
+ "address_not_verified_action": {
3912
+ "description": "Verdict 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; an `unavailable` validation never raises it. Defaults to NO_ACTION, which only records the warning.",
3913
+ "enum": [
3914
+ "DECLINE",
3915
+ "REVIEW",
3916
+ "NO_ACTION"
3917
+ ],
3918
+ "nullable": true,
3919
+ "required": false,
3920
+ "type": "string"
3921
+ },
3922
+ "address_validation_enabled": {
3923
+ "description": "Validate the address this node reads (the one printed on the identity document, or the one on the proof of address) against postal reference data: it confirms the address exists and normalises it, and never links it to a person. The result is the `address_validation` object of the node's decision entry. A paid add-on, charged per address validated (a validation that could not run is free); off by default.",
3924
+ "nullable": true,
3925
+ "required": false,
3926
+ "type": "boolean"
3927
+ },
3298
3928
  "age_restrictions_by_country": {
3299
3929
  "description": "Per-country (and optionally per-state) age gate. `minimum_age` is required for every country listed; `maximum_age` may be null.",
3300
3930
  "example": {
@@ -3520,6 +4150,17 @@
3520
4150
  "required": false,
3521
4151
  "type": "integer"
3522
4152
  },
4153
+ "id_verification_injection_attack_action": {
4154
+ "description": "Verdict when the document (or the ID-lookup selfie) 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. Defaults to DECLINE: each of these proves the frames did not come from the device's own camera. Heuristic capture signals (FRAME_INJECTION_SUSPECTED and the others) are not covered and stay information.",
4155
+ "enum": [
4156
+ "DECLINE",
4157
+ "REVIEW",
4158
+ "NO_ACTION"
4159
+ ],
4160
+ "nullable": true,
4161
+ "required": false,
4162
+ "type": "string"
4163
+ },
3523
4164
  "id_verification_max_retry_attempts": {
3524
4165
  "maximum": 5,
3525
4166
  "minimum": 2,
@@ -3678,7 +4319,7 @@
3678
4319
  "type": "string"
3679
4320
  },
3680
4321
  "methods": {
3681
- "description": "Which ID verification methods each country may use: document capture (today's behaviour), non-doc lookup against a government or other authoritative source, and digital identity wallets. Omit the key, or a country, or a method, and that country is document only. Every method must be available for the country in the capability catalog (GET workflow-graph/id-verification-methods-catalog/); wallets are an accept-list with no ordering. Each fallback is `fallback_to_document` or `decline`; `max_attempts` (1-5, default 1) counts only lookups the registry answered. Where the catalog lists several lookup `sources` for a country, `source` picks exactly one by id; omitted means the country's default (the first listed).",
4322
+ "description": "Which ID verification methods each country may use: document capture (today's behaviour), non-doc lookup against a government or other authoritative source, and digital identity wallets. Omit the key, or a country, or a method, and that country is document only. Every method must be available for the country in the capability catalog (GET workflow-graph/id-verification-methods-catalog/); wallets are an accept-list with no ordering. Each lookup fallback is `fallback_to_document` or `decline`; `wallet.on_failure` also accepts `retry` (see below); `max_attempts` (1-5, default 1) counts only lookups the registry answered. Where the catalog lists several lookup `sources` for a country, `source` picks exactly one by id; omitted means the country's default (the first listed). `document.fallback_only: true` keeps document capture out of the first screen: users start with the wallet or lookup and only those it fails reach document capture. It needs document capture enabled and a wallet or lookup in the country that falls back to it. `wallet.on_failure: retry` keeps a user whose sign-in failed on the wallet step to try again: the session is never declined for it and no document is offered.",
3682
4323
  "example": {
3683
4324
  "BRA": {
3684
4325
  "id_lookup": {
@@ -3697,6 +4338,18 @@
3697
4338
  ]
3698
4339
  }
3699
4340
  },
4341
+ "FIN": {
4342
+ "document": {
4343
+ "enabled": true,
4344
+ "fallback_only": true
4345
+ },
4346
+ "wallet": {
4347
+ "enabled": true,
4348
+ "providers": [
4349
+ "ftn"
4350
+ ]
4351
+ }
4352
+ },
3700
4353
  "ZAF": {
3701
4354
  "document": {
3702
4355
  "enabled": true
@@ -3710,7 +4363,7 @@
3710
4363
  },
3711
4364
  "nullable": true,
3712
4365
  "required": false,
3713
- "shape": "{\"<ISO3>\": {\"document\": {\"enabled\": bool}, \"id_lookup\": {\"enabled\": bool, \"source\"?: \"<source_id>\"|null, \"max_attempts\": 1-5, \"skip_liveness_and_face_match\": bool, \"on_partial_match\": \"fallback_to_document\"|\"decline\", \"on_no_match\": \"fallback_to_document\"|\"decline\", \"on_provider_error\": \"fallback_to_document\"|\"decline\", \"response_fields\"?: [\"<field_key>\", ...]}, \"wallet\": {\"enabled\": bool, \"providers\": [\"<wallet_id>\", ...], \"on_failure\": \"fallback_to_document\"|\"decline\"}}}",
4366
+ "shape": "{\"<ISO3>\": {\"document\": {\"enabled\": bool, \"fallback_only\"?: bool}, \"id_lookup\": {\"enabled\": bool, \"source\"?: \"<source_id>\"|null, \"max_attempts\": 1-5, \"skip_liveness_and_face_match\": bool, \"on_partial_match\": \"fallback_to_document\"|\"decline\", \"on_no_match\": \"fallback_to_document\"|\"decline\", \"on_provider_error\": \"fallback_to_document\"|\"decline\", \"response_fields\"?: [\"<field_key>\", ...]}, \"wallet\": {\"enabled\": bool, \"providers\": [\"<wallet_id>\", ...], \"on_failure\": \"fallback_to_document\"|\"decline\"|\"retry\"}}}",
3714
4367
  "type": "json"
3715
4368
  },
3716
4369
  "minimum_age": {
@@ -4130,6 +4783,23 @@
4130
4783
  "PROOF_OF_ADDRESS": {
4131
4784
  "description": "Configuration for Proof of Address feature.",
4132
4785
  "fields": {
4786
+ "address_not_verified_action": {
4787
+ "description": "Verdict 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; an `unavailable` validation never raises it. Defaults to NO_ACTION, which only records the warning.",
4788
+ "enum": [
4789
+ "DECLINE",
4790
+ "REVIEW",
4791
+ "NO_ACTION"
4792
+ ],
4793
+ "nullable": true,
4794
+ "required": false,
4795
+ "type": "string"
4796
+ },
4797
+ "address_validation_enabled": {
4798
+ "description": "Validate the address this node reads (the one printed on the identity document, or the one on the proof of address) against postal reference data: it confirms the address exists and normalises it, and never links it to a person. The result is the `address_validation` object of the node's decision entry. A paid add-on, charged per address validated (a validation that could not run is free); off by default.",
4799
+ "nullable": true,
4800
+ "required": false,
4801
+ "type": "boolean"
4802
+ },
4133
4803
  "poa_document_authenticity_action": {
4134
4804
  "description": "Verdict when the document fails authenticity checks.",
4135
4805
  "enum": [
@@ -4152,6 +4822,17 @@
4152
4822
  "required": false,
4153
4823
  "type": "string"
4154
4824
  },
4825
+ "poa_document_unproven_text_replacement_action": {
4826
+ "description": "Verdict 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`). Other editing evidence on the same document stays under `poa_document_authenticity_action`; when both apply, the stricter action decides.",
4827
+ "enum": [
4828
+ "NO_ACTION",
4829
+ "REVIEW",
4830
+ "DECLINE"
4831
+ ],
4832
+ "nullable": true,
4833
+ "required": false,
4834
+ "type": "string"
4835
+ },
4155
4836
  "poa_documents_allowed": {
4156
4837
  "description": "Which proof-of-address documents are accepted, per issuing country. Same shape as OCR's `documents_allowed`; omit to accept the full catalog.",
4157
4838
  "example": {
@@ -4428,6 +5109,238 @@
4428
5109
  }
4429
5110
  },
4430
5111
  "serializer": "QuestionnaireFeatureConfigSerializer"
5112
+ },
5113
+ "SIGNATURE": {
5114
+ "description": "",
5115
+ "fields": {
5116
+ "signature_consent_per_document": {
5117
+ "default": true,
5118
+ "nullable": false,
5119
+ "required": false,
5120
+ "type": "boolean"
5121
+ },
5122
+ "signature_declined_action": {
5123
+ "default": "REVIEW",
5124
+ "description": "Verdict when the signer declines; nothing is charged.",
5125
+ "enum": [
5126
+ "DECLINE",
5127
+ "REVIEW",
5128
+ "NO_ACTION"
5129
+ ],
5130
+ "nullable": false,
5131
+ "required": false,
5132
+ "type": "string"
5133
+ },
5134
+ "signature_document_changed_action": {
5135
+ "default": "DECLINE",
5136
+ "description": "Verdict when an original no longer matches its captured SHA-256.",
5137
+ "enum": [
5138
+ "DECLINE",
5139
+ "REVIEW",
5140
+ "NO_ACTION"
5141
+ ],
5142
+ "nullable": false,
5143
+ "required": false,
5144
+ "type": "string"
5145
+ },
5146
+ "signature_documents": {
5147
+ "default": [],
5148
+ "description": "Ordered documents previously uploaded to this workflow (a Word file is stored as its converted PDF); metadata is read from stored files. Fields placed on a document are managed on its signature-documents/{document}/fields/ route, not in this list.",
5149
+ "nullable": false,
5150
+ "required": false,
5151
+ "shape": "[{\"uuid\":\"UUID\", \"title\":\"string\", \"file_name\":\"string\", \"pages\":1, \"size_bytes\":1}]",
5152
+ "type": "json"
5153
+ },
5154
+ "signature_documents_source": {
5155
+ "default": "workflow",
5156
+ "enum": [
5157
+ "workflow",
5158
+ "session",
5159
+ "both"
5160
+ ],
5161
+ "nullable": false,
5162
+ "required": false,
5163
+ "type": "string"
5164
+ },
5165
+ "signature_email_signed_copy": {
5166
+ "default": true,
5167
+ "nullable": false,
5168
+ "required": false,
5169
+ "type": "boolean"
5170
+ },
5171
+ "signature_evidence_page": {
5172
+ "default": true,
5173
+ "nullable": false,
5174
+ "required": false,
5175
+ "type": "boolean"
5176
+ },
5177
+ "signature_format": {
5178
+ "default": "pades",
5179
+ "enum": [
5180
+ "pades",
5181
+ "xades",
5182
+ "cades"
5183
+ ],
5184
+ "nullable": false,
5185
+ "required": false,
5186
+ "type": "string"
5187
+ },
5188
+ "signature_identity_not_verified_action": {
5189
+ "default": "DECLINE",
5190
+ "description": "Verdict when the signer lacks approved identity evidence.",
5191
+ "enum": [
5192
+ "DECLINE",
5193
+ "REVIEW",
5194
+ "NO_ACTION"
5195
+ ],
5196
+ "nullable": false,
5197
+ "required": false,
5198
+ "type": "string"
5199
+ },
5200
+ "signature_level": {
5201
+ "default": "simple",
5202
+ "description": "`simple` (default) needs no ID verification, email or phone: the signer types their name (or uses a verified one the session already has) and signs on the session link, with no code. `aes` needs an approved ID verification and a verified email or phone, and confirms with a one-time code. `qes` is not available yet and is refused. `simple` is only valid for `signature_signer: verified_person`. Simple suits low-risk agreements; regulated or high-value contracts should use `aes`.",
5203
+ "enum": [
5204
+ "simple",
5205
+ "aes",
5206
+ "qes"
5207
+ ],
5208
+ "nullable": false,
5209
+ "required": false,
5210
+ "type": "string"
5211
+ },
5212
+ "signature_link_validity_days": {
5213
+ "default": 7,
5214
+ "maximum": 30,
5215
+ "minimum": 1,
5216
+ "nullable": false,
5217
+ "required": false,
5218
+ "type": "integer"
5219
+ },
5220
+ "signature_name_mismatch_action": {
5221
+ "default": "DECLINE",
5222
+ "description": "Verdict when the verified name does not match the requested signer.",
5223
+ "enum": [
5224
+ "DECLINE",
5225
+ "REVIEW",
5226
+ "NO_ACTION"
5227
+ ],
5228
+ "nullable": false,
5229
+ "required": false,
5230
+ "type": "string"
5231
+ },
5232
+ "signature_otp_channel": {
5233
+ "default": "email",
5234
+ "enum": [
5235
+ "email",
5236
+ "sms"
5237
+ ],
5238
+ "nullable": false,
5239
+ "required": false,
5240
+ "type": "string"
5241
+ },
5242
+ "signature_otp_failed_action": {
5243
+ "default": "DECLINE",
5244
+ "description": "Verdict after three invalid one-time codes.",
5245
+ "enum": [
5246
+ "DECLINE",
5247
+ "REVIEW",
5248
+ "NO_ACTION"
5249
+ ],
5250
+ "nullable": false,
5251
+ "required": false,
5252
+ "type": "string"
5253
+ },
5254
+ "signature_require_read_to_end": {
5255
+ "default": true,
5256
+ "nullable": false,
5257
+ "required": false,
5258
+ "type": "boolean"
5259
+ },
5260
+ "signature_signer": {
5261
+ "default": "verified_person",
5262
+ "enum": [
5263
+ "verified_person",
5264
+ "legal_representative",
5265
+ "key_people"
5266
+ ],
5267
+ "nullable": false,
5268
+ "required": false,
5269
+ "type": "string"
5270
+ },
5271
+ "status_rules": {
5272
+ "items": {
5273
+ "fields": {
5274
+ "field": {
5275
+ "nullable": false,
5276
+ "required": true,
5277
+ "type": "string"
5278
+ },
5279
+ "operator": {
5280
+ "enum": [
5281
+ "equals",
5282
+ "not_equals",
5283
+ "greater_than",
5284
+ "greater_than_or_equals",
5285
+ "less_than",
5286
+ "less_than_or_equals",
5287
+ "contains",
5288
+ "not_contains",
5289
+ "in",
5290
+ "not_in",
5291
+ "is_empty",
5292
+ "is_not_empty",
5293
+ "regex",
5294
+ "fuzzy_match"
5295
+ ],
5296
+ "nullable": false,
5297
+ "required": true,
5298
+ "type": "string"
5299
+ },
5300
+ "score": {
5301
+ "maximum": 100,
5302
+ "minimum": 0,
5303
+ "nullable": false,
5304
+ "required": false,
5305
+ "type": "number"
5306
+ },
5307
+ "status": {
5308
+ "enum": [
5309
+ "Approved",
5310
+ "Declined",
5311
+ "In Review",
5312
+ "No Action"
5313
+ ],
5314
+ "nullable": false,
5315
+ "required": true,
5316
+ "type": "string"
5317
+ },
5318
+ "value": {
5319
+ "nullable": true,
5320
+ "required": false,
5321
+ "type": "json"
5322
+ },
5323
+ "value_type": {
5324
+ "default": "literal",
5325
+ "enum": [
5326
+ "literal",
5327
+ "field",
5328
+ "list",
5329
+ "relative_date"
5330
+ ],
5331
+ "nullable": false,
5332
+ "required": false,
5333
+ "type": "string"
5334
+ }
5335
+ },
5336
+ "type": "object"
5337
+ },
5338
+ "nullable": false,
5339
+ "required": false,
5340
+ "type": "array"
5341
+ }
5342
+ },
5343
+ "serializer": "SignatureFeatureConfigSerializer"
4431
5344
  }
4432
5345
  },
4433
5346
  "schema_version": 1,