Circles

Add a Circle member

Add a pending member by name (+ an optional pre-declared WhatsApp phone). Opts the Circle into Proof of Me.

post/api/v1/circles/{id}/members

Request

  • Base URL: https://api.proof.holdings
  • URL: https://api.proof.holdings/api/v1/circles/{id}/members
  • Auth: one of:
    • HTTP bearer
    • API key in cookie auth_token

Path parameters

idstring required

MongoDB ObjectId

Example:507f1f77bcf86cd799439011

Request body

namestring required
whatsapp_phonestring

Optional pre-declared WhatsApp phone in E.164 (leading +); Telegram is captured at enrollment

Example request

{
  "name": "Mum",
  "whatsapp_phone": "+15551112222"
}

Response

Member added

idstring required

MongoDB ObjectId

namestring required
status'pending' | 'active' required
has_telegramboolean required

Whether the member has a Telegram channel (declared or verified)

has_whatsappboolean required

Whether the member has a WhatsApp channel (declared or verified)

mesh_opted_inboolean required
mesh_opt_outboolean required

The member sent /opt_out: they receive no drills, reminders or checks they did not start themselves

enrolled_phone_hintstring nullable required

Masked form of the phone the contact proved when they enrolled (the Telegram shared contact or the WhatsApp sender) — country prefix and last four digits only, never the full number. Lets the owner see who actually joined. Null until the member enrolls, and for members enrolled before it was recorded.

enrolled_atstring date-time nullable required
last_verified_atstring date-time nullable required

When this member last CONFIRMED an identity check asked of them — i.e. last proved it was them. Null until they have.

Example response

{
  "id": "507f1f77bcf86cd799439011",
  "name": "Mum",
  "status": "active",
  "enrolled_phone_hint": "+9••••••4171"
}

Changes

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