Beneficial Owners
Beneficial owners are the individuals who control or own 25% or more of a corporation entity. Beneficial owners are always people, and never organizations. Generally, you will need to submit between 1 and 5 beneficial owners for every corporation entity. You should update and archive beneficial owners for a corporation entity as their details change.
The Beneficial Owner 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
{
"company_title": "CEO",
"created_at": "2020-01-31T23:59:59Z",
"entity_id": "entity_n8y8tnk2p9339ti393yi",
"id": "entity_beneficial_owner_vozma8szzu1sxezp5zq6",
"idempotency_key": null,
"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"
],
"type": "entity_beneficial_owner"
}
Attributes
company_title
string
Nullable
This person’s role or title within the entity.
created_at
string
The ISO 8601 time at which the Beneficial Owner was created.
entity_id
string
The identifier of the Entity to which this beneficial owner belongs.
id
string
The identifier of this beneficial owner.
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.
individual
dictionary
Personal details for the beneficial owner.
prongs
array of strings
Why this person is considered a beneficial owner of the entity.
type
string
A constant representing the object’s type. For this resource it will always be entity_beneficial_owner.
List Beneficial Owners
1
2
3
curl \
--url "${INCREASE_URL}/entity_beneficial_owners?entity_id=entity_n8y8tnk2p9339ti393yi" \
-H "Authorization: Bearer ${INCREASE_API_KEY}"1
2
3
4
5
6
7
8
9
10
11
12
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 entityBeneficialOwner of client.beneficialOwners.list({
entity_id: 'entity_id',
})) {
console.log(entityBeneficialOwner.id);
}1
2
3
4
5
6
7
8
9
10
11
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.beneficial_owners.list(
entity_id="entity_id",
)
page = page.data[0]
print(page.id)1
2
3
4
5
6
7
8
9
require "increase"
increase = Increase::Client.new(
api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)
page = increase.beneficial_owners.list(entity_id: "entity_id")
puts(page)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
package main
import (
"context"
"fmt"
"os"
"github.com/Increase/increase-go"
"github.com/Increase/increase-go/option"
)
func main() {
client := increase.NewClient(
option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
)
page, err := client.BeneficialOwners.List(context.TODO(), increase.BeneficialOwnerListParams{
EntityID: increase.F("entity_id"),
})
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
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.beneficialowners.BeneficialOwnerListPage;
import com.increase.api.models.beneficialowners.BeneficialOwnerListParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
BeneficialOwnerListParams params = BeneficialOwnerListParams.builder()
.entityId("entity_id")
.build();
BeneficialOwnerListPage page = client.beneficialOwners().list(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.beneficialowners.BeneficialOwnerListPage
import com.increase.api.models.beneficialowners.BeneficialOwnerListParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val params: BeneficialOwnerListParams = BeneficialOwnerListParams.builder()
.entityId("entity_id")
.build()
val page: BeneficialOwnerListPage = client.beneficialOwners().list(params)
}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'));
try {
$page = $client->beneficialOwners->list(
entityID: 'entity_id', cursor: 'cursor', idempotencyKey: 'x', limit: 1
);
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.BeneficialOwners;
IncreaseClient client = new();
BeneficialOwnerListParams parameters = new() { EntityID = "entity_id" };
var page = await client.BeneficialOwners.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": [
{ /* Beneficial Owner object */ },
{ /* Beneficial Owner object */ }
/* ... */
],
"next_cursor": "v57w5d",
}
Parameters
entity_id
string
Required
The identifier of the Entity to list beneficial owners for. Only corporation entities have beneficial owners.
More about Entities.
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
Create a Beneficial Owner
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
curl -X "POST" \
--url "${INCREASE_URL}/entity_beneficial_owners" \
-H "Authorization: Bearer ${INCREASE_API_KEY}" \
-H "Content-Type: application/json" \
-d $'{
"company_title": "CEO",
"entity_id": "entity_n8y8tnk2p9339ti393yi",
"individual": {
"address": {
"city": "New York",
"country": "US",
"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"
]
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
const entityBeneficialOwner = await client.beneficialOwners.create({
entity_id: 'entity_n8y8tnk2p9339ti393yi',
individual: {
address: {
city: 'New York',
country: 'US',
line1: '33 Liberty Street',
},
date_of_birth: '1970-01-31',
identification: { method: 'social_security_number', number: '078051120' },
name: 'Ian Crease',
},
prongs: ['control'],
});
console.log(entityBeneficialOwner.id);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
import os
from datetime import date
from increase import Increase
client = Increase(
api_key=os.environ.get("INCREASE_API_KEY"), # This is the default and can be omitted
)
entity_beneficial_owner = client.beneficial_owners.create(
entity_id="entity_n8y8tnk2p9339ti393yi",
individual={
"address": {
"city": "New York",
"country": "US",
"line1": "33 Liberty Street",
},
"date_of_birth": date.fromisoformat("1970-01-31"),
"identification": {
"method": "social_security_number",
"number": "078051120",
},
"name": "Ian Crease",
},
prongs=["control"],
)
print(entity_beneficial_owner.id)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
require "increase"
increase = Increase::Client.new(
api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)
entity_beneficial_owner = increase.beneficial_owners.create(
entity_id: "entity_n8y8tnk2p9339ti393yi",
individual: {
address: {city: "New York", country: "US", line1: "33 Liberty Street"},
date_of_birth: "1970-01-31",
identification: {method: :social_security_number, number: "078051120"},
name: "Ian Crease"
},
prongs: [:control]
)
puts(entity_beneficial_owner)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
package main
import (
"context"
"fmt"
"os"
"time"
"github.com/Increase/increase-go"
"github.com/Increase/increase-go/option"
)
func main() {
client := increase.NewClient(
option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
)
entityBeneficialOwner, err := client.BeneficialOwners.New(context.TODO(), increase.BeneficialOwnerNewParams{
EntityID: increase.F("entity_n8y8tnk2p9339ti393yi"),
Individual: increase.F(increase.BeneficialOwnerNewParamsIndividual{
Address: increase.F(increase.BeneficialOwnerNewParamsIndividualAddress{
City: increase.F("New York"),
Country: increase.F("US"),
Line1: increase.F("33 Liberty Street"),
}),
DateOfBirth: increase.F(time.Now()),
Identification: increase.F(increase.BeneficialOwnerNewParamsIndividualIdentification{
Method: increase.F(increase.BeneficialOwnerNewParamsIndividualIdentificationMethodSocialSecurityNumber),
Number: increase.F("078051120"),
}),
Name: increase.F("Ian Crease"),
}),
Prongs: increase.F([]increase.BeneficialOwnerNewParamsProng{increase.BeneficialOwnerNewParamsProngControl}),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", entityBeneficialOwner.ID)
}
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
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.beneficialowners.BeneficialOwnerCreateParams;
import com.increase.api.models.beneficialowners.EntityBeneficialOwner;
import java.time.LocalDate;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
BeneficialOwnerCreateParams params = BeneficialOwnerCreateParams.builder()
.entityId("entity_n8y8tnk2p9339ti393yi")
.individual(BeneficialOwnerCreateParams.Individual.builder()
.address(BeneficialOwnerCreateParams.Individual.Address.builder()
.city("New York")
.country("US")
.line1("33 Liberty Street")
.build())
.dateOfBirth(LocalDate.parse("1970-01-31"))
.identification(BeneficialOwnerCreateParams.Individual.Identification.builder()
.method(BeneficialOwnerCreateParams.Individual.Identification.Method.SOCIAL_SECURITY_NUMBER)
.number("078051120")
.build())
.name("Ian Crease")
.build())
.addProng(BeneficialOwnerCreateParams.Prong.CONTROL)
.build();
EntityBeneficialOwner entityBeneficialOwner = client.beneficialOwners().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
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.beneficialowners.BeneficialOwnerCreateParams
import com.increase.api.models.beneficialowners.EntityBeneficialOwner
import java.time.LocalDate
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val params: BeneficialOwnerCreateParams = BeneficialOwnerCreateParams.builder()
.entityId("entity_n8y8tnk2p9339ti393yi")
.individual(BeneficialOwnerCreateParams.Individual.builder()
.address(BeneficialOwnerCreateParams.Individual.Address.builder()
.city("New York")
.country("US")
.line1("33 Liberty Street")
.build())
.dateOfBirth(LocalDate.parse("1970-01-31"))
.identification(BeneficialOwnerCreateParams.Individual.Identification.builder()
.method(BeneficialOwnerCreateParams.Individual.Identification.Method.SOCIAL_SECURITY_NUMBER)
.number("078051120")
.build())
.name("Ian Crease")
.build())
.addProng(BeneficialOwnerCreateParams.Prong.CONTROL)
.build()
val entityBeneficialOwner: EntityBeneficialOwner = client.beneficialOwners().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
<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Increase\Client;
use Increase\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('INCREASE_API_KEY'));
try {
$entityBeneficialOwner = $client->beneficialOwners->create(
entityID: 'entity_n8y8tnk2p9339ti393yi',
individual: [
'address' => [
'city' => 'New York',
'country' => 'US',
'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',
);
var_dump($entityBeneficialOwner);
} catch (APIException $e) {
echo $e->getMessage();
}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
using System;
using Increase.Api;
using Increase.Api.Models.BeneficialOwners;
IncreaseClient client = new();
BeneficialOwnerCreateParams parameters = new()
{
EntityID = "entity_n8y8tnk2p9339ti393yi",
Individual = new()
{
Address = new()
{
City = "New York",
Country = "US",
Line1 = "33 Liberty Street",
Line2 = "x",
State = "NY",
Zip = "10045",
},
DateOfBirth = "1970-01-31",
Identification = new()
{
Method = Method.SocialSecurityNumber,
Number = "078051120",
DriversLicense = new()
{
ExpirationDate = "2019-12-27",
FileID = "file_id",
State = "xx",
BackFileID = "back_file_id",
},
Other = new()
{
Country = "x",
Description = "x",
FileID = "file_id",
BackFileID = "back_file_id",
ExpirationDate = "2019-12-27",
},
Passport = new()
{
Country = "x",
ExpirationDate = "2019-12-27",
FileID = "file_id",
},
},
Name = "Ian Crease",
ConfirmedNoUsTaxID = true,
},
Prongs =
[
Prong.Control
],
};
var entityBeneficialOwner = await client.BeneficialOwners.Create(parameters);
Console.WriteLine(entityBeneficialOwner);
Parameters
company_title
string
This person’s role or title within the entity.
entity_id
string
Required
The identifier of the Entity to associate with the new Beneficial Owner.
More about Entities.
individual
dictionary
Required
Personal details for the beneficial owner.
prongs
array of strings
Required
Why this person is considered a beneficial owner of the entity. At least one option is required, if a person is both a control person and owner, submit an array containing both.
Retrieve a Beneficial Owner
1
2
3
curl \
--url "${INCREASE_URL}/entity_beneficial_owners/entity_beneficial_owner_vozma8szzu1sxezp5zq6" \
-H "Authorization: Bearer ${INCREASE_API_KEY}"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 entityBeneficialOwner = await client.beneficialOwners.retrieve(
'entity_beneficial_owner_vozma8szzu1sxezp5zq6',
);
console.log(entityBeneficialOwner.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_beneficial_owner = client.beneficial_owners.retrieve(
"entity_beneficial_owner_vozma8szzu1sxezp5zq6",
)
print(entity_beneficial_owner.id)1
2
3
4
5
6
7
8
9
require "increase"
increase = Increase::Client.new(
api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)
entity_beneficial_owner = increase.beneficial_owners.retrieve("entity_beneficial_owner_vozma8szzu1sxezp5zq6")
puts(entity_beneficial_owner)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
package main
import (
"context"
"fmt"
"os"
"github.com/Increase/increase-go"
"github.com/Increase/increase-go/option"
)
func main() {
client := increase.NewClient(
option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
)
entityBeneficialOwner, err := client.BeneficialOwners.Get(context.TODO(), "entity_beneficial_owner_vozma8szzu1sxezp5zq6")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", entityBeneficialOwner.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.beneficialowners.BeneficialOwnerRetrieveParams;
import com.increase.api.models.beneficialowners.EntityBeneficialOwner;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
EntityBeneficialOwner entityBeneficialOwner = client.beneficialOwners().retrieve("entity_beneficial_owner_vozma8szzu1sxezp5zq6");
}
}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.beneficialowners.BeneficialOwnerRetrieveParams
import com.increase.api.models.beneficialowners.EntityBeneficialOwner
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val entityBeneficialOwner: EntityBeneficialOwner = client.beneficialOwners().retrieve("entity_beneficial_owner_vozma8szzu1sxezp5zq6")
}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'));
try {
$entityBeneficialOwner = $client->beneficialOwners->retrieve(
'entity_beneficial_owner_vozma8szzu1sxezp5zq6'
);
var_dump($entityBeneficialOwner);
} 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.BeneficialOwners;
IncreaseClient client = new();
BeneficialOwnerRetrieveParams parameters = new()
{
EntityBeneficialOwnerID = "entity_beneficial_owner_vozma8szzu1sxezp5zq6"
};
var entityBeneficialOwner = await client.BeneficialOwners.Retrieve(parameters);
Console.WriteLine(entityBeneficialOwner);
Parameters
entity_beneficial_owner_id
string
Required
The identifier of the Beneficial Owner to retrieve.
More about Beneficial Owners.
Update a Beneficial Owner
1
2
3
4
5
6
7
8
9
10
11
12
13
14
curl -X "PATCH" \
--url "${INCREASE_URL}/entity_beneficial_owners/entity_beneficial_owner_vozma8szzu1sxezp5zq6" \
-H "Authorization: Bearer ${INCREASE_API_KEY}" \
-H "Content-Type: application/json" \
-d $'{
"address": {
"city": "New York",
"country": "US",
"line1": "33 Liberty Street",
"line2": "Unit 2",
"state": "NY",
"zip": "10045"
}
}'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 entityBeneficialOwner = await client.beneficialOwners.update(
'entity_beneficial_owner_vozma8szzu1sxezp5zq6',
);
console.log(entityBeneficialOwner.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_beneficial_owner = client.beneficial_owners.update(
entity_beneficial_owner_id="entity_beneficial_owner_vozma8szzu1sxezp5zq6",
)
print(entity_beneficial_owner.id)1
2
3
4
5
6
7
8
9
require "increase"
increase = Increase::Client.new(
api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)
entity_beneficial_owner = increase.beneficial_owners.update("entity_beneficial_owner_vozma8szzu1sxezp5zq6")
puts(entity_beneficial_owner)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
package main
import (
"context"
"fmt"
"os"
"github.com/Increase/increase-go"
"github.com/Increase/increase-go/option"
)
func main() {
client := increase.NewClient(
option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
)
entityBeneficialOwner, err := client.BeneficialOwners.Update(
context.TODO(),
"entity_beneficial_owner_vozma8szzu1sxezp5zq6",
increase.BeneficialOwnerUpdateParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", entityBeneficialOwner.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.beneficialowners.BeneficialOwnerUpdateParams;
import com.increase.api.models.beneficialowners.EntityBeneficialOwner;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
EntityBeneficialOwner entityBeneficialOwner = client.beneficialOwners().update("entity_beneficial_owner_vozma8szzu1sxezp5zq6");
}
}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.beneficialowners.BeneficialOwnerUpdateParams
import com.increase.api.models.beneficialowners.EntityBeneficialOwner
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val entityBeneficialOwner: EntityBeneficialOwner = client.beneficialOwners().update("entity_beneficial_owner_vozma8szzu1sxezp5zq6")
}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
<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Increase\Client;
use Increase\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('INCREASE_API_KEY'));
try {
$entityBeneficialOwner = $client->beneficialOwners->update(
'entity_beneficial_owner_vozma8szzu1sxezp5zq6',
address: [
'city' => 'New York',
'country' => 'US',
'line1' => '33 Liberty Street',
'line2' => 'Unit 2',
'state' => 'NY',
'zip' => '10045',
],
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',
prongs: ['ownership'],
);
var_dump($entityBeneficialOwner);
} 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.BeneficialOwners;
IncreaseClient client = new();
BeneficialOwnerUpdateParams parameters = new()
{
EntityBeneficialOwnerID = "entity_beneficial_owner_vozma8szzu1sxezp5zq6"
};
var entityBeneficialOwner = await client.BeneficialOwners.Update(parameters);
Console.WriteLine(entityBeneficialOwner);
Parameters
entity_beneficial_owner_id
string
Required
The identifier of the Beneficial Owner to update.
More about Beneficial Owners.
address
dictionary
The individual’s physical address. Mail receiving locations like PO Boxes and PMB’s are disallowed.
confirmed_no_us_tax_id
boolean
The identification method for an individual can only be a passport, driver’s license, or other document if you’ve confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number).
identification
dictionary
A means of verifying the person’s identity.
name
string
The individual’s legal name.
prongs
array of strings
Why this person is considered a beneficial owner of the entity. At least one option is required, if a person is both a control person and owner, submit an array containing both. Providing this replaces the beneficial owner’s current prongs.
Archive a Beneficial Owner
1
2
3
curl -X "POST" \
--url "${INCREASE_URL}/entity_beneficial_owners/entity_beneficial_owner_vozma8szzu1sxezp5zq6/archive" \
-H "Authorization: Bearer ${INCREASE_API_KEY}"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 entityBeneficialOwner = await client.beneficialOwners.archive(
'entity_beneficial_owner_vozma8szzu1sxezp5zq6',
);
console.log(entityBeneficialOwner.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_beneficial_owner = client.beneficial_owners.archive(
"entity_beneficial_owner_vozma8szzu1sxezp5zq6",
)
print(entity_beneficial_owner.id)1
2
3
4
5
6
7
8
9
require "increase"
increase = Increase::Client.new(
api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)
entity_beneficial_owner = increase.beneficial_owners.archive("entity_beneficial_owner_vozma8szzu1sxezp5zq6")
puts(entity_beneficial_owner)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
package main
import (
"context"
"fmt"
"os"
"github.com/Increase/increase-go"
"github.com/Increase/increase-go/option"
)
func main() {
client := increase.NewClient(
option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
)
entityBeneficialOwner, err := client.BeneficialOwners.Archive(context.TODO(), "entity_beneficial_owner_vozma8szzu1sxezp5zq6")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", entityBeneficialOwner.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.beneficialowners.BeneficialOwnerArchiveParams;
import com.increase.api.models.beneficialowners.EntityBeneficialOwner;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
EntityBeneficialOwner entityBeneficialOwner = client.beneficialOwners().archive("entity_beneficial_owner_vozma8szzu1sxezp5zq6");
}
}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.beneficialowners.BeneficialOwnerArchiveParams
import com.increase.api.models.beneficialowners.EntityBeneficialOwner
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val entityBeneficialOwner: EntityBeneficialOwner = client.beneficialOwners().archive("entity_beneficial_owner_vozma8szzu1sxezp5zq6")
}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'));
try {
$entityBeneficialOwner = $client->beneficialOwners->archive(
'entity_beneficial_owner_vozma8szzu1sxezp5zq6'
);
var_dump($entityBeneficialOwner);
} 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.BeneficialOwners;
IncreaseClient client = new();
BeneficialOwnerArchiveParams parameters = new()
{
EntityBeneficialOwnerID = "entity_beneficial_owner_vozma8szzu1sxezp5zq6"
};
var entityBeneficialOwner = await client.BeneficialOwners.Archive(parameters);
Console.WriteLine(entityBeneficialOwner);
Parameters
entity_beneficial_owner_id
string
Required
The identifier of the Beneficial Owner to archive.
More about Beneficial Owners.