One-Time Passcode API Documentation

Overview

The One-Time Passcode API provides endpoints for managing one-time passcode (OTP) operations.

Bootstrap

GET https://api.journeyid.com/one-time-passcode/bootstrap

Retrieves the initial configuration for OTP operations.

Request Body

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

Response

{
  "customers": [
    {
      "id": "string",
      "name": "string",
      "email": "string"
    }
  ]
}

Send OTP

POST https://api.journeyid.com/one-time-passcode/send

Sends a one-time passcode to a customer.

Request Body

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

Response

{
  "success": true,
  "message": "string",
  "requestId": "string (ULID)"
}

Check OTP

POST https://api.journeyid.com/one-time-passcode/check

Verifies a one-time passcode.

Request Body

{
  "requestId": "string (ULID)",
  "code": "string (6 characters)"
}

Response

{
  "codeMatch": boolean
}