[beta] Create a Data Sharing Agreement

Creates a new Data Sharing Agreement (DSA) in pending status. When the flexible operating model is enabled, either the provider or recipient can create an agreement, and the authenticated caller determines createdByParty. The provider owns the assets, and the two organizations must differ. providerOrganizationId defaults to the caller; recipient callers supply the provider ID and providerOrganizationName. Provider callers supply recipientOrganizationName. payer selects the party whose Asset Sharing license supports the agreement and defaults to the creator. Without the flexible operating model, only the provider can create and pay. Use providerDataPackages and recipientDataPackages to declare which categories of data flow to each side, and operator to indicate which organization operates the assets (where the gateways live).

Rate limit: 100 requests/min (learn more about rate limits here).

To use this endpoint, select Write Asset Sharing under the Asset Sharing category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for creating a Data Sharing Agreement.

string
enum
required

Defines where the gateways will be located. Valid values: provider, recipient

Allowed:
string
enum

Party whose Asset Sharing license supports the agreement. Defaults to the creator when the flexible operating model is enabled. Otherwise, the provider pays; omit this field or specify provider. Specifying recipient requires the flexible operating model to be enabled. Valid values: provider, recipient

Allowed:
providerDataPackages
array of strings
required

List of data packages the provider will see.

providerDataPackages*
Allowed:
string

ID of the organization that owns the assets. Defaults to the caller's organization. Recipient-initiated agreements require the flexible operating model to be enabled.

string
length between 3 and 255

Display name for the provider. Required when the caller is the recipient; the caller's own organization name is resolved automatically.

recipientDataPackages
array of strings
required

List of data packages the recipient will see.

recipientDataPackages*
Allowed:
string
required

The ID of the recipient organization.

string
length between 3 and 255

Display name for the recipient. Required when the caller is the provider; the caller's own organization name is resolved automatically.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json