File requests

A file request (a request page in the API) lets other people send you files or answer a form, encrypted to your key. Files land in your inbox; form answers are stored encrypted. Create requests and read what arrives over the API.

List or create file requests (files or form mode).

Files uploaded to the request.

Form answers (decrypted only when the request was made readable by the server).

Make an access code for a request that needs one.

Email the request link (one access code per address when the request needs codes).

Close the request to new uploads and answers.

On your website

Put a file request on your own website: under Requests, open the request, press Add to your website, add your website's address and paste the code it shows. The form runs in a frame served by Share, so your website never sees what people send, and no website you have not listed can show it. When files or answers arrive, whoever made the request gets an email, at most every 10 minutes.

The website guide has the steps for WordPress, Wix, Shopify, Squarespace and Webflow, and the code for any other website.

Signature requests

A key with signatures:read reads your signature requests and who has signed; signatures:write also prepares, sends, reminds and cancels. The document and what each signer entered are encrypted where the request is made, so an answer carries them sealed, for code that holds the document's key, and never the key itself.

Your workspace's requests, newest first, with each signer's status (invited, signed, declined) and how many have signed. limit (up to 100) and before (a time) page through them.

One request: its signers in order, with when each was invited, signed or declined, whose turn it is, and the document's fingerprint as sent and after each signature.

Emails one signer a reminder now, without a link. Only a signer whose turn it is and who has not signed, at most once an hour; it spends one of the day's emails.

Ends the request: nobody can sign any more, the signers are told, and the document is deleted.

Prepares a request without the document, for you to finish in the browser: its signers, order, name, note, how long it stays open and reminders. Nothing is mailed. The answer's review_url opens the new signature request form filled in from it, where you add the PDF and send. A draft lasts seven days.

Sends a request whose PDF and fields your code encrypted, as share sign does: then the document's parts, …/documents/{share_id}/complete, and …/{id}/invite with the link and its key. With "hold": true it waits as a draft for you to check and send in the browser instead.

ID checks

A key with id_checks:read sees your ID checks; id_checks:write makes them. A check's answers give its id, status, parts, dates and the page in the app that shows the result, never the person's address or anything Didit found: those open only in a browser holding your workspace's key.

Send "email", and "sanctions": true or "address": true for those parts, "keep_copy": true to keep a copy of the ID. The person is emailed from your address; with "send": "link" the answer carries the link once instead, for you to send. A check counts against the month when it is made, and gives its place back if it is never started.

curl -s $SHARE/api/v1/id-checks -H "Authorization: Bearer $SHARE_API_KEY"   -H "content-type: application/json"   -d '{"email": "maeve.doyle@client.test", "sanctions": true, "address": true}'

{ "check": { "id": "7f3c9a…", "status": "waiting", "parts": ["id", "sanctions", "address"],
  "keep_copy": false, "url": "https://share.deltabreen.eu/app/id-checks/7f3c9a…", … } }

The status is waiting, in_progress, passed, review (look at it yourself), failed, expired or cancelled.

Remind sends a new link to a check not yet started (once a day); the old one stops working. Cancel stops an open check, and Didit deletes what it holds.

Account

The signed-in account, its plan and the token's scopes.

Current usage against your plan's limits.