Create a person

POST / v1 / accounts /:id / persons

Creates a new person.

Parameters

address object The person’s address.
dob object The person’s date of birth.
email string The person’s email address. The maximum length is 800 characters.
first _ name string The person’s first name.
id _ number string The person’s ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js. Changing this value for the account’s representative requires that the account re-accept the terms of service.
last _ name string The person’s last name.
metadata 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
phone string The person’s phone number.
relationship object The relationship that this person has with the account’s legal entity.
ssn _ last _ 4 string The last four digits of the person’s Social Security number (U.S. only). Changing this value for the account’s representative requires that the account re-accept the terms of service.

More parameters

additional _ tos _ acceptances object
address _ kana object
address _ kanji object
documents object
first _ name _ kana string
first _ name _ kanji string
full _ name _ aliases array of strings
gender enum
id _ number _ secondary string
last _ name _ kana string
last _ name _ kanji string
maiden _ name string
nationality string
person _ token string
political _ exposure enum
registered _ address object
us _ cfpb _ data object
verification object

Returns

Returns a person object.

Response

{ "id": "person_1N9XNb2eZvKYlo2CjPX7xF6F", "object": "person", "account": "acct_1032D82eZvKYlo2C", "created": 1684518375, "dob": { "day": null, "month": null, "year": null }, "first_name": "John", "future_requirements": { "alternatives": [], "currently_due": [], "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "id_number_provided": false, "last_name": "Doe", "metadata": {}, "relationship": { "director": false, "executive": false, "owner": false, "percent_ownership": null, "representative": false, "title": null }, "requirements": { "alternatives": [], "currently_due": [], "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "ssn_last_4_provided": false, "verification": { "additional_document": { "back": null, "details": null, "details_code": null, "front": null }, "details": null, "details_code": null, "document": { "back": null, "details": null, "details_code": null, "front": null }, "status": "unverified" }}

Update a person

POST / v1 / accounts /:id / persons /:id

Updates an existing person.

Parameters

address object The person’s address.
dob object The person’s date of birth.
email string The person’s email address. The maximum length is 800 characters.
first _ name string The person’s first name.
id _ number string The person’s ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js. Changing this value for the account’s representative requires that the account re-accept the terms of service.
last _ name string The person’s last name.
metadata 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
phone string The person’s phone number.
relationship object The relationship that this person has with the account’s legal entity.
ssn _ last _ 4 string The last four digits of the person’s Social Security number (U.S. only). Changing this value for the account’s representative requires that the account re-accept the terms of service.

More parameters

additional _ tos _ acceptances object
address _ kana object
address _ kanji object
documents object
first _ name _ kana string
first _ name _ kanji string
full _ name _ aliases array of strings
gender enum
id _ number _ secondary string
last _ name _ kana string
last _ name _ kanji string
maiden _ name string
nationality string
person _ token string
political _ exposure enum
registered _ address object
us _ cfpb _ data object
verification object

Returns

Returns a person object.

Response

{ "id": "person_1MqjB62eZvKYlo2CaeEJzKVR", "person": "person_1MqjB62eZvKYlo2CaeEJzKVR", "object": "person", "account": "acct_1032D82eZvKYlo2C", "created": 1680035496, "dob": { "day": null, "month": null, "year": null }, "first_name": "Jane", "future_requirements": { "alternatives": [], "currently_due": [], "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "id_number_provided": false, "last_name": "Diaz", "metadata": { "order_id": "6735" }, "relationship": { "director": false, "executive": false, "owner": false, "percent_ownership": null, "representative": false, "title": null }, "requirements": { "alternatives": [], "currently_due": [], "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "ssn_last_4_provided": false, "verification": { "additional_document": { "back": null, "details": null, "details_code": null, "front": null }, "details": null, "details_code": null, "document": { "back": null, "details": null, "details_code": null, "front": null }, "status": "unverified" }}

Retrieve a person

GET / v1 / accounts /:id / persons /:id

Retrieves an existing person.

Parameters

No parameters.

Returns

Returns a person object.

Response

{ "id": "person_1N9XNb2eZvKYlo2CjPX7xF6F", "object": "person", "account": "acct_1032D82eZvKYlo2C", "created": 1684518375, "dob": { "day": null, "month": null, "year": null }, "first_name": null, "future_requirements": { "alternatives": [], "currently_due": [], "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "id_number_provided": false, "last_name": null, "metadata": {}, "relationship": { "director": false, "executive": false, "owner": false, "percent_ownership": null, "representative": false, "title": null }, "requirements": { "alternatives": [], "currently_due": [], "errors": [], "eventually_due": [], "past_due": [], "pending_verification": [] }, "ssn_last_4_provided": false, "verification": { "additional_document": { "back": null, "details": null, "details_code": null, "front": null }, "details": null, "details_code": null, "document": { "back": null, "details": null, "details_code": null, "front": null }, "status": "unverified" }}