Verification Requests

Get request by reference ID

Look up a verification request by your external reference_id. Returns the most recent matching request.

get/api/v1/verification-requests/by-reference/{referenceId}

Request

  • Base URL: https://api.proof.holdings
  • URL: https://api.proof.holdings/api/v1/verification-requests/by-reference/{referenceId}
  • Auth: HTTP bearer

Path parameters

referenceIdstring required

Your external reference ID

Example:order_12345

Response

Verification request details

idstring required

MongoDB ObjectId

reference_idstring
status'pending' | 'partial' | 'completed' | 'expired' | 'cancelled' required

Status of a verification request

action_type'verification' | '2fa' | 'login' | 'custom' | 'confirmation' | 'authorization' required

Type of action for verification request or authorization

partial_okboolean required
validity_requirementstring nullable

Required proof freshness as set on the request (e.g. "7d"); null when none was set

verification_urlstring

URL for the verification flow

redirect_urlstring nullable
callback_urlstring nullable

The webhook URL set on the request, if any

expires_atstring date-time required
completed_atstring date-time
created_atstring date-time required
updated_atstring date-time

Example response

{
  "id": "507f1f77bcf86cd799439011",
  "status": "pending",
  "computed_state": {
    "status": "pending"
  },
  "assets": [
    {
      "type": "phone",
      "allowed_channels": [
        "telegram",
        "whatsapp"
      ],
      "status": "pending",
      "verified_identifier": "+37069199199",
      "verified_channel": "telegram"
    }
  ],
  "action_type": "verification",
  "action_context": {
    "title": "Approve wire transfer",
    "amount": 15000,
    "currency": "USD",
    "entity": "production-cluster"
  },
  "validity_requirement": "7d",
  "verification_url": "https://proof.holdings/verify/abc123"
}

Changes

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