core-documentation

Citizen’s emails

Get emails of a citizen

GET /citizen/:handle/emails

Auth

Paging

NO

Response

{
  rows: [
    {
      id
      email
      is_primary
      is_verified
      visibility
    }
  ]
  totalRowCount
}

Add an email to a citizen

POST /citizen/:handle/emails

Auth

Paging

NO

Input

Key Type Required Description
email string 🌕 要新增的email

Sample input

{
  "email":"[email protected]"
}

Delete a email from a citizen

DELETE /citizen/:handle/emails

Auth

Paging

NO

Input

Key Type Required Description
email string 🌕 要刪除的email

Sample input

{
  "email":"[email protected]"
}

Request verification

GET /citizen/:handle/emails/:emailID/request_verification

Auth

Paging

NO

Confirm verification

GET /citizen/:handle/emails/:emailID/confirm_verification/:token

Auth

Paging

NO

Response

200 ok

{ 
  "message" : "EMAIL_VERIFY_SUCCESS",
  "email": "{email}"
}

401 unauthorized

{ 
  "statusCode" : 401,
  "message": "EMAIL_VERIFY_FAILED"
}

Set visibility

PATCH /citizen/:handle/emails/:emailID/visibility

Auth

Paging

NO

Input

Key Type Required Description
visibility string 🌕 “public” 或 “private”

Sample input

{
  "visibility":"public"
}

Set primary email

PATCH /citizen/:handle/emails/:emailID/set_primary

Auth

Paging

NO