{
  1. Introduction
    1. Service description
    2. Environments
  2. Getting started
    1. Authentication
    2. Upload document
    3. Create dossier
    4. Send invites
    5. Dossier download
  3. Events
    1. Event webhooks
    2. Subscribe to events
    3. Retrieve status callback
  4. Error handling
  5. Use cases
    1. Change language / locale
    2. Send invite using SMS
    3. Send invite using WhatsApp Business Platform
    4. Include invite in your own system
    5. Require identification
    6. Require payment
    7. Cancel a dossier
    8. Configure branding
    9. Configure invitee emails
    10. Create dossier based on a template
  6. Swagger API documentation

Include invite in your own system

When you don't want to use any of the channels offered by Sign, you can retrieve the invite URL. You can distribute this URL in any way you want, for example:

  • Redirect from your own website or software
  • Send custom emails
  • Send using a different channel

Request

POST https://api.cmdisp.com/sign/v1/dossiers/{dossierId}/invites

Request headers

Content-Type: application/json
Authorization: Bearer GENERATED_TOKEN_HERE

Request body

[
    {
        "inviteeId": "d079c1a6-ca7e-494f-bfcc-9e12fb87e8ac",
        "expiresIn": 2592000
    }
]

Response

[
    {
        "id": "d55ac986-656a-454f-9fac-1aabe879442d",
        "inviteeId": "d079c1a6-ca7e-494f-bfcc-9e12fb87e8ac",
        "inviteUri": "https://www.cm.com/en-us/app/sign/invites/HbmN8fb2lhElgv3cEgByjGNfmG0okiWxbibP84i9qyR1cymFA0...",
        "readOnly": false,
        "authenticationMethods": [],
        "identificationMethods": [],
        "channel": null,
        "reminder": false,
        "emailSentAt": null,
        "emailBouncedAt": null,
        "expiresIn": 2592000,
        "expiresAt": "2022-02-01T0:00:00+00:00",
        "createdAt": "2022-01-01T0:00:00+00:00"
    }
]

The invite URL can be retrieved from the inviteUri field.