Skip to content

Commit f0f29f3

Browse files
feat(api): api update
1 parent 2864760 commit f0f29f3

5 files changed

Lines changed: 35 additions & 28 deletions

File tree

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 217
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-438f2a4d4f35670ae5692a6a9a36711af7944ac975bf309a6d50c02a28b13a70.yml
3-
openapi_spec_hash: e4930cc26be238707449872070607e64
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-5d85239e5d724254ab22d922c6cad05e1c361c791ef4a578e1165158bd967753.yml
3+
openapi_spec_hash: b2c90485c02d643ad09954f4d88dbc25
44
config_hash: e1885b38eded054b77308a024c5d80cc

src/increase/resources/entities.py

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,9 @@ def create(
110110
111111
supplemental_documents: Additional documentation associated with the entity.
112112
113-
third_party_verification: A reference to data stored in a third-party verification service. Your
114-
integration may or may not use this field.
113+
third_party_verification: If you are using a third-party service for identity verification, you can use
114+
this field to associate this Entity with the identifier that represents them in
115+
that service.
115116
116117
trust: Details of the trust entity to create. Required if `structure` is equal to
117118
`trust`.
@@ -224,8 +225,9 @@ def update(
224225
risk_rating: An assessment of the entity’s potential risk of involvement in financial crimes,
225226
such as money laundering.
226227
227-
third_party_verification: A reference to data stored in a third-party verification service. Your
228-
integration may or may not use this field.
228+
third_party_verification: If you are using a third-party service for identity verification, you can use
229+
this field to associate this Entity with the identifier that represents them in
230+
that service.
229231
230232
trust: Details of the trust entity to update. If you specify this parameter and the
231233
entity is not a trust, the request will fail.
@@ -750,8 +752,9 @@ async def create(
750752
751753
supplemental_documents: Additional documentation associated with the entity.
752754
753-
third_party_verification: A reference to data stored in a third-party verification service. Your
754-
integration may or may not use this field.
755+
third_party_verification: If you are using a third-party service for identity verification, you can use
756+
this field to associate this Entity with the identifier that represents them in
757+
that service.
755758
756759
trust: Details of the trust entity to create. Required if `structure` is equal to
757760
`trust`.
@@ -864,8 +867,9 @@ async def update(
864867
risk_rating: An assessment of the entity’s potential risk of involvement in financial crimes,
865868
such as money laundering.
866869
867-
third_party_verification: A reference to data stored in a third-party verification service. Your
868-
integration may or may not use this field.
870+
third_party_verification: If you are using a third-party service for identity verification, you can use
871+
this field to associate this Entity with the identifier that represents them in
872+
that service.
869873
870874
trust: Details of the trust entity to update. If you specify this parameter and the
871875
entity is not a trust, the request will fail.

src/increase/types/entity.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -351,9 +351,9 @@ class RiskRating(BaseModel):
351351
rating: Literal["low", "medium", "high"]
352352
"""The rating given to this entity.
353353
354-
- `low` - Low
355-
- `medium` - Medium
356-
- `high` - High
354+
- `low` - Minimal risk of involvement in financial crime.
355+
- `medium` - Moderate risk of involvement in financial crime.
356+
- `high` - Elevated risk of involvement in financial crime.
357357
"""
358358

359359

@@ -633,9 +633,10 @@ class Entity(BaseModel):
633633
"""
634634

635635
third_party_verification: Optional[ThirdPartyVerification] = None
636-
"""A reference to data stored in a third-party verification service.
637-
638-
Your integration may or may not use this field.
636+
"""
637+
If you are using a third-party service for identity verification, you can use
638+
this field to associate this Entity with the identifier that represents them in
639+
that service.
639640
"""
640641

641642
trust: Optional[Trust] = None

src/increase/types/entity_create_params.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -106,9 +106,10 @@ class EntityCreateParams(TypedDict, total=False):
106106
"""Additional documentation associated with the entity."""
107107

108108
third_party_verification: ThirdPartyVerification
109-
"""A reference to data stored in a third-party verification service.
110-
111-
Your integration may or may not use this field.
109+
"""
110+
If you are using a third-party service for identity verification, you can use
111+
this field to associate this Entity with the identifier that represents them in
112+
that service.
112113
"""
113114

114115
trust: Trust
@@ -700,9 +701,9 @@ class RiskRating(TypedDict, total=False):
700701
rating: Required[Literal["low", "medium", "high"]]
701702
"""The rating given to this entity.
702703
703-
- `low` - Low
704-
- `medium` - Medium
705-
- `high` - High
704+
- `low` - Minimal risk of involvement in financial crime.
705+
- `medium` - Moderate risk of involvement in financial crime.
706+
- `high` - Elevated risk of involvement in financial crime.
706707
"""
707708

708709

src/increase/types/entity_update_params.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,10 @@ class EntityUpdateParams(TypedDict, total=False):
5252
"""
5353

5454
third_party_verification: ThirdPartyVerification
55-
"""A reference to data stored in a third-party verification service.
56-
57-
Your integration may or may not use this field.
55+
"""
56+
If you are using a third-party service for identity verification, you can use
57+
this field to associate this Entity with the identifier that represents them in
58+
that service.
5859
"""
5960

6061
trust: Trust
@@ -176,9 +177,9 @@ class RiskRating(TypedDict, total=False):
176177
rating: Required[Literal["low", "medium", "high"]]
177178
"""The rating given to this entity.
178179
179-
- `low` - Low
180-
- `medium` - Medium
181-
- `high` - High
180+
- `low` - Minimal risk of involvement in financial crime.
181+
- `medium` - Moderate risk of involvement in financial crime.
182+
- `high` - Elevated risk of involvement in financial crime.
182183
"""
183184

184185

0 commit comments

Comments
 (0)