Attributes
- idstring
Unique identifier for the token.
- objectstring, value is "v2.core.account_person_token"
String representing the object’s type. Objects of the same type share the same value of the object field.
- createdtimestamp
Time at which the token was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
- expires_
attimestamp Time at which the token will expire.
- livemodeboolean
Has the value
trueif the token exists in live mode or the valuefalseif the object exists in test mode. - usedboolean
Determines if the token has already been used (tokens can only be used once).
{ "id": "perstok_61RS0CgWt1xBt8M1Q16RS0Cg0WSQO5ZXUVpZxZ9tAIbY", "object": "v2.core.account_person_token", "created": "2025-11-17T14:00:00.000Z", "expires_at": "2025-11-17T14:10:00.000Z", "livemode": true, "used": false}Creates a Person Token associated with an Account.
Learn more about calling API v2 endpoints.Parameters
- account_
idstringRequired The Account the Person is 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.
- 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 token.
- objectstring, value is "v2.core.account_person_token"
String representing the object’s type. Objects of the same type share the same value of the object field.
- createdtimestamp
Time at which the token was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
- expires_
attimestamp Time at which the token will expire.
- livemodeboolean
Has the value
trueif the token exists in live mode or the valuefalseif the object exists in test mode. - usedboolean
Determines if the token has already been used (tokens can only be used once).
Token must be created with publishable key.
Account cannot exceed a configured concurrency rate limit on updates.
{ "id": "perstok_61RS0CgWt1xBt8M1Q16RS0Cg0WSQO5ZXUVpZxZ9tAIbY", "object": "v2.core.account_person_token", "created": "2025-11-17T14:00:00.000Z", "expires_at": "2025-11-17T14:10:00.000Z", "livemode": true, "used": false}Retrieves a Person Token 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 Token to retrieve.
Returns
Response attributes
- idstring
Unique identifier for the token.
- objectstring, value is "v2.core.account_person_token"
String representing the object’s type. Objects of the same type share the same value of the object field.
- createdtimestamp
Time at which the token was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
- expires_
attimestamp Time at which the token will expire.
- livemodeboolean
Has the value
trueif the token exists in live mode or the valuefalseif the object exists in test mode. - usedboolean
Determines if the token has already been used (tokens can only be used once).
The resource wasn’t found.
Account cannot exceed a configured concurrency rate limit on updates.
{ "id": "perstok_61RS0CgWt1xBt8M1Q16RS0Cg0WSQO5ZXUVpZxZ9tAIbY", "object": "v2.core.account_person_token", "created": "2025-11-17T14:00:00.000Z", "expires_at": "2025-11-17T14:10:00.000Z", "livemode": true, "used": true}