Skip to content

FMSG-002 Id Standard

FMSG-002 Id Standard describes an HTTP API for a fmsg host to lookup the identity of a participant to:

  1. Verify the user indeed exists
  2. Check user is accepting messages
  3. Get user’s daily and total message count and data limits, and actuals.
  4. Get user metadata such as display name and any host specific tags

TODO move address from query string to body

GET /addr/{address}

{
    "name": "jsmith",
    "address": "@jsmith@example.com",
    "displayName": "John Smith",
    "acceptingNew": true,

    "limitRecvSizeTotal": -1,
    "limitRecvSizePerMsg": 1024,
    "limitRecvSizePer1d": 102400,
    "limitRecvCountPer1d": 500,

    "limitSendSizeTotal": -1,
    "limitSendSizePerMsg": -1,
    "limitSendSizePer1d": -1,
    "limitSendCountPer1d": -1,

    "recvSizeTotal": 92835135,
    "recvSizePerPer1d": 0,
    "recvCountPer1d": 0,

    "sendSizeTotal": 23459872,
    "sendSizePer1d": 23423,
    "sendCountPer1d": 4,

    "tags": []
}

POST /addr/recv POST /addr/sent

{
    "address": "@alice@example.com",
    "timestamp": 1776482588.5446732,
    "size": 456
}