Creates a single-use token that represents the details for a person. Use this when you create or update persons associated with a Connect account. Learn more about account tokens.
You can only create person tokens with your application’s publishable key and in live mode. You can use your application’s secret key to create person tokens only in test mode.
Parameters
- personobjectRequired
Information for the person this token represents.
Returns
Returns the created person token if it’s successful. Otherwise, this call raises an error.
{ "id": "cpt_1EDww82eZvKYlo2CsdelTHFu", "object": "token", "client_ip": "8.21.168.117", "created": 1552582904, "livemode": false, "redaction": null, "type": "person", "used": false}Creates a single-use token that represents the details of personally identifiable information (PII). You can use this token in place of an id_number or id_number_secondary in Account or Person Update API methods. You can only use a PII token once.
Parameters
- piiobjectRequired
The PII this token represents.
Returns
Returns the created PII token if it’s successful. Otherwise, this call raises an error.
{ "id": "pii_18PwbX2eZvKYlo2CzRXgwN3J", "object": "token", "client_ip": "124.123.76.134", "created": 1466783547, "livemode": false, "redaction": null, "type": "pii", "used": false}Retrieves the token with the given ID.
Parameters
No parameters.
Returns
Returns a token if you provide a valid ID. Raises an error otherwise.
{ "id": "tok_1N3T00LkdIwHu7ixt44h1F8k", "object": "token", "card": { "id": "card_1N3T00LkdIwHu7ixRdxpVI1Q", "object": "card", "address_city": null, "address_country": null, "address_line1": null, "address_line1_check": null, "address_line2": null, "address_state": null, "address_zip": null, "address_zip_check": null, "brand": "Visa", "country": "US", "cvc_check": "unchecked", "dynamic_last4": null, "exp_month": 5, "exp_year": 2026, "fingerprint": "mToisGZ01V71BCos", "funding": "credit", "last4": "4242", "metadata": {}, "name": null, "tokenization_method": null, "wallet": null }, "client_ip": "52.35.78.6", "created": 1683071568, "livemode": false, "type": "card", "used": false}