Passkey Authentication

An integration guide for an IVR or IVA

Credentials

For this integration, you'll need your Secret Key, found in Developer Settings.

Step 1: Check customer enrollment

First, we'll make an API call to check whether the customer is enrolled in the Journey Passkey Authentication service.

curl -X POST https://api.journeyid.com/passkeys/bootstrap \
  -H "Authorization: Bearer <SECRET_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "phoneNumber": "+1234567890", // e164 formatted phone number
    "sessionRef": "1234567890", // a unique identifier for the session
    "customerRef": "1234567890" // a unique identifier for the customer
  }'

Input	Description	Required	Example
phoneNumber	The incoming ANI	Yes	+1234567890
sessionRef	The call or chat ID	Yes	112fba89-5c74
customerRef	An internal and unique customer identifier	No	3e4167ad-7379

Refs are 8-64 characters and can contain alphanumeric characters, hyphens, underscores, and @ symbols.