Update a person

POST /v1/accounts/{account}/people/{person}

Copy endpoint

https://api.stripe.com/

Parameters

path Path Parameters

Name	Type
`account` required	string
`person` required	string

Request Body

application/x-www-form-urlencoded

{
additional_tos_acceptances?: { account?: { date?: number;ip?: string;user_agent?: string | ""; }; };
address?: {
city?: string;
country?: string;
line1?: string;
line2?: string;
postal_code?: string;
state?: string;
};
address_kana?: {
city?: string;
country?: string;
line1?: string;
line2?: string;
postal_code?: string;
state?: string;
town?: string;
};
address_kanji?: {
city?: string;
country?: string;
line1?: string;
line2?: string;
postal_code?: string;
state?: string;
town?: string;
};
dob?: { day: number;month: number;year: number; } | "";
documents?: { company_authorization?: { files?: (string | "")[]; };passport?: { files?: (string | "")[]; };visa?: { files?: (string | "")[]; }; };
email?: string;
expand?: string[];
first_name?: string;
first_name_kana?: string;
first_name_kanji?: string;
full_name_aliases?: string[] | "";
gender?: string;
id_number?: string;
id_number_secondary?: string;
last_name?: string;
last_name_kana?: string;
last_name_kanji?: string;
maiden_name?: string;
metadata?: { } | "";
nationality?: string;
person_token?: string;
phone?: string;
political_exposure?: "existing" | "none";
registered_address?: {
city?: string;
country?: string;
line1?: string;
line2?: string;
postal_code?: string;
state?: string;
};
relationship?: {
authorizer?: boolean;
director?: boolean;
executive?: boolean;
legal_guardian?: boolean;
owner?: boolean;
percent_ownership?: "" | number;
representative?: boolean;
title?: string;
};
ssn_last_4?: string;
us_cfpb_data?: { ethnicity_details?: { ethnicity?: ("cuban" | "hispanic_or_latino" | "mexican" | "not_hispanic_or_latino" | "other_hispanic_or_latino" | "prefer_not_to_answer" | "puerto_rican")[];ethnicity_other?: string; };race_details?: { race?: ("african_american" | "american_indian_or_alaska_native" | "asian" | "asian_indian" | "black_or_african_american" | "chinese" | "ethiopian" | "filipino" | "guamanian_or_chamorro" | "haitian" | "jamaican" | "japanese" | "korean" | "native_hawaiian" | "native_hawaiian_or_other_pacific_islander" | "nigerian" | "other_asian" | "other_black_or_african_american" | "other_pacific_islander" | "prefer_not_to_answer" | "samoan" | "somali" | "vietnamese" | "white")[];race_other?: string; };self_identified_gender?: string; };
verification?: { additional_document?: { back?: string;front?: string; };document?: { back?: string;front?: string; }; };
}

Responses

200 application/json

Successful response.

interface Person {
account: string;
additional_tos_acceptances?:

PersonAdditionalTosAcceptances

interface PersonAdditionalTosAcceptances {
account?: PersonAdditionalTosAcceptance | null;
}

;
address?:

Address

interface Address {
city?: string | null;
country?: string | null;
line1?: string | null;
line2?: string | null;
postal_code?: string | null;
state?: string | null;
}

;
address_kana?:

LegalEntityJapanAddress

interface LegalEntityJapanAddress {
city?: string | null;
country?: string | null;
line1?: string | null;
line2?: string | null;
postal_code?: string | null;
state?: string | null;
town?: string | null;
}

| null;
address_kanji?:

LegalEntityJapanAddress

| null;
created: number;
dob?:

LegalEntityDob

interface LegalEntityDob {
day?: number | null;
month?: number | null;
year?: number | null;
}

;
email?: string | null;
first_name?: string | null;
first_name_kana?: string | null;
first_name_kanji?: string | null;
full_name_aliases?: string[];
future_requirements?:

PersonFutureRequirements

interface PersonFutureRequirements {
alternatives?: AccountRequirementsAlternative[] | null;
currently_due: string[];
errors: AccountRequirementsError[];
eventually_due: string[];
past_due: string[];
pending_verification: string[];
}

| null;
gender?: string | null;
id: string;
id_number_provided?: boolean;
id_number_secondary_provided?: boolean;
last_name?: string | null;
last_name_kana?: string | null;
last_name_kanji?: string | null;
maiden_name?: string | null;
metadata?: { };
nationality?: string | null;
object: "person";
phone?: string | null;
political_exposure?: "existing" | "none";
registered_address?:

Address

interface Address {
city?: string | null;
country?: string | null;
line1?: string | null;
line2?: string | null;
postal_code?: string | null;
state?: string | null;
}

;
relationship?:

PersonRelationship

interface PersonRelationship {
authorizer?: boolean | null;
director?: boolean | null;
executive?: boolean | null;
legal_guardian?: boolean | null;
owner?: boolean | null;
percent_ownership?: number | null;
representative?: boolean | null;
title?: string | null;
}

;
requirements?:

PersonRequirements

interface PersonRequirements {
alternatives?: AccountRequirementsAlternative[] | null;
currently_due: string[];
errors: AccountRequirementsError[];
eventually_due: string[];
past_due: string[];
pending_verification: string[];
}

| null;
ssn_last_4_provided?: boolean;
us_cfpb_data?:

PersonUsCfpbData

interface PersonUsCfpbData {
ethnicity_details?: PersonEthnicityDetails | null;
race_details?: PersonRaceDetails | null;
self_identified_gender?: string | null;
}

| null;
verification?:

LegalEntityPersonVerification

interface LegalEntityPersonVerification {
additional_document?: LegalEntityPersonVerificationDocument | null;
details?: string | null;
details_code?: string | null;
document?: LegalEntityPersonVerificationDocument;
status: string;
}

;
}

default application/json

Error response.

interface Error {
error:

ApiErrors

interface ApiErrors {
advice_code?: string;
charge?: string;
code?: string;
decline_code?: string;
doc_url?: string;
message?: string;
network_advice_code?: string;
network_decline_code?: string;
param?: string;
payment_intent?: PaymentIntent;
payment_method?: PaymentMethod;
payment_method_type?: string;
request_log_url?: string;
setup_intent?: SetupIntent;
source?: BankAccount | Card | Source;
type: "api_error" | "card_error" | "idempotency_error" | "invalid_request_error";
}

;
}