Create a Data Share link, and optionally email it to the recipient.

post

https://example.com/v1/data-share/create-link

Use this when sharing selected company data with a recipient.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

recipientEmail

string

required

The email of the user for which you want to grant access.

recipientRole

string

enum

required

The role of the company in relation to your company. Can affect fields that the recipient will see.

Allowed:

recipientName

string

Optional, but recommended as it's used for email greetings and landing pages.

recipientCompany

string

Optional, but recommended as it's used for email greetings and landing pages.

expiresInHours

number

Defaults to 168

The link generated will be valid for this length of time in minutes. Defaults to 1 week

sendEmail

boolean

Defaults to false

Set to true to send an email invitation with the generated link.

array of strings

Defaults to []

A list of emails to Cc when a an email is sent to the recipient. Only relevant if sendEmail is true.

bcc

array of strings

Defaults to []

A list of emails to Bcc when a an email is sent to the recipient. Only relevant if sendEmail is true.

bcc

shareTaxInfo

boolean

Defaults to false

Opt in to show sensitive tax information. The authenticated user must have the tax security role for their entity, or the request is rejected with a 403.

shareBankInfo

boolean

Defaults to false

Opt in to show sensitive bank information. The authenticated user must have the banking security role for their entity, or the request is rejected with a 403.

showDocumentsOnly

boolean

Defaults to false

Only share access to the document center. This will only share the document center with the documents included under limitAccessToElements (or all of them if limitAccessToElements is omitted).

ndaAcceptanceNeeded

boolean

Defaults to false

Set this flag to require the recipient to agree to an NDA form before being granted access.

ndaTemplate

string

Select the NDA template you want to use with this Data Share. Pass in your unique slug or the ID of the template you want to use.

ndaCallbackUrl

string

When this recipient accepts the NDA, send a request to this URL. Only relevant if ndaAcceptanceNeeded is true, otherwise it's ignored.

When someone accepts the NDA agreement, a request will be sent to this callback URL (if it was provided). It will be a JSON POST request with a DataShareNdaEntry in the payload. This request is only made one time, whether is succeeds or fails.

ndaCallbackUrlVerification

boolean

Defaults to true

When this recipient accepts the NDA, send a request to this URL. Only relevant if ndaAcceptanceNeeded is true, otherwise it's ignored.

This is just an extra check to ensure that the webhook is up and running. For verification, you must respond to a GET NDACALLBACKURL request with a non-error status code and with the payload {"entityId":"ENTITYID"} (replace ENTITYID, which is sent in the header of the request as x-entity-id).

limitAccessToElements

array of objects

Limit access to specific categories/topics/questions (a.k.a elements) specified here. Query list of topics from the API. It will show all parents and children of the provided elements.

limitAccessToElements

external

object

Any JSON-able data you pass in here will be sent back in any webhooks, etc.

Responses

401

The authenticated user has not completed two-factor authentication, which is required to share sensitive tax or bank data.

403

The authenticated user does not have the security role required to share the requested sensitive tax or bank data.

200A payload that includes the newly generated link unique to the recipient and other options you passed in.