Sessions

Create phone session

Create a phone verification session (phone-first flow).

post/api/v1/sessions

Request

  • Base URL: https://api.proof.holdings
  • URL: https://api.proof.holdings/api/v1/sessions
  • Auth: HTTP bearer

Request body

profile_idstring

The sub-account (project) this is for; its branding and templates are used for every message. An account-wide key may name any project of its account; a project-bound key acts for its own project only (naming another answers 403 profile_mismatch). Omitted: the key's project, else the primary project.

phonestring required

Phone number in E.164 format

channel'whatsapp' | 'telegram' | 'sms'

Preferred messaging channel

Example request

{
  "profile_id": "507f1f77bcf86cd799439011",
  "phone": "+37069199199"
}

Response

Session created

idstring required

MongoDB ObjectId

status'pending' | 'verified' | 'expired' required
created_atstring date-time required
expires_atstring date-time required

Example response

{
  "id": "507f1f77bcf86cd799439011",
  "challenge": {
    "code": "X7K2M9",
    "instruction": "Send X7K2M9 to +370 691 99199 on WhatsApp",
    "expires_at": "2026-02-13T12:00:00Z"
  },
  "proof": {
    "token": "eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9...",
    "expires_at": "2025-01-15T12:00:00Z",
    "confidence": "high"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.