Trusted Twins

Trusted twins are twins that are connected to your twin. By connecting to a trusted twin, both twins have access to one another’s data. For example, the twins can see each other’s personalities to coordinate relevant activities between the parties.


List all your trusted twins

Query a twin to see its trusted twin network

Add a trusted twin to your twin

To Delete or Remove a Trusted Twin


List all your trusted twins

To list the trusted twins connected to your twin, you can do a GET request to the following endpoint.

curl --location --request GET '<API_URL>/my/connections/' \ --header 'Content-Type: application/vnd.api+json' \ --header 'X-Organization: <ORG_ID>' \ --header 'X-Twin: <TWIN_ID>' \ --header 'Authorization: Token <ACCESS_TOKEN>'

Query a twin to see its trusted twin network

To view the trusted twins connected to a particular twin, you can do a POST request to the following endpoint, with the name of the twin you want to query.

curl --location --request POST '<API_URL>/connections/' \ --header 'Content-Type: application/vnd.api+json' \ --header 'X-Organization: <ORG_ID>' \ --header 'X-Twin: <TWIN_ID>' \ --header 'Authorization: Token <ACCESS_TOKEN>' --date-raw '{ "data":{ "type": "connections", "attributes": { "name": "<TRUSTED_TWIN_NAME>" } } }'

This will return a response similar to the following:

{ "data": { "type": "connections", "id": "401df87b-3f1c-4b55-b335-b3341e36d0e1", "attributes": { "created": "2022-07-01T16:35:35.722701Z", "modified": "2022-07-01T16:35:35.722701Z", "name": "<TWIN_NAME_ID>", "description": "", "meta-data": {} }, "relationships": { "organization": { "data": null }, "connections": { "data": [], "meta": { "count": 0 } } } } }

Add a trusted twin to your twin

To add a trusted twin to your twin, you can POST a request to the following url:

curl --location --request POST '<API_URL>/connections/add_connection' \ --header 'Content-Type: application/vnd.api+json' \ --header 'X-Organization: <ORG_ID>' \ --header 'X-Twin: <TWIN_ID>' \ --header 'Authorization: Token <ACCESS_TOKEN>' --date-raw '{ "data":{ "type": "connections", "attributes": { "twin_id": "<TRUSTED_TWIN_ID>" } } }'

An example response will look like the following:

{ "data": { "type": "connections", "id": "<YOUR_TWIN_ID>", "attributes": { "created": "2022-06-30T16:28:16.183628Z", "modified": "2022-06-30T16:28:16.183628Z", "name": "Personal", "description": "", "meta-data": {} }, "relationships": { "organization": { "data": { "type": "organizations", "id": "<YOUR_ORG_ID>" } }, "connections": { "data": [ { "type": "twins", "id": "<OTHER_TWIN_ID>" } ], "meta": { "count": 1 } } } } }

To Delete or Remove a Trusted Twin

To delete a trusted twin (this deletes the connection for both parties), you can send a DELETE request on the url like the following:

curl --location --request POST '<API_URL>/connections/delete_connection' \ --header 'Content-Type: application/vnd.api+json' \ --header 'X-Organization: <ORG_ID>' \ --header 'X-Twin: <TWIN_ID>' \ --header 'Authorization: Token <ACCESS_TOKEN>' --date-raw '{ "data":{ "type": "connections", "attributes": { "twin_id": "<TRUSTED_TWIN_ID>" } } }'