InstanceShareableBertyID returns a Berty ID that can be shared as a string, QR code or deep link.

POST /messenger/v1/InstanceShareableBertyID

Body Required

  • reset boolean(boolean)
  • display_name string

Responses

  • 200

    A successful response.

    Hide response attributes Show response attributes object
    • berty_id object
      Hide berty_id attributes Show berty_id attributes object
      • public_rendezvous_seed string(byte)
      • account_pk string(byte)
      • display_name string
    • berty_id_payload string
    • deep_link string
    • html_url string
  • default

    An unexpected error response

    Hide response attributes Show response attributes object
    • error string
    • code integer(int32)
    • message string
    • details array[object]
      Hide details attributes Show details attributes array[object]
      • type_url string
      • value string(byte)
POST /messenger/v1/InstanceShareableBertyID 
curl \
 -X POST http://api.example.com/messenger/v1/InstanceShareableBertyID \
 -d '{"reset":true,"display_name":"string"}'
Request example 
{
  "reset": true,
  "display_name": "string"
}
Request examples 
{
  "reset": true,
  "display_name": "string"
}
Response examples (200) 
{
  "berty_id": {
    "public_rendezvous_seed": "string",
    "account_pk": "string",
    "display_name": "string"
  },
  "berty_id_payload": "string",
  "deep_link": "string",
  "html_url": "string"
}
Response examples (200) 
{
  "berty_id": {
    "public_rendezvous_seed": "string",
    "account_pk": "string",
    "display_name": "string"
  },
  "berty_id_payload": "string",
  "deep_link": "string",
  "html_url": "string"
}
Response examples (default) 
{
  "error": "string",
  "code": 42,
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string"
    }
  ]
}
Response examples (default) 
{
  "error": "string",
  "code": 42,
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string"
    }
  ]
}