Update a Sub Account Holder

PATCH

accounts

sub_account_holder

{sub_account_holder_id}

object

person

object

first_name

string

middle_name

string

last_name

string

id_type

enum<string>

id_number

string

date_of_birth

string

phone

string

address

object

line1

string

line2

string

city

string

state

string

country

string

postal_code

string

kyc

object

string

status

enum<string>

method

string

url

string

details

object

name

object

address

object

dob

object

ssn

object

phone

object

watchlist

object

fraud

object

idv

object

string

status

enum<string>

method

string

url

string

reasons

array

business

object

legal_name

string

dba

string

entity_type

enum<string>

id_type

enum<string>

id_number

string

phone

string

formation_date

string

address

object

line1

string

line2

string

city

string

state

string

country

string

postal_code

string

kyb

object

string

status

enum<string>

method

string

url

string

details

object

name

object

address

object

watchlist

object

fraud

object

members

array

verification

object

status

enum<string>

method

string

url

string

external_reference_id

string

purpose

string

metadata

object

status

enum<string>

Headers

api-key

string

required

API key is required to call Solid APIs. You can view and manage your API keys in the Solid dashboard.

Path Parameters

sub_account_holder_id

string

required

Body

application/json

person

object

person.first_name

string

first name of the person

person.middle_name

string

middle name of the person

person.last_name

string

last name of the person

person.id_type

enum<string>

type of identity used

Available options:

ssn,

passport,

other

person.id_number

string

if id_type is ssn, id_number must be full SSN
if id_type is passport, id_number must be passport number
if id_type is other, id_number must be unique number of the id

id_number must be unique, as in, you cannot use the same id_number for two different persons

person.date_of_birth

string

date of birth of the person (YYYY-MM-DD)

person.phone

string

phone number of the person (E.164, max 16 chars, starts with +)

person.email

string

email of the person

person.address

object

person.kyc

object

person.kyc.id

string

unique id of the KYC

person.kyc.status

enum<string>

status of the KYC

Available options:

pass,

fail,

review,

not_started

person.kyc.method

string

sub account holder verification method. It could be an external vendor(Ex: alloy) or Solid

person.kyc.url

string

url to the person or business verification result. It could be a link to the external vendor or Solid

person.kyc.details

object

person.idv

object

business

object

business.legal_name

string

legal name of the business

business.dba

string

doing business as

business.entity_type

enum<string>

entity type of the business

Available options:

sole_proprietor,

single_member_llc,

limited_liability_company,

general_partnership,

unlisted_corporation,

publicly_traded_corporation,

association,

non_profit,

government_organization,

revocable_trust,

irrevocable_trust,

estate,

professional_association,

limited_partnership,

limited_liability_partnership,

professional_corporation

business.id_type

enum<string>

type of the business identity used

Available options:

ein,

other

business.id_number

string

if id_type is ssn, id_number must be full SSN
if id_type is ein, id_number must be ein number
if id_type is other, id_number must be unique number of the id

id_number must be unique, as in, you cannot use the same id_number for two different businesses

business.phone

string

phone number of the business (E.164, max 16 chars, starts with +)

business.email

string

email of the business

business.formation_date

string

date business was formed (YYYY-MM-DD)

business.address

object

business.kyb

object

business.members

object[]

business.members.first_name

string

first name of the person

business.members.middle_name

string

middle name of the person

business.members.last_name

string

last name of the person

business.members.id_type

enum<string>

type of identity used

Available options:

ssn,

passport,

other

business.members.id_number

string

if id_type is ssn, id_number must be full SSN
if id_type is passport, id_number must be passport number
if id_type is other, id_number must be unique number of the id

id_number must be unique, as in, you cannot use the same id_number for two different persons

business.members.date_of_birth

string

date of birth of the person (YYYY-MM-DD)

business.members.phone

string

phone number of the person (E.164, max 16 chars, starts with +)

business.members.email

string

email of the person

business.members.address

object

business.members.ownership

number

ownership percentage in the business

business.members.title

string

title of the member in the business

business.members.control_person

enum<string>

true if this member is the control person of the business

Available options:

true,

false

business.members.kyc

object

verification

object

external_reference_id

string

unique id to cross-reference records with external systems

purpose

string

purpose of sub account holder

metadata

object

Metadata takes free-form key-value pairs. You may send metadata when you create an object (POST) and when updating the object (PATCH). If you would like to remove metadata that is already on an object, you can unset it by passing in the key-value pair with an empty string, like this: {"key": ""}

status

enum<string>

status of sub account holder

Available options:

open,

closed,

credit_blocked,

debit_blocked,

blocked,

locked

Response

200 - application/json

string

unique id of the sub account holder

client_id

string

unique id of the client that created the sub account

master_account_holder_id

string

unique id of the master account holder

master_account_id

string

unique id of the master account

person

object

person.first_name

string

first name of the person

person.middle_name

string

middle name of the person

person.last_name

string

last name of the person

person.id_type

enum<string>

type of identity used

Available options:

ssn,

passport,

other

person.id_number

string

if id_type is ssn, id_number must be full SSN
if id_type is passport, id_number must be passport number
if id_type is other, id_number must be unique number of the id

id_number must be unique, as in, you cannot use the same id_number for two different persons

person.date_of_birth

string

date of birth of the person (YYYY-MM-DD)

person.phone

string

phone number of the person (E.164, max 16 chars, starts with +)

person.email

string

email of the person

person.address

object

person.kyc

object

person.kyc.id

string

unique id of the KYC

person.kyc.status

enum<string>

status of the KYC

Available options:

pass,

fail,

review,

not_started

person.kyc.method

string

sub account holder verification method. It could be an external vendor(Ex: alloy) or Solid

person.kyc.url

string

url to the person or business verification result. It could be a link to the external vendor or Solid

person.kyc.details

object

person.idv

object

business

object

business.legal_name

string

legal name of the business

business.dba

string

doing business as

business.entity_type

enum<string>

entity type of the business

Available options:

sole_proprietor,

single_member_llc,

limited_liability_company,

general_partnership,

unlisted_corporation,

publicly_traded_corporation,

association,

non_profit,

government_organization,

revocable_trust,

irrevocable_trust,

estate,

professional_association,

limited_partnership,

limited_liability_partnership,

professional_corporation

business.id_type

enum<string>

type of the business identity used

Available options:

ein,

other

business.id_number

string

if id_type is ssn, id_number must be full SSN
if id_type is ein, id_number must be ein number
if id_type is other, id_number must be unique number of the id

id_number must be unique, as in, you cannot use the same id_number for two different businesses

business.phone

string

phone number of the business (E.164, max 16 chars, starts with +)

business.email

string

email of the business

business.formation_date

string

date business was formed (YYYY-MM-DD)

business.address

object

business.kyb

object

business.members

object[]

business.members.first_name

string

first name of the person

business.members.middle_name

string

middle name of the person

business.members.last_name

string

last name of the person

business.members.id_type

enum<string>

type of identity used

Available options:

ssn,

passport,

other

business.members.id_number

string

if id_type is ssn, id_number must be full SSN
if id_type is passport, id_number must be passport number
if id_type is other, id_number must be unique number of the id

id_number must be unique, as in, you cannot use the same id_number for two different persons

business.members.date_of_birth

string

date of birth of the person (YYYY-MM-DD)

business.members.phone

string

phone number of the person (E.164, max 16 chars, starts with +)

business.members.email

string

email of the person

business.members.address

object

business.members.ownership

number

ownership percentage in the business

business.members.title

string

title of the member in the business

business.members.control_person

enum<string>

true if this member is the control person of the business

Available options:

true,

false

business.members.kyc

object

ofac

object

external_reference_id

string

unique id to cross-reference records with external systems

purpose

string

purpose of sub account holder

attachments

object[]

metadata

object

status

enum<string>

status of sub account holder

Available options:

pending_activation,

activated,

suspended,

deactivated,

locked

timestamps

object

Retrieve a Sub Account Holder Submit a KYC

Getting Started

Master Accounts

Sub Account Holders

Sub Accounts

Counterparties

Card Holders

Cards

Transactions

Attachments

Webhooks

Simulation

Update a Sub Account Holder

Headers

Path Parameters

Body

Response