Journey

Appearance

Document Signature API Documentation ​

Overview ​

The Document Signature API provides endpoints for managing document signing operations.

Bootstrap ​

GET https://api.journeyid.com/document-signature/bootstrap

Retrieves the initial configuration for document signing, including available documents and customer information.

Request Body ​

json
{
  "phoneNumber": "string (E.164 format)",
  "customerRef": "string (optional)",
  "sessionRef": "string (optional)"
}

Response ​

json
{
  "documents": [
    {
      "id": "string (UUID)",
      "title": "string",
      "variables": [
        {
          "name": "string",
          "type": "string",
          "required": boolean
        }
      ]
    }
  ],
  "customers": [
    {
      "id": "string",
      "name": "string",
      "email": "string"
    }
  ]
}

Send ​

POST https://api.journeyid.com/document-signature/send

Sends a document for signature to a customer.

Request Body ​

json
{
  // Common request fields
  "sessionRef": "string",
  "customerRef": "string (optional)",
  "phoneNumber": "string (E.164 format)",

  // App specific fields
  "documentId": "string (uuid)",
  "variables": {
    "[variableName]": "string"
  }
}

Response ​

json
{
  "requestId": "string",
  "wsToken": "string"
}