Business Cards

All endpoints in this document require secret: sk1_... and x-account-access-id: aid1.....

Business cards are contact card entries owned by the account. Each card can be associated with an alias and shared via a QR code vCard flow.

Endpoints

List business cards

`GET /api/v1/business-cards`

Returns all business cards owned by the authenticated account.

Response fields

[]
[].id
[].name
[].aliasId
[].aliasAddress

Response codes

200 OK
401 Unauthorized

Example

curl "http://Hide-My-Email.info/api/v1/business-cards" \
  -H "secret: sk1_example" \
  -H "x-account-access-id: aid1_example"

Read one business card

`GET /api/v1/business-cards/

Returns one business card owned by the authenticated account.

Path parameters

cardId

Response fields

id
name
aliasId
aliasAddress

Response codes

200 OK
401 Unauthorized
404 Not Found

Example

curl "http://Hide-My-Email.info/api/v1/business-cards/card_123" \
  -H "secret: sk1_example" \
  -H "x-account-access-id: aid1_example"

Create business card

`POST /api/v1/business-cards`

Creates a new business card for the authenticated account.

Request body fields

name - required
aliasId - optional alias to associate with this card

Response fields

success
message
card
card.id
card.name
card.aliasId
card.aliasAddress

Response codes

200 OK
400 Bad Request
401 Unauthorized

Example

curl -X POST "http://Hide-My-Email.info/api/v1/business-cards" \
  -H "secret: sk1_example" \
  -H "x-account-access-id: aid1_example" \
  -H "Content-Type: application/json" \
  -d "{\"name\":\"Alice\",\"aliasId\":\"alias_123\"}"

Update business card

`PUT /api/v1/business-cards/

Updates one business card owned by the authenticated account.

Path parameters

cardId

Request body fields

name - required
aliasId - optional

Response fields

success
message
card

Response codes

200 OK
400 Bad Request
401 Unauthorized
404 Not Found

Example

curl -X PUT "http://Hide-My-Email.info/api/v1/business-cards/card_123" \
  -H "secret: sk1_example" \
  -H "x-account-access-id: aid1_example" \
  -H "Content-Type: application/json" \
  -d "{\"name\":\"Alice Updated\",\"aliasId\":\"alias_456\"}"

Delete business card

`DELETE /api/v1/business-cards/

Deletes one business card owned by the authenticated account.

Path parameters

cardId

Response body: none.

Response codes

204 No Content
401 Unauthorized
404 Not Found

Example

curl -X DELETE "http://Hide-My-Email.info/api/v1/business-cards/card_123" \
  -H "secret: sk1_example" \
  -H "x-account-access-id: aid1_example"