Create an ephemeral key

POST / v1 / ephemeral_keys

Creates a short-lived API key for a given resource.

Parameters

• customer string The ID of the Customer you’d like to modify using the resulting ephemeral key.
• issuing _ card string The ID of the Issuing Card you’d like to access using the resulting ephemeral key.
• nonce string A single-use token, created by Stripe.js, used for creating ephemeral keys for Issuing Cards without exchanging sensitive information.
• verification _ session string The ID of the Identity VerificationSession you’d like to access using the resulting ephemeral key

Returns

Returns the key object.

cURL

Response

{ "id": "ephkey_1Mr6PhLkdIwHu7ix9Al0eucz", "object": "ephemeral_key", "associated_objects": [ { "type": "customer", "id": "cus_NcCEBjJZgYGgljz" } ], "created": 1680226347, "expires": 1680229947, "livemode": false, "secret": "ek_test_YWNjdF8xTTJKVGtMa2RJd0h1N2l4LDJTWXVEUUY2c0hZTllRc0dGb2hVanBXRktQTlZoNHc_00TkfmS8Az"}

Immediately invalidate an ephemeral key

DELETE / v1 / ephemeral_keys /:id

Invalidates a short-lived API key for a given resource.

Parameters

No parameters.

Returns

Returns the key object.

Response

{ "id": "ephkey_1Mr6PhLkdIwHu7ix9Al0eucz", "object": "ephemeral_key", "associated_objects": [ { "type": "customer", "id": "cus_NcCEBjJZgYGgljz" } ], "created": 1680226347, "expires": 1680229947, "livemode": false}