Creating Share Tokens

Source Organizations can create Share Tokens to share end user data from completed Inquiries with data sharing partners (Destination Organizations). The Destination Organization can use the Share Token to copy and verify the end user’s data.

Source Organizations can create Share Tokens via API, Dashboard, or Workflow.

Creating Share Tokens via API

To create a Share Token via API, the Source Organization provides the Organization Bridge ID and an Inquiry ID. The bridge-id specifies which partner organization can access the specified source-id, and only that partner organization is able to redeem the created Share Token. The source-id must be an Inquiry ID.

$
curl -X POST https://api.withpersona.com/api/v1/connect/share-tokens \
>
  -H "Authorization: Bearer <token>" \
>
  -H "Content-Type: application/json" \
>
  -d '{
>
    "data": {
>
      "attributes": {
>
        "bridge-id": "cnob_ABC123",
>
        "source-id": "inq_ABC123"
>
      }
>
    }
>
  }'

1
{
2
  "data": {
3
    "type": "connect/share-token",
4
    "id": "cnst_ABC123",
5
    "attributes": {
6
      "status": "new",
7
      "source-id": "inq_ABC123",
8
      "created-at": "2023-08-17T23:18:13.000Z",
9
      "updated-at": "2023-08-17T23:18:13.000Z",
10
      "expires-at": "2023-08-18T23:18:13.000Z"
11
    }
12
  }
13
}

Creating Share Tokens via Dashboard

Source Organizations can also create Share Tokens using their Dashboard under the Connect > Share Tokens page. This can be helpful for testing and one-off data shares. Creating the Share Token requires selecting an Organization Bridge and providing an Inquiry ID. Only the specified Destination Organization will be able to redeem the Share Token, and the Source ID must be an Inquiry ID.

Creating Share Tokens via Workflows

Source Organizations can use Workflows to automate Share Token creation. For example, the Source Organization can use a Workflow to automatically create a Share Token upon Inquiry completion. Similarly, the Destination Organization can use a Workflow to automatically redeem the created Share Token. This can be helpful for integrating into Connect with minimal developement work.

If you’re interested in using Workflows to automate Share Token creation, please reach out to your Persona account team or connect@withpersona.com for additional information.

Exchanging Share Tokens

After creating a Share Token, the Source Organization can send it to the Destination Organization using the Destination Organization’s API or SDK, or another secure channel. Alternatively, the Destination Organization can use a Workflow to automatically get notified about and redeem Share Tokens when they are created.