Entities
Entities are the legal entities that own accounts. They can be people, corporations, partnerships, government authorities, or trusts. To learn more, see Entities.
Events
Your application can listen to webhooks
about this resource.
The events about Entities will have
the categories "entity.created" or "entity.updated"
.
The Entity object
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
{
"corporation": {
"address": {
"city": "New York",
"country": "US",
"line1": "33 Liberty Street",
"line2": null,
"state": "NY",
"zip": "10045"
},
"beneficial_owners": [
{
"company_title": "CEO",
"id": "entity_beneficial_owner_vozma8szzu1sxezp5zq6",
"individual": {
"address": {
"city": "New York",
"country": "US",
"line1": "33 Liberty Street",
"line2": null,
"state": "NY",
"zip": "10045"
},
"date_of_birth": "1970-01-31",
"identification": {
"method": "social_security_number",
"number_last4": "1120"
},
"name": "Ian Crease"
},
"prongs": [
"control",
"ownership"
]
}
],
"beneficial_ownership_exemption_reason": null,
"email": null,
"incorporation_state": "NY",
"industry_code": null,
"legal_identifier": {
"category": "us_employer_identification_number",
"value": "602214076"
},
"name": "National Phonograph Company",
"website": "https://example.com"
},
"created_at": "2020-01-31T23:59:59Z",
"creating_entity_onboarding_session_id": null,
"description": null,
"details_confirmed_at": null,
"government_authority": null,
"id": "entity_n8y8tnk2p9339ti393yi",
"idempotency_key": null,
"joint": null,
"natural_person": null,
"risk_rating": null,
"status": "active",
"structure": "corporation",
"supplemental_documents": [
{
"created_at": "2020-01-31T23:59:59Z",
"entity_id": "entity_n8y8tnk2p9339ti393yi",
"file_id": "file_makxrc67oh9l6sg7w9yc",
"idempotency_key": null,
"type": "entity_supplemental_document"
}
],
"terms_agreements": [],
"third_party_verification": null,
"trust": null,
"type": "entity",
"validation": null
}
Attributes
corporation
dictionary
Nullable
Details of the corporation entity. Will be present if structure is equal to corporation.
created_at
string
The ISO 8601 time at which the Entity was created.
creating_entity_onboarding_session_id
string
Nullable
The identifier of the Entity Onboarding Session that was used to create this Entity, if any.
id
string
The entity’s identifier.
idempotency_key
string
Nullable
The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
natural_person
dictionary
Nullable
Details of the natural person entity. Will be present if structure is equal to natural_person.
status
enum
The status of the entity.
structure
enum
The entity’s legal structure.
type
string
A constant representing the object’s type. For this resource it will always be entity.
More!
description
string
Nullable
details_confirmed_at
string
Nullable
government_authority
dictionary
Nullable
joint
dictionary
Nullable
risk_rating
dictionary
Nullable
supplemental_documents
array
terms_agreements
array
third_party_verification
dictionary
Nullable
trust
dictionary
Nullable
List Entities
1
2
3
curl \
--url "${INCREASE_URL}/entities" \
-H "Authorization: Bearer ${INCREASE_API_KEY}"1
2
3
4
5
6
7
8
9
10
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const entity of client.entities.list()) {
console.log(entity.id);
}1
2
3
4
5
6
7
8
9
import os
from increase import Increase
client = Increase(
api_key=os.environ.get("INCREASE_API_KEY"), # This is the default and can be omitted
)
page = client.entities.list()
page = page.data[0]
print(page.id)1
2
3
4
5
6
7
require "increase"
increase = Increase::Client.new(api_key: "My API Key")
page = increase.entities.list
puts(page)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
package main
import (
"context"
"fmt"
"github.com/Increase/increase-go"
"github.com/Increase/increase-go/option"
)
func main() {
client := increase.NewClient(
option.WithAPIKey("My API Key"),
)
page, err := client.Entities.List(context.TODO(), increase.EntityListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.entities.EntityListPage;
import com.increase.api.models.entities.EntityListParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
EntityListPage page = client.entities().list();
}
}1
2
3
4
5
6
7
8
9
10
11
12
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.entities.EntityListPage
import com.increase.api.models.entities.EntityListParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val page: EntityListPage = client.entities().list()
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Increase\Client;
use Increase\Core\Exceptions\APIException;
$client = new Client(
apiKey: getenv('INCREASE_API_KEY') ?: 'My API Key', environment: 'sandbox'
);
try {
$page = $client->entities->list(
createdAt: [
'after' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
'before' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
'onOrAfter' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
'onOrBefore' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
],
cursor: 'cursor',
idempotencyKey: 'x',
limit: 1,
status: ['in' => ['active']],
);
var_dump($page);
} catch (APIException $e) {
echo $e->getMessage();
}1
2
3
4
5
6
7
8
9
10
11
12
13
using System;
using Increase.Api;
using Increase.Api.Models.Entities;
IncreaseClient client = new();
EntityListParams parameters = new();
var page = await client.Entities.List(parameters);
await foreach (var item in page.Paginate())
{
Console.WriteLine(item);
}
Returns a
list response
:
1
2
3
4
5
6
7
8
{
"data": [
{ /* Entity object */ },
{ /* Entity object */ }
/* ... */
],
"next_cursor": "v57w5d",
}
Parameters
status.in
array of strings
Filter Entities for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.
idempotency_key
string
Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
More
cursor
string
limit
integer
created_at.after
string
created_at.before
string
created_at.on_or_after
string
created_at.on_or_before
string
Create an Entity
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
curl -X "POST" \
--url "${INCREASE_URL}/entities" \
-H "Authorization: Bearer ${INCREASE_API_KEY}" \
-H "Content-Type: application/json" \
-d $'{
"corporation": {
"address": {
"city": "New York",
"line1": "33 Liberty Street",
"state": "NY",
"zip": "10045"
},
"beneficial_owners": [
{
"company_title": "CEO",
"individual": {
"address": {
"city": "New York",
"line1": "33 Liberty Street",
"state": "NY",
"zip": "10045"
},
"date_of_birth": "1970-01-31",
"identification": {
"method": "social_security_number",
"number": "078051120"
},
"name": "Ian Crease"
},
"prongs": [
"control"
]
}
],
"incorporation_state": "NY",
"legal_identifier": {
"category": "us_employer_identification_number",
"value": "602214076"
},
"name": "National Phonograph Company",
"website": "https://example.com"
},
"structure": "corporation"
}'1
2
3
4
5
6
7
8
9
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
const entity = await client.entities.create({ structure: 'corporation' });
console.log(entity.id);1
2
3
4
5
6
7
8
9
10
import os
from increase import Increase
client = Increase(
api_key=os.environ.get("INCREASE_API_KEY"), # This is the default and can be omitted
)
entity = client.entities.create(
structure="corporation",
)
print(entity.id)1
2
3
4
5
6
7
require "increase"
increase = Increase::Client.new(api_key: "My API Key")
entity = increase.entities.create(structure: :corporation)
puts(entity)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
package main
import (
"context"
"fmt"
"github.com/Increase/increase-go"
"github.com/Increase/increase-go/option"
)
func main() {
client := increase.NewClient(
option.WithAPIKey("My API Key"),
)
entity, err := client.Entities.New(context.TODO(), increase.EntityNewParams{
Structure: increase.F(increase.EntityNewParamsStructureCorporation),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", entity.ID)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.entities.Entity;
import com.increase.api.models.entities.EntityCreateParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
EntityCreateParams params = EntityCreateParams.builder()
.structure(EntityCreateParams.Structure.CORPORATION)
.build();
Entity entity = client.entities().create(params);
}
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.entities.Entity
import com.increase.api.models.entities.EntityCreateParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val params: EntityCreateParams = EntityCreateParams.builder()
.structure(EntityCreateParams.Structure.CORPORATION)
.build()
val entity: Entity = client.entities().create(params)
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Increase\Client;
use Increase\Core\Exceptions\APIException;
$client = new Client(
apiKey: getenv('INCREASE_API_KEY') ?: 'My API Key', environment: 'sandbox'
);
try {
$entity = $client->entities->create(
structure: 'corporation',
corporation: [
'address' => [
'city' => 'New York',
'country' => 'x',
'line1' => '33 Liberty Street',
'line2' => 'x',
'state' => 'NY',
'zip' => '10045',
],
'beneficialOwners' => [
[
'individual' => [
'address' => [
'city' => 'New York',
'country' => 'x',
'line1' => '33 Liberty Street',
'line2' => 'x',
'state' => 'NY',
'zip' => '10045',
],
'dateOfBirth' => '1970-01-31',
'identification' => [
'method' => 'social_security_number',
'number' => '078051120',
'driversLicense' => [
'expirationDate' => '2019-12-27',
'fileID' => 'file_id',
'state' => 'xx',
'backFileID' => 'back_file_id',
],
'other' => [
'country' => 'x',
'description' => 'x',
'fileID' => 'file_id',
'backFileID' => 'back_file_id',
'expirationDate' => '2019-12-27',
],
'passport' => [
'country' => 'x',
'expirationDate' => '2019-12-27',
'fileID' => 'file_id',
],
],
'name' => 'Ian Crease',
'confirmedNoUsTaxID' => true,
],
'prongs' => ['control'],
'companyTitle' => 'CEO',
],
],
'legalIdentifier' => [
'value' => '602214076',
'category' => 'us_employer_identification_number',
],
'name' => 'National Phonograph Company',
'beneficialOwnershipExemptionReason' => 'regulated_financial_institution',
'email' => 'dev@stainless.com',
'incorporationState' => 'NY',
'industryCode' => 'x',
'website' => 'https://example.com',
],
description: 'x',
governmentAuthority: [
'address' => [
'city' => 'x',
'line1' => 'x',
'state' => 'xx',
'zip' => 'x',
'line2' => 'x',
],
'authorizedPersons' => [['name' => 'x']],
'category' => 'municipality',
'name' => 'x',
'taxIdentifier' => 'x',
'website' => 'website',
],
joint: [
'individuals' => [
[
'address' => [
'city' => 'x',
'country' => 'x',
'line1' => 'x',
'line2' => 'x',
'state' => 'x',
'zip' => 'x',
],
'dateOfBirth' => '2019-12-27',
'identification' => [
'method' => 'social_security_number',
'number' => 'xxxx',
'driversLicense' => [
'expirationDate' => '2019-12-27',
'fileID' => 'file_id',
'state' => 'xx',
'backFileID' => 'back_file_id',
],
'other' => [
'country' => 'x',
'description' => 'x',
'fileID' => 'file_id',
'backFileID' => 'back_file_id',
'expirationDate' => '2019-12-27',
],
'passport' => [
'country' => 'x',
'expirationDate' => '2019-12-27',
'fileID' => 'file_id',
],
],
'name' => 'x',
'confirmedNoUsTaxID' => true,
],
],
],
naturalPerson: [
'address' => [
'city' => 'x',
'country' => 'x',
'line1' => 'x',
'line2' => 'x',
'state' => 'x',
'zip' => 'x',
],
'dateOfBirth' => '2019-12-27',
'identification' => [
'method' => 'social_security_number',
'number' => 'xxxx',
'driversLicense' => [
'expirationDate' => '2019-12-27',
'fileID' => 'file_id',
'state' => 'xx',
'backFileID' => 'back_file_id',
],
'other' => [
'country' => 'x',
'description' => 'x',
'fileID' => 'file_id',
'backFileID' => 'back_file_id',
'expirationDate' => '2019-12-27',
],
'passport' => [
'country' => 'x',
'expirationDate' => '2019-12-27',
'fileID' => 'file_id',
],
],
'name' => 'x',
'confirmedNoUsTaxID' => true,
],
riskRating: [
'ratedAt' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
'rating' => 'low',
],
supplementalDocuments: [['fileID' => 'file_id']],
termsAgreements: [
[
'agreedAt' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
'ipAddress' => 'x',
'termsURL' => 'x',
],
],
thirdPartyVerification: ['reference' => 'x', 'vendor' => 'alloy'],
trust: [
'address' => [
'city' => 'x',
'line1' => 'x',
'state' => 'xx',
'zip' => 'x',
'line2' => 'x',
],
'category' => 'revocable',
'name' => 'x',
'trustees' => [
[
'structure' => 'individual',
'individual' => [
'address' => [
'city' => 'x',
'country' => 'x',
'line1' => 'x',
'line2' => 'x',
'state' => 'x',
'zip' => 'x',
],
'dateOfBirth' => '2019-12-27',
'identification' => [
'method' => 'social_security_number',
'number' => 'xxxx',
'driversLicense' => [
'expirationDate' => '2019-12-27',
'fileID' => 'file_id',
'state' => 'xx',
'backFileID' => 'back_file_id',
],
'other' => [
'country' => 'x',
'description' => 'x',
'fileID' => 'file_id',
'backFileID' => 'back_file_id',
'expirationDate' => '2019-12-27',
],
'passport' => [
'country' => 'x',
'expirationDate' => '2019-12-27',
'fileID' => 'file_id',
],
],
'name' => 'x',
'confirmedNoUsTaxID' => true,
],
],
],
'formationDocumentFileID' => 'formation_document_file_id',
'formationState' => 'x',
'grantor' => [
'address' => [
'city' => 'x',
'country' => 'x',
'line1' => 'x',
'line2' => 'x',
'state' => 'x',
'zip' => 'x',
],
'dateOfBirth' => '2019-12-27',
'identification' => [
'method' => 'social_security_number',
'number' => 'xxxx',
'driversLicense' => [
'expirationDate' => '2019-12-27',
'fileID' => 'file_id',
'state' => 'xx',
'backFileID' => 'back_file_id',
],
'other' => [
'country' => 'x',
'description' => 'x',
'fileID' => 'file_id',
'backFileID' => 'back_file_id',
'expirationDate' => '2019-12-27',
],
'passport' => [
'country' => 'x',
'expirationDate' => '2019-12-27',
'fileID' => 'file_id',
],
],
'name' => 'x',
'confirmedNoUsTaxID' => true,
],
'taxIdentifier' => 'x',
],
);
var_dump($entity);
} catch (APIException $e) {
echo $e->getMessage();
}1
2
3
4
5
6
7
8
9
10
11
using System;
using Increase.Api;
using Increase.Api.Models.Entities;
IncreaseClient client = new();
EntityCreateParams parameters = new() { Structure = Structure.Corporation };
var entity = await client.Entities.Create(parameters);
Console.WriteLine(entity);
Parameters
corporation
dictionary
Details of the corporation entity to create. Required if structure is equal to corporation.
natural_person
dictionary
Details of the natural person entity to create. Required if structure is equal to natural_person. Natural people entities should be submitted with social_security_number or individual_taxpayer_identification_number identification methods.
structure
enum
Required
The type of Entity to create.
More
description
string
government_authority
dictionary
joint
dictionary
risk_rating
dictionary
supplemental_documents
array
terms_agreements
array
third_party_verification
dictionary
trust
dictionary
Retrieve an Entity
1
2
3
curl \
--url "${INCREASE_URL}/entities/entity_n8y8tnk2p9339ti393yi" \
-H "Authorization: Bearer ${INCREASE_API_KEY}"1
2
3
4
5
6
7
8
9
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
const entity = await client.entities.retrieve('entity_n8y8tnk2p9339ti393yi');
console.log(entity.id);1
2
3
4
5
6
7
8
9
10
import os
from increase import Increase
client = Increase(
api_key=os.environ.get("INCREASE_API_KEY"), # This is the default and can be omitted
)
entity = client.entities.retrieve(
"entity_n8y8tnk2p9339ti393yi",
)
print(entity.id)1
2
3
4
5
6
7
require "increase"
increase = Increase::Client.new(api_key: "My API Key")
entity = increase.entities.retrieve("entity_n8y8tnk2p9339ti393yi")
puts(entity)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
package main
import (
"context"
"fmt"
"github.com/Increase/increase-go"
"github.com/Increase/increase-go/option"
)
func main() {
client := increase.NewClient(
option.WithAPIKey("My API Key"),
)
entity, err := client.Entities.Get(context.TODO(), "entity_n8y8tnk2p9339ti393yi")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", entity.ID)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.entities.Entity;
import com.increase.api.models.entities.EntityRetrieveParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
Entity entity = client.entities().retrieve("entity_n8y8tnk2p9339ti393yi");
}
}1
2
3
4
5
6
7
8
9
10
11
12
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.entities.Entity
import com.increase.api.models.entities.EntityRetrieveParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val entity: Entity = client.entities().retrieve("entity_n8y8tnk2p9339ti393yi")
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Increase\Client;
use Increase\Core\Exceptions\APIException;
$client = new Client(
apiKey: getenv('INCREASE_API_KEY') ?: 'My API Key', environment: 'sandbox'
);
try {
$entity = $client->entities->retrieve('entity_n8y8tnk2p9339ti393yi');
var_dump($entity);
} catch (APIException $e) {
echo $e->getMessage();
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
using System;
using Increase.Api;
using Increase.Api.Models.Entities;
IncreaseClient client = new();
EntityRetrieveParams parameters = new()
{
EntityID = "entity_n8y8tnk2p9339ti393yi"
};
var entity = await client.Entities.Retrieve(parameters);
Console.WriteLine(entity);
Parameters
entity_id
string
Required
The identifier of the Entity to retrieve.
More about Entities.
Update an Entity
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
curl -X "PATCH" \
--url "${INCREASE_URL}/entities/entity_n8y8tnk2p9339ti393yi" \
-H "Authorization: Bearer ${INCREASE_API_KEY}" \
-H "Content-Type: application/json" \
-d $'{
"corporation": {
"address": {
"city": "New York",
"country": "US",
"line1": "33 Liberty Street",
"line2": "Unit 2",
"state": "NY",
"zip": "10045"
}
},
"risk_rating": {
"rated_at": "2020-01-31T23:59:59Z",
"rating": "low"
}
}'1
2
3
4
5
6
7
8
9
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
const entity = await client.entities.update('entity_n8y8tnk2p9339ti393yi');
console.log(entity.id);1
2
3
4
5
6
7
8
9
10
import os
from increase import Increase
client = Increase(
api_key=os.environ.get("INCREASE_API_KEY"), # This is the default and can be omitted
)
entity = client.entities.update(
entity_id="entity_n8y8tnk2p9339ti393yi",
)
print(entity.id)1
2
3
4
5
6
7
require "increase"
increase = Increase::Client.new(api_key: "My API Key")
entity = increase.entities.update("entity_n8y8tnk2p9339ti393yi")
puts(entity)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
package main
import (
"context"
"fmt"
"github.com/Increase/increase-go"
"github.com/Increase/increase-go/option"
)
func main() {
client := increase.NewClient(
option.WithAPIKey("My API Key"),
)
entity, err := client.Entities.Update(
context.TODO(),
"entity_n8y8tnk2p9339ti393yi",
increase.EntityUpdateParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", entity.ID)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.entities.Entity;
import com.increase.api.models.entities.EntityUpdateParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
Entity entity = client.entities().update("entity_n8y8tnk2p9339ti393yi");
}
}1
2
3
4
5
6
7
8
9
10
11
12
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.entities.Entity
import com.increase.api.models.entities.EntityUpdateParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val entity: Entity = client.entities().update("entity_n8y8tnk2p9339ti393yi")
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Increase\Client;
use Increase\Core\Exceptions\APIException;
$client = new Client(
apiKey: getenv('INCREASE_API_KEY') ?: 'My API Key', environment: 'sandbox'
);
try {
$entity = $client->entities->update(
'entity_n8y8tnk2p9339ti393yi',
corporation: [
'address' => [
'city' => 'New York',
'country' => 'US',
'line1' => '33 Liberty Street',
'line2' => 'Unit 2',
'state' => 'NY',
'zip' => '10045',
],
'email' => 'dev@stainless.com',
'incorporationState' => 'x',
'industryCode' => 'x',
'legalIdentifier' => [
'value' => 'x', 'category' => 'us_employer_identification_number'
],
'name' => 'x',
'website' => 'website',
],
detailsConfirmedAt: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
governmentAuthority: [
'address' => [
'city' => 'x',
'line1' => 'x',
'state' => 'xx',
'zip' => 'x',
'line2' => 'x',
],
'name' => 'x',
],
naturalPerson: [
'address' => [
'city' => 'x',
'country' => 'x',
'line1' => 'x',
'line2' => 'x',
'state' => 'x',
'zip' => 'x',
],
'confirmedNoUsTaxID' => true,
'identification' => [
'method' => 'social_security_number',
'number' => 'xxxx',
'driversLicense' => [
'expirationDate' => '2019-12-27',
'fileID' => 'file_id',
'state' => 'xx',
'backFileID' => 'back_file_id',
],
'other' => [
'country' => 'x',
'description' => 'x',
'fileID' => 'file_id',
'backFileID' => 'back_file_id',
'expirationDate' => '2019-12-27',
],
'passport' => [
'country' => 'x',
'expirationDate' => '2019-12-27',
'fileID' => 'file_id',
],
],
'name' => 'x',
],
riskRating: [
'ratedAt' => new \DateTimeImmutable('2020-01-31T23:59:59Z'),
'rating' => 'low',
],
termsAgreements: [
[
'agreedAt' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
'ipAddress' => 'x',
'termsURL' => 'x',
],
],
thirdPartyVerification: ['reference' => 'x', 'vendor' => 'alloy'],
trust: [
'address' => [
'city' => 'x',
'line1' => 'x',
'state' => 'xx',
'zip' => 'x',
'line2' => 'x',
],
'name' => 'x',
],
);
var_dump($entity);
} catch (APIException $e) {
echo $e->getMessage();
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
using System;
using Increase.Api;
using Increase.Api.Models.Entities;
IncreaseClient client = new();
EntityUpdateParams parameters = new()
{
EntityID = "entity_n8y8tnk2p9339ti393yi"
};
var entity = await client.Entities.Update(parameters);
Console.WriteLine(entity);
Parameters
entity_id
string
Required
The entity identifier.
More about Entities.
corporation
dictionary
Details of the corporation entity to update. If you specify this parameter and the entity is not a corporation, the request will fail.
government_authority
dictionary
Details of the government authority entity to update. If you specify this parameter and the entity is not a government authority, the request will fail.
natural_person
dictionary
Details of the natural person entity to update. If you specify this parameter and the entity is not a natural person, the request will fail.
More
details_confirmed_at
string
risk_rating
dictionary
terms_agreements
array
third_party_verification
dictionary
trust
dictionary
Archive an Entity
1
2
3
curl -X "POST" \
--url "${INCREASE_URL}/entities/entity_n8y8tnk2p9339ti393yi/archive" \
-H "Authorization: Bearer ${INCREASE_API_KEY}"1
2
3
4
5
6
7
8
9
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
const entity = await client.entities.archive('entity_n8y8tnk2p9339ti393yi');
console.log(entity.id);1
2
3
4
5
6
7
8
9
10
import os
from increase import Increase
client = Increase(
api_key=os.environ.get("INCREASE_API_KEY"), # This is the default and can be omitted
)
entity = client.entities.archive(
"entity_n8y8tnk2p9339ti393yi",
)
print(entity.id)1
2
3
4
5
6
7
require "increase"
increase = Increase::Client.new(api_key: "My API Key")
entity = increase.entities.archive("entity_n8y8tnk2p9339ti393yi")
puts(entity)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
package main
import (
"context"
"fmt"
"github.com/Increase/increase-go"
"github.com/Increase/increase-go/option"
)
func main() {
client := increase.NewClient(
option.WithAPIKey("My API Key"),
)
entity, err := client.Entities.Archive(context.TODO(), "entity_n8y8tnk2p9339ti393yi")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", entity.ID)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.entities.Entity;
import com.increase.api.models.entities.EntityArchiveParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
Entity entity = client.entities().archive("entity_n8y8tnk2p9339ti393yi");
}
}1
2
3
4
5
6
7
8
9
10
11
12
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.entities.Entity
import com.increase.api.models.entities.EntityArchiveParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val entity: Entity = client.entities().archive("entity_n8y8tnk2p9339ti393yi")
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Increase\Client;
use Increase\Core\Exceptions\APIException;
$client = new Client(
apiKey: getenv('INCREASE_API_KEY') ?: 'My API Key', environment: 'sandbox'
);
try {
$entity = $client->entities->archive('entity_n8y8tnk2p9339ti393yi');
var_dump($entity);
} catch (APIException $e) {
echo $e->getMessage();
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
using System;
using Increase.Api;
using Increase.Api.Models.Entities;
IncreaseClient client = new();
EntityArchiveParams parameters = new()
{
EntityID = "entity_n8y8tnk2p9339ti393yi"
};
var entity = await client.Entities.Archive(parameters);
Console.WriteLine(entity);
Parameters
entity_id
string
Required
The identifier of the Entity to archive. Any accounts associated with an entity must be closed before the entity can be archived.
More about Entities.
Sandbox: Simulate validation of an Entity
Simulate updates to an Entity’s validation. In production, Know Your Customer validations run automatically for eligible programs. While developing, use this API to simulate issues with information submissions.
1
2
3
4
5
6
7
8
9
10
11
curl -X "POST" \
--url "${INCREASE_URL}/simulations/entities/entity_n8y8tnk2p9339ti393yi/update_validation" \
-H "Authorization: Bearer ${INCREASE_API_KEY}" \
-H "Content-Type: application/json" \
-d $'{
"issues": [
{
"category": "entity_tax_identifier"
}
]
}'1
2
3
4
5
6
7
8
9
10
11
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
const entity = await client.simulations.entities.updateValidation('entity_n8y8tnk2p9339ti393yi', {
issues: [{ category: 'entity_tax_identifier' }],
});
console.log(entity.id);1
2
3
4
5
6
7
8
9
10
11
12
13
import os
from increase import Increase
client = Increase(
api_key=os.environ.get("INCREASE_API_KEY"), # This is the default and can be omitted
)
entity = client.simulations.entities.update_validation(
entity_id="entity_n8y8tnk2p9339ti393yi",
issues=[{
"category": "entity_tax_identifier"
}],
)
print(entity.id)1
2
3
4
5
6
7
8
9
10
require "increase"
increase = Increase::Client.new(api_key: "My API Key")
entity = increase.simulations.entities.update_validation(
"entity_n8y8tnk2p9339ti393yi",
issues: [{category: :entity_tax_identifier}]
)
puts(entity)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
package main
import (
"context"
"fmt"
"github.com/Increase/increase-go"
"github.com/Increase/increase-go/option"
)
func main() {
client := increase.NewClient(
option.WithAPIKey("My API Key"),
)
entity, err := client.Simulations.Entities.UpdateValidation(
context.TODO(),
"entity_n8y8tnk2p9339ti393yi",
increase.SimulationEntityUpdateValidationParams{
Issues: increase.F([]increase.SimulationEntityUpdateValidationParamsIssue{{
Category: increase.F(increase.SimulationEntityUpdateValidationParamsIssuesCategoryEntityTaxIdentifier),
}}),
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", entity.ID)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.entities.Entity;
import com.increase.api.models.simulations.entities.EntityUpdateValidationParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
EntityUpdateValidationParams params = EntityUpdateValidationParams.builder()
.entityId("entity_n8y8tnk2p9339ti393yi")
.addIssue(EntityUpdateValidationParams.Issue.builder()
.category(EntityUpdateValidationParams.Issue.Category.ENTITY_TAX_IDENTIFIER)
.build())
.build();
Entity entity = client.simulations().entities().updateValidation(params);
}
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.entities.Entity
import com.increase.api.models.simulations.entities.EntityUpdateValidationParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val params: EntityUpdateValidationParams = EntityUpdateValidationParams.builder()
.entityId("entity_n8y8tnk2p9339ti393yi")
.addIssue(EntityUpdateValidationParams.Issue.builder()
.category(EntityUpdateValidationParams.Issue.Category.ENTITY_TAX_IDENTIFIER)
.build())
.build()
val entity: Entity = client.simulations().entities().updateValidation(params)
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Increase\Client;
use Increase\Core\Exceptions\APIException;
$client = new Client(
apiKey: getenv('INCREASE_API_KEY') ?: 'My API Key', environment: 'sandbox'
);
try {
$entity = $client->simulations->entities->updateValidation(
'entity_n8y8tnk2p9339ti393yi',
issues: [['category' => 'entity_tax_identifier']],
);
var_dump($entity);
} catch (APIException $e) {
echo $e->getMessage();
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
using System;
using Increase.Api;
using Increase.Api.Models.Simulations.Entities;
IncreaseClient client = new();
EntityUpdateValidationParams parameters = new()
{
EntityID = "entity_n8y8tnk2p9339ti393yi",
Issues =
[
new(Category.EntityTaxIdentifier)
],
};
var entity = await client.Simulations.Entities.UpdateValidation(parameters);
Console.WriteLine(entity);
Parameters
entity_id
string
Required
The identifier of the Entity whose validation status to update.
More about Entities.
issues
array
Required
The validation issues to attach. If no issues are provided, the validation status will be set to valid.