connect

Redeem a Share Token

Initiates redemption of a Share Token in one of two modes:

  • Clone: Omit data.attributes.destination-id to create a new object from the source. Inquiry and Verification Share Tokens can be cloned.
  • Hydrate: Provide data.attributes.destination-id to import source data into an existing object. Account, Transaction, and Inquiry Share Tokens can hydrate an existing Account, Transaction, or Inquiry.

Redemption is asynchronous. A successful request returns the Share Token with a pending status while Persona processes the import.

post/connect/share-tokens/{share-token-id}/redeem

Request

  • Base URL: https://api.withpersona.com/api/v1
  • URL: https://api.withpersona.com/api/v1/connect/share-tokens/{share-token-id}/redeem
  • Auth: HTTP bearer

Path parameters

share-token-idstring required

The token/ID of the Share Token to be redeemed.

Query parameters

includestring

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details.

fieldsobject

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.

Headers

Key-Inflection'camel' | 'kebab' | 'snake'

Determines casing for the API response.

Idempotency-Keystring

Ensures the request is idempotent.

Persona-Version'2026-09-29' | '2025-12-08' | '2025-10-27' | '2023-01-05' | '2022-09-01' | '2021-08-18' | '2021-07-05' | '2021-02-21' | '2020-05-18'

Server API version. More info on versioning can be found here.

Request body

Response

Share Token redemption has been initiated and is processing.

Changes

No recorded changes to this operation across all 1 revision of this API.