List authorizations

Get paginated list of authorizations with filtering by status, phone, and channel.

get/api/v1/authorizations

Request

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

Query parameters

pageinteger

Example:1

limitinteger

Example:20

status'pending' | 'active' | 'expired' | 'revoked' | 'denied'

Status of an authorization

Example:active

phonestring

Example:+15551234567

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

Channel authorized for sending confirmations

Example:whatsapp

Response

List of authorizations

Example response

{
  "data": [
    {
      "id": "507f1f77bcf86cd799439011",
      "status": "active",
      "hitl_id": "507f1f77bcf86cd799439011",
      "circle_id": "507f1f77bcf86cd799439011",
      "recipient": "123456789",
      "phone": "+15551234567",
      "channel": "whatsapp",
      "scope": "confirmations",
      "business_name": "Acme Corp",
      "label": "Sarah — CFO",
      "recipient_display_name": "Sarah @sarah_cfo",
      "enrolled": true,
      "verification_id": "507f1f77bcf86cd799439011",
      "confirmations_sent": 5
    }
  ]
}

Changes

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