Integration flows

The integrations most of Parasend's customers build, step by step. Each box is one step, in the order it happens; the label says who acts, and every endpoint and event links to its page. Start with the first: the others build on it.

• Your system
• In the portal
• Parasend
• Recipient
• Webhook to you
• Anyone

Send and prove, in Parasend’s look

The basic integration: one document to one person, notified from Parasend’s address in Parasend’s look, and the proof back in your system.

1. Your systemUpload the document POST/v1/files

   Each file gets a fil_ ID and its SHA-256.

2. Your systemCreate the delivery POST/v1/deliveries

   To one recipient by e-mail, phone or both, with the files, a title and the identification you require.

3. ParasendParasend notifies the recipient delivery.notified

   By e-mail, SMS or both, from Parasend’s address and in Parasend’s look.

4. RecipientThe recipient opens, identifies and confirms delivery.openeddelivery.confirmed

   With eID, an ID document check, an SMS code or the link alone, as you chose.

5. Webhook to youYour endpoint hears every step POST/v1/webhook_endpoints delivery.notifieddelivery.openeddelivery.confirmeddelivery.evidence_sealed

   Set up once. Signed, retried and replayable; or ask for them with List events.

6. Your systemKeep the proof GET/v1/deliveries/{id}/evidence/documentGET/v1/deliveries/{id}/evidence/record

   The Delivery Certificate (PDF) and the sealed evidence record (XML), once delivery.evidence_sealed arrives.

7. AnyoneAnyone can check the certificate POST/v1/public/verify

   At parasend.com/verify, or with the API, without an account.

Nobody confirms? Reminders follow by your follow-up policy (delivery.reminded), and at the end delivery.expired.

Your own look: brand, e-mail sender and link domain

The same delivery, but the notice comes From your own address, its link is on your own domain, and the notice and the page carry your logo and colours. The setup is done once, in the portal; the API reads it and uses it.

1. In the portalAdd your e-mail sender GET/v1/email_senders/{id}POST/v1/email_senders/{id}/check

   Under E-mail senders: your From address, such as tilkynningar@fyrirtaeki.example. Publish the DNS records it shows; the API follows it until it is active.

2. In the portalAdd your link domain GET/v1/recipient_domains

   Under My domains: such as skjol.fyrirtaeki.example, with its DNS record. Recipients’ links then use it.

3. Your systemMake a brand profile POST/v1/brand_assetsPOST/v1/brand_profiles

   Your logo, colours and name, with the API or in the portal. Choose its e-mail sender and link domain in the portal (that needs a fresh sign-in), and make it your default so every delivery uses it.

4. Your systemCreate the delivery POST/v1/deliveries

   As in the first flow. options.brand_profile_id picks a profile; without it, your default is used.

5. RecipientThe recipient gets it from you delivery.notifieddelivery.openeddelivery.confirmed

   The e-mail From your address, the link on your domain, your look in the notice and on the page.

6. Your systemThe same proof GET/v1/deliveries/{id}/evidence/document

   Events, evidence and certificate as in the first flow.

While your sender cannot send, notices go from Parasend’s address under your brand’s name, or wait for it, as you chose (on_failure).

Many at once: batches

For runs of hundreds or thousands: put the deliveries in a batch, check it, and send it out in one go.

1. Your systemUpload the files POST/v1/files

   One per document, or one shared by every delivery.

2. Your systemCreate a batch POST/v1/batches

   Its name, the defaults every delivery takes, and a follow-up policy.

3. Your systemAdd the deliveries POST/v1/batches/{id}/deliveries

   In as many calls as you need; each delivery is checked as it is added.

4. Your systemCheck it before sending GET/v1/batches/{id}/preflight

   What would go, what would not and why, before anything is sent.

5. Your systemSend it out POST/v1/batches/{id}/finalize batch.finalized

   Every delivery goes its own way from here, with its own events.

6. Webhook to youFollow the batch GET/v1/batches/{id}/reportGET/v1/batches/{id}/deliveries batch.completed

   The report counts where every delivery stands.

7. Your systemWhat it cost GET/v1/deliveries/costs

   batch_id adds up the whole batch.

Debt collection, with the cost passed on

A notice to a debtor, reminders until they confirm, and Parasend’s cost for each delivery, to pass on at cost.

1. Your systemSet up a follow-up policy POST/v1/reminder_policies

   Reminders by e-mail and SMS after the days you choose, until the recipient confirms.

2. Your systemSend the notice POST/v1/deliveries

   To the debtor, with recipient.personal_code and options.reminder_policy; metadata holds your claim reference.

3. ParasendParasend reminds POST/v1/deliveries/{id}/remind delivery.reminded

   Automatically, by the policy; Send a reminder sends one now.

4. RecipientThe debtor confirms delivery.confirmed

   Reminders stop.

5. Your systemFind a debtor’s deliveries GET/v1/deliveries

   pin finds every delivery to one kennitala.

6. Your systemPass the cost on GET/v1/deliveries/{id}/costGET/v1/deliveries/costs

   Every billable item with amount, vat and total_amount; from and to give a month, so each cost is counted once.

7. Your systemProof for the file GET/v1/deliveries/{id}/evidence/document

   The Delivery Certificate for the claim.

Only this person may open it

For documents only one named person may see: the delivery opens only for that person’s own eID or ID document.

1. Your systemCreate the delivery for one person POST/v1/deliveries

   recipient.conditional_authentication: true with their personal_code and verification_level: high (eID), or their id_document_number with substantial (ID document check).

2. RecipientThe recipient proves who they are delivery.opened

   Only that person’s eID, or ID document, opens it.

3. Webhook to youSomeone else is turned away delivery.auth_failed

   With the reason personal_code_mismatch or id_document_mismatch. The delivery stays closed.

4. RecipientThe right person confirms delivery.confirmed

   The verified identity is recorded.

5. Your systemProof of who opened it GET/v1/deliveries/{id}/evidence/document

   The certificate names the verified identity and its level.

#Next

• Quickstart: the first flow, in five minutes, with a test key.
• Receiving webhooks: the events every flow sends, signed.
• Test and live mode: try every flow in test mode first; nothing is sent and nothing is billed.