Journey

Appearance

Results API Documentation ​

Retrieve Result ​

GET https://api.journeyid.com/results/:id

Retrieves a specific result record by its request ID.

Query Parameters ​

  • id: string (ULID) - Required. The unique identifier of the result to retrieve.

Response ​

json
{
  "accountId": "string",
  "app": "e-form" | "document-signature"| "one-time-passcode" | "passkeys" | "payments",
  "customerRef": "string",
  "id": "string",
  "sessionRef": "string",
  "status": "success" | "failure" | "timeout",
  "timestamp": "2024-01-01T00:00:00Z",
  "agentId": "string (sometimes)", // Typically the email of the agent that initiated the request
  "phoneNumber": "string (sometimes)",
  "ipAddress": "string (sometimes)",
  "userAgent": "string (sometimes)"
}

App-Specific Fields ​

The response includes app-specific fields based on the app type:

Document Signature ​
json
{
  "title": "string",
  "url": "string (optional)"
}
E-Form ​
json
{
  "data": [
    {
      "type": "string",
      "key": "string",
      "value": "any"
    }
  ],
  "zeroKnowledge": "boolean"
}
One-Time Passcode ​
json
{
  // No additional fields
}
Passkeys ​
json
{
  "action": "string"
}
Payments ​
json
{
  "product": "string",
  "quantity": "number",
  "amount": "number",
  "currency": "string",
  "gateway": "string",
  "productId": "string",
  "transactionId": "string",
  "gatewayUrl": "string (optional)"
}