didit-sdk 1.0.0

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 (234) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +25 -0
  3. data/LICENSE +21 -0
  4. data/README.md +277 -0
  5. data/lib/didit/authentication/base64_url.rb +34 -0
  6. data/lib/didit/authentication/cache.rb +201 -0
  7. data/lib/didit/authentication/http.rb +150 -0
  8. data/lib/didit/authentication/issuer.rb +115 -0
  9. data/lib/didit/authentication/jws.rb +231 -0
  10. data/lib/didit/authentication/key_set.rb +89 -0
  11. data/lib/didit/authentication/pkce.rb +64 -0
  12. data/lib/didit/authentication/types.rb +175 -0
  13. data/lib/didit/authentication.rb +546 -0
  14. data/lib/didit/client.rb +211 -0
  15. data/lib/didit/errors.rb +153 -0
  16. data/lib/didit/file_part.rb +85 -0
  17. data/lib/didit/internal/config.rb +94 -0
  18. data/lib/didit/internal/errors.rb +83 -0
  19. data/lib/didit/internal/log.rb +41 -0
  20. data/lib/didit/internal/multipart.rb +60 -0
  21. data/lib/didit/internal/request.rb +322 -0
  22. data/lib/didit/internal/transport.rb +198 -0
  23. data/lib/didit/internal/util.rb +76 -0
  24. data/lib/didit/internal.rb +15 -0
  25. data/lib/didit/model.rb +199 -0
  26. data/lib/didit/page.rb +130 -0
  27. data/lib/didit/raw_response.rb +57 -0
  28. data/lib/didit/resource.rb +15 -0
  29. data/lib/didit/resources/account.rb +309 -0
  30. data/lib/didit/resources/address_validation.rb +73 -0
  31. data/lib/didit/resources/age_estimation.rb +110 -0
  32. data/lib/didit/resources/aml.rb +166 -0
  33. data/lib/didit/resources/aml_monitoring.rb +30 -0
  34. data/lib/didit/resources/analytics.rb +87 -0
  35. data/lib/didit/resources/bank.rb +65 -0
  36. data/lib/didit/resources/billing.rb +61 -0
  37. data/lib/didit/resources/biometric_templates.rb +234 -0
  38. data/lib/didit/resources/blocklist.rb +130 -0
  39. data/lib/didit/resources/business_sessions.rb +29 -0
  40. data/lib/didit/resources/businesses.rb +471 -0
  41. data/lib/didit/resources/cases.rb +2116 -0
  42. data/lib/didit/resources/customization.rb +153 -0
  43. data/lib/didit/resources/database_validation.rb +327 -0
  44. data/lib/didit/resources/document_ai.rb +145 -0
  45. data/lib/didit/resources/email.rb +254 -0
  46. data/lib/didit/resources/face_match.rb +103 -0
  47. data/lib/didit/resources/face_search.rb +103 -0
  48. data/lib/didit/resources/fraud_checks.rb +130 -0
  49. data/lib/didit/resources/id_verification.rb +163 -0
  50. data/lib/didit/resources/id_wallets.rb +1468 -0
  51. data/lib/didit/resources/investigator.rb +419 -0
  52. data/lib/didit/resources/ip.rb +68 -0
  53. data/lib/didit/resources/kyb.rb +256 -0
  54. data/lib/didit/resources/lists.rb +332 -0
  55. data/lib/didit/resources/monitoring_events.rb +466 -0
  56. data/lib/didit/resources/networks.rb +427 -0
  57. data/lib/didit/resources/passive_liveness.rb +103 -0
  58. data/lib/didit/resources/phone.rb +271 -0
  59. data/lib/didit/resources/pricing.rb +40 -0
  60. data/lib/didit/resources/proof_of_address.rb +167 -0
  61. data/lib/didit/resources/questionnaires.rb +170 -0
  62. data/lib/didit/resources/regulatory_reports.rb +314 -0
  63. data/lib/didit/resources/report_templates.rb +146 -0
  64. data/lib/didit/resources/sessions.rb +2820 -0
  65. data/lib/didit/resources/transactions.rb +981 -0
  66. data/lib/didit/resources/travel_rule.rb +1202 -0
  67. data/lib/didit/resources/users.rb +521 -0
  68. data/lib/didit/resources/wallet_screening.rb +190 -0
  69. data/lib/didit/resources/webhooks.rb +396 -0
  70. data/lib/didit/resources/workflows.rb +214 -0
  71. data/lib/didit/resources.rb +263 -0
  72. data/lib/didit/types/account.rb +11 -0
  73. data/lib/didit/types/account_components.rb +105 -0
  74. data/lib/didit/types/address_validation.rb +8 -0
  75. data/lib/didit/types/age_estimation.rb +89 -0
  76. data/lib/didit/types/aml.rb +193 -0
  77. data/lib/didit/types/aml_monitoring.rb +73 -0
  78. data/lib/didit/types/analytics.rb +62 -0
  79. data/lib/didit/types/bank.rb +8 -0
  80. data/lib/didit/types/billing.rb +18 -0
  81. data/lib/didit/types/biometric_templates.rb +292 -0
  82. data/lib/didit/types/blocklist.rb +31 -0
  83. data/lib/didit/types/businesses.rb +45 -0
  84. data/lib/didit/types/cases.rb +368 -0
  85. data/lib/didit/types/components.rb +12206 -0
  86. data/lib/didit/types/customization.rb +8 -0
  87. data/lib/didit/types/database_validation.rb +177 -0
  88. data/lib/didit/types/document_ai.rb +135 -0
  89. data/lib/didit/types/email.rb +116 -0
  90. data/lib/didit/types/face_match.rb +93 -0
  91. data/lib/didit/types/face_search.rb +129 -0
  92. data/lib/didit/types/fraud_checks.rb +8 -0
  93. data/lib/didit/types/id_verification.rb +231 -0
  94. data/lib/didit/types/id_wallets.rb +8 -0
  95. data/lib/didit/types/investigator.rb +221 -0
  96. data/lib/didit/types/ip.rb +8 -0
  97. data/lib/didit/types/kyb.rb +1391 -0
  98. data/lib/didit/types/lists.rb +111 -0
  99. data/lib/didit/types/monitoring_events.rb +235 -0
  100. data/lib/didit/types/networks.rb +120 -0
  101. data/lib/didit/types/passive_liveness.rb +95 -0
  102. data/lib/didit/types/phone.rb +69 -0
  103. data/lib/didit/types/proof_of_address.rb +166 -0
  104. data/lib/didit/types/questionnaires.rb +29 -0
  105. data/lib/didit/types/regulatory_reports.rb +100 -0
  106. data/lib/didit/types/report_templates.rb +41 -0
  107. data/lib/didit/types/sessions.rb +1441 -0
  108. data/lib/didit/types/transactions.rb +245 -0
  109. data/lib/didit/types/travel_rule.rb +168 -0
  110. data/lib/didit/types/users.rb +180 -0
  111. data/lib/didit/types/wallet_screening.rb +49 -0
  112. data/lib/didit/types/webhooks.rb +355 -0
  113. data/lib/didit/types/workflows.rb +32 -0
  114. data/lib/didit/types.rb +1681 -0
  115. data/lib/didit/version.rb +5 -0
  116. data/lib/didit/webhooks/canonical_json.rb +187 -0
  117. data/lib/didit/webhooks/client_methods.rb +23 -0
  118. data/lib/didit/webhooks/events.rb +221 -0
  119. data/lib/didit/webhooks/headers.rb +83 -0
  120. data/lib/didit/webhooks/verifier.rb +260 -0
  121. data/lib/didit/webhooks.rb +99 -0
  122. data/lib/didit-sdk.rb +4 -0
  123. data/lib/didit.rb +31 -0
  124. data/sig/didit/authentication/base64_url.rbs +10 -0
  125. data/sig/didit/authentication/cache.rbs +60 -0
  126. data/sig/didit/authentication/http.rbs +37 -0
  127. data/sig/didit/authentication/issuer.rbs +17 -0
  128. data/sig/didit/authentication/jws.rbs +41 -0
  129. data/sig/didit/authentication/jwt.rbs +14 -0
  130. data/sig/didit/authentication/key_set.rbs +25 -0
  131. data/sig/didit/authentication/pkce.rbs +20 -0
  132. data/sig/didit/authentication/types.rbs +114 -0
  133. data/sig/didit/authentication.rbs +81 -0
  134. data/sig/didit/client.rbs +61 -0
  135. data/sig/didit/errors.rbs +80 -0
  136. data/sig/didit/file_part.rbs +19 -0
  137. data/sig/didit/internal.rbs +199 -0
  138. data/sig/didit/model.rbs +42 -0
  139. data/sig/didit/page.rbs +34 -0
  140. data/sig/didit/raw_response.rbs +20 -0
  141. data/sig/didit/resource.rbs +8 -0
  142. data/sig/didit/resources/account.rbs +23 -0
  143. data/sig/didit/resources/address_validation.rbs +9 -0
  144. data/sig/didit/resources/age_estimation.rbs +9 -0
  145. data/sig/didit/resources/aml.rbs +10 -0
  146. data/sig/didit/resources/aml_monitoring.rbs +9 -0
  147. data/sig/didit/resources/analytics.rbs +9 -0
  148. data/sig/didit/resources/bank.rbs +9 -0
  149. data/sig/didit/resources/billing.rbs +10 -0
  150. data/sig/didit/resources/biometric_templates.rbs +13 -0
  151. data/sig/didit/resources/blocklist.rbs +11 -0
  152. data/sig/didit/resources/business_sessions.rbs +9 -0
  153. data/sig/didit/resources/businesses.rbs +22 -0
  154. data/sig/didit/resources/cases.rbs +103 -0
  155. data/sig/didit/resources/customization.rbs +10 -0
  156. data/sig/didit/resources/database_validation.rbs +9 -0
  157. data/sig/didit/resources/document_ai.rbs +9 -0
  158. data/sig/didit/resources/email.rbs +11 -0
  159. data/sig/didit/resources/face_match.rbs +9 -0
  160. data/sig/didit/resources/face_search.rbs +9 -0
  161. data/sig/didit/resources/fraud_checks.rbs +11 -0
  162. data/sig/didit/resources/id_verification.rbs +9 -0
  163. data/sig/didit/resources/id_wallets.rbs +37 -0
  164. data/sig/didit/resources/investigator.rbs +23 -0
  165. data/sig/didit/resources/ip.rbs +9 -0
  166. data/sig/didit/resources/kyb.rbs +12 -0
  167. data/sig/didit/resources/lists.rbs +20 -0
  168. data/sig/didit/resources/monitoring_events.rbs +16 -0
  169. data/sig/didit/resources/networks.rbs +25 -0
  170. data/sig/didit/resources/passive_liveness.rbs +9 -0
  171. data/sig/didit/resources/phone.rbs +11 -0
  172. data/sig/didit/resources/pricing.rbs +9 -0
  173. data/sig/didit/resources/proof_of_address.rbs +9 -0
  174. data/sig/didit/resources/questionnaires.rbs +13 -0
  175. data/sig/didit/resources/regulatory_reports.rbs +16 -0
  176. data/sig/didit/resources/report_templates.rbs +13 -0
  177. data/sig/didit/resources/sessions.rbs +78 -0
  178. data/sig/didit/resources/transactions.rbs +43 -0
  179. data/sig/didit/resources/travel_rule.rbs +62 -0
  180. data/sig/didit/resources/users.rbs +21 -0
  181. data/sig/didit/resources/wallet_screening.rbs +11 -0
  182. data/sig/didit/resources/webhooks.rbs +23 -0
  183. data/sig/didit/resources/workflows.rbs +13 -0
  184. data/sig/didit/resources.rbs +50 -0
  185. data/sig/didit/types/account.rbs +22 -0
  186. data/sig/didit/types/account_components.rbs +94 -0
  187. data/sig/didit/types/address_validation.rbs +7 -0
  188. data/sig/didit/types/age_estimation.rbs +80 -0
  189. data/sig/didit/types/aml.rbs +174 -0
  190. data/sig/didit/types/aml_monitoring.rbs +67 -0
  191. data/sig/didit/types/analytics.rbs +57 -0
  192. data/sig/didit/types/bank.rbs +9 -0
  193. data/sig/didit/types/billing.rbs +19 -0
  194. data/sig/didit/types/biometric_templates.rbs +268 -0
  195. data/sig/didit/types/blocklist.rbs +33 -0
  196. data/sig/didit/types/businesses.rbs +54 -0
  197. data/sig/didit/types/cases.rbs +414 -0
  198. data/sig/didit/types/components.rbs +10920 -0
  199. data/sig/didit/types/customization.rbs +7 -0
  200. data/sig/didit/types/database_validation.rbs +152 -0
  201. data/sig/didit/types/document_ai.rbs +123 -0
  202. data/sig/didit/types/email.rbs +112 -0
  203. data/sig/didit/types/face_match.rbs +86 -0
  204. data/sig/didit/types/face_search.rbs +112 -0
  205. data/sig/didit/types/fraud_checks.rbs +9 -0
  206. data/sig/didit/types/id_verification.rbs +196 -0
  207. data/sig/didit/types/id_wallets.rbs +55 -0
  208. data/sig/didit/types/investigator.rbs +212 -0
  209. data/sig/didit/types/ip.rbs +7 -0
  210. data/sig/didit/types/kyb.rbs +1254 -0
  211. data/sig/didit/types/lists.rbs +106 -0
  212. data/sig/didit/types/monitoring_events.rbs +234 -0
  213. data/sig/didit/types/networks.rbs +113 -0
  214. data/sig/didit/types/passive_liveness.rbs +87 -0
  215. data/sig/didit/types/phone.rbs +65 -0
  216. data/sig/didit/types/proof_of_address.rbs +144 -0
  217. data/sig/didit/types/questionnaires.rbs +30 -0
  218. data/sig/didit/types/regulatory_reports.rbs +101 -0
  219. data/sig/didit/types/report_templates.rbs +42 -0
  220. data/sig/didit/types/sessions.rbs +1349 -0
  221. data/sig/didit/types/transactions.rbs +273 -0
  222. data/sig/didit/types/travel_rule.rbs +188 -0
  223. data/sig/didit/types/users.rbs +181 -0
  224. data/sig/didit/types/wallet_screening.rbs +40 -0
  225. data/sig/didit/types/webhooks.rbs +311 -0
  226. data/sig/didit/types/workflows.rbs +30 -0
  227. data/sig/didit/webhooks/canonical_json.rbs +25 -0
  228. data/sig/didit/webhooks/client_methods.rbs +11 -0
  229. data/sig/didit/webhooks/events.rbs +125 -0
  230. data/sig/didit/webhooks/headers.rbs +22 -0
  231. data/sig/didit/webhooks/verifier.rbs +54 -0
  232. data/sig/didit/webhooks.rbs +37 -0
  233. data/sig/didit.rbs +20 -0
  234. metadata +300 -0
@@ -0,0 +1,1391 @@
1
+ # Code generated by codegen from openapi/*.json. DO NOT EDIT.
2
+ # frozen_string_literal: true
3
+
4
+ module Didit
5
+ module Types
6
+ # Whether the owner is a natural person or a corporate entity.
7
+ module KybListShareholdersResponse202KybRegistryBeneficialOwnersEntityType
8
+ PERSON = "person"
9
+ COMPANY = "company"
10
+
11
+ VALUES = [PERSON, COMPANY].freeze
12
+ end
13
+
14
+ # Known values of an open enum: the API may send others.
15
+ module KybListShareholdersResponse202KybRegistryBeneficialOwnersKycStatus
16
+ APPROVED = "Approved"
17
+ DECLINED = "Declined"
18
+ PENDING = "Pending"
19
+
20
+ VALUES = [APPROVED, DECLINED, PENDING].freeze
21
+ end
22
+
23
+ # Registry fetch lifecycle. Mirrored by `data_resolved`.
24
+ module KybListShareholdersResponse202KybRegistryFetchStatus
25
+ PENDING = "pending"
26
+ RESOLVED = "resolved"
27
+
28
+ VALUES = [PENDING, RESOLVED].freeze
29
+ end
30
+
31
+ # Status of an associated KYC session, when one was started for this officer. `null` otherwise.
32
+ module KybListShareholdersResponse202KybRegistryOfficersKycStatus
33
+ APPROVED = "Approved"
34
+ DECLINED = "Declined"
35
+ PENDING = "Pending"
36
+
37
+ VALUES = [APPROVED, DECLINED, PENDING].freeze
38
+ end
39
+
40
+ # Normalized role derived from the designation. Full 17-value model set; registry parsing on this endpoint
41
+ # typically emits director, non_executive_director, secretary, chairman, or company_officer.
42
+ module KybListShareholdersResponse202KybRegistryOfficersRole
43
+ DIRECTOR = "director"
44
+ NON_EXECUTIVE_DIRECTOR = "non_executive_director"
45
+ SECRETARY = "secretary"
46
+ CHAIRMAN = "chairman"
47
+ UBO = "ubo"
48
+ SHAREHOLDER = "shareholder"
49
+ REPRESENTATIVE = "representative"
50
+ FOUNDER = "founder"
51
+ LEGAL_ADVISOR = "legal_advisor"
52
+ AUTHORIZED_SIGNATORY = "authorized_signatory"
53
+ TRUSTEE = "trustee"
54
+ BENEFICIARY = "beneficiary"
55
+ COMPANY_OFFICER = "company_officer"
56
+ SETTLOR = "settlor"
57
+ PROTECTOR = "protector"
58
+ INVESTOR = "investor"
59
+ OTHER = "other"
60
+
61
+ VALUES = [DIRECTOR, NON_EXECUTIVE_DIRECTOR, SECRETARY, CHAIRMAN, UBO, SHAREHOLDER, REPRESENTATIVE, FOUNDER, LEGAL_ADVISOR, AUTHORIZED_SIGNATORY, TRUSTEE, BENEFICIARY, COMPANY_OFFICER, SETTLOR, PROTECTOR, INVESTOR, OTHER].freeze
62
+ end
63
+
64
+ # `delivered` when the ownership data came back, `not_held` when the ownership registry answered and does not list
65
+ # this company (see `registry_data.ownership_error`), `unavailable` when an ownership tier was requested but the
66
+ # registry had none for this company or could not be asked (see `registry_data.ownership_error`), `pending` when
67
+ # the ownership section has not been retrieved from the registry yet and Didit is still completing it,
68
+ # `not_requested` on the Lite tier.
69
+ module KybListShareholdersResponse202KybRegistryRegistryOwnershipStatus
70
+ NOT_REQUESTED = "not_requested"
71
+ DELIVERED = "delivered"
72
+ NOT_HELD = "not_held"
73
+ UNAVAILABLE = "unavailable"
74
+ PENDING = "pending"
75
+
76
+ VALUES = [NOT_REQUESTED, DELIVERED, NOT_HELD, UNAVAILABLE, PENDING].freeze
77
+ end
78
+
79
+ # Normalized company status as reported by the registry.
80
+ module KybListShareholdersResponse202KybRegistryRegistryStatus
81
+ ACTIVE = "active"
82
+ DISSOLVED = "dissolved"
83
+ DEREGISTERED = "deregistered"
84
+ SEE_FULL_DETAILS = "see full details"
85
+ AUTHORISED = "authorised"
86
+ APPOINTED_REPRESENTATIVE = "appointed representative"
87
+ UNAUTHORISED = "unauthorised"
88
+ INACTIVE = "inactive"
89
+ NO_LONGER_AUTHORISED = "no longer authorised"
90
+ CLOSED = "closed"
91
+ STRUCK_OFF = "struck off"
92
+
93
+ VALUES = [ACTIVE, DISSOLVED, DEREGISTERED, SEE_FULL_DETAILS, AUTHORISED, APPOINTED_REPRESENTATIVE, UNAUTHORISED, INACTIVE, NO_LONGER_AUTHORISED, CLOSED, STRUCK_OFF].freeze
94
+ end
95
+
96
+ # Same as the top-level `registry_tier_delivered`.
97
+ module KybListShareholdersResponse202KybRegistryRegistryTierDelivered
98
+ BASIC = "basic"
99
+ SHAREHOLDERS = "shareholders"
100
+ UBO = "ubo"
101
+
102
+ VALUES = [BASIC, SHAREHOLDERS, UBO].freeze
103
+ end
104
+
105
+ # Didit's assessment of the registry check (e.g. `In Review` when the company is not active in the registry or
106
+ # ownership data could not be derived).
107
+ module KybListShareholdersResponse202KybRegistryStatus
108
+ NOT_FINISHED = "Not Finished"
109
+ APPROVED = "Approved"
110
+ DECLINED = "Declined"
111
+ IN_REVIEW = "In Review"
112
+
113
+ VALUES = [NOT_FINISHED, APPROVED, DECLINED, IN_REVIEW].freeze
114
+ end
115
+
116
+ # The source that decided `vat_validation_status`: an official registry, or `format_rules`. `null` when no check
117
+ # ran.
118
+ module KybListShareholdersResponse202KybRegistryVatValidationSource
119
+ EU_VIES = "eu_vies"
120
+ PL_VAT_WHITE_LIST = "pl_vat_white_list"
121
+ NO_BRREG = "no_brreg"
122
+ CH_UID_REGISTER = "ch_uid_register"
123
+ BR_RECEITA_FEDERAL = "br_receita_federal"
124
+ CO_RUES = "co_rues"
125
+ CR_HACIENDA = "cr_hacienda"
126
+ EC_SRI = "ec_sri"
127
+ PY_DNIT = "py_dnit"
128
+ FORMAT_RULES = "format_rules"
129
+
130
+ VALUES = [EU_VIES, PL_VAT_WHITE_LIST, NO_BRREG, CH_UID_REGISTER, BR_RECEITA_FEDERAL, CO_RUES, CR_HACIENDA, EC_SRI, PY_DNIT, FORMAT_RULES].freeze
131
+ end
132
+
133
+ # Result of validating the VAT number or, when there is none, the `tax_number`, at registry submit. `valid` /
134
+ # `invalid`: decided by the official registry of the country (EU VIES, Norway, Switzerland, Brazil, Colombia,
135
+ # Costa Rica, Ecuador, Paraguay; Poland also by its domestic VAT register). `format_valid` / `invalid_format`:
136
+ # decided by the country's format and check-digit rules where no registry can be queried. `could_not_validate`:
137
+ # the registry was unavailable. `not_applicable`: no number, a country without registry or rules, or a sandbox
138
+ # session.
139
+ module KybListShareholdersResponse202KybRegistryVatValidationStatus
140
+ VALID = "valid"
141
+ INVALID = "invalid"
142
+ FORMAT_VALID = "format_valid"
143
+ INVALID_FORMAT = "invalid_format"
144
+ COULD_NOT_VALIDATE = "could_not_validate"
145
+ NOT_APPLICABLE = "not_applicable"
146
+
147
+ VALUES = [VALID, INVALID, FORMAT_VALID, INVALID_FORMAT, COULD_NOT_VALIDATE, NOT_APPLICABLE].freeze
148
+ end
149
+
150
+ # The tier actually delivered and billed. Lower than requested when the country's registries hold no ownership
151
+ # data, or the registry has no ownership record for this company.
152
+ module KybListShareholdersResponse202RegistryTierDelivered
153
+ BASIC = "basic"
154
+ SHAREHOLDERS = "shareholders"
155
+ UBO = "ubo"
156
+
157
+ VALUES = [BASIC, SHAREHOLDERS, UBO].freeze
158
+ end
159
+
160
+ # The tier this endpoint sells: `basic` (Lite) for select, `shareholders`, `ubo`.
161
+ module KybListShareholdersResponse202RegistryTierRequested
162
+ BASIC = "basic"
163
+ SHAREHOLDERS = "shareholders"
164
+ UBO = "ubo"
165
+
166
+ VALUES = [BASIC, SHAREHOLDERS, UBO].freeze
167
+ end
168
+
169
+ # Whether the owner is a natural person or a corporate entity.
170
+ module KybListShareholdersResponseKybRegistryBeneficialOwnersEntityType
171
+ PERSON = "person"
172
+ COMPANY = "company"
173
+
174
+ VALUES = [PERSON, COMPANY].freeze
175
+ end
176
+
177
+ # Known values of an open enum: the API may send others.
178
+ module KybListShareholdersResponseKybRegistryBeneficialOwnersKycStatus
179
+ APPROVED = "Approved"
180
+ DECLINED = "Declined"
181
+ PENDING = "Pending"
182
+
183
+ VALUES = [APPROVED, DECLINED, PENDING].freeze
184
+ end
185
+
186
+ # Registry fetch lifecycle. Mirrored by `data_resolved`.
187
+ module KybListShareholdersResponseKybRegistryFetchStatus
188
+ PENDING = "pending"
189
+ RESOLVED = "resolved"
190
+
191
+ VALUES = [PENDING, RESOLVED].freeze
192
+ end
193
+
194
+ # Status of an associated KYC session, when one was started for this officer. `null` otherwise.
195
+ module KybListShareholdersResponseKybRegistryOfficersKycStatus
196
+ APPROVED = "Approved"
197
+ DECLINED = "Declined"
198
+ PENDING = "Pending"
199
+
200
+ VALUES = [APPROVED, DECLINED, PENDING].freeze
201
+ end
202
+
203
+ # Normalized role derived from the designation. Full 17-value model set; registry parsing on this endpoint
204
+ # typically emits director, non_executive_director, secretary, chairman, or company_officer.
205
+ module KybListShareholdersResponseKybRegistryOfficersRole
206
+ DIRECTOR = "director"
207
+ NON_EXECUTIVE_DIRECTOR = "non_executive_director"
208
+ SECRETARY = "secretary"
209
+ CHAIRMAN = "chairman"
210
+ UBO = "ubo"
211
+ SHAREHOLDER = "shareholder"
212
+ REPRESENTATIVE = "representative"
213
+ FOUNDER = "founder"
214
+ LEGAL_ADVISOR = "legal_advisor"
215
+ AUTHORIZED_SIGNATORY = "authorized_signatory"
216
+ TRUSTEE = "trustee"
217
+ BENEFICIARY = "beneficiary"
218
+ COMPANY_OFFICER = "company_officer"
219
+ SETTLOR = "settlor"
220
+ PROTECTOR = "protector"
221
+ INVESTOR = "investor"
222
+ OTHER = "other"
223
+
224
+ VALUES = [DIRECTOR, NON_EXECUTIVE_DIRECTOR, SECRETARY, CHAIRMAN, UBO, SHAREHOLDER, REPRESENTATIVE, FOUNDER, LEGAL_ADVISOR, AUTHORIZED_SIGNATORY, TRUSTEE, BENEFICIARY, COMPANY_OFFICER, SETTLOR, PROTECTOR, INVESTOR, OTHER].freeze
225
+ end
226
+
227
+ # `delivered` when the ownership data came back, `not_held` when the ownership registry answered and does not list
228
+ # this company (see `registry_data.ownership_error`), `unavailable` when an ownership tier was requested but the
229
+ # registry had none for this company or could not be asked (see `registry_data.ownership_error`), `pending` when
230
+ # the ownership section has not been retrieved from the registry yet and Didit is still completing it,
231
+ # `not_requested` on the Lite tier.
232
+ module KybListShareholdersResponseKybRegistryRegistryOwnershipStatus
233
+ NOT_REQUESTED = "not_requested"
234
+ DELIVERED = "delivered"
235
+ NOT_HELD = "not_held"
236
+ UNAVAILABLE = "unavailable"
237
+ PENDING = "pending"
238
+
239
+ VALUES = [NOT_REQUESTED, DELIVERED, NOT_HELD, UNAVAILABLE, PENDING].freeze
240
+ end
241
+
242
+ # Normalized company status as reported by the registry.
243
+ module KybListShareholdersResponseKybRegistryRegistryStatus
244
+ ACTIVE = "active"
245
+ DISSOLVED = "dissolved"
246
+ DEREGISTERED = "deregistered"
247
+ SEE_FULL_DETAILS = "see full details"
248
+ AUTHORISED = "authorised"
249
+ APPOINTED_REPRESENTATIVE = "appointed representative"
250
+ UNAUTHORISED = "unauthorised"
251
+ INACTIVE = "inactive"
252
+ NO_LONGER_AUTHORISED = "no longer authorised"
253
+ CLOSED = "closed"
254
+ STRUCK_OFF = "struck off"
255
+
256
+ VALUES = [ACTIVE, DISSOLVED, DEREGISTERED, SEE_FULL_DETAILS, AUTHORISED, APPOINTED_REPRESENTATIVE, UNAUTHORISED, INACTIVE, NO_LONGER_AUTHORISED, CLOSED, STRUCK_OFF].freeze
257
+ end
258
+
259
+ # Same as the top-level `registry_tier_delivered`.
260
+ module KybListShareholdersResponseKybRegistryRegistryTierDelivered
261
+ BASIC = "basic"
262
+ SHAREHOLDERS = "shareholders"
263
+ UBO = "ubo"
264
+
265
+ VALUES = [BASIC, SHAREHOLDERS, UBO].freeze
266
+ end
267
+
268
+ # Didit's assessment of the registry check (e.g. `In Review` when the company is not active in the registry or
269
+ # ownership data could not be derived).
270
+ module KybListShareholdersResponseKybRegistryStatus
271
+ NOT_FINISHED = "Not Finished"
272
+ APPROVED = "Approved"
273
+ DECLINED = "Declined"
274
+ IN_REVIEW = "In Review"
275
+
276
+ VALUES = [NOT_FINISHED, APPROVED, DECLINED, IN_REVIEW].freeze
277
+ end
278
+
279
+ # The source that decided `vat_validation_status`: an official registry, or `format_rules`. `null` when no check
280
+ # ran.
281
+ module KybListShareholdersResponseKybRegistryVatValidationSource
282
+ EU_VIES = "eu_vies"
283
+ PL_VAT_WHITE_LIST = "pl_vat_white_list"
284
+ NO_BRREG = "no_brreg"
285
+ CH_UID_REGISTER = "ch_uid_register"
286
+ BR_RECEITA_FEDERAL = "br_receita_federal"
287
+ CO_RUES = "co_rues"
288
+ CR_HACIENDA = "cr_hacienda"
289
+ EC_SRI = "ec_sri"
290
+ PY_DNIT = "py_dnit"
291
+ FORMAT_RULES = "format_rules"
292
+
293
+ VALUES = [EU_VIES, PL_VAT_WHITE_LIST, NO_BRREG, CH_UID_REGISTER, BR_RECEITA_FEDERAL, CO_RUES, CR_HACIENDA, EC_SRI, PY_DNIT, FORMAT_RULES].freeze
294
+ end
295
+
296
+ # Result of validating the VAT number or, when there is none, the `tax_number`, at registry submit. `valid` /
297
+ # `invalid`: decided by the official registry of the country (EU VIES, Norway, Switzerland, Brazil, Colombia,
298
+ # Costa Rica, Ecuador, Paraguay; Poland also by its domestic VAT register). `format_valid` / `invalid_format`:
299
+ # decided by the country's format and check-digit rules where no registry can be queried. `could_not_validate`:
300
+ # the registry was unavailable. `not_applicable`: no number, a country without registry or rules, or a sandbox
301
+ # session.
302
+ module KybListShareholdersResponseKybRegistryVatValidationStatus
303
+ VALID = "valid"
304
+ INVALID = "invalid"
305
+ FORMAT_VALID = "format_valid"
306
+ INVALID_FORMAT = "invalid_format"
307
+ COULD_NOT_VALIDATE = "could_not_validate"
308
+ NOT_APPLICABLE = "not_applicable"
309
+
310
+ VALUES = [VALID, INVALID, FORMAT_VALID, INVALID_FORMAT, COULD_NOT_VALIDATE, NOT_APPLICABLE].freeze
311
+ end
312
+
313
+ # The tier actually delivered and billed. Lower than requested when the country's registries hold no ownership
314
+ # data, or the registry has no ownership record for this company.
315
+ module KybListShareholdersResponseRegistryTierDelivered
316
+ BASIC = "basic"
317
+ SHAREHOLDERS = "shareholders"
318
+ UBO = "ubo"
319
+
320
+ VALUES = [BASIC, SHAREHOLDERS, UBO].freeze
321
+ end
322
+
323
+ # The tier this endpoint sells: `basic` (Lite) for select, `shareholders`, `ubo`.
324
+ module KybListShareholdersResponseRegistryTierRequested
325
+ BASIC = "basic"
326
+ SHAREHOLDERS = "shareholders"
327
+ UBO = "ubo"
328
+
329
+ VALUES = [BASIC, SHAREHOLDERS, UBO].freeze
330
+ end
331
+
332
+ # Whether the owner is a natural person or a corporate entity.
333
+ module KybListUbosResponse202KybRegistryBeneficialOwnersEntityType
334
+ PERSON = "person"
335
+ COMPANY = "company"
336
+
337
+ VALUES = [PERSON, COMPANY].freeze
338
+ end
339
+
340
+ # Known values of an open enum: the API may send others.
341
+ module KybListUbosResponse202KybRegistryBeneficialOwnersKycStatus
342
+ APPROVED = "Approved"
343
+ DECLINED = "Declined"
344
+ PENDING = "Pending"
345
+
346
+ VALUES = [APPROVED, DECLINED, PENDING].freeze
347
+ end
348
+
349
+ # Registry fetch lifecycle. Mirrored by `data_resolved`.
350
+ module KybListUbosResponse202KybRegistryFetchStatus
351
+ PENDING = "pending"
352
+ RESOLVED = "resolved"
353
+
354
+ VALUES = [PENDING, RESOLVED].freeze
355
+ end
356
+
357
+ # Status of an associated KYC session, when one was started for this officer. `null` otherwise.
358
+ module KybListUbosResponse202KybRegistryOfficersKycStatus
359
+ APPROVED = "Approved"
360
+ DECLINED = "Declined"
361
+ PENDING = "Pending"
362
+
363
+ VALUES = [APPROVED, DECLINED, PENDING].freeze
364
+ end
365
+
366
+ # Normalized role derived from the designation. Full 17-value model set; registry parsing on this endpoint
367
+ # typically emits director, non_executive_director, secretary, chairman, or company_officer.
368
+ module KybListUbosResponse202KybRegistryOfficersRole
369
+ DIRECTOR = "director"
370
+ NON_EXECUTIVE_DIRECTOR = "non_executive_director"
371
+ SECRETARY = "secretary"
372
+ CHAIRMAN = "chairman"
373
+ UBO = "ubo"
374
+ SHAREHOLDER = "shareholder"
375
+ REPRESENTATIVE = "representative"
376
+ FOUNDER = "founder"
377
+ LEGAL_ADVISOR = "legal_advisor"
378
+ AUTHORIZED_SIGNATORY = "authorized_signatory"
379
+ TRUSTEE = "trustee"
380
+ BENEFICIARY = "beneficiary"
381
+ COMPANY_OFFICER = "company_officer"
382
+ SETTLOR = "settlor"
383
+ PROTECTOR = "protector"
384
+ INVESTOR = "investor"
385
+ OTHER = "other"
386
+
387
+ VALUES = [DIRECTOR, NON_EXECUTIVE_DIRECTOR, SECRETARY, CHAIRMAN, UBO, SHAREHOLDER, REPRESENTATIVE, FOUNDER, LEGAL_ADVISOR, AUTHORIZED_SIGNATORY, TRUSTEE, BENEFICIARY, COMPANY_OFFICER, SETTLOR, PROTECTOR, INVESTOR, OTHER].freeze
388
+ end
389
+
390
+ # `delivered` when the ownership data came back, `not_held` when the ownership registry answered and does not list
391
+ # this company (see `registry_data.ownership_error`), `unavailable` when an ownership tier was requested but the
392
+ # registry had none for this company or could not be asked (see `registry_data.ownership_error`), `pending` when
393
+ # the ownership section has not been retrieved from the registry yet and Didit is still completing it,
394
+ # `not_requested` on the Lite tier.
395
+ module KybListUbosResponse202KybRegistryRegistryOwnershipStatus
396
+ NOT_REQUESTED = "not_requested"
397
+ DELIVERED = "delivered"
398
+ NOT_HELD = "not_held"
399
+ UNAVAILABLE = "unavailable"
400
+ PENDING = "pending"
401
+
402
+ VALUES = [NOT_REQUESTED, DELIVERED, NOT_HELD, UNAVAILABLE, PENDING].freeze
403
+ end
404
+
405
+ # Normalized company status as reported by the registry.
406
+ module KybListUbosResponse202KybRegistryRegistryStatus
407
+ ACTIVE = "active"
408
+ DISSOLVED = "dissolved"
409
+ DEREGISTERED = "deregistered"
410
+ SEE_FULL_DETAILS = "see full details"
411
+ AUTHORISED = "authorised"
412
+ APPOINTED_REPRESENTATIVE = "appointed representative"
413
+ UNAUTHORISED = "unauthorised"
414
+ INACTIVE = "inactive"
415
+ NO_LONGER_AUTHORISED = "no longer authorised"
416
+ CLOSED = "closed"
417
+ STRUCK_OFF = "struck off"
418
+
419
+ VALUES = [ACTIVE, DISSOLVED, DEREGISTERED, SEE_FULL_DETAILS, AUTHORISED, APPOINTED_REPRESENTATIVE, UNAUTHORISED, INACTIVE, NO_LONGER_AUTHORISED, CLOSED, STRUCK_OFF].freeze
420
+ end
421
+
422
+ # Same as the top-level `registry_tier_delivered`.
423
+ module KybListUbosResponse202KybRegistryRegistryTierDelivered
424
+ BASIC = "basic"
425
+ SHAREHOLDERS = "shareholders"
426
+ UBO = "ubo"
427
+
428
+ VALUES = [BASIC, SHAREHOLDERS, UBO].freeze
429
+ end
430
+
431
+ # Didit's assessment of the registry check (e.g. `In Review` when the company is not active in the registry or
432
+ # ownership data could not be derived).
433
+ module KybListUbosResponse202KybRegistryStatus
434
+ NOT_FINISHED = "Not Finished"
435
+ APPROVED = "Approved"
436
+ DECLINED = "Declined"
437
+ IN_REVIEW = "In Review"
438
+
439
+ VALUES = [NOT_FINISHED, APPROVED, DECLINED, IN_REVIEW].freeze
440
+ end
441
+
442
+ # The source that decided `vat_validation_status`: an official registry, or `format_rules`. `null` when no check
443
+ # ran.
444
+ module KybListUbosResponse202KybRegistryVatValidationSource
445
+ EU_VIES = "eu_vies"
446
+ PL_VAT_WHITE_LIST = "pl_vat_white_list"
447
+ NO_BRREG = "no_brreg"
448
+ CH_UID_REGISTER = "ch_uid_register"
449
+ BR_RECEITA_FEDERAL = "br_receita_federal"
450
+ CO_RUES = "co_rues"
451
+ CR_HACIENDA = "cr_hacienda"
452
+ EC_SRI = "ec_sri"
453
+ PY_DNIT = "py_dnit"
454
+ FORMAT_RULES = "format_rules"
455
+
456
+ VALUES = [EU_VIES, PL_VAT_WHITE_LIST, NO_BRREG, CH_UID_REGISTER, BR_RECEITA_FEDERAL, CO_RUES, CR_HACIENDA, EC_SRI, PY_DNIT, FORMAT_RULES].freeze
457
+ end
458
+
459
+ # Result of validating the VAT number or, when there is none, the `tax_number`, at registry submit. `valid` /
460
+ # `invalid`: decided by the official registry of the country (EU VIES, Norway, Switzerland, Brazil, Colombia,
461
+ # Costa Rica, Ecuador, Paraguay; Poland also by its domestic VAT register). `format_valid` / `invalid_format`:
462
+ # decided by the country's format and check-digit rules where no registry can be queried. `could_not_validate`:
463
+ # the registry was unavailable. `not_applicable`: no number, a country without registry or rules, or a sandbox
464
+ # session.
465
+ module KybListUbosResponse202KybRegistryVatValidationStatus
466
+ VALID = "valid"
467
+ INVALID = "invalid"
468
+ FORMAT_VALID = "format_valid"
469
+ INVALID_FORMAT = "invalid_format"
470
+ COULD_NOT_VALIDATE = "could_not_validate"
471
+ NOT_APPLICABLE = "not_applicable"
472
+
473
+ VALUES = [VALID, INVALID, FORMAT_VALID, INVALID_FORMAT, COULD_NOT_VALIDATE, NOT_APPLICABLE].freeze
474
+ end
475
+
476
+ # The tier actually delivered and billed. Lower than requested when the country's registries hold no ownership
477
+ # data, when the registry has no ownership record for this company, or when the resolved report of a `ubo` request
478
+ # names no natural person as a beneficial owner.
479
+ module KybListUbosResponse202RegistryTierDelivered
480
+ BASIC = "basic"
481
+ SHAREHOLDERS = "shareholders"
482
+ UBO = "ubo"
483
+
484
+ VALUES = [BASIC, SHAREHOLDERS, UBO].freeze
485
+ end
486
+
487
+ # The tier this endpoint sells: `basic` (Lite) for select, `shareholders`, `ubo`.
488
+ module KybListUbosResponse202RegistryTierRequested
489
+ BASIC = "basic"
490
+ SHAREHOLDERS = "shareholders"
491
+ UBO = "ubo"
492
+
493
+ VALUES = [BASIC, SHAREHOLDERS, UBO].freeze
494
+ end
495
+
496
+ # Whether the owner is a natural person or a corporate entity.
497
+ module KybListUbosResponseKybRegistryBeneficialOwnersEntityType
498
+ PERSON = "person"
499
+ COMPANY = "company"
500
+
501
+ VALUES = [PERSON, COMPANY].freeze
502
+ end
503
+
504
+ # Known values of an open enum: the API may send others.
505
+ module KybListUbosResponseKybRegistryBeneficialOwnersKycStatus
506
+ APPROVED = "Approved"
507
+ DECLINED = "Declined"
508
+ PENDING = "Pending"
509
+
510
+ VALUES = [APPROVED, DECLINED, PENDING].freeze
511
+ end
512
+
513
+ # Registry fetch lifecycle. Mirrored by `data_resolved`.
514
+ module KybListUbosResponseKybRegistryFetchStatus
515
+ PENDING = "pending"
516
+ RESOLVED = "resolved"
517
+
518
+ VALUES = [PENDING, RESOLVED].freeze
519
+ end
520
+
521
+ # Status of an associated KYC session, when one was started for this officer. `null` otherwise.
522
+ module KybListUbosResponseKybRegistryOfficersKycStatus
523
+ APPROVED = "Approved"
524
+ DECLINED = "Declined"
525
+ PENDING = "Pending"
526
+
527
+ VALUES = [APPROVED, DECLINED, PENDING].freeze
528
+ end
529
+
530
+ # Normalized role derived from the designation. Full 17-value model set; registry parsing on this endpoint
531
+ # typically emits director, non_executive_director, secretary, chairman, or company_officer.
532
+ module KybListUbosResponseKybRegistryOfficersRole
533
+ DIRECTOR = "director"
534
+ NON_EXECUTIVE_DIRECTOR = "non_executive_director"
535
+ SECRETARY = "secretary"
536
+ CHAIRMAN = "chairman"
537
+ UBO = "ubo"
538
+ SHAREHOLDER = "shareholder"
539
+ REPRESENTATIVE = "representative"
540
+ FOUNDER = "founder"
541
+ LEGAL_ADVISOR = "legal_advisor"
542
+ AUTHORIZED_SIGNATORY = "authorized_signatory"
543
+ TRUSTEE = "trustee"
544
+ BENEFICIARY = "beneficiary"
545
+ COMPANY_OFFICER = "company_officer"
546
+ SETTLOR = "settlor"
547
+ PROTECTOR = "protector"
548
+ INVESTOR = "investor"
549
+ OTHER = "other"
550
+
551
+ VALUES = [DIRECTOR, NON_EXECUTIVE_DIRECTOR, SECRETARY, CHAIRMAN, UBO, SHAREHOLDER, REPRESENTATIVE, FOUNDER, LEGAL_ADVISOR, AUTHORIZED_SIGNATORY, TRUSTEE, BENEFICIARY, COMPANY_OFFICER, SETTLOR, PROTECTOR, INVESTOR, OTHER].freeze
552
+ end
553
+
554
+ # `delivered` when the ownership data came back, `not_held` when the ownership registry answered and does not list
555
+ # this company (see `registry_data.ownership_error`), `unavailable` when an ownership tier was requested but the
556
+ # registry had none for this company or could not be asked (see `registry_data.ownership_error`), `pending` when
557
+ # the ownership section has not been retrieved from the registry yet and Didit is still completing it,
558
+ # `not_requested` on the Lite tier.
559
+ module KybListUbosResponseKybRegistryRegistryOwnershipStatus
560
+ NOT_REQUESTED = "not_requested"
561
+ DELIVERED = "delivered"
562
+ NOT_HELD = "not_held"
563
+ UNAVAILABLE = "unavailable"
564
+ PENDING = "pending"
565
+
566
+ VALUES = [NOT_REQUESTED, DELIVERED, NOT_HELD, UNAVAILABLE, PENDING].freeze
567
+ end
568
+
569
+ # Normalized company status as reported by the registry.
570
+ module KybListUbosResponseKybRegistryRegistryStatus
571
+ ACTIVE = "active"
572
+ DISSOLVED = "dissolved"
573
+ DEREGISTERED = "deregistered"
574
+ SEE_FULL_DETAILS = "see full details"
575
+ AUTHORISED = "authorised"
576
+ APPOINTED_REPRESENTATIVE = "appointed representative"
577
+ UNAUTHORISED = "unauthorised"
578
+ INACTIVE = "inactive"
579
+ NO_LONGER_AUTHORISED = "no longer authorised"
580
+ CLOSED = "closed"
581
+ STRUCK_OFF = "struck off"
582
+
583
+ VALUES = [ACTIVE, DISSOLVED, DEREGISTERED, SEE_FULL_DETAILS, AUTHORISED, APPOINTED_REPRESENTATIVE, UNAUTHORISED, INACTIVE, NO_LONGER_AUTHORISED, CLOSED, STRUCK_OFF].freeze
584
+ end
585
+
586
+ # Same as the top-level `registry_tier_delivered`.
587
+ module KybListUbosResponseKybRegistryRegistryTierDelivered
588
+ BASIC = "basic"
589
+ SHAREHOLDERS = "shareholders"
590
+ UBO = "ubo"
591
+
592
+ VALUES = [BASIC, SHAREHOLDERS, UBO].freeze
593
+ end
594
+
595
+ # Didit's assessment of the registry check (e.g. `In Review` when the company is not active in the registry or
596
+ # ownership data could not be derived).
597
+ module KybListUbosResponseKybRegistryStatus
598
+ NOT_FINISHED = "Not Finished"
599
+ APPROVED = "Approved"
600
+ DECLINED = "Declined"
601
+ IN_REVIEW = "In Review"
602
+
603
+ VALUES = [NOT_FINISHED, APPROVED, DECLINED, IN_REVIEW].freeze
604
+ end
605
+
606
+ # The source that decided `vat_validation_status`: an official registry, or `format_rules`. `null` when no check
607
+ # ran.
608
+ module KybListUbosResponseKybRegistryVatValidationSource
609
+ EU_VIES = "eu_vies"
610
+ PL_VAT_WHITE_LIST = "pl_vat_white_list"
611
+ NO_BRREG = "no_brreg"
612
+ CH_UID_REGISTER = "ch_uid_register"
613
+ BR_RECEITA_FEDERAL = "br_receita_federal"
614
+ CO_RUES = "co_rues"
615
+ CR_HACIENDA = "cr_hacienda"
616
+ EC_SRI = "ec_sri"
617
+ PY_DNIT = "py_dnit"
618
+ FORMAT_RULES = "format_rules"
619
+
620
+ VALUES = [EU_VIES, PL_VAT_WHITE_LIST, NO_BRREG, CH_UID_REGISTER, BR_RECEITA_FEDERAL, CO_RUES, CR_HACIENDA, EC_SRI, PY_DNIT, FORMAT_RULES].freeze
621
+ end
622
+
623
+ # Result of validating the VAT number or, when there is none, the `tax_number`, at registry submit. `valid` /
624
+ # `invalid`: decided by the official registry of the country (EU VIES, Norway, Switzerland, Brazil, Colombia,
625
+ # Costa Rica, Ecuador, Paraguay; Poland also by its domestic VAT register). `format_valid` / `invalid_format`:
626
+ # decided by the country's format and check-digit rules where no registry can be queried. `could_not_validate`:
627
+ # the registry was unavailable. `not_applicable`: no number, a country without registry or rules, or a sandbox
628
+ # session.
629
+ module KybListUbosResponseKybRegistryVatValidationStatus
630
+ VALID = "valid"
631
+ INVALID = "invalid"
632
+ FORMAT_VALID = "format_valid"
633
+ INVALID_FORMAT = "invalid_format"
634
+ COULD_NOT_VALIDATE = "could_not_validate"
635
+ NOT_APPLICABLE = "not_applicable"
636
+
637
+ VALUES = [VALID, INVALID, FORMAT_VALID, INVALID_FORMAT, COULD_NOT_VALIDATE, NOT_APPLICABLE].freeze
638
+ end
639
+
640
+ # The tier actually delivered and billed. Lower than requested when the country's registries hold no ownership
641
+ # data, when the registry has no ownership record for this company, or when the resolved report of a `ubo` request
642
+ # names no natural person as a beneficial owner.
643
+ module KybListUbosResponseRegistryTierDelivered
644
+ BASIC = "basic"
645
+ SHAREHOLDERS = "shareholders"
646
+ UBO = "ubo"
647
+
648
+ VALUES = [BASIC, SHAREHOLDERS, UBO].freeze
649
+ end
650
+
651
+ # The tier this endpoint sells: `basic` (Lite) for select, `shareholders`, `ubo`.
652
+ module KybListUbosResponseRegistryTierRequested
653
+ BASIC = "basic"
654
+ SHAREHOLDERS = "shareholders"
655
+ UBO = "ubo"
656
+
657
+ VALUES = [BASIC, SHAREHOLDERS, UBO].freeze
658
+ end
659
+
660
+ # Name-matching strategy applied by the registry search. `contains` is the only accepted value: no registry source
661
+ # behind the search offers a prefix or fuzzy mode, so `start_with` and `fuzzy` are rejected with `400` (`not a
662
+ # valid choice`).
663
+ module KybSearchParamsSearchType
664
+ CONTAINS = "contains"
665
+
666
+ VALUES = [CONTAINS].freeze
667
+ end
668
+
669
+ # Registry tier whose provider chain this search runs on. `basic` (default) searches the country's Lite chain;
670
+ # `shareholders` and `ubo` search that tier's ownership chain, which can be a different source, so an empty Lite
671
+ # search does not prove the registry lacks the company. A country that does not offer the named tier is searched
672
+ # at the highest tier it offers up to that one. Retrieve the candidate from the endpoint that sells the tier you
673
+ # searched: `POST /v3/kyb/select/` (Lite), `POST /v3/kyb/shareholders/` or `POST /v3/kyb/ubo/`.
674
+ module KybSearchParamsTier
675
+ BASIC = "basic"
676
+ SHAREHOLDERS = "shareholders"
677
+ UBO = "ubo"
678
+
679
+ VALUES = [BASIC, SHAREHOLDERS, UBO].freeze
680
+ end
681
+
682
+ # Whether the owner is a natural person or a corporate entity.
683
+ module KybSelectResponseKybRegistryBeneficialOwnersEntityType
684
+ PERSON = "person"
685
+ COMPANY = "company"
686
+
687
+ VALUES = [PERSON, COMPANY].freeze
688
+ end
689
+
690
+ # Known values of an open enum: the API may send others.
691
+ module KybSelectResponseKybRegistryBeneficialOwnersKycStatus
692
+ APPROVED = "Approved"
693
+ DECLINED = "Declined"
694
+ PENDING = "Pending"
695
+
696
+ VALUES = [APPROVED, DECLINED, PENDING].freeze
697
+ end
698
+
699
+ # Registry fetch lifecycle. Mirrored by `data_resolved`.
700
+ module KybSelectResponseKybRegistryFetchStatus
701
+ PENDING = "pending"
702
+ RESOLVED = "resolved"
703
+
704
+ VALUES = [PENDING, RESOLVED].freeze
705
+ end
706
+
707
+ # Status of an associated KYC session, when one was started for this officer. `null` otherwise.
708
+ module KybSelectResponseKybRegistryOfficersKycStatus
709
+ APPROVED = "Approved"
710
+ DECLINED = "Declined"
711
+ PENDING = "Pending"
712
+
713
+ VALUES = [APPROVED, DECLINED, PENDING].freeze
714
+ end
715
+
716
+ # Normalized role derived from the designation. Full 17-value model set; registry parsing on this endpoint
717
+ # typically emits director, non_executive_director, secretary, chairman, or company_officer.
718
+ module KybSelectResponseKybRegistryOfficersRole
719
+ DIRECTOR = "director"
720
+ NON_EXECUTIVE_DIRECTOR = "non_executive_director"
721
+ SECRETARY = "secretary"
722
+ CHAIRMAN = "chairman"
723
+ UBO = "ubo"
724
+ SHAREHOLDER = "shareholder"
725
+ REPRESENTATIVE = "representative"
726
+ FOUNDER = "founder"
727
+ LEGAL_ADVISOR = "legal_advisor"
728
+ AUTHORIZED_SIGNATORY = "authorized_signatory"
729
+ TRUSTEE = "trustee"
730
+ BENEFICIARY = "beneficiary"
731
+ COMPANY_OFFICER = "company_officer"
732
+ SETTLOR = "settlor"
733
+ PROTECTOR = "protector"
734
+ INVESTOR = "investor"
735
+ OTHER = "other"
736
+
737
+ VALUES = [DIRECTOR, NON_EXECUTIVE_DIRECTOR, SECRETARY, CHAIRMAN, UBO, SHAREHOLDER, REPRESENTATIVE, FOUNDER, LEGAL_ADVISOR, AUTHORIZED_SIGNATORY, TRUSTEE, BENEFICIARY, COMPANY_OFFICER, SETTLOR, PROTECTOR, INVESTOR, OTHER].freeze
738
+ end
739
+
740
+ # `delivered` when the ownership data came back, `not_held` when the ownership registry answered and does not list
741
+ # this company (see `registry_data.ownership_error`), `unavailable` when an ownership tier was requested but the
742
+ # registry had none for this company or could not be asked (see `registry_data.ownership_error`), `not_requested`
743
+ # on the Lite tier.
744
+ module KybSelectResponseKybRegistryRegistryOwnershipStatus
745
+ NOT_REQUESTED = "not_requested"
746
+ DELIVERED = "delivered"
747
+ NOT_HELD = "not_held"
748
+ UNAVAILABLE = "unavailable"
749
+
750
+ VALUES = [NOT_REQUESTED, DELIVERED, NOT_HELD, UNAVAILABLE].freeze
751
+ end
752
+
753
+ # Normalized company status as reported by the registry.
754
+ module KybSelectResponseKybRegistryRegistryStatus
755
+ ACTIVE = "active"
756
+ DISSOLVED = "dissolved"
757
+ DEREGISTERED = "deregistered"
758
+ SEE_FULL_DETAILS = "see full details"
759
+ AUTHORISED = "authorised"
760
+ APPOINTED_REPRESENTATIVE = "appointed representative"
761
+ UNAUTHORISED = "unauthorised"
762
+ INACTIVE = "inactive"
763
+ NO_LONGER_AUTHORISED = "no longer authorised"
764
+ CLOSED = "closed"
765
+ STRUCK_OFF = "struck off"
766
+
767
+ VALUES = [ACTIVE, DISSOLVED, DEREGISTERED, SEE_FULL_DETAILS, AUTHORISED, APPOINTED_REPRESENTATIVE, UNAUTHORISED, INACTIVE, NO_LONGER_AUTHORISED, CLOSED, STRUCK_OFF].freeze
768
+ end
769
+
770
+ # Same as the top-level `registry_tier_delivered`.
771
+ module KybSelectResponseKybRegistryRegistryTierDelivered
772
+ BASIC = "basic"
773
+ SHAREHOLDERS = "shareholders"
774
+ UBO = "ubo"
775
+
776
+ VALUES = [BASIC, SHAREHOLDERS, UBO].freeze
777
+ end
778
+
779
+ # Didit's assessment of the registry check (e.g. `In Review` when the company is not active in the registry or
780
+ # ownership data could not be derived).
781
+ module KybSelectResponseKybRegistryStatus
782
+ NOT_FINISHED = "Not Finished"
783
+ APPROVED = "Approved"
784
+ DECLINED = "Declined"
785
+ IN_REVIEW = "In Review"
786
+
787
+ VALUES = [NOT_FINISHED, APPROVED, DECLINED, IN_REVIEW].freeze
788
+ end
789
+
790
+ # The source that decided `vat_validation_status`: an official registry, or `format_rules`. `null` when no check
791
+ # ran.
792
+ module KybSelectResponseKybRegistryVatValidationSource
793
+ EU_VIES = "eu_vies"
794
+ PL_VAT_WHITE_LIST = "pl_vat_white_list"
795
+ NO_BRREG = "no_brreg"
796
+ CH_UID_REGISTER = "ch_uid_register"
797
+ BR_RECEITA_FEDERAL = "br_receita_federal"
798
+ CO_RUES = "co_rues"
799
+ CR_HACIENDA = "cr_hacienda"
800
+ EC_SRI = "ec_sri"
801
+ PY_DNIT = "py_dnit"
802
+ FORMAT_RULES = "format_rules"
803
+
804
+ VALUES = [EU_VIES, PL_VAT_WHITE_LIST, NO_BRREG, CH_UID_REGISTER, BR_RECEITA_FEDERAL, CO_RUES, CR_HACIENDA, EC_SRI, PY_DNIT, FORMAT_RULES].freeze
805
+ end
806
+
807
+ # Result of validating the VAT number or, when there is none, the `tax_number`, at registry submit. `valid` /
808
+ # `invalid`: decided by the official registry of the country (EU VIES, Norway, Switzerland, Brazil, Colombia,
809
+ # Costa Rica, Ecuador, Paraguay; Poland also by its domestic VAT register). `format_valid` / `invalid_format`:
810
+ # decided by the country's format and check-digit rules where no registry can be queried. `could_not_validate`:
811
+ # the registry was unavailable. `not_applicable`: no number, a country without registry or rules, or a sandbox
812
+ # session.
813
+ module KybSelectResponseKybRegistryVatValidationStatus
814
+ VALID = "valid"
815
+ INVALID = "invalid"
816
+ FORMAT_VALID = "format_valid"
817
+ INVALID_FORMAT = "invalid_format"
818
+ COULD_NOT_VALIDATE = "could_not_validate"
819
+ NOT_APPLICABLE = "not_applicable"
820
+
821
+ VALUES = [VALID, INVALID, FORMAT_VALID, INVALID_FORMAT, COULD_NOT_VALIDATE, NOT_APPLICABLE].freeze
822
+ end
823
+
824
+ # The tier actually delivered and billed. Lower than requested when the country's registries hold no ownership
825
+ # data, or the registry has no ownership record for this company.
826
+ module KybSelectResponseRegistryTierDelivered
827
+ BASIC = "basic"
828
+ SHAREHOLDERS = "shareholders"
829
+ UBO = "ubo"
830
+
831
+ VALUES = [BASIC, SHAREHOLDERS, UBO].freeze
832
+ end
833
+
834
+ # The tier this endpoint sells: `basic` (Lite) for select, `shareholders`, `ubo`.
835
+ module KybSelectResponseRegistryTierRequested
836
+ BASIC = "basic"
837
+ SHAREHOLDERS = "shareholders"
838
+ UBO = "ubo"
839
+
840
+ VALUES = [BASIC, SHAREHOLDERS, UBO].freeze
841
+ end
842
+
843
+ class KybListShareholdersResponse < Didit::Model
844
+ field :request_id, "request_id", :string
845
+ field :registry_tier_requested, "registry_tier_requested", :string
846
+ field :registry_tier_delivered, "registry_tier_delivered", :string
847
+ field :kyb_registry, "kyb_registry", "KybListShareholdersResponseKybRegistry"
848
+ field :vendor_data, "vendor_data", :string
849
+ field :metadata, "metadata", :any
850
+ field :created_at, "created_at", :datetime
851
+ end
852
+
853
+ class KybListShareholdersResponse202 < Didit::Model
854
+ field :request_id, "request_id", :string
855
+ field :registry_tier_requested, "registry_tier_requested", :string
856
+ field :registry_tier_delivered, "registry_tier_delivered", :string
857
+ field :kyb_registry, "kyb_registry", "KybListShareholdersResponse202KybRegistry"
858
+ field :vendor_data, "vendor_data", :string
859
+ field :metadata, "metadata", :any
860
+ field :created_at, "created_at", :datetime
861
+ end
862
+
863
+ # Full registry company profile.
864
+ class KybListShareholdersResponse202KybRegistry < Didit::Model
865
+ field :uuid, "uuid", :string
866
+ field :node_id, "node_id", :string
867
+ field :status, "status", :string
868
+ field :registry_status, "registry_status", :string
869
+ field :data_resolved, "data_resolved", :boolean
870
+ field :company_name, "company_name", :string
871
+ field :registration_number, "registration_number", :string
872
+ field :country_code, "country_code", :string
873
+ field :region, "region", :string
874
+ field :company_type, "company_type", :string
875
+ field :incorporation_date, "incorporation_date", :date
876
+ field :registered_address, "registered_address", :string
877
+ field :tax_number, "tax_number", :string
878
+ field :risk_level, "risk_level", :string
879
+ field :verification_status, "verification_status", :string
880
+ field :is_from_registry, "is_from_registry", :boolean
881
+ field :fetch_status, "fetch_status", :string
882
+ field :alternative_names, "alternative_names", :string
883
+ field :nature_of_business, "nature_of_business", :string
884
+ field :registered_capital, "registered_capital", :string
885
+ field :registered_capital_amount, "registered_capital_amount", :string
886
+ field :registered_capital_currency, "registered_capital_currency", :string
887
+ field :website, "website", :string
888
+ field :email, "email", :string
889
+ field :phone, "phone", :string
890
+ field :legal_entity_identifier, "legal_entity_identifier", :string
891
+ field :location_of_registration, "location_of_registration", :string
892
+ field :vat_number, "vat_number", :string
893
+ field :vat_validation_status, "vat_validation_status", :string
894
+ field :vat_validated_number, "vat_validated_number", :string
895
+ field :vat_validation_source, "vat_validation_source", :string
896
+ field :vat_validated_name, "vat_validated_name", :string
897
+ field :vat_validated_address, "vat_validated_address", :string
898
+ field :vat_checked_at, "vat_checked_at", :datetime
899
+ field :financial_summary, "financial_summary", :any
900
+ field :officers, "officers", [:array, "KybListShareholdersResponse202KybRegistryOfficers"]
901
+ field :beneficial_owners, "beneficial_owners", [:array, "KybListShareholdersResponse202KybRegistryBeneficialOwners"]
902
+ field :addresses, "addresses", [:array, "KYBRegistryAddress"]
903
+ field :industries, "industries", [:array, "KYBRegistryIndustry"]
904
+ field :accounts, "accounts", :any
905
+ field :registry_data, "registry_data", :any
906
+ field :user_provided_data, "user_provided_data", :any
907
+ field :confirmed_by_user_at, "confirmed_by_user_at", :datetime
908
+ field :last_console_edit_at, "last_console_edit_at", :datetime
909
+ field :is_editable, "is_editable", :boolean
910
+ field :registry_tier_delivered, "registry_tier_delivered", :string
911
+ field :registry_ownership_status, "registry_ownership_status", :string
912
+ field :ownership, "ownership", "KYBRegistryOwnership"
913
+ field :registry_tier, "registry_tier", :string
914
+ end
915
+
916
+ class KybListShareholdersResponse202KybRegistryBeneficialOwners < Didit::Model
917
+ field :uuid, "uuid", :string
918
+ field :name, "name", :string
919
+ field :first_name, "first_name", :string
920
+ field :last_name, "last_name", :string
921
+ field :entity_type, "entity_type", :string
922
+ field :roles, "roles", [:array, :string]
923
+ field :ownership_min_shares, "ownership_min_shares", :string
924
+ field :ownership_max_shares, "ownership_max_shares", :string
925
+ field :is_active, "is_active", :boolean
926
+ field :kyc_status, "kyc_status", :string
927
+ field :kyc_session_url, "kyc_session_url", :string
928
+ field :effective_ownership_percent, "effective_ownership_percent", :float
929
+ field :company_name, "company_name", :string
930
+ field :registration_number, "registration_number", :string
931
+ field :country_of_birth, "country_of_birth", :string
932
+ field :email, "email", :string
933
+ field :nationality, "nationality", :string
934
+ field :designation, "designation", :string
935
+ field :voting_min_shares, "voting_min_shares", :string
936
+ field :voting_max_shares, "voting_max_shares", :string
937
+ field :date_of_birth, "date_of_birth", :date
938
+ field :appointment_date, "appointment_date", :date
939
+ field :shareholding, "shareholding", "KYBRegistryShareholding"
940
+ end
941
+
942
+ class KybListShareholdersResponse202KybRegistryOfficers < Didit::Model
943
+ field :uuid, "uuid", :string
944
+ field :name, "name", :string
945
+ field :designation, "designation", :string
946
+ field :role, "role", :string
947
+ field :nationality, "nationality", :string
948
+ field :is_active, "is_active", :boolean
949
+ field :kyc_status, "kyc_status", :string
950
+ field :kyc_session_url, "kyc_session_url", :string
951
+ field :first_name, "first_name", :string
952
+ field :last_name, "last_name", :string
953
+ field :address, "address", :string
954
+ field :appointment_date, "appointment_date", :date
955
+ field :termination_date, "termination_date", :date
956
+ field :date_of_birth, "date_of_birth", :date
957
+ field :date_of_birth_year, "date_of_birth_year", :integer
958
+ field :date_of_birth_month, "date_of_birth_month", :integer
959
+ end
960
+
961
+ # Full registry company profile.
962
+ class KybListShareholdersResponseKybRegistry < Didit::Model
963
+ field :uuid, "uuid", :string
964
+ field :node_id, "node_id", :string
965
+ field :status, "status", :string
966
+ field :registry_status, "registry_status", :string
967
+ field :data_resolved, "data_resolved", :boolean
968
+ field :company_name, "company_name", :string
969
+ field :registration_number, "registration_number", :string
970
+ field :country_code, "country_code", :string
971
+ field :region, "region", :string
972
+ field :company_type, "company_type", :string
973
+ field :incorporation_date, "incorporation_date", :date
974
+ field :registered_address, "registered_address", :string
975
+ field :tax_number, "tax_number", :string
976
+ field :risk_level, "risk_level", :string
977
+ field :verification_status, "verification_status", :string
978
+ field :is_from_registry, "is_from_registry", :boolean
979
+ field :fetch_status, "fetch_status", :string
980
+ field :alternative_names, "alternative_names", :string
981
+ field :nature_of_business, "nature_of_business", :string
982
+ field :registered_capital, "registered_capital", :string
983
+ field :registered_capital_amount, "registered_capital_amount", :string
984
+ field :registered_capital_currency, "registered_capital_currency", :string
985
+ field :website, "website", :string
986
+ field :email, "email", :string
987
+ field :phone, "phone", :string
988
+ field :legal_entity_identifier, "legal_entity_identifier", :string
989
+ field :location_of_registration, "location_of_registration", :string
990
+ field :vat_number, "vat_number", :string
991
+ field :vat_validation_status, "vat_validation_status", :string
992
+ field :vat_validated_number, "vat_validated_number", :string
993
+ field :vat_validation_source, "vat_validation_source", :string
994
+ field :vat_validated_name, "vat_validated_name", :string
995
+ field :vat_validated_address, "vat_validated_address", :string
996
+ field :vat_checked_at, "vat_checked_at", :datetime
997
+ field :financial_summary, "financial_summary", :any
998
+ field :officers, "officers", [:array, "KybListShareholdersResponseKybRegistryOfficers"]
999
+ field :beneficial_owners, "beneficial_owners", [:array, "KybListShareholdersResponseKybRegistryBeneficialOwners"]
1000
+ field :addresses, "addresses", [:array, "KYBRegistryAddress"]
1001
+ field :industries, "industries", [:array, "KYBRegistryIndustry"]
1002
+ field :accounts, "accounts", :any
1003
+ field :registry_data, "registry_data", :any
1004
+ field :user_provided_data, "user_provided_data", :any
1005
+ field :confirmed_by_user_at, "confirmed_by_user_at", :datetime
1006
+ field :last_console_edit_at, "last_console_edit_at", :datetime
1007
+ field :is_editable, "is_editable", :boolean
1008
+ field :registry_tier_delivered, "registry_tier_delivered", :string
1009
+ field :registry_ownership_status, "registry_ownership_status", :string
1010
+ field :ownership, "ownership", "KYBRegistryOwnership"
1011
+ field :registry_tier, "registry_tier", :string
1012
+ end
1013
+
1014
+ class KybListShareholdersResponseKybRegistryBeneficialOwners < Didit::Model
1015
+ field :uuid, "uuid", :string
1016
+ field :name, "name", :string
1017
+ field :first_name, "first_name", :string
1018
+ field :last_name, "last_name", :string
1019
+ field :entity_type, "entity_type", :string
1020
+ field :roles, "roles", [:array, :string]
1021
+ field :ownership_min_shares, "ownership_min_shares", :string
1022
+ field :ownership_max_shares, "ownership_max_shares", :string
1023
+ field :is_active, "is_active", :boolean
1024
+ field :kyc_status, "kyc_status", :string
1025
+ field :kyc_session_url, "kyc_session_url", :string
1026
+ field :effective_ownership_percent, "effective_ownership_percent", :float
1027
+ field :company_name, "company_name", :string
1028
+ field :registration_number, "registration_number", :string
1029
+ field :country_of_birth, "country_of_birth", :string
1030
+ field :email, "email", :string
1031
+ field :nationality, "nationality", :string
1032
+ field :designation, "designation", :string
1033
+ field :voting_min_shares, "voting_min_shares", :string
1034
+ field :voting_max_shares, "voting_max_shares", :string
1035
+ field :date_of_birth, "date_of_birth", :date
1036
+ field :appointment_date, "appointment_date", :date
1037
+ field :shareholding, "shareholding", "KYBRegistryShareholding"
1038
+ end
1039
+
1040
+ class KybListShareholdersResponseKybRegistryOfficers < Didit::Model
1041
+ field :uuid, "uuid", :string
1042
+ field :name, "name", :string
1043
+ field :designation, "designation", :string
1044
+ field :role, "role", :string
1045
+ field :nationality, "nationality", :string
1046
+ field :is_active, "is_active", :boolean
1047
+ field :kyc_status, "kyc_status", :string
1048
+ field :kyc_session_url, "kyc_session_url", :string
1049
+ field :first_name, "first_name", :string
1050
+ field :last_name, "last_name", :string
1051
+ field :address, "address", :string
1052
+ field :appointment_date, "appointment_date", :date
1053
+ field :termination_date, "termination_date", :date
1054
+ field :date_of_birth, "date_of_birth", :date
1055
+ field :date_of_birth_year, "date_of_birth_year", :integer
1056
+ field :date_of_birth_month, "date_of_birth_month", :integer
1057
+ end
1058
+
1059
+ class KybListUbosResponse < Didit::Model
1060
+ field :request_id, "request_id", :string
1061
+ field :registry_tier_requested, "registry_tier_requested", :string
1062
+ field :registry_tier_delivered, "registry_tier_delivered", :string
1063
+ field :kyb_registry, "kyb_registry", "KybListUbosResponseKybRegistry"
1064
+ field :vendor_data, "vendor_data", :string
1065
+ field :metadata, "metadata", :any
1066
+ field :created_at, "created_at", :datetime
1067
+ end
1068
+
1069
+ class KybListUbosResponse202 < Didit::Model
1070
+ field :request_id, "request_id", :string
1071
+ field :registry_tier_requested, "registry_tier_requested", :string
1072
+ field :registry_tier_delivered, "registry_tier_delivered", :string
1073
+ field :kyb_registry, "kyb_registry", "KybListUbosResponse202KybRegistry"
1074
+ field :vendor_data, "vendor_data", :string
1075
+ field :metadata, "metadata", :any
1076
+ field :created_at, "created_at", :datetime
1077
+ end
1078
+
1079
+ # Full registry company profile.
1080
+ class KybListUbosResponse202KybRegistry < Didit::Model
1081
+ field :uuid, "uuid", :string
1082
+ field :node_id, "node_id", :string
1083
+ field :status, "status", :string
1084
+ field :registry_status, "registry_status", :string
1085
+ field :data_resolved, "data_resolved", :boolean
1086
+ field :company_name, "company_name", :string
1087
+ field :registration_number, "registration_number", :string
1088
+ field :country_code, "country_code", :string
1089
+ field :region, "region", :string
1090
+ field :company_type, "company_type", :string
1091
+ field :incorporation_date, "incorporation_date", :date
1092
+ field :registered_address, "registered_address", :string
1093
+ field :tax_number, "tax_number", :string
1094
+ field :risk_level, "risk_level", :string
1095
+ field :verification_status, "verification_status", :string
1096
+ field :is_from_registry, "is_from_registry", :boolean
1097
+ field :fetch_status, "fetch_status", :string
1098
+ field :alternative_names, "alternative_names", :string
1099
+ field :nature_of_business, "nature_of_business", :string
1100
+ field :registered_capital, "registered_capital", :string
1101
+ field :registered_capital_amount, "registered_capital_amount", :string
1102
+ field :registered_capital_currency, "registered_capital_currency", :string
1103
+ field :website, "website", :string
1104
+ field :email, "email", :string
1105
+ field :phone, "phone", :string
1106
+ field :legal_entity_identifier, "legal_entity_identifier", :string
1107
+ field :location_of_registration, "location_of_registration", :string
1108
+ field :vat_number, "vat_number", :string
1109
+ field :vat_validation_status, "vat_validation_status", :string
1110
+ field :vat_validated_number, "vat_validated_number", :string
1111
+ field :vat_validation_source, "vat_validation_source", :string
1112
+ field :vat_validated_name, "vat_validated_name", :string
1113
+ field :vat_validated_address, "vat_validated_address", :string
1114
+ field :vat_checked_at, "vat_checked_at", :datetime
1115
+ field :financial_summary, "financial_summary", :any
1116
+ field :officers, "officers", [:array, "KybListUbosResponse202KybRegistryOfficers"]
1117
+ field :beneficial_owners, "beneficial_owners", [:array, "KybListUbosResponse202KybRegistryBeneficialOwners"]
1118
+ field :addresses, "addresses", [:array, "KYBRegistryAddress"]
1119
+ field :industries, "industries", [:array, "KYBRegistryIndustry"]
1120
+ field :accounts, "accounts", :any
1121
+ field :registry_data, "registry_data", :any
1122
+ field :user_provided_data, "user_provided_data", :any
1123
+ field :confirmed_by_user_at, "confirmed_by_user_at", :datetime
1124
+ field :last_console_edit_at, "last_console_edit_at", :datetime
1125
+ field :is_editable, "is_editable", :boolean
1126
+ field :registry_tier_delivered, "registry_tier_delivered", :string
1127
+ field :registry_ownership_status, "registry_ownership_status", :string
1128
+ field :ownership, "ownership", "KYBRegistryOwnership"
1129
+ field :registry_tier, "registry_tier", :string
1130
+ end
1131
+
1132
+ class KybListUbosResponse202KybRegistryBeneficialOwners < Didit::Model
1133
+ field :uuid, "uuid", :string
1134
+ field :name, "name", :string
1135
+ field :first_name, "first_name", :string
1136
+ field :last_name, "last_name", :string
1137
+ field :entity_type, "entity_type", :string
1138
+ field :roles, "roles", [:array, :string]
1139
+ field :ownership_min_shares, "ownership_min_shares", :string
1140
+ field :ownership_max_shares, "ownership_max_shares", :string
1141
+ field :is_active, "is_active", :boolean
1142
+ field :kyc_status, "kyc_status", :string
1143
+ field :kyc_session_url, "kyc_session_url", :string
1144
+ field :effective_ownership_percent, "effective_ownership_percent", :float
1145
+ field :company_name, "company_name", :string
1146
+ field :registration_number, "registration_number", :string
1147
+ field :country_of_birth, "country_of_birth", :string
1148
+ field :email, "email", :string
1149
+ field :nationality, "nationality", :string
1150
+ field :designation, "designation", :string
1151
+ field :voting_min_shares, "voting_min_shares", :string
1152
+ field :voting_max_shares, "voting_max_shares", :string
1153
+ field :date_of_birth, "date_of_birth", :date
1154
+ field :appointment_date, "appointment_date", :date
1155
+ field :shareholding, "shareholding", "KYBRegistryShareholding"
1156
+ end
1157
+
1158
+ class KybListUbosResponse202KybRegistryOfficers < Didit::Model
1159
+ field :uuid, "uuid", :string
1160
+ field :name, "name", :string
1161
+ field :designation, "designation", :string
1162
+ field :role, "role", :string
1163
+ field :nationality, "nationality", :string
1164
+ field :is_active, "is_active", :boolean
1165
+ field :kyc_status, "kyc_status", :string
1166
+ field :kyc_session_url, "kyc_session_url", :string
1167
+ field :first_name, "first_name", :string
1168
+ field :last_name, "last_name", :string
1169
+ field :address, "address", :string
1170
+ field :appointment_date, "appointment_date", :date
1171
+ field :termination_date, "termination_date", :date
1172
+ field :date_of_birth, "date_of_birth", :date
1173
+ field :date_of_birth_year, "date_of_birth_year", :integer
1174
+ field :date_of_birth_month, "date_of_birth_month", :integer
1175
+ end
1176
+
1177
+ # Full registry company profile.
1178
+ class KybListUbosResponseKybRegistry < Didit::Model
1179
+ field :uuid, "uuid", :string
1180
+ field :node_id, "node_id", :string
1181
+ field :status, "status", :string
1182
+ field :registry_status, "registry_status", :string
1183
+ field :data_resolved, "data_resolved", :boolean
1184
+ field :company_name, "company_name", :string
1185
+ field :registration_number, "registration_number", :string
1186
+ field :country_code, "country_code", :string
1187
+ field :region, "region", :string
1188
+ field :company_type, "company_type", :string
1189
+ field :incorporation_date, "incorporation_date", :date
1190
+ field :registered_address, "registered_address", :string
1191
+ field :tax_number, "tax_number", :string
1192
+ field :risk_level, "risk_level", :string
1193
+ field :verification_status, "verification_status", :string
1194
+ field :is_from_registry, "is_from_registry", :boolean
1195
+ field :fetch_status, "fetch_status", :string
1196
+ field :alternative_names, "alternative_names", :string
1197
+ field :nature_of_business, "nature_of_business", :string
1198
+ field :registered_capital, "registered_capital", :string
1199
+ field :registered_capital_amount, "registered_capital_amount", :string
1200
+ field :registered_capital_currency, "registered_capital_currency", :string
1201
+ field :website, "website", :string
1202
+ field :email, "email", :string
1203
+ field :phone, "phone", :string
1204
+ field :legal_entity_identifier, "legal_entity_identifier", :string
1205
+ field :location_of_registration, "location_of_registration", :string
1206
+ field :vat_number, "vat_number", :string
1207
+ field :vat_validation_status, "vat_validation_status", :string
1208
+ field :vat_validated_number, "vat_validated_number", :string
1209
+ field :vat_validation_source, "vat_validation_source", :string
1210
+ field :vat_validated_name, "vat_validated_name", :string
1211
+ field :vat_validated_address, "vat_validated_address", :string
1212
+ field :vat_checked_at, "vat_checked_at", :datetime
1213
+ field :financial_summary, "financial_summary", :any
1214
+ field :officers, "officers", [:array, "KybListUbosResponseKybRegistryOfficers"]
1215
+ field :beneficial_owners, "beneficial_owners", [:array, "KybListUbosResponseKybRegistryBeneficialOwners"]
1216
+ field :addresses, "addresses", [:array, "KYBRegistryAddress"]
1217
+ field :industries, "industries", [:array, "KYBRegistryIndustry"]
1218
+ field :accounts, "accounts", :any
1219
+ field :registry_data, "registry_data", :any
1220
+ field :user_provided_data, "user_provided_data", :any
1221
+ field :confirmed_by_user_at, "confirmed_by_user_at", :datetime
1222
+ field :last_console_edit_at, "last_console_edit_at", :datetime
1223
+ field :is_editable, "is_editable", :boolean
1224
+ field :registry_tier_delivered, "registry_tier_delivered", :string
1225
+ field :registry_ownership_status, "registry_ownership_status", :string
1226
+ field :ownership, "ownership", "KYBRegistryOwnership"
1227
+ field :registry_tier, "registry_tier", :string
1228
+ end
1229
+
1230
+ class KybListUbosResponseKybRegistryBeneficialOwners < Didit::Model
1231
+ field :uuid, "uuid", :string
1232
+ field :name, "name", :string
1233
+ field :first_name, "first_name", :string
1234
+ field :last_name, "last_name", :string
1235
+ field :entity_type, "entity_type", :string
1236
+ field :roles, "roles", [:array, :string]
1237
+ field :ownership_min_shares, "ownership_min_shares", :string
1238
+ field :ownership_max_shares, "ownership_max_shares", :string
1239
+ field :is_active, "is_active", :boolean
1240
+ field :kyc_status, "kyc_status", :string
1241
+ field :kyc_session_url, "kyc_session_url", :string
1242
+ field :effective_ownership_percent, "effective_ownership_percent", :float
1243
+ field :company_name, "company_name", :string
1244
+ field :registration_number, "registration_number", :string
1245
+ field :country_of_birth, "country_of_birth", :string
1246
+ field :email, "email", :string
1247
+ field :nationality, "nationality", :string
1248
+ field :designation, "designation", :string
1249
+ field :voting_min_shares, "voting_min_shares", :string
1250
+ field :voting_max_shares, "voting_max_shares", :string
1251
+ field :date_of_birth, "date_of_birth", :date
1252
+ field :appointment_date, "appointment_date", :date
1253
+ field :shareholding, "shareholding", "KYBRegistryShareholding"
1254
+ end
1255
+
1256
+ class KybListUbosResponseKybRegistryOfficers < Didit::Model
1257
+ field :uuid, "uuid", :string
1258
+ field :name, "name", :string
1259
+ field :designation, "designation", :string
1260
+ field :role, "role", :string
1261
+ field :nationality, "nationality", :string
1262
+ field :is_active, "is_active", :boolean
1263
+ field :kyc_status, "kyc_status", :string
1264
+ field :kyc_session_url, "kyc_session_url", :string
1265
+ field :first_name, "first_name", :string
1266
+ field :last_name, "last_name", :string
1267
+ field :address, "address", :string
1268
+ field :appointment_date, "appointment_date", :date
1269
+ field :termination_date, "termination_date", :date
1270
+ field :date_of_birth, "date_of_birth", :date
1271
+ field :date_of_birth_year, "date_of_birth_year", :integer
1272
+ field :date_of_birth_month, "date_of_birth_month", :integer
1273
+ end
1274
+
1275
+ class KybSearchResponse < Didit::Model
1276
+ field :request_id, "request_id", :string
1277
+ field :kyb_registry, "kyb_registry", "KYBRegistrySearchResults"
1278
+ field :vendor_data, "vendor_data", :string
1279
+ field :metadata, "metadata", :any
1280
+ field :created_at, "created_at", :datetime
1281
+ end
1282
+
1283
+ class KybSelectResponse < Didit::Model
1284
+ field :request_id, "request_id", :string
1285
+ field :registry_tier_requested, "registry_tier_requested", :string
1286
+ field :registry_tier_delivered, "registry_tier_delivered", :string
1287
+ field :kyb_registry, "kyb_registry", "KybSelectResponseKybRegistry"
1288
+ field :vendor_data, "vendor_data", :string
1289
+ field :metadata, "metadata", :any
1290
+ field :created_at, "created_at", :datetime
1291
+ end
1292
+
1293
+ # Full registry company profile.
1294
+ class KybSelectResponseKybRegistry < Didit::Model
1295
+ field :uuid, "uuid", :string
1296
+ field :node_id, "node_id", :string
1297
+ field :status, "status", :string
1298
+ field :registry_status, "registry_status", :string
1299
+ field :data_resolved, "data_resolved", :boolean
1300
+ field :company_name, "company_name", :string
1301
+ field :registration_number, "registration_number", :string
1302
+ field :country_code, "country_code", :string
1303
+ field :region, "region", :string
1304
+ field :company_type, "company_type", :string
1305
+ field :incorporation_date, "incorporation_date", :date
1306
+ field :registered_address, "registered_address", :string
1307
+ field :tax_number, "tax_number", :string
1308
+ field :risk_level, "risk_level", :string
1309
+ field :verification_status, "verification_status", :string
1310
+ field :is_from_registry, "is_from_registry", :boolean
1311
+ field :fetch_status, "fetch_status", :string
1312
+ field :alternative_names, "alternative_names", :string
1313
+ field :nature_of_business, "nature_of_business", :string
1314
+ field :registered_capital, "registered_capital", :string
1315
+ field :registered_capital_amount, "registered_capital_amount", :string
1316
+ field :registered_capital_currency, "registered_capital_currency", :string
1317
+ field :website, "website", :string
1318
+ field :email, "email", :string
1319
+ field :phone, "phone", :string
1320
+ field :legal_entity_identifier, "legal_entity_identifier", :string
1321
+ field :location_of_registration, "location_of_registration", :string
1322
+ field :vat_number, "vat_number", :string
1323
+ field :vat_validation_status, "vat_validation_status", :string
1324
+ field :vat_validated_number, "vat_validated_number", :string
1325
+ field :vat_validation_source, "vat_validation_source", :string
1326
+ field :vat_validated_name, "vat_validated_name", :string
1327
+ field :vat_validated_address, "vat_validated_address", :string
1328
+ field :vat_checked_at, "vat_checked_at", :datetime
1329
+ field :financial_summary, "financial_summary", :any
1330
+ field :officers, "officers", [:array, "KybSelectResponseKybRegistryOfficers"]
1331
+ field :beneficial_owners, "beneficial_owners", [:array, "KybSelectResponseKybRegistryBeneficialOwners"]
1332
+ field :addresses, "addresses", [:array, "KYBRegistryAddress"]
1333
+ field :industries, "industries", [:array, "KYBRegistryIndustry"]
1334
+ field :accounts, "accounts", :any
1335
+ field :registry_data, "registry_data", :any
1336
+ field :user_provided_data, "user_provided_data", :any
1337
+ field :confirmed_by_user_at, "confirmed_by_user_at", :datetime
1338
+ field :last_console_edit_at, "last_console_edit_at", :datetime
1339
+ field :is_editable, "is_editable", :boolean
1340
+ field :registry_tier_delivered, "registry_tier_delivered", :string
1341
+ field :registry_ownership_status, "registry_ownership_status", :string
1342
+ field :ownership, "ownership", "KYBRegistryOwnership"
1343
+ field :registry_tier, "registry_tier", :string
1344
+ end
1345
+
1346
+ class KybSelectResponseKybRegistryBeneficialOwners < Didit::Model
1347
+ field :uuid, "uuid", :string
1348
+ field :name, "name", :string
1349
+ field :first_name, "first_name", :string
1350
+ field :last_name, "last_name", :string
1351
+ field :entity_type, "entity_type", :string
1352
+ field :roles, "roles", [:array, :string]
1353
+ field :ownership_min_shares, "ownership_min_shares", :string
1354
+ field :ownership_max_shares, "ownership_max_shares", :string
1355
+ field :is_active, "is_active", :boolean
1356
+ field :kyc_status, "kyc_status", :string
1357
+ field :kyc_session_url, "kyc_session_url", :string
1358
+ field :effective_ownership_percent, "effective_ownership_percent", :float
1359
+ field :company_name, "company_name", :string
1360
+ field :registration_number, "registration_number", :string
1361
+ field :country_of_birth, "country_of_birth", :string
1362
+ field :email, "email", :string
1363
+ field :nationality, "nationality", :string
1364
+ field :designation, "designation", :string
1365
+ field :voting_min_shares, "voting_min_shares", :string
1366
+ field :voting_max_shares, "voting_max_shares", :string
1367
+ field :date_of_birth, "date_of_birth", :date
1368
+ field :appointment_date, "appointment_date", :date
1369
+ field :shareholding, "shareholding", "KYBRegistryShareholding"
1370
+ end
1371
+
1372
+ class KybSelectResponseKybRegistryOfficers < Didit::Model
1373
+ field :uuid, "uuid", :string
1374
+ field :name, "name", :string
1375
+ field :designation, "designation", :string
1376
+ field :role, "role", :string
1377
+ field :nationality, "nationality", :string
1378
+ field :is_active, "is_active", :boolean
1379
+ field :kyc_status, "kyc_status", :string
1380
+ field :kyc_session_url, "kyc_session_url", :string
1381
+ field :first_name, "first_name", :string
1382
+ field :last_name, "last_name", :string
1383
+ field :address, "address", :string
1384
+ field :appointment_date, "appointment_date", :date
1385
+ field :termination_date, "termination_date", :date
1386
+ field :date_of_birth, "date_of_birth", :date
1387
+ field :date_of_birth_year, "date_of_birth_year", :integer
1388
+ field :date_of_birth_month, "date_of_birth_month", :integer
1389
+ end
1390
+ end
1391
+ end