Persons v2
A Person represents an individual associated with an Account’s identity (for example, an owner, director, executive, or representative). Use Persons to provide and update identity information for verification and compliance.
Attributes
- idstring
Unique identifier for the Person.
- objectstring, value is "v2.core.account_person"
String representing the object’s type. Objects of the same type share the same value of the object field.
- accountstring
The account ID which the individual belongs to.
- additional_
addressesnullable array of objects Additional addresses associated with the person.
- additional_
namesnullable array of objects Additional names (e.g. aliases) associated with the person.
- additional_
terms_ of_ servicenullable object Attestations of accepted terms of service agreements.
- addressnullable object
The person’s residential address.
- createdtimestamp
Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
- date_
of_ birthnullable object The person’s date of birth.
- documentsnullable object
Documents that may be submitted to satisfy various informational requests.
- emailnullable string
The person’s email address.
- given_
namenullable string The person’s first name.
- id_
numbersnullable array of objects The identification numbers (e.g., SSN) associated with the person.
- legal_
gendernullable enum The person’s gender (International regulations require either “male” or “female”).
Possible enum valuesfemaleFemale gender person.
maleMale gender person.
- livemodeboolean
Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - metadatanullable map
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- nationalitiesnullable array of enums
The countries where the person is a national. Two-letter country code (ISO 3166-1 alpha-2).
- phonenullable string
The person’s phone number.
- political_
exposurenullable enum The person’s political exposure.
Possible enum valuesexistingThe person has disclosed that they do have political exposure.
noneThe person has disclosed that they have no political exposure.
- relationshipnullable object
The relationship that this person has with the Account’s business or legal entity.
- script_
addressesnullable object The script addresses (e.g., non-Latin characters) associated with the person.
- script_
namesnullable object The script names (e.g. non-Latin characters) associated with the person.
- surnamenullable string
The person’s last name.
- updatedtimestamp
Time at which the object was last updated. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
{ "id": "person_test_61RS0CgWt1xBt8M1Q16RS0Cg0WSQO5ZXUVpZxZ9tAIbY", "object": "v2.core.account_person", "account": "acct_1Nv0FGQ9RKHgCVdK", "additional_addresses": [], "additional_names": [], "address": { "city": "Brothers", "country": "us", "line1": "27 Fredrick Ave", "postal_code": "97712", "state": "OR" }, "created": "2024-11-26T17:10:07.000Z", "email": "jenny.rosen@example.com", "given_name": "Jenny", "id_numbers": [ { "type": "us_ssn_last_4" } ], "metadata": {}, "nationalities": [], "relationship": { "owner": true, "percent_ownership": "0.8", "representative": true, "title": "CEO" }, "surname": "Rosen", "updated": "2024-11-26T17:10:07.000Z"}Create a Person. Adds an individual to an Account’s identity. You can set relationship attributes and identity information at creation.
Learn more about calling API v2 endpoints.Parameters
- account_
idstringRequired Account the Person should be associated with.
- additional_
addressesarray of objects Additional addresses associated with the person.
- additional_
namesarray of objects Additional names (e.g. aliases) associated with the person.
- additional_
terms_ of_ serviceobject Attestations of accepted terms of service agreements.
- addressobject
The person’s residential address.
- date_
of_ birthobject The person’s date of birth.
- documentsobject
Documents that may be submitted to satisfy various informational requests.
- emailstring
Email.
- given_
namestring The person’s first name.
- id_
numbersarray of objects The identification numbers (e.g., SSN) associated with the person.
- legal_
genderenum The person’s gender (International regulations require either “male” or “female”).
Possible enum valuesfemaleFemale gender person.
maleMale gender person.
- metadatamap
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- nationalitiesarray of enums
The nationalities (countries) this person is associated with.
- person_
tokenstring The person token generated by the person token api.
- phonestring
The phone number for this person.
- political_
exposureenum The person’s political exposure.
Possible enum valuesexistingThe person has disclosed that they do have political exposure.
noneThe person has disclosed that they have no political exposure.
- relationshipobject
The relationship that this person has with the Account’s business or legal entity.
- script_
addressesobject The script addresses (e.g., non-Latin characters) associated with the person.
- script_
namesobject The script names (e.g. non-Latin characters) associated with the person.
- surnamestring
The person’s last name.
Returns
Response attributes
- idstring
Unique identifier for the Person.
- objectstring, value is "v2.core.account_person"
String representing the object’s type. Objects of the same type share the same value of the object field.
- accountstring
The account ID which the individual belongs to.
- additional_
addressesnullable array of objects Additional addresses associated with the person.
- additional_
namesnullable array of objects Additional names (e.g. aliases) associated with the person.
- additional_
terms_ of_ servicenullable object Attestations of accepted terms of service agreements.
- addressnullable object
The person’s residential address.
- createdtimestamp
Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
- date_
of_ birthnullable object The person’s date of birth.
- documentsnullable object
Documents that may be submitted to satisfy various informational requests.
- emailnullable string
The person’s email address.
- given_
namenullable string The person’s first name.
- id_
numbersnullable array of objects The identification numbers (e.g., SSN) associated with the person.
- legal_
gendernullable enum The person’s gender (International regulations require either “male” or “female”).
Possible enum valuesfemaleFemale gender person.
maleMale gender person.
- livemodeboolean
Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - metadatanullable map
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- nationalitiesnullable array of enums
The countries where the person is a national. Two-letter country code (ISO 3166-1 alpha-2).
- phonenullable string
The person’s phone number.
- political_
exposurenullable enum The person’s political exposure.
Possible enum valuesexistingThe person has disclosed that they do have political exposure.
noneThe person has disclosed that they have no political exposure.
- relationshipnullable object
The relationship that this person has with the Account’s business or legal entity.
- script_
addressesnullable object The script addresses (e.g., non-Latin characters) associated with the person.
- script_
namesnullable object The script names (e.g. non-Latin characters) associated with the person.
- surnamenullable string
The person’s last name.
- updatedtimestamp
Time at which the object was last updated. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
Account is not yet compatible with V2 APIs.
Accounts v2 is not enabled for your platform.
More than one legal guardian is added to an account.
More than one representative is added to an account.
Additional terms of service are signed by someone other than the legal guardian.
Invalid characters are provided for address fields.
Address country doesn’t match identity country.
Registered/script address country doesn’t match residential address country.
Address country is required but not provided.
Address postal code is invalid.
Address state is invalid.
Address town is invalid.
There can only be one authorizer.
An authorizer cannot be a representative.
Representative date of birth does not meet the age limit.
Representative date of birth is provided an invalid date or a future date.
Provided file tokens for documents are invalid, not found, deleted, or belong to a different account.
Provided file tokens for documents are of the wrong purpose.
Duplicate person is added to an account.
Email contains unsupported domain.
Incorrect email is provided.
Provided ID number is of the wrong format for the given type.
The identity. value is required but not provided.
A person token is created with one account but used on a different account.
Incorrect ID number is provided for a country.
The incorrect token type is provided .
Additional person is added for an individual business type.
Some relationships are specific to type, structure, and country.
Invalid IP address is provided.
Person is designated as both legal guardian and representative.
A legal guardian may not be added to the account without an existing representative.
Kana Kanji script addresses must have JP country.
Parameter cannot be passed alongside person_token.
Error returned when relationship.owner is set to true but the ownership percentage is set to 0%.
Person token required for platforms in mandated countries (e.g., France).
Phone number is invalid.
Postal code is required for Japanese addresses.
Provided script characters are invalid for the script.
The token is re-used with a different idempotency key.
Token has expired.
Total ownership percentages of all Persons on the account exceeds 100%.
Address is in an unsupported postal code.
Address is in an unsupported state.
V1 Account ID cannot be used in V2 Account APIs.
V1 Customer ID cannot be used in V2 Account APIs.
A v1 token ID is passed in v2 APIs.
Invalid person token.
Account cannot exceed a configured concurrency rate limit on updates.
{ "id": "person_test_61RS0CgWt1xBt8M1Q16RS0Cg0WSQO5ZXUVpZxZ9tAIbY", "object": "v2.core.account_person", "account": "acct_1Nv0FGQ9RKHgCVdK", "additional_addresses": [], "additional_names": [], "address": { "city": "Brothers", "country": "us", "line1": "27 Fredrick Ave", "postal_code": "97712", "state": "OR" }, "created": "2024-11-26T17:10:07.000Z", "email": "jenny.rosen@example.com", "given_name": "Jenny", "id_numbers": [ { "type": "us_ssn_last_4" } ], "livemode": true, "metadata": {}, "nationalities": [], "relationship": { "owner": true, "percent_ownership": "0.8", "representative": true, "title": "CEO" }, "surname": "Rosen", "updated": "2024-11-26T17:10:07.000Z"}Updates a Person associated with an Account.
Learn more about calling API v2 endpoints.Parameters
- account_
idstringRequired The Account the Person is associated with.
- idstringRequired
The ID of the Person to update.
- additional_
addressesarray of objects Additional addresses associated with the person.
- additional_
namesarray of objects Additional names (e.g. aliases) associated with the person.
- additional_
terms_ of_ serviceobject Attestations of accepted terms of service agreements.
- addressobject
The primary address associated with the person.
- date_
of_ birthobject The person’s date of birth.
- documentsobject
Documents that may be submitted to satisfy various informational requests.
- emailstring
Email.
- given_
namestring The person’s first name.
- id_
numbersarray of objects The identification numbers (e.g., SSN) associated with the person.
- legal_
genderenum The person’s gender (International regulations require either “male” or “female”).
Possible enum valuesfemaleFemale gender person.
maleMale gender person.
- metadatamap
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- nationalitiesarray of enums
The nationalities (countries) this person is associated with.
- person_
tokenstring The person token generated by the person token api.
- phonestring
The phone number for this person.
- political_
exposureenum The person’s political exposure.
Possible enum valuesexistingThe person has disclosed that they do have political exposure.
noneThe person has disclosed that they have no political exposure.
- relationshipobject
The relationship that this person has with the Account’s business or legal entity.
- script_
addressesobject The script addresses (e.g., non-Latin characters) associated with the person.
- script_
namesobject The script names (e.g. non-Latin characters) associated with the person.
- surnamestring
The person’s last name.
Returns
Response attributes
- idstring
Unique identifier for the Person.
- objectstring, value is "v2.core.account_person"
String representing the object’s type. Objects of the same type share the same value of the object field.
- accountstring
The account ID which the individual belongs to.
- additional_
addressesnullable array of objects Additional addresses associated with the person.
- additional_
namesnullable array of objects Additional names (e.g. aliases) associated with the person.
- additional_
terms_ of_ servicenullable object Attestations of accepted terms of service agreements.
- addressnullable object
The person’s residential address.
- createdtimestamp
Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
- date_
of_ birthnullable object The person’s date of birth.
- documentsnullable object
Documents that may be submitted to satisfy various informational requests.
- emailnullable string
The person’s email address.
- given_
namenullable string The person’s first name.
- id_
numbersnullable array of objects The identification numbers (e.g., SSN) associated with the person.
- legal_
gendernullable enum The person’s gender (International regulations require either “male” or “female”).
Possible enum valuesfemaleFemale gender person.
maleMale gender person.
- livemodeboolean
Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - metadatanullable map
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- nationalitiesnullable array of enums
The countries where the person is a national. Two-letter country code (ISO 3166-1 alpha-2).
- phonenullable string
The person’s phone number.
- political_
exposurenullable enum The person’s political exposure.
Possible enum valuesexistingThe person has disclosed that they do have political exposure.
noneThe person has disclosed that they have no political exposure.
- relationshipnullable object
The relationship that this person has with the Account’s business or legal entity.
- script_
addressesnullable object The script addresses (e.g., non-Latin characters) associated with the person.
- script_
namesnullable object The script names (e.g. non-Latin characters) associated with the person.
- surnamenullable string
The person’s last name.
- updatedtimestamp
Time at which the object was last updated. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
Account is not yet compatible with V2 APIs.
Accounts v2 is not enabled for your platform.
More than one legal guardian is added to an account.
More than one representative is added to an account.
Additional terms of service are signed by someone other than the legal guardian.
Invalid characters are provided for address fields.
Address country doesn’t match identity country.
Registered/script address country doesn’t match residential address country.
Address country is required but not provided.
Address postal code is invalid.
Address state is invalid.
Address town is invalid.
Representative date of birth does not meet the age limit.
Representative date of birth is provided an invalid date or a future date.
Provided file tokens for documents are invalid, not found, deleted, or belong to a different account.
Provided file tokens for documents are of the wrong purpose.
Duplicate person is added to an account.
Email contains unsupported domain.
Incorrect email is provided.
Provided ID number is of the wrong format for the given type.
The identity. value is required but not provided.
Identity param has been made immutable due to the state of the account.
A person token is created with one account but used on a different account.
Incorrect ID number is provided for a country.
The incorrect token type is provided .
Invalid IP address is provided.
Person is designated as both legal guardian and representative.
A legal guardian may not be added to the account without an existing representative.
Kana Kanji script addresses must have JP country.
Parameter cannot be passed alongside person_token.
Error returned when relationship.owner is set to true but the ownership percentage is set to 0%.
Person token required for platforms in mandated countries (e.g., France).
Phone number is invalid.
Postal code is required for Japanese addresses.
Provided script characters are invalid for the script.
The token is re-used with a different idempotency key.
Token has expired.
Total ownership percentages of all Persons on the account exceeds 100%.
Address is in an unsupported postal code.
Address is in an unsupported state.
V1 Account ID cannot be used in V2 Account APIs.
V1 Customer ID cannot be used in V2 Account APIs.
A v1 token ID is passed in v2 APIs.
Invalid person token.
The resource wasn’t found.
Account cannot exceed a configured concurrency rate limit on updates.
{ "id": "person_test_61RS0CgWt1xBt8M1Q16RS0Cg0WSQO5ZXUVpZxZ9tAIbY", "object": "v2.core.account_person", "account": "acct_1Nv0FGQ9RKHgCVdK", "additional_addresses": [], "additional_names": [], "address": { "city": "Brothers", "country": "us", "line1": "27 Fredrick Ave", "postal_code": "97712", "state": "OR" }, "created": "2024-11-26T17:10:07.000Z", "date_of_birth": { "day": 28, "month": 1, "year": 2000 }, "email": "jenny.rosen@example.com", "given_name": "Jenny", "id_numbers": [ { "type": "us_ssn_last_4" } ], "livemode": true, "metadata": {}, "nationalities": [], "relationship": { "owner": true, "percent_ownership": "0.8", "representative": true, "title": "CEO" }, "surname": "Rosen", "updated": "2024-11-26T17:12:55.000Z"}Retrieves a Person associated with an Account.
Learn more about calling API v2 endpoints.Parameters
- account_
idstringRequired The Account the Person is associated with.
- idstringRequired
The ID of the Person to retrieve.
Returns
Response attributes
- idstring
Unique identifier for the Person.
- objectstring, value is "v2.core.account_person"
String representing the object’s type. Objects of the same type share the same value of the object field.
- accountstring
The account ID which the individual belongs to.
- additional_
addressesnullable array of objects Additional addresses associated with the person.
- additional_
namesnullable array of objects Additional names (e.g. aliases) associated with the person.
- additional_
terms_ of_ servicenullable object Attestations of accepted terms of service agreements.
- addressnullable object
The person’s residential address.
- createdtimestamp
Time at which the object was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
- date_
of_ birthnullable object The person’s date of birth.
- documentsnullable object
Documents that may be submitted to satisfy various informational requests.
- emailnullable string
The person’s email address.
- given_
namenullable string The person’s first name.
- id_
numbersnullable array of objects The identification numbers (e.g., SSN) associated with the person.
- legal_
gendernullable enum The person’s gender (International regulations require either “male” or “female”).
Possible enum valuesfemaleFemale gender person.
maleMale gender person.
- livemodeboolean
Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - metadatanullable map
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- nationalitiesnullable array of enums
The countries where the person is a national. Two-letter country code (ISO 3166-1 alpha-2).
- phonenullable string
The person’s phone number.
- political_
exposurenullable enum The person’s political exposure.
Possible enum valuesexistingThe person has disclosed that they do have political exposure.
noneThe person has disclosed that they have no political exposure.
- relationshipnullable object
The relationship that this person has with the Account’s business or legal entity.
- script_
addressesnullable object The script addresses (e.g., non-Latin characters) associated with the person.
- script_
namesnullable object The script names (e.g. non-Latin characters) associated with the person.
- surnamenullable string
The person’s last name.
- updatedtimestamp
Time at which the object was last updated. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
Account is not yet compatible with V2 APIs.
Accounts v2 is not enabled for your platform.
V1 Account ID cannot be used in V2 Account APIs.
V1 Customer ID cannot be used in V2 Account APIs.
The resource wasn’t found.
Account cannot exceed a configured concurrency rate limit on updates.
{ "id": "person_test_61RS0CgWt1xBt8M1Q16RS0Cg0WSQO5ZXUVpZxZ9tAIbY", "object": "v2.core.account_person", "account": "acct_1Nv0FGQ9RKHgCVdK", "additional_addresses": [], "additional_names": [], "address": { "city": "Brothers", "country": "us", "line1": "27 Fredrick Ave", "postal_code": "97712", "state": "OR" }, "created": "2024-11-26T17:10:07.000Z", "date_of_birth": { "day": 28, "month": 1, "year": 2000 }, "email": "jenny.rosen@example.com", "given_name": "Jenny", "id_numbers": [ { "type": "us_ssn_last_4" } ], "livemode": true, "metadata": {}, "nationalities": [], "relationship": { "owner": true, "percent_ownership": "0.8", "representative": true, "title": "CEO" }, "surname": "Rosen", "updated": "2024-11-26T17:12:55.000Z"}